From f0bd3cc2c1a621ff9cb83b9f677c87bbd603f606 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Sat, 21 Oct 2017 14:03:27 +0200 Subject: [PATCH] classref: Remove stray spaces in method signatures --- classes/class_@gdscript.rst | 458 +++---- classes/class_acceptdialog.rst | 60 +- classes/class_animatedsprite.rst | 108 +- classes/class_animatedsprite3d.rst | 58 +- classes/class_animation.rst | 242 ++-- classes/class_animationplayer.rst | 236 ++-- classes/class_animationtreeplayer.rst | 386 +++--- classes/class_area.rst | 282 ++--- classes/class_area2d.rst | 234 ++-- classes/class_array.rst | 188 +-- classes/class_arraymesh.rst | 140 +-- classes/class_arvranchor.rst | 38 +- classes/class_arvrcontroller.rst | 54 +- classes/class_arvrinterface.rst | 80 +- classes/class_arvrorigin.rst | 14 +- classes/class_arvrpositionaltracker.rst | 56 +- classes/class_arvrserver.rst | 82 +- classes/class_astar.rst | 104 +- classes/class_atlastexture.rst | 38 +- classes/class_audioeffectamplify.rst | 14 +- classes/class_audioeffectchorus.rst | 110 +- classes/class_audioeffectcompressor.rst | 86 +- classes/class_audioeffectdelay.rst | 158 +-- classes/class_audioeffectdistortion.rst | 62 +- classes/class_audioeffecteq.rst | 20 +- classes/class_audioeffectfilter.rst | 50 +- classes/class_audioeffectlimiter.rst | 50 +- classes/class_audioeffectpanner.rst | 14 +- classes/class_audioeffectphaser.rst | 62 +- classes/class_audioeffectpitchshift.rst | 14 +- classes/class_audioeffectreverb.rst | 98 +- classes/class_audioeffectstereoenhance.rst | 38 +- classes/class_audioserver.rst | 202 ++-- classes/class_audiostreamoggvorbis.rst | 38 +- classes/class_audiostreamplayer.rst | 94 +- classes/class_audiostreamplayer2d.rst | 118 +- classes/class_audiostreamplayer3d.rst | 226 ++-- classes/class_audiostreamrandompitch.rst | 26 +- classes/class_audiostreamsample.rst | 86 +- classes/class_backbuffercopy.rst | 26 +- classes/class_basebutton.rst | 118 +- classes/class_basis.rst | 110 +- classes/class_bitmap.rst | 44 +- classes/class_bitmapfont.rst | 86 +- classes/class_boneattachment.rst | 14 +- classes/class_bool.rst | 20 +- classes/class_boxcontainer.rst | 20 +- classes/class_boxshape.rst | 14 +- classes/class_button.rst | 62 +- classes/class_buttongroup.rst | 8 +- classes/class_camera.rst | 176 +-- classes/class_camera2d.rst | 254 ++-- classes/class_canvasitem.rst | 370 +++--- classes/class_canvasitemmaterial.rst | 26 +- classes/class_canvaslayer.rst | 92 +- classes/class_canvasmodulate.rst | 14 +- classes/class_capsulemesh.rst | 50 +- classes/class_capsuleshape.rst | 26 +- classes/class_capsuleshape2d.rst | 26 +- classes/class_centercontainer.rst | 14 +- classes/class_circleshape2d.rst | 14 +- classes/class_classdb.rst | 122 +- classes/class_collisionobject.rst | 134 +-- classes/class_collisionobject2d.rst | 134 +-- classes/class_collisionpolygon.rst | 38 +- classes/class_collisionpolygon2d.rst | 50 +- classes/class_collisionshape.rst | 38 +- classes/class_collisionshape2d.rst | 38 +- classes/class_color.rst | 74 +- classes/class_colorpicker.rst | 46 +- classes/class_colorpickerbutton.rst | 34 +- classes/class_colorrect.rst | 14 +- classes/class_concavepolygonshape.rst | 14 +- classes/class_concavepolygonshape2d.rst | 14 +- classes/class_conetwistjoint.rst | 14 +- classes/class_configfile.rst | 56 +- classes/class_confirmationdialog.rst | 8 +- classes/class_container.rst | 16 +- classes/class_control.rst | 608 +++++----- classes/class_convexpolygonshape.rst | 14 +- classes/class_convexpolygonshape2d.rst | 20 +- classes/class_csharpscript.rst | 8 +- classes/class_cubemap.rst | 62 +- classes/class_cubemesh.rst | 50 +- classes/class_curve.rst | 148 +-- classes/class_curve2d.rst | 110 +- classes/class_curve3d.rst | 128 +- classes/class_curvetexture.rst | 20 +- classes/class_cylindermesh.rst | 62 +- classes/class_dampedspringjoint2d.rst | 50 +- classes/class_dictionary.rst | 56 +- classes/class_directionallight.rst | 38 +- classes/class_directory.rst | 110 +- classes/class_dynamicfont.rst | 92 +- classes/class_dynamicfontdata.rst | 14 +- classes/class_editorexportplugin.rst | 32 +- classes/class_editorfiledialog.rst | 128 +- classes/class_editorfilesystem.rst | 56 +- classes/class_editorfilesystemdirectory.rst | 74 +- classes/class_editorimportplugin.rst | 62 +- classes/class_editorinterface.rst | 98 +- classes/class_editorplugin.rst | 224 ++-- .../class_editorresourceconversionplugin.rst | 14 +- classes/class_editorresourcepreview.rst | 34 +- .../class_editorresourcepreviewgenerator.rst | 20 +- classes/class_editorscript.rst | 26 +- classes/class_editorselection.rst | 34 +- classes/class_editorsettings.rst | 88 +- classes/class_editorspatialgizmo.rst | 80 +- classes/class_encodedobjectasid.rst | 14 +- classes/class_engine.rst | 80 +- classes/class_environment.rst | 830 ++++++------- classes/class_file.rst | 260 ++-- classes/class_filedialog.rst | 116 +- classes/class_float.rst | 20 +- classes/class_font.rst | 50 +- classes/class_funcref.rst | 20 +- classes/class_gdfunctionstate.rst | 16 +- classes/class_gdnative.rst | 32 +- classes/class_gdnativeclass.rst | 8 +- classes/class_gdnativelibrary.rst | 32 +- classes/class_gdscript.rst | 14 +- classes/class_generic6dofjoint.rst | 74 +- classes/class_geometry.rst | 122 +- classes/class_geometryinstance.rst | 98 +- classes/class_giprobe.rst | 134 +-- classes/class_giprobedata.rst | 134 +-- classes/class_godotsharp.rst | 26 +- classes/class_gradient.rst | 74 +- classes/class_gradienttexture.rst | 20 +- classes/class_graphedit.rst | 112 +- classes/class_graphnode.rst | 198 ++-- classes/class_gridcontainer.rst | 14 +- classes/class_gridmap.rst | 134 +-- classes/class_groovejoint2d.rst | 26 +- classes/class_hingejoint.rst | 26 +- classes/class_httpclient.rst | 128 +- classes/class_httprequest.rst | 82 +- classes/class_image.rst | 260 ++-- classes/class_imagetexture.rst | 62 +- classes/class_immediategeometry.rst | 62 +- classes/class_input.rst | 214 ++-- classes/class_inputevent.rst | 86 +- classes/class_inputeventaction.rst | 20 +- classes/class_inputeventjoypadbutton.rst | 32 +- classes/class_inputeventjoypadmotion.rst | 26 +- classes/class_inputeventkey.rst | 44 +- classes/class_inputeventmouse.rst | 38 +- classes/class_inputeventmousebutton.rst | 44 +- classes/class_inputeventmousemotion.rst | 26 +- classes/class_inputeventscreendrag.rst | 50 +- classes/class_inputeventscreentouch.rst | 32 +- classes/class_inputeventwithmodifiers.rst | 62 +- classes/class_inputmap.rst | 62 +- classes/class_instanceplaceholder.rst | 20 +- classes/class_int.rst | 20 +- classes/class_interpolatedcamera.rst | 44 +- classes/class_ip.rst | 44 +- classes/class_itemlist.rst | 316 ++--- classes/class_joint.rst | 50 +- classes/class_joint2d.rst | 50 +- classes/class_json.rst | 14 +- classes/class_jsonparseresult.rst | 50 +- classes/class_kinematicbody.rst | 68 +- classes/class_kinematicbody2d.rst | 68 +- classes/class_kinematiccollision.rst | 68 +- classes/class_kinematiccollision2d.rst | 68 +- classes/class_label.rst | 146 +-- classes/class_largetexture.rst | 50 +- classes/class_light.rst | 98 +- classes/class_light2d.rst | 254 ++-- classes/class_lightoccluder2d.rst | 26 +- classes/class_line2d.rst | 164 +-- classes/class_lineedit.rst | 174 +-- classes/class_lineshape2d.rst | 26 +- classes/class_linkbutton.rst | 26 +- classes/class_listener.rst | 26 +- classes/class_mainloop.rst | 80 +- classes/class_marshalls.rst | 38 +- classes/class_material.rst | 26 +- classes/class_menubutton.rst | 10 +- classes/class_mesh.rst | 32 +- classes/class_meshdatatool.rst | 230 ++-- classes/class_meshinstance.rst | 56 +- classes/class_meshlibrary.rst | 98 +- classes/class_mobilevrinterface.rst | 74 +- classes/class_multimesh.rst | 80 +- classes/class_multimeshinstance.rst | 14 +- classes/class_mutex.rst | 20 +- classes/class_nativescript.rst | 32 +- classes/class_navigation.rst | 62 +- classes/class_navigation2d.rst | 38 +- classes/class_navigationmesh.rst | 248 ++-- classes/class_navigationmeshinstance.rst | 26 +- classes/class_navigationpolygon.rst | 86 +- classes/class_navigationpolygoninstance.rst | 26 +- classes/class_networkedmultiplayerenet.rst | 38 +- classes/class_networkedmultiplayerpeer.rst | 60 +- classes/class_nil.rst | 158 +-- classes/class_ninepatchrect.rst | 76 +- classes/class_node.rst | 524 ++++---- classes/class_node2d.rst | 206 ++-- classes/class_nodepath.rst | 50 +- classes/class_object.rst | 244 ++-- classes/class_occluderpolygon2d.rst | 38 +- classes/class_omnilight.rst | 26 +- classes/class_optionbutton.rst | 124 +- classes/class_os.rst | 596 +++++----- classes/class_packeddatacontainer.rst | 14 +- classes/class_packeddatacontainerref.rst | 8 +- classes/class_packedscene.rst | 26 +- classes/class_packetpeer.rst | 50 +- classes/class_packetpeerstream.rst | 32 +- classes/class_packetpeerudp.rst | 44 +- classes/class_panoramasky.rst | 14 +- classes/class_parallaxbackground.rst | 74 +- classes/class_parallaxlayer.rst | 38 +- classes/class_particles.rst | 206 ++-- classes/class_particles2d.rst | 230 ++-- classes/class_particlesmaterial.rst | 230 ++-- classes/class_path.rst | 14 +- classes/class_path2d.rst | 14 +- classes/class_pathfollow.rst | 86 +- classes/class_pathfollow2d.rst | 86 +- classes/class_pckpacker.rst | 20 +- classes/class_performance.rst | 8 +- classes/class_phashtranslation.rst | 8 +- classes/class_physics2ddirectbodystate.rst | 164 +-- classes/class_physics2ddirectspacestate.rst | 38 +- classes/class_physics2dserver.rst | 512 ++++---- .../class_physics2dshapequeryparameters.rst | 92 +- classes/class_physics2dshapequeryresult.rst | 32 +- classes/class_physics2dtestmotionresult.rst | 56 +- classes/class_physicsbody.rst | 62 +- classes/class_physicsbody2d.rst | 62 +- classes/class_physicsdirectbodystate.rst | 188 +-- classes/class_physicsdirectspacestate.rst | 32 +- classes/class_physicsserver.rst | 620 +++++----- classes/class_physicsshapequeryparameters.rst | 80 +- classes/class_physicsshapequeryresult.rst | 32 +- classes/class_pinjoint.rst | 14 +- classes/class_pinjoint2d.rst | 14 +- classes/class_plane.rst | 80 +- classes/class_planemesh.rst | 38 +- classes/class_planeshape.rst | 14 +- classes/class_polygon2d.rst | 146 +-- classes/class_polygonpathfinder.rst | 50 +- classes/class_poolbytearray.rst | 92 +- classes/class_poolcolorarray.rst | 62 +- classes/class_poolintarray.rst | 62 +- classes/class_poolrealarray.rst | 62 +- classes/class_poolstringarray.rst | 68 +- classes/class_poolvector2array.rst | 62 +- classes/class_poolvector3array.rst | 62 +- classes/class_popup.rst | 42 +- classes/class_popupmenu.rst | 264 ++--- classes/class_primitivemesh.rst | 20 +- classes/class_prismmesh.rst | 62 +- classes/class_proceduralsky.rst | 194 +-- classes/class_progressbar.rst | 14 +- classes/class_projectsettings.rst | 104 +- classes/class_proximitygroup.rst | 34 +- classes/class_quat.rst | 80 +- classes/class_range.rst | 114 +- classes/class_raycast.rst | 116 +- classes/class_raycast2d.rst | 128 +- classes/class_rayshape.rst | 14 +- classes/class_rayshape2d.rst | 14 +- classes/class_rect2.rst | 80 +- classes/class_rect3.rst | 128 +- classes/class_rectangleshape2d.rst | 14 +- classes/class_reference.rst | 20 +- classes/class_reflectionprobe.rst | 146 +-- classes/class_regex.rst | 50 +- classes/class_regexmatch.rst | 44 +- classes/class_remotetransform.rst | 62 +- classes/class_remotetransform2d.rst | 62 +- classes/class_resource.rst | 76 +- classes/class_resourceinteractiveloader.rst | 32 +- classes/class_resourceloader.rst | 38 +- classes/class_resourcepreloader.rst | 38 +- classes/class_resourcesaver.rst | 14 +- classes/class_richtextlabel.rst | 274 ++--- classes/class_rid.rst | 14 +- classes/class_rigidbody.rst | 240 ++-- classes/class_rigidbody2d.rst | 276 ++--- classes/class_scenestate.rst | 116 +- classes/class_scenetree.rst | 262 ++-- classes/class_scenetreetimer.rst | 16 +- classes/class_script.rst | 56 +- classes/class_scripteditor.rst | 18 +- classes/class_scrollbar.rst | 16 +- classes/class_scrollcontainer.rst | 50 +- classes/class_segmentshape2d.rst | 26 +- classes/class_semaphore.rst | 14 +- classes/class_shader.rst | 38 +- classes/class_shadermaterial.rst | 26 +- classes/class_shape2d.rst | 38 +- classes/class_shortcut.rst | 32 +- classes/class_skeleton.rst | 134 +-- classes/class_sky.rst | 14 +- classes/class_slider.rst | 38 +- classes/class_sliderjoint.rst | 14 +- classes/class_spatial.rst | 256 ++-- classes/class_spatialmaterial.rst | 650 +++++----- classes/class_spatialvelocitytracker.rst | 32 +- classes/class_spheremesh.rst | 62 +- classes/class_sphereshape.rst | 14 +- classes/class_spinbox.rst | 44 +- classes/class_splitcontainer.rst | 40 +- classes/class_sprite.rst | 150 +-- classes/class_sprite3d.rst | 76 +- classes/class_spritebase3d.rst | 128 +- classes/class_spriteframes.rst | 92 +- classes/class_staticbody.rst | 50 +- classes/class_staticbody2d.rst | 50 +- classes/class_streampeer.rst | 194 +-- classes/class_streampeerbuffer.rst | 50 +- classes/class_streampeerssl.rst | 26 +- classes/class_streampeertcp.rst | 38 +- classes/class_streamtexture.rst | 14 +- classes/class_string.rst | 524 ++++---- classes/class_stylebox.rst | 50 +- classes/class_styleboxflat.rst | 182 +-- classes/class_styleboxtexture.rst | 124 +- classes/class_surfacetool.rst | 134 +-- classes/class_tabcontainer.rst | 116 +- classes/class_tabs.rst | 122 +- classes/class_tcp_server.rst | 26 +- classes/class_textedit.rst | 318 ++--- classes/class_texture.rst | 62 +- classes/class_texturebutton.rst | 98 +- classes/class_textureprogress.rst | 110 +- classes/class_texturerect.rst | 38 +- classes/class_theme.rst | 182 +-- classes/class_thread.rst | 26 +- classes/class_tilemap.rst | 298 ++--- classes/class_tileset.rst | 218 ++-- classes/class_timer.rst | 88 +- classes/class_touchscreenbutton.rst | 120 +- classes/class_transform.rst | 92 +- classes/class_transform2d.rst | 104 +- classes/class_translation.rst | 44 +- classes/class_translationserver.rst | 38 +- classes/class_tree.rst | 240 ++-- classes/class_treeitem.rst | 362 +++--- classes/class_tween.rst | 176 +-- classes/class_undoredo.rst | 92 +- classes/class_vector2.rst | 140 +-- classes/class_vector3.rst | 152 +-- classes/class_vehiclebody.rst | 68 +- classes/class_vehiclewheel.rst | 146 +-- classes/class_videoplayer.rst | 140 +-- classes/class_viewport.rst | 406 +++---- classes/class_viewportcontainer.rst | 14 +- classes/class_viewporttexture.rst | 14 +- classes/class_visibilityenabler.rst | 14 +- classes/class_visibilityenabler2d.rst | 14 +- classes/class_visibilitynotifier.rst | 28 +- classes/class_visibilitynotifier2d.rst | 28 +- classes/class_visualinstance.rst | 32 +- classes/class_visualscript.rst | 256 ++-- .../class_visualscriptbasictypeconstant.rst | 26 +- classes/class_visualscriptbuiltinfunc.rst | 14 +- classes/class_visualscriptclassconstant.rst | 26 +- classes/class_visualscriptcomment.rst | 38 +- classes/class_visualscriptconstant.rst | 26 +- classes/class_visualscriptconstructor.rst | 26 +- classes/class_visualscriptcustomnode.rst | 86 +- classes/class_visualscriptdeconstruct.rst | 14 +- classes/class_visualscriptemitsignal.rst | 14 +- classes/class_visualscriptenginesingleton.rst | 14 +- classes/class_visualscriptfunctioncall.rst | 122 +- classes/class_visualscriptfunctionstate.rst | 20 +- classes/class_visualscriptglobalconstant.rst | 14 +- classes/class_visualscriptinputaction.rst | 26 +- classes/class_visualscriptlocalvar.rst | 26 +- classes/class_visualscriptlocalvarset.rst | 26 +- classes/class_visualscriptmathconstant.rst | 14 +- classes/class_visualscriptnode.rst | 28 +- classes/class_visualscriptoperator.rst | 26 +- classes/class_visualscriptpreload.rst | 14 +- classes/class_visualscriptpropertyget.rst | 86 +- classes/class_visualscriptpropertyset.rst | 98 +- classes/class_visualscriptresourcepath.rst | 14 +- classes/class_visualscriptreturn.rst | 26 +- classes/class_visualscriptscenenode.rst | 14 +- classes/class_visualscriptselect.rst | 14 +- classes/class_visualscriptsequence.rst | 14 +- classes/class_visualscriptsubcall.rst | 8 +- classes/class_visualscripttypecast.rst | 26 +- classes/class_visualscriptvariableget.rst | 14 +- classes/class_visualscriptvariableset.rst | 14 +- classes/class_visualscriptyield.rst | 26 +- classes/class_visualscriptyieldsignal.rst | 50 +- classes/class_visualserver.rst | 1052 ++++++++--------- classes/class_weakref.rst | 8 +- classes/class_windowdialog.rst | 32 +- classes/class_world.rst | 44 +- classes/class_world2d.rst | 20 +- classes/class_worldenvironment.rst | 14 +- classes/class_xmlparser.rst | 104 +- classes/class_ysort.rst | 14 +- 403 files changed, 18060 insertions(+), 18060 deletions(-) diff --git a/classes/class_@gdscript.rst b/classes/class_@gdscript.rst index 7020a05f7..5516ae971 100644 --- a/classes/class_@gdscript.rst +++ b/classes/class_@gdscript.rst @@ -17,159 +17,159 @@ Built-in GDScript functions. Member Functions ---------------- -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`Color8` **(** :ref:`int` r8, :ref:`int` g8, :ref:`int` b8, :ref:`int` a8 **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`ColorN` **(** :ref:`String` name, :ref:`float` alpha **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`abs` **(** :ref:`float` s **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`acos` **(** :ref:`float` s **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`asin` **(** :ref:`float` s **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`assert` **(** :ref:`bool` condition **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`atan` **(** :ref:`float` s **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`atan2` **(** :ref:`float` x, :ref:`float` y **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`bytes2var` **(** :ref:`PoolByteArray` bytes **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`ceil` **(** :ref:`float` s **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`char` **(** :ref:`int` ascii **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`clamp` **(** :ref:`float` val, :ref:`float` min, :ref:`float` max **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`convert` **(** :ref:`Variant` what, :ref:`int` type **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`cos` **(** :ref:`float` s **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`cosh` **(** :ref:`float` s **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`db2linear` **(** :ref:`float` db **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`decimals` **(** :ref:`float` step **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`dectime` **(** :ref:`float` value, :ref:`float` amount, :ref:`float` step **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`deg2rad` **(** :ref:`float` deg **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`dict2inst` **(** :ref:`Dictionary` dict **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`ease` **(** :ref:`float` s, :ref:`float` curve **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`exp` **(** :ref:`float` s **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`floor` **(** :ref:`float` s **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`fmod` **(** :ref:`float` x, :ref:`float` y **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`fposmod` **(** :ref:`float` x, :ref:`float` y **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`funcref` **(** :ref:`Object` instance, :ref:`String` funcname **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`hash` **(** :ref:`Variant` var **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`inst2dict` **(** :ref:`Object` inst **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`instance_from_id` **(** :ref:`int` instance_id **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`inverse_lerp` **(** :ref:`float` from, :ref:`float` to, :ref:`float` value **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_inf` **(** :ref:`float` s **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_nan` **(** :ref:`float` s **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`len` **(** :ref:`Variant` var **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`lerp` **(** :ref:`float` from, :ref:`float` to, :ref:`float` weight **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear2db` **(** :ref:`float` nrg **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`load` **(** :ref:`String` path **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`log` **(** :ref:`float` s **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`max` **(** :ref:`float` a, :ref:`float` b **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`min` **(** :ref:`float` a, :ref:`float` b **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`nearest_po2` **(** :ref:`int` val **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`parse_json` **(** :ref:`String` json **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`pow` **(** :ref:`float` x, :ref:`float` y **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Resource` | :ref:`preload` **(** :ref:`String` path **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`print` **(** **)** vararg | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`print_stack` **(** **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`printerr` **(** **)** vararg | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`printraw` **(** **)** vararg | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`prints` **(** **)** vararg | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`printt` **(** **)** vararg | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`rad2deg` **(** :ref:`float` rad **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`rand_range` **(** :ref:`float` from, :ref:`float` to **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`rand_seed` **(** :ref:`int` seed **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`randf` **(** **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`randi` **(** **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`randomize` **(** **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`range` **(** **)** vararg | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`range_lerp` **(** :ref:`float` value, :ref:`float` istart, :ref:`float` istop, :ref:`float` ostart, :ref:`float` ostop **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`round` **(** :ref:`float` s **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`seed` **(** :ref:`int` seed **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`sign` **(** :ref:`float` s **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`sin` **(** :ref:`float` s **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`sinh` **(** :ref:`float` s **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`sqrt` **(** :ref:`float` s **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`stepify` **(** :ref:`float` s, :ref:`float` step **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`str` **(** **)** vararg | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`str2var` **(** :ref:`String` string **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`tan` **(** :ref:`float` s **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`tanh` **(** :ref:`float` s **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`to_json` **(** :ref:`Variant` var **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`type_exists` **(** :ref:`String` type **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`typeof` **(** :ref:`Variant` what **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`validate_json` **(** :ref:`String` json **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`var2bytes` **(** :ref:`Variant` var **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`var2str` **(** :ref:`Variant` var **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`weakref` **(** :ref:`Object` obj **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`GDFunctionState` | :ref:`yield` **(** :ref:`Object` object, :ref:`String` signal **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`Color8` **(** :ref:`int` r8, :ref:`int` g8, :ref:`int` b8, :ref:`int` a8 **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`ColorN` **(** :ref:`String` name, :ref:`float` alpha **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`abs` **(** :ref:`float` s **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`acos` **(** :ref:`float` s **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`asin` **(** :ref:`float` s **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`assert` **(** :ref:`bool` condition **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`atan` **(** :ref:`float` s **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`atan2` **(** :ref:`float` x, :ref:`float` y **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`bytes2var` **(** :ref:`PoolByteArray` bytes **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`ceil` **(** :ref:`float` s **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`char` **(** :ref:`int` ascii **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`clamp` **(** :ref:`float` val, :ref:`float` min, :ref:`float` max **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`convert` **(** :ref:`Variant` what, :ref:`int` type **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`cos` **(** :ref:`float` s **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`cosh` **(** :ref:`float` s **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`db2linear` **(** :ref:`float` db **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`decimals` **(** :ref:`float` step **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`dectime` **(** :ref:`float` value, :ref:`float` amount, :ref:`float` step **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`deg2rad` **(** :ref:`float` deg **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`dict2inst` **(** :ref:`Dictionary` dict **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`ease` **(** :ref:`float` s, :ref:`float` curve **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`exp` **(** :ref:`float` s **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`floor` **(** :ref:`float` s **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`fmod` **(** :ref:`float` x, :ref:`float` y **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`fposmod` **(** :ref:`float` x, :ref:`float` y **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`funcref` **(** :ref:`Object` instance, :ref:`String` funcname **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`hash` **(** :ref:`Variant` var **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`inst2dict` **(** :ref:`Object` inst **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`instance_from_id` **(** :ref:`int` instance_id **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`inverse_lerp` **(** :ref:`float` from, :ref:`float` to, :ref:`float` value **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_inf` **(** :ref:`float` s **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_nan` **(** :ref:`float` s **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`len` **(** :ref:`Variant` var **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`lerp` **(** :ref:`float` from, :ref:`float` to, :ref:`float` weight **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear2db` **(** :ref:`float` nrg **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`load` **(** :ref:`String` path **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`log` **(** :ref:`float` s **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`max` **(** :ref:`float` a, :ref:`float` b **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`min` **(** :ref:`float` a, :ref:`float` b **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`nearest_po2` **(** :ref:`int` val **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`parse_json` **(** :ref:`String` json **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`pow` **(** :ref:`float` x, :ref:`float` y **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Resource` | :ref:`preload` **(** :ref:`String` path **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`print` **(** **)** vararg | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`print_stack` **(** **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`printerr` **(** **)** vararg | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`printraw` **(** **)** vararg | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`prints` **(** **)** vararg | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`printt` **(** **)** vararg | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`rad2deg` **(** :ref:`float` rad **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`rand_range` **(** :ref:`float` from, :ref:`float` to **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`rand_seed` **(** :ref:`int` seed **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`randf` **(** **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`randi` **(** **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`randomize` **(** **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`range` **(** **)** vararg | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`range_lerp` **(** :ref:`float` value, :ref:`float` istart, :ref:`float` istop, :ref:`float` ostart, :ref:`float` ostop **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`round` **(** :ref:`float` s **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`seed` **(** :ref:`int` seed **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`sign` **(** :ref:`float` s **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`sin` **(** :ref:`float` s **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`sinh` **(** :ref:`float` s **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`sqrt` **(** :ref:`float` s **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`stepify` **(** :ref:`float` s, :ref:`float` step **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`str` **(** **)** vararg | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`str2var` **(** :ref:`String` string **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`tan` **(** :ref:`float` s **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`tanh` **(** :ref:`float` s **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`to_json` **(** :ref:`Variant` var **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`type_exists` **(** :ref:`String` type **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`typeof` **(** :ref:`Variant` what **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`validate_json` **(** :ref:`String` json **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`var2bytes` **(** :ref:`Variant` var **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`var2str` **(** :ref:`Variant` var **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`weakref` **(** :ref:`Object` obj **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`GDFunctionState` | :ref:`yield` **(** :ref:`Object` object, :ref:`String` signal **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -190,7 +190,7 @@ Member Function Description .. _class_@GDScript_Color8: -- :ref:`Color` **Color8** **(** :ref:`int` r8, :ref:`int` g8, :ref:`int` b8, :ref:`int` a8 **)** +- :ref:`Color` **Color8** **(** :ref:`int` r8, :ref:`int` g8, :ref:`int` b8, :ref:`int` a8 **)** Returns a 32 bit color with red, green, blue and alpha channels. Each channel has 8 bits of information ranging from 0 to 255. @@ -208,7 +208,7 @@ Returns a 32 bit color with red, green, blue and alpha channels. Each channel ha .. _class_@GDScript_ColorN: -- :ref:`Color` **ColorN** **(** :ref:`String` name, :ref:`float` alpha **)** +- :ref:`Color` **ColorN** **(** :ref:`String` name, :ref:`float` alpha **)** Returns color ``name`` with ``alpha`` ranging from 0 to 1. Note: ``name`` is defined in color_names.inc. @@ -218,7 +218,7 @@ Returns color ``name`` with ``alpha`` ranging from 0 to 1. Note: ``name`` is def .. _class_@GDScript_abs: -- :ref:`float` **abs** **(** :ref:`float` s **)** +- :ref:`float` **abs** **(** :ref:`float` s **)** Returns the absolute value of parameter ``s`` (i.e. unsigned value, works for integer and float). @@ -229,7 +229,7 @@ Returns the absolute value of parameter ``s`` (i.e. unsigned value, works for i .. _class_@GDScript_acos: -- :ref:`float` **acos** **(** :ref:`float` s **)** +- :ref:`float` **acos** **(** :ref:`float` s **)** Returns the arc cosine of ``s`` in radians. Use to get the angle of cosine ``s``. @@ -240,7 +240,7 @@ Returns the arc cosine of ``s`` in radians. Use to get the angle of cosine ``s`` .. _class_@GDScript_asin: -- :ref:`float` **asin** **(** :ref:`float` s **)** +- :ref:`float` **asin** **(** :ref:`float` s **)** Returns the arc sine of ``s`` in radians. Use to get the angle of sine ``s``. @@ -251,7 +251,7 @@ Returns the arc sine of ``s`` in radians. Use to get the angle of sine ``s``. .. _class_@GDScript_assert: -- void **assert** **(** :ref:`bool` condition **)** +- void **assert** **(** :ref:`bool` condition **)** Assert that the ``condition`` is true. If the ``condition`` is false a fatal error is generated and the program is halted. Useful for debugging to make sure a value is always true. @@ -265,7 +265,7 @@ Assert that the ``condition`` is true. If the ``condition`` is false a fatal err .. _class_@GDScript_atan: -- :ref:`float` **atan** **(** :ref:`float` s **)** +- :ref:`float` **atan** **(** :ref:`float` s **)** Returns the arc tangent of ``s`` in radians. Use it to get the angle from an angle's tangent in trigonometry: ``atan(tan(angle)) == angle``. @@ -277,7 +277,7 @@ The method cannot know in which quadrant the angle should fall. See :ref:`atan2< .. _class_@GDScript_atan2: -- :ref:`float` **atan2** **(** :ref:`float` x, :ref:`float` y **)** +- :ref:`float` **atan2** **(** :ref:`float` x, :ref:`float` y **)** Returns the arc tangent of ``y/x`` in radians. Use to get the angle of tangent ``y/x``. To compute the value, the method takes into account the sign of both arguments in order to determine the quadrant. @@ -287,13 +287,13 @@ Returns the arc tangent of ``y/x`` in radians. Use to get the angle of tangent ` .. _class_@GDScript_bytes2var: -- :ref:`Variant` **bytes2var** **(** :ref:`PoolByteArray` bytes **)** +- :ref:`Variant` **bytes2var** **(** :ref:`PoolByteArray` bytes **)** Decodes a byte array back to a value. .. _class_@GDScript_ceil: -- :ref:`float` **ceil** **(** :ref:`float` s **)** +- :ref:`float` **ceil** **(** :ref:`float` s **)** Rounds ``s`` upward, returning the smallest integral value that is not less than ``s``. @@ -304,7 +304,7 @@ Rounds ``s`` upward, returning the smallest integral value that is not less than .. _class_@GDScript_char: -- :ref:`String` **char** **(** :ref:`int` ascii **)** +- :ref:`String` **char** **(** :ref:`int` ascii **)** Returns a character as a String of the given ASCII code. @@ -317,7 +317,7 @@ Returns a character as a String of the given ASCII code. .. _class_@GDScript_clamp: -- :ref:`float` **clamp** **(** :ref:`float` val, :ref:`float` min, :ref:`float` max **)** +- :ref:`float` **clamp** **(** :ref:`float` val, :ref:`float` min, :ref:`float` max **)** Clamps ``val`` and returns a value not less than ``min`` and not more than ``max``. @@ -333,7 +333,7 @@ Clamps ``val`` and returns a value not less than ``min`` and not more than ``max .. _class_@GDScript_convert: -- :ref:`Object` **convert** **(** :ref:`Variant` what, :ref:`int` type **)** +- :ref:`Object` **convert** **(** :ref:`Variant` what, :ref:`int` type **)** Converts from a type to another in the best way possible. The ``type`` parameter uses the enum TYPE\_\* in :ref:`@Global Scope`. @@ -349,7 +349,7 @@ Converts from a type to another in the best way possible. The ``type`` parameter .. _class_@GDScript_cos: -- :ref:`float` **cos** **(** :ref:`float` s **)** +- :ref:`float` **cos** **(** :ref:`float` s **)** Returns the cosine of angle ``s`` in radians. @@ -361,7 +361,7 @@ Returns the cosine of angle ``s`` in radians. .. _class_@GDScript_cosh: -- :ref:`float` **cosh** **(** :ref:`float` s **)** +- :ref:`float` **cosh** **(** :ref:`float` s **)** Returns the hyperbolic cosine of ``s`` in radians. @@ -372,13 +372,13 @@ Returns the hyperbolic cosine of ``s`` in radians. .. _class_@GDScript_db2linear: -- :ref:`float` **db2linear** **(** :ref:`float` db **)** +- :ref:`float` **db2linear** **(** :ref:`float` db **)** Converts from decibels to linear energy (audio). .. _class_@GDScript_decimals: -- :ref:`float` **decimals** **(** :ref:`float` step **)** +- :ref:`float` **decimals** **(** :ref:`float` step **)** Returns the position of the first non-zero digit, after the decimal point. @@ -389,7 +389,7 @@ Returns the position of the first non-zero digit, after the decimal point. .. _class_@GDScript_dectime: -- :ref:`float` **dectime** **(** :ref:`float` value, :ref:`float` amount, :ref:`float` step **)** +- :ref:`float` **dectime** **(** :ref:`float` value, :ref:`float` amount, :ref:`float` step **)** Returns the result of ``value`` decreased by ``step`` \* ``amount``. @@ -400,7 +400,7 @@ Returns the result of ``value`` decreased by ``step`` \* ``amount``. .. _class_@GDScript_deg2rad: -- :ref:`float` **deg2rad** **(** :ref:`float` deg **)** +- :ref:`float` **deg2rad** **(** :ref:`float` deg **)** Returns degrees converted to radians. @@ -411,19 +411,19 @@ Returns degrees converted to radians. .. _class_@GDScript_dict2inst: -- :ref:`Object` **dict2inst** **(** :ref:`Dictionary` dict **)** +- :ref:`Object` **dict2inst** **(** :ref:`Dictionary` dict **)** Converts a previously converted instance to a dictionary, back into an instance. Useful for deserializing. .. _class_@GDScript_ease: -- :ref:`float` **ease** **(** :ref:`float` s, :ref:`float` curve **)** +- :ref:`float` **ease** **(** :ref:`float` s, :ref:`float` curve **)** Easing function, based on exponent. 0 is constant, 1 is linear, 0 to 1 is ease-in, 1+ is ease out. Negative values are in-out/out in. .. _class_@GDScript_exp: -- :ref:`float` **exp** **(** :ref:`float` s **)** +- :ref:`float` **exp** **(** :ref:`float` s **)** Raises the Euler's constant **e** to the power of ``s`` and returns it. **e** has an approximate value of 2.71828. @@ -433,7 +433,7 @@ Raises the Euler's constant **e** to the power of ``s`` and returns it. **e** ha .. _class_@GDScript_floor: -- :ref:`float` **floor** **(** :ref:`float` s **)** +- :ref:`float` **floor** **(** :ref:`float` s **)** Rounds ``s`` to the closest smaller integer and returns it. @@ -446,7 +446,7 @@ Rounds ``s`` to the closest smaller integer and returns it. .. _class_@GDScript_fmod: -- :ref:`float` **fmod** **(** :ref:`float` x, :ref:`float` y **)** +- :ref:`float` **fmod** **(** :ref:`float` x, :ref:`float` y **)** Returns the floating-point remainder of ``x/y``. @@ -457,7 +457,7 @@ Returns the floating-point remainder of ``x/y``. .. _class_@GDScript_fposmod: -- :ref:`float` **fposmod** **(** :ref:`float` x, :ref:`float` y **)** +- :ref:`float` **fposmod** **(** :ref:`float` x, :ref:`float` y **)** Returns the floating-point remainder of ``x/y`` that wraps equally in positive and negative. @@ -485,7 +485,7 @@ Produces: .. _class_@GDScript_funcref: -- :ref:`Object` **funcref** **(** :ref:`Object` instance, :ref:`String` funcname **)** +- :ref:`Object` **funcref** **(** :ref:`Object` instance, :ref:`String` funcname **)** Returns a reference to the specified function ``funcname`` in the ``instance`` node. As functions aren't first-class objects in GDscript, use ``funcref`` to store a :ref:`FuncRef` in a variable and call it later. @@ -499,7 +499,7 @@ Returns a reference to the specified function ``funcname`` in the ``instance`` n .. _class_@GDScript_hash: -- :ref:`int` **hash** **(** :ref:`Variant` var **)** +- :ref:`int` **hash** **(** :ref:`Variant` var **)** Returns the integer hash of the variable passed. @@ -509,7 +509,7 @@ Returns the integer hash of the variable passed. .. _class_@GDScript_inst2dict: -- :ref:`Dictionary` **inst2dict** **(** :ref:`Object` inst **)** +- :ref:`Dictionary` **inst2dict** **(** :ref:`Object` inst **)** Returns the passed instance converted to a dictionary (useful for serializing). @@ -530,7 +530,7 @@ Prints out: .. _class_@GDScript_instance_from_id: -- :ref:`Object` **instance_from_id** **(** :ref:`int` instance_id **)** +- :ref:`Object` **instance_from_id** **(** :ref:`int` instance_id **)** Returns the Object that corresponds to ``instance_id``. All Objects have a unique instance ID. @@ -544,7 +544,7 @@ Returns the Object that corresponds to ``instance_id``. All Objects have a uniqu .. _class_@GDScript_inverse_lerp: -- :ref:`float` **inverse_lerp** **(** :ref:`float` from, :ref:`float` to, :ref:`float` value **)** +- :ref:`float` **inverse_lerp** **(** :ref:`float` from, :ref:`float` to, :ref:`float` value **)** Returns a normalized value considering the given range. @@ -554,19 +554,19 @@ Returns a normalized value considering the given range. .. _class_@GDScript_is_inf: -- :ref:`bool` **is_inf** **(** :ref:`float` s **)** +- :ref:`bool` **is_inf** **(** :ref:`float` s **)** Returns True/False whether ``s`` is an infinity value (either positive infinity or negative infinity). .. _class_@GDScript_is_nan: -- :ref:`bool` **is_nan** **(** :ref:`float` s **)** +- :ref:`bool` **is_nan** **(** :ref:`float` s **)** Returns True/False whether ``s`` is a NaN (Not-A-Number) value. .. _class_@GDScript_len: -- :ref:`int` **len** **(** :ref:`Variant` var **)** +- :ref:`int` **len** **(** :ref:`Variant` var **)** Returns length of Variant ``var``. Length is the character count of String, element count of Array, size of Dictionary, etc. Note: Generates a fatal error if Variant can not provide a length. @@ -577,7 +577,7 @@ Returns length of Variant ``var``. Length is the character count of String, elem .. _class_@GDScript_lerp: -- :ref:`float` **lerp** **(** :ref:`float` from, :ref:`float` to, :ref:`float` weight **)** +- :ref:`float` **lerp** **(** :ref:`float` from, :ref:`float` to, :ref:`float` weight **)** Linearly interpolates between two values by a normalized value. @@ -587,13 +587,13 @@ Linearly interpolates between two values by a normalized value. .. _class_@GDScript_linear2db: -- :ref:`float` **linear2db** **(** :ref:`float` nrg **)** +- :ref:`float` **linear2db** **(** :ref:`float` nrg **)** Converts from linear energy to decibels (audio). .. _class_@GDScript_load: -- :ref:`Object` **load** **(** :ref:`String` path **)** +- :ref:`Object` **load** **(** :ref:`String` path **)** Loads a resource from the filesystem located at 'path'. Note: resource paths can be obtained by right clicking on a resource in the Assets Panel and choosing "Copy Path". @@ -604,7 +604,7 @@ Loads a resource from the filesystem located at 'path'. Note: resource paths can .. _class_@GDScript_log: -- :ref:`float` **log** **(** :ref:`float` s **)** +- :ref:`float` **log** **(** :ref:`float` s **)** Natural logarithm. The amount of time needed to reach a certain level of continuous growth. Note: This is not the same as the log function on your calculator which is a base 10 logarithm. @@ -614,7 +614,7 @@ Natural logarithm. The amount of time needed to reach a certain level of continu .. _class_@GDScript_max: -- :ref:`float` **max** **(** :ref:`float` a, :ref:`float` b **)** +- :ref:`float` **max** **(** :ref:`float` a, :ref:`float` b **)** Returns the maximum of two values. @@ -625,7 +625,7 @@ Returns the maximum of two values. .. _class_@GDScript_min: -- :ref:`float` **min** **(** :ref:`float` a, :ref:`float` b **)** +- :ref:`float` **min** **(** :ref:`float` a, :ref:`float` b **)** Returns the minimum of two values. @@ -636,7 +636,7 @@ Returns the minimum of two values. .. _class_@GDScript_nearest_po2: -- :ref:`int` **nearest_po2** **(** :ref:`int` val **)** +- :ref:`int` **nearest_po2** **(** :ref:`int` val **)** Returns the nearest larger power of 2 for integer ``val``. @@ -648,7 +648,7 @@ Returns the nearest larger power of 2 for integer ``val``. .. _class_@GDScript_parse_json: -- :ref:`Variant` **parse_json** **(** :ref:`String` json **)** +- :ref:`Variant` **parse_json** **(** :ref:`String` json **)** Parse JSON text to a Variant (use :ref:`typeof` to check if it is what you expect). @@ -664,7 +664,7 @@ Be aware that the JSON specification does not define integer or float types, but .. _class_@GDScript_pow: -- :ref:`float` **pow** **(** :ref:`float` x, :ref:`float` y **)** +- :ref:`float` **pow** **(** :ref:`float` x, :ref:`float` y **)** Returns the result of ``x`` raised to the power of ``y``. @@ -674,7 +674,7 @@ Returns the result of ``x`` raised to the power of ``y``. .. _class_@GDScript_preload: -- :ref:`Resource` **preload** **(** :ref:`String` path **)** +- :ref:`Resource` **preload** **(** :ref:`String` path **)** Returns a resource from the filesystem that is loaded during script parsing. Note: resource paths can be obtained by right clicking on a resource in the Assets Panel and choosing "Copy Path". @@ -685,7 +685,7 @@ Returns a resource from the filesystem that is loaded during script parsing. Not .. _class_@GDScript_print: -- void **print** **(** **)** vararg +- void **print** **(** **)** vararg Converts one or more arguments to strings in the best way possible and prints them to the console. @@ -696,7 +696,7 @@ Converts one or more arguments to strings in the best way possible and prints th .. _class_@GDScript_print_stack: -- void **print_stack** **(** **)** +- void **print_stack** **(** **)** Prints a stack track at code location, only works when running with debugger turned on. @@ -708,7 +708,7 @@ Output in the console would look something like this: .. _class_@GDScript_printerr: -- void **printerr** **(** **)** vararg +- void **printerr** **(** **)** vararg Prints one or more arguments to strings in the best way possible to standard error line. @@ -718,7 +718,7 @@ Prints one or more arguments to strings in the best way possible to standard err .. _class_@GDScript_printraw: -- void **printraw** **(** **)** vararg +- void **printraw** **(** **)** vararg Prints one or more arguments to strings in the best way possible to console. No newline is added at the end. @@ -730,7 +730,7 @@ Prints one or more arguments to strings in the best way possible to console. No .. _class_@GDScript_prints: -- void **prints** **(** **)** vararg +- void **prints** **(** **)** vararg Prints one or more arguments to the console with a space between each argument. @@ -740,7 +740,7 @@ Prints one or more arguments to the console with a space between each argument. .. _class_@GDScript_printt: -- void **printt** **(** **)** vararg +- void **printt** **(** **)** vararg Prints one or more arguments to the console with a tab between each argument. @@ -750,7 +750,7 @@ Prints one or more arguments to the console with a tab between each argument. .. _class_@GDScript_rad2deg: -- :ref:`float` **rad2deg** **(** :ref:`float` rad **)** +- :ref:`float` **rad2deg** **(** :ref:`float` rad **)** Converts from radians to degrees. @@ -760,7 +760,7 @@ Converts from radians to degrees. .. _class_@GDScript_rand_range: -- :ref:`float` **rand_range** **(** :ref:`float` from, :ref:`float` to **)** +- :ref:`float` **rand_range** **(** :ref:`float` from, :ref:`float` to **)** Random range, any floating point value between ``from`` and ``to``. @@ -770,13 +770,13 @@ Random range, any floating point value between ``from`` and ``to``. .. _class_@GDScript_rand_seed: -- :ref:`Array` **rand_seed** **(** :ref:`int` seed **)** +- :ref:`Array` **rand_seed** **(** :ref:`int` seed **)** Random from seed: pass a ``seed``, and an array with both number and new seed is returned. "Seed" here refers to the internal state of the pseudo random number generator. The internal state of the current implementation is 64 bits. .. _class_@GDScript_randf: -- :ref:`float` **randf** **(** **)** +- :ref:`float` **randf** **(** **)** Returns a random floating point value between 0 and 1. @@ -786,7 +786,7 @@ Returns a random floating point value between 0 and 1. .. _class_@GDScript_randi: -- :ref:`int` **randi** **(** **)** +- :ref:`int` **randi** **(** **)** Returns a random 32 bit integer. Use remainder to obtain a random value between 0 and N (where N is smaller than 2^32 -1). @@ -798,7 +798,7 @@ Returns a random 32 bit integer. Use remainder to obtain a random value between .. _class_@GDScript_randomize: -- void **randomize** **(** **)** +- void **randomize** **(** **)** Randomizes the seed (or the internal state) of the random number generator. Current implementation reseeds using a number based on time. @@ -809,7 +809,7 @@ Randomizes the seed (or the internal state) of the random number generator. Curr .. _class_@GDScript_range: -- :ref:`Array` **range** **(** **)** vararg +- :ref:`Array` **range** **(** **)** vararg Returns an array with the given range. Range can be 1 argument N (0 to N-1), two arguments (initial, final-1) or three arguments (initial, final-1, increment). @@ -841,7 +841,7 @@ Output: .. _class_@GDScript_range_lerp: -- :ref:`float` **range_lerp** **(** :ref:`float` value, :ref:`float` istart, :ref:`float` istop, :ref:`float` ostart, :ref:`float` ostop **)** +- :ref:`float` **range_lerp** **(** :ref:`float` value, :ref:`float` istart, :ref:`float` istop, :ref:`float` ostart, :ref:`float` ostop **)** Maps a ``value`` from range ``[istart, istop]`` to ``[ostart, ostop]``. @@ -851,7 +851,7 @@ Maps a ``value`` from range ``[istart, istop]`` to ``[ostart, ostop]``. .. _class_@GDScript_round: -- :ref:`float` **round** **(** :ref:`float` s **)** +- :ref:`float` **round** **(** :ref:`float` s **)** Returns the integral value that is nearest to ``s``, with halfway cases rounded away from zero. @@ -861,7 +861,7 @@ Returns the integral value that is nearest to ``s``, with halfway cases rounded .. _class_@GDScript_seed: -- void **seed** **(** :ref:`int` seed **)** +- void **seed** **(** :ref:`int` seed **)** Sets seed for the random number generator. @@ -872,7 +872,7 @@ Sets seed for the random number generator. .. _class_@GDScript_sign: -- :ref:`float` **sign** **(** :ref:`float` s **)** +- :ref:`float` **sign** **(** :ref:`float` s **)** Returns sign of ``s`` -1 or 1. @@ -883,7 +883,7 @@ Returns sign of ``s`` -1 or 1. .. _class_@GDScript_sin: -- :ref:`float` **sin** **(** :ref:`float` s **)** +- :ref:`float` **sin** **(** :ref:`float` s **)** Returns the sine of angle ``s`` in radians. @@ -893,7 +893,7 @@ Returns the sine of angle ``s`` in radians. .. _class_@GDScript_sinh: -- :ref:`float` **sinh** **(** :ref:`float` s **)** +- :ref:`float` **sinh** **(** :ref:`float` s **)** Returns the hyperbolic sine of ``s``. @@ -904,7 +904,7 @@ Returns the hyperbolic sine of ``s``. .. _class_@GDScript_sqrt: -- :ref:`float` **sqrt** **(** :ref:`float` s **)** +- :ref:`float` **sqrt** **(** :ref:`float` s **)** Returns the square root of ``s``. @@ -914,13 +914,13 @@ Returns the square root of ``s``. .. _class_@GDScript_stepify: -- :ref:`float` **stepify** **(** :ref:`float` s, :ref:`float` step **)** +- :ref:`float` **stepify** **(** :ref:`float` s, :ref:`float` step **)** Snaps float value ``s`` to a given ``step``. .. _class_@GDScript_str: -- :ref:`String` **str** **(** **)** vararg +- :ref:`String` **str** **(** **)** vararg Converts one or more arguments to string in the best way possible. @@ -933,7 +933,7 @@ Converts one or more arguments to string in the best way possible. .. _class_@GDScript_str2var: -- :ref:`Variant` **str2var** **(** :ref:`String` string **)** +- :ref:`Variant` **str2var** **(** :ref:`String` string **)** Converts a formatted string that was returned by :ref:`var2str` to the original value. @@ -945,7 +945,7 @@ Converts a formatted string that was returned by :ref:`var2str` **tan** **(** :ref:`float` s **)** +- :ref:`float` **tan** **(** :ref:`float` s **)** Returns the tangent of angle ``s`` in radians. @@ -955,7 +955,7 @@ Returns the tangent of angle ``s`` in radians. .. _class_@GDScript_tanh: -- :ref:`float` **tanh** **(** :ref:`float` s **)** +- :ref:`float` **tanh** **(** :ref:`float` s **)** Returns the hyperbolic tangent of ``s``. @@ -966,7 +966,7 @@ Returns the hyperbolic tangent of ``s``. .. _class_@GDScript_to_json: -- :ref:`String` **to_json** **(** :ref:`Variant` var **)** +- :ref:`String` **to_json** **(** :ref:`Variant` var **)** Converts a Variant ``var`` to JSON text and return the result. Useful for serializing data to store or send over the network. @@ -978,7 +978,7 @@ Converts a Variant ``var`` to JSON text and return the result. Useful for serial .. _class_@GDScript_type_exists: -- :ref:`bool` **type_exists** **(** :ref:`String` type **)** +- :ref:`bool` **type_exists** **(** :ref:`String` type **)** Returns whether the given class exists in :ref:`ClassDB`. @@ -989,7 +989,7 @@ Returns whether the given class exists in :ref:`ClassDB`. .. _class_@GDScript_typeof: -- :ref:`int` **typeof** **(** :ref:`Variant` what **)** +- :ref:`int` **typeof** **(** :ref:`Variant` what **)** Returns the internal type of the given Variant object, using the TYPE\_\* enum in :ref:`@Global Scope`. @@ -1003,7 +1003,7 @@ Returns the internal type of the given Variant object, using the TYPE\_\* enum i .. _class_@GDScript_validate_json: -- :ref:`String` **validate_json** **(** :ref:`String` json **)** +- :ref:`String` **validate_json** **(** :ref:`String` json **)** Checks that ``json`` is valid JSON data. Returns empty string if valid. Returns error message if not valid. @@ -1018,13 +1018,13 @@ Checks that ``json`` is valid JSON data. Returns empty string if valid. Returns .. _class_@GDScript_var2bytes: -- :ref:`PoolByteArray` **var2bytes** **(** :ref:`Variant` var **)** +- :ref:`PoolByteArray` **var2bytes** **(** :ref:`Variant` var **)** Encodes a variable value to a byte array. .. _class_@GDScript_var2str: -- :ref:`String` **var2str** **(** :ref:`Variant` var **)** +- :ref:`String` **var2str** **(** :ref:`Variant` var **)** Converts a Variant ``var`` to a formatted string that can later be parsed using :ref:`str2var`. @@ -1044,7 +1044,7 @@ prints .. _class_@GDScript_weakref: -- :ref:`Object` **weakref** **(** :ref:`Object` obj **)** +- :ref:`Object` **weakref** **(** :ref:`Object` obj **)** Returns a weak reference to an object. @@ -1052,7 +1052,7 @@ A weak reference to an object is not enough to keep the object alive: when the o .. _class_@GDScript_yield: -- :ref:`GDFunctionState` **yield** **(** :ref:`Object` object, :ref:`String` signal **)** +- :ref:`GDFunctionState` **yield** **(** :ref:`Object` object, :ref:`String` signal **)** Stops the function execution and returns the current state. Call :ref:`GDFunctionState.resume` on the state to resume execution. This invalidates the state. diff --git a/classes/class_acceptdialog.rst b/classes/class_acceptdialog.rst index 8d497a5e9..7ffc249ac 100644 --- a/classes/class_acceptdialog.rst +++ b/classes/class_acceptdialog.rst @@ -21,38 +21,38 @@ Base dialog for user notification. Member Functions ---------------- -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Button` | :ref:`add_button` **(** :ref:`String` text, :ref:`bool` right=false, :ref:`String` action="" **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Button` | :ref:`add_cancel` **(** :ref:`String` name **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_hide_on_ok` **(** **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Label` | :ref:`get_label` **(** **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Button` | :ref:`get_ok` **(** **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_text` **(** **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`register_text_enter` **(** :ref:`Node` line_edit **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_hide_on_ok` **(** :ref:`bool` enabled **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_text` **(** :ref:`String` text **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Button` | :ref:`add_button` **(** :ref:`String` text, :ref:`bool` right=false, :ref:`String` action="" **)** | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Button` | :ref:`add_cancel` **(** :ref:`String` name **)** | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_hide_on_ok` **(** **)** const | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Label` | :ref:`get_label` **(** **)** | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Button` | :ref:`get_ok` **(** **)** | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_text` **(** **)** const | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`register_text_enter` **(** :ref:`Node` line_edit **)** | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_hide_on_ok` **(** :ref:`bool` enabled **)** | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_text` **(** :ref:`String` text **)** | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_AcceptDialog_confirmed: -- **confirmed** **(** **)** +- **confirmed** **(** **)** Emitted when the dialog is accepted. .. _class_AcceptDialog_custom_action: -- **custom_action** **(** :ref:`String` action **)** +- **custom_action** **(** :ref:`String` action **)** Emitted when a custom button is pressed. See :ref:`add_button`. @@ -79,7 +79,7 @@ Member Function Description .. _class_AcceptDialog_add_button: -- :ref:`Button` **add_button** **(** :ref:`String` text, :ref:`bool` right=false, :ref:`String` action="" **)** +- :ref:`Button` **add_button** **(** :ref:`String` text, :ref:`bool` right=false, :ref:`String` action="" **)** Adds a button with label *text* and a custom *action* to the dialog and returns the created button. *action* will be passed to the custom_action signal when pressed. @@ -87,49 +87,49 @@ If ``true``, *right* will place the button to the right of any sibling buttons. .. _class_AcceptDialog_add_cancel: -- :ref:`Button` **add_cancel** **(** :ref:`String` name **)** +- :ref:`Button` **add_cancel** **(** :ref:`String` name **)** Adds a button with label *name* and a cancel action to the dialog and returns the created button. .. _class_AcceptDialog_get_hide_on_ok: -- :ref:`bool` **get_hide_on_ok** **(** **)** const +- :ref:`bool` **get_hide_on_ok** **(** **)** const Return true if the dialog will be hidden when accepted (default true). .. _class_AcceptDialog_get_label: -- :ref:`Label` **get_label** **(** **)** +- :ref:`Label` **get_label** **(** **)** Return the label used for built-in text. .. _class_AcceptDialog_get_ok: -- :ref:`Button` **get_ok** **(** **)** +- :ref:`Button` **get_ok** **(** **)** Return the OK Button. .. _class_AcceptDialog_get_text: -- :ref:`String` **get_text** **(** **)** const +- :ref:`String` **get_text** **(** **)** const Return the built-in label text. .. _class_AcceptDialog_register_text_enter: -- void **register_text_enter** **(** :ref:`Node` line_edit **)** +- void **register_text_enter** **(** :ref:`Node` line_edit **)** Registers a :ref:`LineEdit` in the dialog. When the enter key is pressed, the dialog will be accepted. .. _class_AcceptDialog_set_hide_on_ok: -- void **set_hide_on_ok** **(** :ref:`bool` enabled **)** +- void **set_hide_on_ok** **(** :ref:`bool` enabled **)** Set whether the dialog is hidden when accepted (default true). .. _class_AcceptDialog_set_text: -- void **set_text** **(** :ref:`String` text **)** +- void **set_text** **(** :ref:`String` text **)** Set the built-in label text. diff --git a/classes/class_animatedsprite.rst b/classes/class_animatedsprite.rst index 98baf7d46..19cde3522 100644 --- a/classes/class_animatedsprite.rst +++ b/classes/class_animatedsprite.rst @@ -19,54 +19,54 @@ Sprite node that can use multiple textures for animation. Member Functions ---------------- -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_animation` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_frame` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_offset` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`SpriteFrames` | :ref:`get_sprite_frames` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_centered` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_flipped_h` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_flipped_v` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_playing` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`play` **(** :ref:`String` anim="" **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_animation` **(** :ref:`String` animation **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_centered` **(** :ref:`bool` centered **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_flip_h` **(** :ref:`bool` flip_h **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_flip_v` **(** :ref:`bool` flip_v **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_frame` **(** :ref:`int` frame **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_offset` **(** :ref:`Vector2` offset **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sprite_frames` **(** :ref:`SpriteFrames` sprite_frames **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_animation` **(** **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_frame` **(** **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_offset` **(** **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`SpriteFrames` | :ref:`get_sprite_frames` **(** **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_centered` **(** **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_flipped_h` **(** **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_flipped_v` **(** **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_playing` **(** **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`play` **(** :ref:`String` anim="" **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_animation` **(** :ref:`String` animation **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_centered` **(** :ref:`bool` centered **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_flip_h` **(** :ref:`bool` flip_h **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_flip_v` **(** :ref:`bool` flip_v **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_frame` **(** :ref:`int` frame **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_offset` **(** :ref:`Vector2` offset **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_sprite_frames` **(** :ref:`SpriteFrames` sprite_frames **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_AnimatedSprite_animation_finished: -- **animation_finished** **(** **)** +- **animation_finished** **(** **)** Emitted when the animation is finished (when it plays the last frame). If the animation is looping, this signal is emitted every time the last frame is drawn. .. _class_AnimatedSprite_frame_changed: -- **frame_changed** **(** **)** +- **frame_changed** **(** **)** Emitted when :ref:`frame` changed. @@ -117,103 +117,103 @@ Member Function Description .. _class_AnimatedSprite_get_animation: -- :ref:`String` **get_animation** **(** **)** const +- :ref:`String` **get_animation** **(** **)** const Return the name of the current animation set to the node. .. _class_AnimatedSprite_get_frame: -- :ref:`int` **get_frame** **(** **)** const +- :ref:`int` **get_frame** **(** **)** const Return the visible frame index. .. _class_AnimatedSprite_get_offset: -- :ref:`Vector2` **get_offset** **(** **)** const +- :ref:`Vector2` **get_offset** **(** **)** const Return the offset of the sprite in the node origin. .. _class_AnimatedSprite_get_sprite_frames: -- :ref:`SpriteFrames` **get_sprite_frames** **(** **)** const +- :ref:`SpriteFrames` **get_sprite_frames** **(** **)** const Get the :ref:`SpriteFrames` resource, which contains all frames. .. _class_AnimatedSprite_is_centered: -- :ref:`bool` **is_centered** **(** **)** const +- :ref:`bool` **is_centered** **(** **)** const Return true when centered. See :ref:`set_centered`. .. _class_AnimatedSprite_is_flipped_h: -- :ref:`bool` **is_flipped_h** **(** **)** const +- :ref:`bool` **is_flipped_h** **(** **)** const Return true if sprite is flipped horizontally. .. _class_AnimatedSprite_is_flipped_v: -- :ref:`bool` **is_flipped_v** **(** **)** const +- :ref:`bool` **is_flipped_v** **(** **)** const Return true if sprite is flipped vertically. .. _class_AnimatedSprite_is_playing: -- :ref:`bool` **is_playing** **(** **)** const +- :ref:`bool` **is_playing** **(** **)** const Return true if an animation if currently being played. .. _class_AnimatedSprite_play: -- void **play** **(** :ref:`String` anim="" **)** +- void **play** **(** :ref:`String` anim="" **)** Play the animation set in parameter. If no parameter is provided, the current animation is played. .. _class_AnimatedSprite_set_animation: -- void **set_animation** **(** :ref:`String` animation **)** +- void **set_animation** **(** :ref:`String` animation **)** Set the current animation of the node and reinits the frame counter of the animation. .. _class_AnimatedSprite_set_centered: -- void **set_centered** **(** :ref:`bool` centered **)** +- void **set_centered** **(** :ref:`bool` centered **)** When turned on, offset at (0,0) is the center of the sprite, when off, the top-left corner is. .. _class_AnimatedSprite_set_flip_h: -- void **set_flip_h** **(** :ref:`bool` flip_h **)** +- void **set_flip_h** **(** :ref:`bool` flip_h **)** If true, sprite is flipped horizontally. .. _class_AnimatedSprite_set_flip_v: -- void **set_flip_v** **(** :ref:`bool` flip_v **)** +- void **set_flip_v** **(** :ref:`bool` flip_v **)** If true, sprite is flipped vertically. .. _class_AnimatedSprite_set_frame: -- void **set_frame** **(** :ref:`int` frame **)** +- void **set_frame** **(** :ref:`int` frame **)** Set the visible sprite frame index (from the list of frames inside the :ref:`SpriteFrames` resource). .. _class_AnimatedSprite_set_offset: -- void **set_offset** **(** :ref:`Vector2` offset **)** +- void **set_offset** **(** :ref:`Vector2` offset **)** Set the offset of the sprite in the node origin. Position varies depending on whether it is centered or not. .. _class_AnimatedSprite_set_sprite_frames: -- void **set_sprite_frames** **(** :ref:`SpriteFrames` sprite_frames **)** +- void **set_sprite_frames** **(** :ref:`SpriteFrames` sprite_frames **)** Set the :ref:`SpriteFrames` resource, which contains all frames. .. _class_AnimatedSprite_stop: -- void **stop** **(** **)** +- void **stop** **(** **)** Stop the current animation (does not reset the frame counter). diff --git a/classes/class_animatedsprite3d.rst b/classes/class_animatedsprite3d.rst index a235c1eb6..14aa021ee 100644 --- a/classes/class_animatedsprite3d.rst +++ b/classes/class_animatedsprite3d.rst @@ -19,32 +19,32 @@ Brief Description Member Functions ---------------- -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_animation` **(** **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_frame` **(** **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`SpriteFrames` | :ref:`get_sprite_frames` **(** **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_playing` **(** **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`play` **(** :ref:`String` anim="" **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_animation` **(** :ref:`String` animation **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_frame` **(** :ref:`int` frame **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sprite_frames` **(** :ref:`SpriteFrames` sprite_frames **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_animation` **(** **)** const | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_frame` **(** **)** const | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`SpriteFrames` | :ref:`get_sprite_frames` **(** **)** const | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_playing` **(** **)** const | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`play` **(** :ref:`String` anim="" **)** | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_animation` **(** :ref:`String` animation **)** | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_frame` **(** :ref:`int` frame **)** | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_sprite_frames` **(** :ref:`SpriteFrames` sprite_frames **)** | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** **)** | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_AnimatedSprite3D_frame_changed: -- **frame_changed** **(** **)** +- **frame_changed** **(** **)** Emitted when :ref:`frame` changed. @@ -79,55 +79,55 @@ Member Function Description .. _class_AnimatedSprite3D_get_animation: -- :ref:`String` **get_animation** **(** **)** const +- :ref:`String` **get_animation** **(** **)** const Return the name of the current animation set to the node. .. _class_AnimatedSprite3D_get_frame: -- :ref:`int` **get_frame** **(** **)** const +- :ref:`int` **get_frame** **(** **)** const Return the visible frame index. .. _class_AnimatedSprite3D_get_sprite_frames: -- :ref:`SpriteFrames` **get_sprite_frames** **(** **)** const +- :ref:`SpriteFrames` **get_sprite_frames** **(** **)** const Get the :ref:`SpriteFrames` resource, which contains all frames. .. _class_AnimatedSprite3D_is_playing: -- :ref:`bool` **is_playing** **(** **)** const +- :ref:`bool` **is_playing** **(** **)** const Return true if an animation if currently being played. .. _class_AnimatedSprite3D_play: -- void **play** **(** :ref:`String` anim="" **)** +- void **play** **(** :ref:`String` anim="" **)** Play the animation set in parameter. If no parameter is provided, the current animation is played. .. _class_AnimatedSprite3D_set_animation: -- void **set_animation** **(** :ref:`String` animation **)** +- void **set_animation** **(** :ref:`String` animation **)** Set the current animation of the node and reinits the frame counter of the animation. .. _class_AnimatedSprite3D_set_frame: -- void **set_frame** **(** :ref:`int` frame **)** +- void **set_frame** **(** :ref:`int` frame **)** Set the visible sprite frame index (from the list of frames inside the :ref:`SpriteFrames` resource). .. _class_AnimatedSprite3D_set_sprite_frames: -- void **set_sprite_frames** **(** :ref:`SpriteFrames` sprite_frames **)** +- void **set_sprite_frames** **(** :ref:`SpriteFrames` sprite_frames **)** Set the :ref:`SpriteFrames` resource, which contains all frames. .. _class_AnimatedSprite3D_stop: -- void **stop** **(** **)** +- void **stop** **(** **)** Stop the current animation (does not reset the frame counter). diff --git a/classes/class_animation.rst b/classes/class_animation.rst index 3bbc5f0d2..95a88a0ef 100644 --- a/classes/class_animation.rst +++ b/classes/class_animation.rst @@ -19,87 +19,87 @@ Contains data used to animate everything in the engine. Member Functions ---------------- -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`add_track` **(** :ref:`int` type, :ref:`int` at_position=-1 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_track` **(** :ref:`NodePath` path **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_length` **(** **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_step` **(** **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_track_count` **(** **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_loop` **(** **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`method_track_get_key_indices` **(** :ref:`int` idx, :ref:`float` time_sec, :ref:`float` delta **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`method_track_get_name` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`method_track_get_params` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_track` **(** :ref:`int` idx **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_length` **(** :ref:`float` time_sec **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_loop` **(** :ref:`bool` enabled **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_step` **(** :ref:`float` size_sec **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`track_find_key` **(** :ref:`int` idx, :ref:`float` time, :ref:`bool` exact=false **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`track_get_interpolation_loop_wrap` **(** :ref:`int` idx **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`track_get_interpolation_type` **(** :ref:`int` idx **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`track_get_key_count` **(** :ref:`int` idx **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`track_get_key_time` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`track_get_key_transition` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`track_get_key_value` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`track_get_path` **(** :ref:`int` idx **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`track_get_type` **(** :ref:`int` idx **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_insert_key` **(** :ref:`int` idx, :ref:`float` time, :ref:`Variant` key, :ref:`float` transition=1 **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`track_is_imported` **(** :ref:`int` idx **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_move_down` **(** :ref:`int` idx **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_move_up` **(** :ref:`int` idx **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_remove_key` **(** :ref:`int` idx, :ref:`int` key_idx **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_remove_key_at_position` **(** :ref:`int` idx, :ref:`float` position **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_set_imported` **(** :ref:`int` idx, :ref:`bool` imported **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_set_interpolation_loop_wrap` **(** :ref:`int` idx, :ref:`bool` interpolation **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_set_interpolation_type` **(** :ref:`int` idx, :ref:`int` interpolation **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_set_key_transition` **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`float` transition **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_set_key_value` **(** :ref:`int` idx, :ref:`int` key, :ref:`Variant` value **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_set_path` **(** :ref:`int` idx, :ref:`NodePath` path **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`transform_track_insert_key` **(** :ref:`int` idx, :ref:`float` time, :ref:`Vector3` location, :ref:`Quat` rotation, :ref:`Vector3` scale **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`transform_track_interpolate` **(** :ref:`int` idx, :ref:`float` time_sec **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`value_track_get_key_indices` **(** :ref:`int` idx, :ref:`float` time_sec, :ref:`float` delta **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`value_track_get_update_mode` **(** :ref:`int` idx **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`value_track_set_update_mode` **(** :ref:`int` idx, :ref:`int` mode **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`add_track` **(** :ref:`int` type, :ref:`int` at_position=-1 **)** | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find_track` **(** :ref:`NodePath` path **)** const | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_length` **(** **)** const | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_step` **(** **)** const | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_track_count` **(** **)** const | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_loop` **(** **)** const | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`method_track_get_key_indices` **(** :ref:`int` idx, :ref:`float` time_sec, :ref:`float` delta **)** const | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`method_track_get_name` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`method_track_get_params` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_track` **(** :ref:`int` idx **)** | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_length` **(** :ref:`float` time_sec **)** | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_loop` **(** :ref:`bool` enabled **)** | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_step` **(** :ref:`float` size_sec **)** | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`track_find_key` **(** :ref:`int` idx, :ref:`float` time, :ref:`bool` exact=false **)** const | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`track_get_interpolation_loop_wrap` **(** :ref:`int` idx **)** const | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`track_get_interpolation_type` **(** :ref:`int` idx **)** const | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`track_get_key_count` **(** :ref:`int` idx **)** const | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`track_get_key_time` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`track_get_key_transition` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`track_get_key_value` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`track_get_path` **(** :ref:`int` idx **)** const | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`track_get_type` **(** :ref:`int` idx **)** const | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_insert_key` **(** :ref:`int` idx, :ref:`float` time, :ref:`Variant` key, :ref:`float` transition=1 **)** | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`track_is_imported` **(** :ref:`int` idx **)** const | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_move_down` **(** :ref:`int` idx **)** | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_move_up` **(** :ref:`int` idx **)** | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_remove_key` **(** :ref:`int` idx, :ref:`int` key_idx **)** | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_remove_key_at_position` **(** :ref:`int` idx, :ref:`float` position **)** | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_set_imported` **(** :ref:`int` idx, :ref:`bool` imported **)** | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_set_interpolation_loop_wrap` **(** :ref:`int` idx, :ref:`bool` interpolation **)** | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_set_interpolation_type` **(** :ref:`int` idx, :ref:`int` interpolation **)** | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_set_key_transition` **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`float` transition **)** | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_set_key_value` **(** :ref:`int` idx, :ref:`int` key, :ref:`Variant` value **)** | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_set_path` **(** :ref:`int` idx, :ref:`NodePath` path **)** | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`transform_track_insert_key` **(** :ref:`int` idx, :ref:`float` time, :ref:`Vector3` location, :ref:`Quat` rotation, :ref:`Vector3` scale **)** | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`transform_track_interpolate` **(** :ref:`int` idx, :ref:`float` time_sec **)** const | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`value_track_get_key_indices` **(** :ref:`int` idx, :ref:`float` time_sec, :ref:`float` delta **)** const | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`value_track_get_update_mode` **(** :ref:`int` idx **)** const | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`value_track_set_update_mode` **(** :ref:`int` idx, :ref:`int` mode **)** | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -126,237 +126,237 @@ Member Function Description .. _class_Animation_add_track: -- :ref:`int` **add_track** **(** :ref:`int` type, :ref:`int` at_position=-1 **)** +- :ref:`int` **add_track** **(** :ref:`int` type, :ref:`int` at_position=-1 **)** Add a track to the Animation. The track type must be specified as any of the values in the TYPE\_\* enumeration. .. _class_Animation_clear: -- void **clear** **(** **)** +- void **clear** **(** **)** Clear the animation (clear all tracks and reset all). .. _class_Animation_find_track: -- :ref:`int` **find_track** **(** :ref:`NodePath` path **)** const +- :ref:`int` **find_track** **(** :ref:`NodePath` path **)** const Return the index of the specified track. If the track is not found, return -1. .. _class_Animation_get_length: -- :ref:`float` **get_length** **(** **)** const +- :ref:`float` **get_length** **(** **)** const Return the total length of the animation (in seconds). .. _class_Animation_get_step: -- :ref:`float` **get_step** **(** **)** const +- :ref:`float` **get_step** **(** **)** const Get the animation step value. .. _class_Animation_get_track_count: -- :ref:`int` **get_track_count** **(** **)** const +- :ref:`int` **get_track_count** **(** **)** const Return the amount of tracks in the animation. .. _class_Animation_has_loop: -- :ref:`bool` **has_loop** **(** **)** const +- :ref:`bool` **has_loop** **(** **)** const Return whether the animation has the loop flag set. .. _class_Animation_method_track_get_key_indices: -- :ref:`PoolIntArray` **method_track_get_key_indices** **(** :ref:`int` idx, :ref:`float` time_sec, :ref:`float` delta **)** const +- :ref:`PoolIntArray` **method_track_get_key_indices** **(** :ref:`int` idx, :ref:`float` time_sec, :ref:`float` delta **)** const Return all the key indices of a method track, given a position and delta time. .. _class_Animation_method_track_get_name: -- :ref:`String` **method_track_get_name** **(** :ref:`int` idx, :ref:`int` key_idx **)** const +- :ref:`String` **method_track_get_name** **(** :ref:`int` idx, :ref:`int` key_idx **)** const Return the method name of a method track. .. _class_Animation_method_track_get_params: -- :ref:`Array` **method_track_get_params** **(** :ref:`int` idx, :ref:`int` key_idx **)** const +- :ref:`Array` **method_track_get_params** **(** :ref:`int` idx, :ref:`int` key_idx **)** const Return the arguments values to be called on a method track for a given key in a given track. .. _class_Animation_remove_track: -- void **remove_track** **(** :ref:`int` idx **)** +- void **remove_track** **(** :ref:`int` idx **)** Remove a track by specifying the track index. .. _class_Animation_set_length: -- void **set_length** **(** :ref:`float` time_sec **)** +- void **set_length** **(** :ref:`float` time_sec **)** Set the total length of the animation (in seconds). Note that length is not delimited by the last key, as this one may be before or after the end to ensure correct interpolation and looping. .. _class_Animation_set_loop: -- void **set_loop** **(** :ref:`bool` enabled **)** +- void **set_loop** **(** :ref:`bool` enabled **)** Set a flag indicating that the animation must loop. This is uses for correct interpolation of animation cycles, and for hinting the player that it must restart the animation. .. _class_Animation_set_step: -- void **set_step** **(** :ref:`float` size_sec **)** +- void **set_step** **(** :ref:`float` size_sec **)** Set the animation step value. .. _class_Animation_track_find_key: -- :ref:`int` **track_find_key** **(** :ref:`int` idx, :ref:`float` time, :ref:`bool` exact=false **)** const +- :ref:`int` **track_find_key** **(** :ref:`int` idx, :ref:`float` time, :ref:`bool` exact=false **)** const Find the key index by time in a given track. Optionally, only find it if the exact time is given. .. _class_Animation_track_get_interpolation_loop_wrap: -- :ref:`bool` **track_get_interpolation_loop_wrap** **(** :ref:`int` idx **)** const +- :ref:`bool` **track_get_interpolation_loop_wrap** **(** :ref:`int` idx **)** const .. _class_Animation_track_get_interpolation_type: -- :ref:`int` **track_get_interpolation_type** **(** :ref:`int` idx **)** const +- :ref:`int` **track_get_interpolation_type** **(** :ref:`int` idx **)** const Return the interpolation type of a given track, from the INTERPOLATION\_\* enum. .. _class_Animation_track_get_key_count: -- :ref:`int` **track_get_key_count** **(** :ref:`int` idx **)** const +- :ref:`int` **track_get_key_count** **(** :ref:`int` idx **)** const Return the amount of keys in a given track. .. _class_Animation_track_get_key_time: -- :ref:`float` **track_get_key_time** **(** :ref:`int` idx, :ref:`int` key_idx **)** const +- :ref:`float` **track_get_key_time** **(** :ref:`int` idx, :ref:`int` key_idx **)** const Return the time at which the key is located. .. _class_Animation_track_get_key_transition: -- :ref:`float` **track_get_key_transition** **(** :ref:`int` idx, :ref:`int` key_idx **)** const +- :ref:`float` **track_get_key_transition** **(** :ref:`int` idx, :ref:`int` key_idx **)** const Return the transition curve (easing) for a specific key (see built-in math function "ease"). .. _class_Animation_track_get_key_value: -- :ref:`Variant` **track_get_key_value** **(** :ref:`int` idx, :ref:`int` key_idx **)** const +- :ref:`Variant` **track_get_key_value** **(** :ref:`int` idx, :ref:`int` key_idx **)** const Return the value of a given key in a given track. .. _class_Animation_track_get_path: -- :ref:`NodePath` **track_get_path** **(** :ref:`int` idx **)** const +- :ref:`NodePath` **track_get_path** **(** :ref:`int` idx **)** const Get the path of a track. for more information on the path format, see :ref:`track_set_path` .. _class_Animation_track_get_type: -- :ref:`int` **track_get_type** **(** :ref:`int` idx **)** const +- :ref:`int` **track_get_type** **(** :ref:`int` idx **)** const Get the type of a track. .. _class_Animation_track_insert_key: -- void **track_insert_key** **(** :ref:`int` idx, :ref:`float` time, :ref:`Variant` key, :ref:`float` transition=1 **)** +- void **track_insert_key** **(** :ref:`int` idx, :ref:`float` time, :ref:`Variant` key, :ref:`float` transition=1 **)** Insert a generic key in a given track. .. _class_Animation_track_is_imported: -- :ref:`bool` **track_is_imported** **(** :ref:`int` idx **)** const +- :ref:`bool` **track_is_imported** **(** :ref:`int` idx **)** const Return true if the given track is imported. Else, return false. .. _class_Animation_track_move_down: -- void **track_move_down** **(** :ref:`int` idx **)** +- void **track_move_down** **(** :ref:`int` idx **)** Move a track down. .. _class_Animation_track_move_up: -- void **track_move_up** **(** :ref:`int` idx **)** +- void **track_move_up** **(** :ref:`int` idx **)** Move a track up. .. _class_Animation_track_remove_key: -- void **track_remove_key** **(** :ref:`int` idx, :ref:`int` key_idx **)** +- void **track_remove_key** **(** :ref:`int` idx, :ref:`int` key_idx **)** Remove a key by index in a given track. .. _class_Animation_track_remove_key_at_position: -- void **track_remove_key_at_position** **(** :ref:`int` idx, :ref:`float` position **)** +- void **track_remove_key_at_position** **(** :ref:`int` idx, :ref:`float` position **)** Remove a key by position (seconds) in a given track. .. _class_Animation_track_set_imported: -- void **track_set_imported** **(** :ref:`int` idx, :ref:`bool` imported **)** +- void **track_set_imported** **(** :ref:`int` idx, :ref:`bool` imported **)** Set the given track as imported or not. .. _class_Animation_track_set_interpolation_loop_wrap: -- void **track_set_interpolation_loop_wrap** **(** :ref:`int` idx, :ref:`bool` interpolation **)** +- void **track_set_interpolation_loop_wrap** **(** :ref:`int` idx, :ref:`bool` interpolation **)** .. _class_Animation_track_set_interpolation_type: -- void **track_set_interpolation_type** **(** :ref:`int` idx, :ref:`int` interpolation **)** +- void **track_set_interpolation_type** **(** :ref:`int` idx, :ref:`int` interpolation **)** Set the interpolation type of a given track, from the INTERPOLATION\_\* enum. .. _class_Animation_track_set_key_transition: -- void **track_set_key_transition** **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`float` transition **)** +- void **track_set_key_transition** **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`float` transition **)** Set the transition curve (easing) for a specific key (see built-in math function "ease"). .. _class_Animation_track_set_key_value: -- void **track_set_key_value** **(** :ref:`int` idx, :ref:`int` key, :ref:`Variant` value **)** +- void **track_set_key_value** **(** :ref:`int` idx, :ref:`int` key, :ref:`Variant` value **)** Set the value of an existing key. .. _class_Animation_track_set_path: -- void **track_set_path** **(** :ref:`int` idx, :ref:`NodePath` path **)** +- void **track_set_path** **(** :ref:`int` idx, :ref:`NodePath` path **)** Set the path of a track. Paths must be valid scene-tree paths to a node, and must be specified starting from the parent node of the node that will reproduce the animation. Tracks that control properties or bones must append their name after the path, separated by ":". Example: "character/skeleton:ankle" or "character/mesh:transform/local" .. _class_Animation_transform_track_insert_key: -- :ref:`int` **transform_track_insert_key** **(** :ref:`int` idx, :ref:`float` time, :ref:`Vector3` location, :ref:`Quat` rotation, :ref:`Vector3` scale **)** +- :ref:`int` **transform_track_insert_key** **(** :ref:`int` idx, :ref:`float` time, :ref:`Vector3` location, :ref:`Quat` rotation, :ref:`Vector3` scale **)** Insert a transform key for a transform track. .. _class_Animation_transform_track_interpolate: -- :ref:`Array` **transform_track_interpolate** **(** :ref:`int` idx, :ref:`float` time_sec **)** const +- :ref:`Array` **transform_track_interpolate** **(** :ref:`int` idx, :ref:`float` time_sec **)** const Return the interpolated value of a transform track at a given time (in seconds). An array consisting of 3 elements: position (:ref:`Vector3`), rotation (:ref:`Quat`) and scale (:ref:`Vector3`). .. _class_Animation_value_track_get_key_indices: -- :ref:`PoolIntArray` **value_track_get_key_indices** **(** :ref:`int` idx, :ref:`float` time_sec, :ref:`float` delta **)** const +- :ref:`PoolIntArray` **value_track_get_key_indices** **(** :ref:`int` idx, :ref:`float` time_sec, :ref:`float` delta **)** const Return all the key indices of a value track, given a position and delta time. .. _class_Animation_value_track_get_update_mode: -- :ref:`int` **value_track_get_update_mode** **(** :ref:`int` idx **)** const +- :ref:`int` **value_track_get_update_mode** **(** :ref:`int` idx **)** const Return the update mode of a value track. .. _class_Animation_value_track_set_update_mode: -- void **value_track_set_update_mode** **(** :ref:`int` idx, :ref:`int` mode **)** +- void **value_track_set_update_mode** **(** :ref:`int` idx, :ref:`int` mode **)** Set the update mode (UPDATE\_\*) of a value track. diff --git a/classes/class_animationplayer.rst b/classes/class_animationplayer.rst index 265447cdf..652273e44 100644 --- a/classes/class_animationplayer.rst +++ b/classes/class_animationplayer.rst @@ -19,102 +19,102 @@ Container and player of :ref:`Animation` resources. Member Functions ---------------- -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`add_animation` **(** :ref:`String` name, :ref:`Animation` animation **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`advance` **(** :ref:`float` delta **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`animation_get_next` **(** :ref:`String` anim_from **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`animation_set_next` **(** :ref:`String` anim_from, :ref:`String` anim_to **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_caches` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_queue` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`find_animation` **(** :ref:`Animation` animation **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Animation` | :ref:`get_animation` **(** :ref:`String` name **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_animation_list` **(** **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_animation_process_mode` **(** **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_autoplay` **(** **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_blend_time` **(** :ref:`String` anim_from, :ref:`String` anim_to **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_current_animation` **(** **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_current_animation_length` **(** **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_current_animation_position` **(** **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_default_blend_time` **(** **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_position` **(** **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_root` **(** **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_speed_scale` **(** **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_animation` **(** :ref:`String` name **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_active` **(** **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_playing` **(** **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`play` **(** :ref:`String` name="", :ref:`float` custom_blend=-1, :ref:`float` custom_speed=1.0, :ref:`bool` from_end=false **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`play_backwards` **(** :ref:`String` name="", :ref:`float` custom_blend=-1 **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`queue` **(** :ref:`String` name **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_animation` **(** :ref:`String` name **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rename_animation` **(** :ref:`String` name, :ref:`String` newname **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`seek` **(** :ref:`float` seconds, :ref:`bool` update=false **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_active` **(** :ref:`bool` active **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_animation_process_mode` **(** :ref:`int` mode **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_autoplay` **(** :ref:`String` name **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_blend_time` **(** :ref:`String` anim_from, :ref:`String` anim_to, :ref:`float` sec **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_current_animation` **(** :ref:`String` anim **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_default_blend_time` **(** :ref:`float` sec **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_root` **(** :ref:`NodePath` path **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_speed_scale` **(** :ref:`float` speed **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** :ref:`bool` reset=true **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop_all` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`add_animation` **(** :ref:`String` name, :ref:`Animation` animation **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`advance` **(** :ref:`float` delta **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`animation_get_next` **(** :ref:`String` anim_from **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`animation_set_next` **(** :ref:`String` anim_from, :ref:`String` anim_to **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_caches` **(** **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_queue` **(** **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`find_animation` **(** :ref:`Animation` animation **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Animation` | :ref:`get_animation` **(** :ref:`String` name **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_animation_list` **(** **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_animation_process_mode` **(** **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_autoplay` **(** **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_blend_time` **(** :ref:`String` anim_from, :ref:`String` anim_to **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_current_animation` **(** **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_current_animation_length` **(** **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_current_animation_position` **(** **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_default_blend_time` **(** **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_position` **(** **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_root` **(** **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_speed_scale` **(** **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_animation` **(** :ref:`String` name **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_active` **(** **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_playing` **(** **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`play` **(** :ref:`String` name="", :ref:`float` custom_blend=-1, :ref:`float` custom_speed=1.0, :ref:`bool` from_end=false **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`play_backwards` **(** :ref:`String` name="", :ref:`float` custom_blend=-1 **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`queue` **(** :ref:`String` name **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_animation` **(** :ref:`String` name **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rename_animation` **(** :ref:`String` name, :ref:`String` newname **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`seek` **(** :ref:`float` seconds, :ref:`bool` update=false **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_active` **(** :ref:`bool` active **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_animation_process_mode` **(** :ref:`int` mode **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_autoplay` **(** :ref:`String` name **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_blend_time` **(** :ref:`String` anim_from, :ref:`String` anim_to, :ref:`float` sec **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_current_animation` **(** :ref:`String` anim **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_default_blend_time` **(** :ref:`float` sec **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_root` **(** :ref:`NodePath` path **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_speed_scale` **(** :ref:`float` speed **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** :ref:`bool` reset=true **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop_all` **(** **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_AnimationPlayer_animation_changed: -- **animation_changed** **(** :ref:`String` old_name, :ref:`String` new_name **)** +- **animation_changed** **(** :ref:`String` old_name, :ref:`String` new_name **)** If the currently being played animation changes, this signal will notify of such change. .. _class_AnimationPlayer_animation_finished: -- **animation_finished** **(** :ref:`String` name **)** +- **animation_finished** **(** :ref:`String` name **)** Notifies when an animation finished playing. .. _class_AnimationPlayer_animation_started: -- **animation_started** **(** :ref:`String` name **)** +- **animation_started** **(** :ref:`String` name **)** Notifies when an animation starts playing. @@ -151,229 +151,229 @@ Member Function Description .. _class_AnimationPlayer_add_animation: -- :ref:`int` **add_animation** **(** :ref:`String` name, :ref:`Animation` animation **)** +- :ref:`int` **add_animation** **(** :ref:`String` name, :ref:`Animation` animation **)** Add an animation resource to the player, which will be later referenced by the "name" argument. .. _class_AnimationPlayer_advance: -- void **advance** **(** :ref:`float` delta **)** +- void **advance** **(** :ref:`float` delta **)** Used to skip ahead or skip back in an animation. Delta is the time in seconds to skip. .. _class_AnimationPlayer_animation_get_next: -- :ref:`String` **animation_get_next** **(** :ref:`String` anim_from **)** const +- :ref:`String` **animation_get_next** **(** :ref:`String` anim_from **)** const Return the name of the next animation in the queue. .. _class_AnimationPlayer_animation_set_next: -- void **animation_set_next** **(** :ref:`String` anim_from, :ref:`String` anim_to **)** +- void **animation_set_next** **(** :ref:`String` anim_from, :ref:`String` anim_to **)** Set the name of an animation that will be played after. .. _class_AnimationPlayer_clear_caches: -- void **clear_caches** **(** **)** +- void **clear_caches** **(** **)** The animation player creates caches for faster access to the nodes it will animate. However, if a specific node is removed, it may not notice it, so clear_caches will force the player to search for the nodes again. .. _class_AnimationPlayer_clear_queue: -- void **clear_queue** **(** **)** +- void **clear_queue** **(** **)** If animations are queued to play, clear them. .. _class_AnimationPlayer_find_animation: -- :ref:`String` **find_animation** **(** :ref:`Animation` animation **)** const +- :ref:`String` **find_animation** **(** :ref:`Animation` animation **)** const Find an animation name by resource. .. _class_AnimationPlayer_get_animation: -- :ref:`Animation` **get_animation** **(** :ref:`String` name **)** const +- :ref:`Animation` **get_animation** **(** :ref:`String` name **)** const Get an :ref:`Animation` resource by requesting a name. .. _class_AnimationPlayer_get_animation_list: -- :ref:`PoolStringArray` **get_animation_list** **(** **)** const +- :ref:`PoolStringArray` **get_animation_list** **(** **)** const Get the list of names of the animations stored in the player. .. _class_AnimationPlayer_get_animation_process_mode: -- :ref:`int` **get_animation_process_mode** **(** **)** const +- :ref:`int` **get_animation_process_mode** **(** **)** const Return the mode in which the animation player processes. See :ref:`set_animation_process_mode`. .. _class_AnimationPlayer_get_autoplay: -- :ref:`String` **get_autoplay** **(** **)** const +- :ref:`String` **get_autoplay** **(** **)** const Return the name of the animation that will be automatically played when the scene is loaded. .. _class_AnimationPlayer_get_blend_time: -- :ref:`float` **get_blend_time** **(** :ref:`String` anim_from, :ref:`String` anim_to **)** const +- :ref:`float` **get_blend_time** **(** :ref:`String` anim_from, :ref:`String` anim_to **)** const Get the blend time between two animations, referenced by their names. .. _class_AnimationPlayer_get_current_animation: -- :ref:`String` **get_current_animation** **(** **)** const +- :ref:`String` **get_current_animation** **(** **)** const Return the name of the animation being played. .. _class_AnimationPlayer_get_current_animation_length: -- :ref:`float` **get_current_animation_length** **(** **)** const +- :ref:`float` **get_current_animation_length** **(** **)** const Get the length (in seconds) of the currently being played animation. .. _class_AnimationPlayer_get_current_animation_position: -- :ref:`float` **get_current_animation_position** **(** **)** const +- :ref:`float` **get_current_animation_position** **(** **)** const Get the position (in seconds) of the currently being played animation. .. _class_AnimationPlayer_get_default_blend_time: -- :ref:`float` **get_default_blend_time** **(** **)** const +- :ref:`float` **get_default_blend_time** **(** **)** const Return the default blend time between animations. .. _class_AnimationPlayer_get_position: -- :ref:`float` **get_position** **(** **)** const +- :ref:`float` **get_position** **(** **)** const Return the playback position (in seconds) in an animation channel (or channel 0 if none is provided). .. _class_AnimationPlayer_get_root: -- :ref:`NodePath` **get_root** **(** **)** const +- :ref:`NodePath` **get_root** **(** **)** const Return path to root node (see :ref:`set_root`). .. _class_AnimationPlayer_get_speed_scale: -- :ref:`float` **get_speed_scale** **(** **)** const +- :ref:`float` **get_speed_scale** **(** **)** const Get the speed scaling ratio in a given animation channel (or channel 0 if none is provided). Default ratio is *1* (no scaling). .. _class_AnimationPlayer_has_animation: -- :ref:`bool` **has_animation** **(** :ref:`String` name **)** const +- :ref:`bool` **has_animation** **(** :ref:`String` name **)** const Request whether an :ref:`Animation` name exist within the player. .. _class_AnimationPlayer_is_active: -- :ref:`bool` **is_active** **(** **)** const +- :ref:`bool` **is_active** **(** **)** const Return true if the player is active. .. _class_AnimationPlayer_is_playing: -- :ref:`bool` **is_playing** **(** **)** const +- :ref:`bool` **is_playing** **(** **)** const Return whether an animation is playing. .. _class_AnimationPlayer_play: -- void **play** **(** :ref:`String` name="", :ref:`float` custom_blend=-1, :ref:`float` custom_speed=1.0, :ref:`bool` from_end=false **)** +- void **play** **(** :ref:`String` name="", :ref:`float` custom_blend=-1, :ref:`float` custom_speed=1.0, :ref:`bool` from_end=false **)** Play a given animation by the animation name. Custom speed and blend times can be set. If custom speed is negative (-1), 'from_end' being true can play the animation backwards. .. _class_AnimationPlayer_play_backwards: -- void **play_backwards** **(** :ref:`String` name="", :ref:`float` custom_blend=-1 **)** +- void **play_backwards** **(** :ref:`String` name="", :ref:`float` custom_blend=-1 **)** Play a given animation by the animation name in reverse. .. _class_AnimationPlayer_queue: -- void **queue** **(** :ref:`String` name **)** +- void **queue** **(** :ref:`String` name **)** Queue an animation for playback once the current one is done. .. _class_AnimationPlayer_remove_animation: -- void **remove_animation** **(** :ref:`String` name **)** +- void **remove_animation** **(** :ref:`String` name **)** Remove an animation from the player (by supplying the same name used to add it). .. _class_AnimationPlayer_rename_animation: -- void **rename_animation** **(** :ref:`String` name, :ref:`String` newname **)** +- void **rename_animation** **(** :ref:`String` name, :ref:`String` newname **)** Rename an existing animation. .. _class_AnimationPlayer_seek: -- void **seek** **(** :ref:`float` seconds, :ref:`bool` update=false **)** +- void **seek** **(** :ref:`float` seconds, :ref:`bool` update=false **)** Seek the animation to a given position in time (in seconds). If 'update' is true, the animation will be updated too, otherwise it will be updated at process time. .. _class_AnimationPlayer_set_active: -- void **set_active** **(** :ref:`bool` active **)** +- void **set_active** **(** :ref:`bool` active **)** Set the player as active (playing). If false, it will do nothing. .. _class_AnimationPlayer_set_animation_process_mode: -- void **set_animation_process_mode** **(** :ref:`int` mode **)** +- void **set_animation_process_mode** **(** :ref:`int` mode **)** Set the mode in which the animation player processes. By default, it processes on idle time (framerate dependent), but using fixed time works well for animating static collision bodies in 2D and 3D. See enum ANIMATION_PROCESS\_\*. .. _class_AnimationPlayer_set_autoplay: -- void **set_autoplay** **(** :ref:`String` name **)** +- void **set_autoplay** **(** :ref:`String` name **)** Set the name of the animation that will be automatically played when the scene is loaded. .. _class_AnimationPlayer_set_blend_time: -- void **set_blend_time** **(** :ref:`String` anim_from, :ref:`String` anim_to, :ref:`float` sec **)** +- void **set_blend_time** **(** :ref:`String` anim_from, :ref:`String` anim_to, :ref:`float` sec **)** Specify a blend time (in seconds) between two animations, referenced by their names. .. _class_AnimationPlayer_set_current_animation: -- void **set_current_animation** **(** :ref:`String` anim **)** +- void **set_current_animation** **(** :ref:`String` anim **)** Set the current animation (even if no playback occurs). Using set_current_animation() and set_active() are similar to calling play(). .. _class_AnimationPlayer_set_default_blend_time: -- void **set_default_blend_time** **(** :ref:`float` sec **)** +- void **set_default_blend_time** **(** :ref:`float` sec **)** Set the default blend time between animations. .. _class_AnimationPlayer_set_root: -- void **set_root** **(** :ref:`NodePath` path **)** +- void **set_root** **(** :ref:`NodePath` path **)** AnimationPlayer resolves animation track paths from this node (which is relative to itself), by default root is "..", but it can be changed. .. _class_AnimationPlayer_set_speed_scale: -- void **set_speed_scale** **(** :ref:`float` speed **)** +- void **set_speed_scale** **(** :ref:`float` speed **)** Set a speed scaling ratio in a given animation channel (or channel 0 if none is provided). Default ratio is *1* (no scaling). .. _class_AnimationPlayer_stop: -- void **stop** **(** :ref:`bool` reset=true **)** +- void **stop** **(** :ref:`bool` reset=true **)** Stop the currently playing animation. .. _class_AnimationPlayer_stop_all: -- void **stop_all** **(** **)** +- void **stop_all** **(** **)** Stop playback of animations (deprecated). diff --git a/classes/class_animationtreeplayer.rst b/classes/class_animationtreeplayer.rst index 8b02cebb1..c957743fc 100644 --- a/classes/class_animationtreeplayer.rst +++ b/classes/class_animationtreeplayer.rst @@ -19,135 +19,135 @@ Animation Player that uses a node graph for the blending. Member Functions ---------------- -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_node` **(** :ref:`int` type, :ref:`String` id **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`advance` **(** :ref:`float` delta **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Animation` | :ref:`animation_node_get_animation` **(** :ref:`String` id **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`animation_node_get_master_animation` **(** :ref:`String` id **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`animation_node_set_animation` **(** :ref:`String` id, :ref:`Animation` animation **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`animation_node_set_filter_path` **(** :ref:`String` id, :ref:`NodePath` path, :ref:`bool` enable **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`animation_node_set_master_animation` **(** :ref:`String` id, :ref:`String` source **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`are_nodes_connected` **(** :ref:`String` id, :ref:`String` dst_id, :ref:`int` dst_input_idx **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`blend2_node_get_amount` **(** :ref:`String` id **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`blend2_node_set_amount` **(** :ref:`String` id, :ref:`float` blend **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`blend2_node_set_filter_path` **(** :ref:`String` id, :ref:`NodePath` path, :ref:`bool` enable **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`blend3_node_get_amount` **(** :ref:`String` id **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`blend3_node_set_amount` **(** :ref:`String` id, :ref:`float` blend **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`blend4_node_get_amount` **(** :ref:`String` id **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`blend4_node_set_amount` **(** :ref:`String` id, :ref:`Vector2` blend **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`connect_nodes` **(** :ref:`String` id, :ref:`String` dst_id, :ref:`int` dst_input_idx **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`disconnect_nodes` **(** :ref:`String` id, :ref:`int` dst_input_idx **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_animation_process_mode` **(** **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_base_path` **(** **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_master_player` **(** **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_node_list` **(** **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_active` **(** **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`mix_node_get_amount` **(** :ref:`String` id **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mix_node_set_amount` **(** :ref:`String` id, :ref:`float` ratio **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`node_exists` **(** :ref:`String` node **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`node_get_input_count` **(** :ref:`String` id **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`node_get_input_source` **(** :ref:`String` id, :ref:`int` idx **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`node_get_position` **(** :ref:`String` id **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`node_get_type` **(** :ref:`String` id **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`node_rename` **(** :ref:`String` node, :ref:`String` new_name **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`node_set_position` **(** :ref:`String` id, :ref:`Vector2` screen_position **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`oneshot_node_get_autorestart_delay` **(** :ref:`String` id **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`oneshot_node_get_autorestart_random_delay` **(** :ref:`String` id **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`oneshot_node_get_fadein_time` **(** :ref:`String` id **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`oneshot_node_get_fadeout_time` **(** :ref:`String` id **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`oneshot_node_has_autorestart` **(** :ref:`String` id **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`oneshot_node_is_active` **(** :ref:`String` id **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`oneshot_node_set_autorestart` **(** :ref:`String` id, :ref:`bool` enable **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`oneshot_node_set_autorestart_delay` **(** :ref:`String` id, :ref:`float` delay_sec **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`oneshot_node_set_autorestart_random_delay` **(** :ref:`String` id, :ref:`float` rand_sec **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`oneshot_node_set_fadein_time` **(** :ref:`String` id, :ref:`float` time_sec **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`oneshot_node_set_fadeout_time` **(** :ref:`String` id, :ref:`float` time_sec **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`oneshot_node_set_filter_path` **(** :ref:`String` id, :ref:`NodePath` path, :ref:`bool` enable **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`oneshot_node_start` **(** :ref:`String` id **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`oneshot_node_stop` **(** :ref:`String` id **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`recompute_caches` **(** **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_node` **(** :ref:`String` id **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reset` **(** **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_active` **(** :ref:`bool` enabled **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_animation_process_mode` **(** :ref:`int` mode **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_base_path` **(** :ref:`NodePath` path **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_master_player` **(** :ref:`NodePath` nodepath **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`timescale_node_get_scale` **(** :ref:`String` id **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`timescale_node_set_scale` **(** :ref:`String` id, :ref:`float` scale **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`timeseek_node_seek` **(** :ref:`String` id, :ref:`float` seconds **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`transition_node_delete_input` **(** :ref:`String` id, :ref:`int` input_idx **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`transition_node_get_current` **(** :ref:`String` id **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`transition_node_get_input_count` **(** :ref:`String` id **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`transition_node_get_xfade_time` **(** :ref:`String` id **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`transition_node_has_input_auto_advance` **(** :ref:`String` id, :ref:`int` input_idx **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`transition_node_set_current` **(** :ref:`String` id, :ref:`int` input_idx **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`transition_node_set_input_auto_advance` **(** :ref:`String` id, :ref:`int` input_idx, :ref:`bool` enable **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`transition_node_set_input_count` **(** :ref:`String` id, :ref:`int` count **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`transition_node_set_xfade_time` **(** :ref:`String` id, :ref:`float` time_sec **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_node` **(** :ref:`int` type, :ref:`String` id **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`advance` **(** :ref:`float` delta **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Animation` | :ref:`animation_node_get_animation` **(** :ref:`String` id **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`animation_node_get_master_animation` **(** :ref:`String` id **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`animation_node_set_animation` **(** :ref:`String` id, :ref:`Animation` animation **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`animation_node_set_filter_path` **(** :ref:`String` id, :ref:`NodePath` path, :ref:`bool` enable **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`animation_node_set_master_animation` **(** :ref:`String` id, :ref:`String` source **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`are_nodes_connected` **(** :ref:`String` id, :ref:`String` dst_id, :ref:`int` dst_input_idx **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`blend2_node_get_amount` **(** :ref:`String` id **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`blend2_node_set_amount` **(** :ref:`String` id, :ref:`float` blend **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`blend2_node_set_filter_path` **(** :ref:`String` id, :ref:`NodePath` path, :ref:`bool` enable **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`blend3_node_get_amount` **(** :ref:`String` id **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`blend3_node_set_amount` **(** :ref:`String` id, :ref:`float` blend **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`blend4_node_get_amount` **(** :ref:`String` id **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`blend4_node_set_amount` **(** :ref:`String` id, :ref:`Vector2` blend **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`connect_nodes` **(** :ref:`String` id, :ref:`String` dst_id, :ref:`int` dst_input_idx **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`disconnect_nodes` **(** :ref:`String` id, :ref:`int` dst_input_idx **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_animation_process_mode` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_base_path` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_master_player` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_node_list` **(** **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_active` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`mix_node_get_amount` **(** :ref:`String` id **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`mix_node_set_amount` **(** :ref:`String` id, :ref:`float` ratio **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`node_exists` **(** :ref:`String` node **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`node_get_input_count` **(** :ref:`String` id **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`node_get_input_source` **(** :ref:`String` id, :ref:`int` idx **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`node_get_position` **(** :ref:`String` id **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`node_get_type` **(** :ref:`String` id **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`node_rename` **(** :ref:`String` node, :ref:`String` new_name **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`node_set_position` **(** :ref:`String` id, :ref:`Vector2` screen_position **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`oneshot_node_get_autorestart_delay` **(** :ref:`String` id **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`oneshot_node_get_autorestart_random_delay` **(** :ref:`String` id **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`oneshot_node_get_fadein_time` **(** :ref:`String` id **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`oneshot_node_get_fadeout_time` **(** :ref:`String` id **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`oneshot_node_has_autorestart` **(** :ref:`String` id **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`oneshot_node_is_active` **(** :ref:`String` id **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`oneshot_node_set_autorestart` **(** :ref:`String` id, :ref:`bool` enable **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`oneshot_node_set_autorestart_delay` **(** :ref:`String` id, :ref:`float` delay_sec **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`oneshot_node_set_autorestart_random_delay` **(** :ref:`String` id, :ref:`float` rand_sec **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`oneshot_node_set_fadein_time` **(** :ref:`String` id, :ref:`float` time_sec **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`oneshot_node_set_fadeout_time` **(** :ref:`String` id, :ref:`float` time_sec **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`oneshot_node_set_filter_path` **(** :ref:`String` id, :ref:`NodePath` path, :ref:`bool` enable **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`oneshot_node_start` **(** :ref:`String` id **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`oneshot_node_stop` **(** :ref:`String` id **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`recompute_caches` **(** **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_node` **(** :ref:`String` id **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reset` **(** **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_active` **(** :ref:`bool` enabled **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_animation_process_mode` **(** :ref:`int` mode **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_base_path` **(** :ref:`NodePath` path **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_master_player` **(** :ref:`NodePath` nodepath **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`timescale_node_get_scale` **(** :ref:`String` id **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`timescale_node_set_scale` **(** :ref:`String` id, :ref:`float` scale **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`timeseek_node_seek` **(** :ref:`String` id, :ref:`float` seconds **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`transition_node_delete_input` **(** :ref:`String` id, :ref:`int` input_idx **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`transition_node_get_current` **(** :ref:`String` id **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`transition_node_get_input_count` **(** :ref:`String` id **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`transition_node_get_xfade_time` **(** :ref:`String` id **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`transition_node_has_input_auto_advance` **(** :ref:`String` id, :ref:`int` input_idx **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`transition_node_set_current` **(** :ref:`String` id, :ref:`int` input_idx **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`transition_node_set_input_auto_advance` **(** :ref:`String` id, :ref:`int` input_idx, :ref:`bool` enable **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`transition_node_set_input_count` **(** :ref:`String` id, :ref:`int` count **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`transition_node_set_xfade_time` **(** :ref:`String` id, :ref:`float` time_sec **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -183,346 +183,346 @@ Member Function Description .. _class_AnimationTreePlayer_add_node: -- void **add_node** **(** :ref:`int` type, :ref:`String` id **)** +- void **add_node** **(** :ref:`int` type, :ref:`String` id **)** Add a node of a given type in the graph with given id. .. _class_AnimationTreePlayer_advance: -- void **advance** **(** :ref:`float` delta **)** +- void **advance** **(** :ref:`float` delta **)** .. _class_AnimationTreePlayer_animation_node_get_animation: -- :ref:`Animation` **animation_node_get_animation** **(** :ref:`String` id **)** const +- :ref:`Animation` **animation_node_get_animation** **(** :ref:`String` id **)** const Returns an animation given its name. .. _class_AnimationTreePlayer_animation_node_get_master_animation: -- :ref:`String` **animation_node_get_master_animation** **(** :ref:`String` id **)** const +- :ref:`String` **animation_node_get_master_animation** **(** :ref:`String` id **)** const .. _class_AnimationTreePlayer_animation_node_set_animation: -- void **animation_node_set_animation** **(** :ref:`String` id, :ref:`Animation` animation **)** +- void **animation_node_set_animation** **(** :ref:`String` id, :ref:`Animation` animation **)** Set the animation for an animation node. .. _class_AnimationTreePlayer_animation_node_set_filter_path: -- void **animation_node_set_filter_path** **(** :ref:`String` id, :ref:`NodePath` path, :ref:`bool` enable **)** +- void **animation_node_set_filter_path** **(** :ref:`String` id, :ref:`NodePath` path, :ref:`bool` enable **)** .. _class_AnimationTreePlayer_animation_node_set_master_animation: -- void **animation_node_set_master_animation** **(** :ref:`String` id, :ref:`String` source **)** +- void **animation_node_set_master_animation** **(** :ref:`String` id, :ref:`String` source **)** .. _class_AnimationTreePlayer_are_nodes_connected: -- :ref:`bool` **are_nodes_connected** **(** :ref:`String` id, :ref:`String` dst_id, :ref:`int` dst_input_idx **)** const +- :ref:`bool` **are_nodes_connected** **(** :ref:`String` id, :ref:`String` dst_id, :ref:`int` dst_input_idx **)** const Returns whether node ``id`` and ``dst_id`` are connected at the specified slot. .. _class_AnimationTreePlayer_blend2_node_get_amount: -- :ref:`float` **blend2_node_get_amount** **(** :ref:`String` id **)** const +- :ref:`float` **blend2_node_get_amount** **(** :ref:`String` id **)** const Returns the blend amount of a Blend2 node given its name. .. _class_AnimationTreePlayer_blend2_node_set_amount: -- void **blend2_node_set_amount** **(** :ref:`String` id, :ref:`float` blend **)** +- void **blend2_node_set_amount** **(** :ref:`String` id, :ref:`float` blend **)** Sets the blend amount of a Blend2 node given its name and value. .. _class_AnimationTreePlayer_blend2_node_set_filter_path: -- void **blend2_node_set_filter_path** **(** :ref:`String` id, :ref:`NodePath` path, :ref:`bool` enable **)** +- void **blend2_node_set_filter_path** **(** :ref:`String` id, :ref:`NodePath` path, :ref:`bool` enable **)** .. _class_AnimationTreePlayer_blend3_node_get_amount: -- :ref:`float` **blend3_node_get_amount** **(** :ref:`String` id **)** const +- :ref:`float` **blend3_node_get_amount** **(** :ref:`String` id **)** const Returns the blend amount of a Blend3 node given its name. .. _class_AnimationTreePlayer_blend3_node_set_amount: -- void **blend3_node_set_amount** **(** :ref:`String` id, :ref:`float` blend **)** +- void **blend3_node_set_amount** **(** :ref:`String` id, :ref:`float` blend **)** Sets the blend amount of a Blend3 node given its name and value. .. _class_AnimationTreePlayer_blend4_node_get_amount: -- :ref:`Vector2` **blend4_node_get_amount** **(** :ref:`String` id **)** const +- :ref:`Vector2` **blend4_node_get_amount** **(** :ref:`String` id **)** const Returns the blend amount of a Blend4 node given its name. .. _class_AnimationTreePlayer_blend4_node_set_amount: -- void **blend4_node_set_amount** **(** :ref:`String` id, :ref:`Vector2` blend **)** +- void **blend4_node_set_amount** **(** :ref:`String` id, :ref:`Vector2` blend **)** Sets the blend amount of a Blend4 node given its name and value. .. _class_AnimationTreePlayer_connect_nodes: -- :ref:`int` **connect_nodes** **(** :ref:`String` id, :ref:`String` dst_id, :ref:`int` dst_input_idx **)** +- :ref:`int` **connect_nodes** **(** :ref:`String` id, :ref:`String` dst_id, :ref:`int` dst_input_idx **)** Connects node ``id`` to ``dst_id`` at the specified input slot. .. _class_AnimationTreePlayer_disconnect_nodes: -- void **disconnect_nodes** **(** :ref:`String` id, :ref:`int` dst_input_idx **)** +- void **disconnect_nodes** **(** :ref:`String` id, :ref:`int` dst_input_idx **)** Disconnects nodes connected to ``id`` at the specified input slot. .. _class_AnimationTreePlayer_get_animation_process_mode: -- :ref:`int` **get_animation_process_mode** **(** **)** const +- :ref:`int` **get_animation_process_mode** **(** **)** const Returns playback process mode of this AnimationTreePlayer. .. _class_AnimationTreePlayer_get_base_path: -- :ref:`NodePath` **get_base_path** **(** **)** const +- :ref:`NodePath` **get_base_path** **(** **)** const .. _class_AnimationTreePlayer_get_master_player: -- :ref:`NodePath` **get_master_player** **(** **)** const +- :ref:`NodePath` **get_master_player** **(** **)** const .. _class_AnimationTreePlayer_get_node_list: -- :ref:`PoolStringArray` **get_node_list** **(** **)** +- :ref:`PoolStringArray` **get_node_list** **(** **)** Returns a PoolStringArray containing the name of all nodes. .. _class_AnimationTreePlayer_is_active: -- :ref:`bool` **is_active** **(** **)** const +- :ref:`bool` **is_active** **(** **)** const Returns whether this AnimationTreePlayer is active. .. _class_AnimationTreePlayer_mix_node_get_amount: -- :ref:`float` **mix_node_get_amount** **(** :ref:`String` id **)** const +- :ref:`float` **mix_node_get_amount** **(** :ref:`String` id **)** const Returns mix amount of a Mix node given its name. .. _class_AnimationTreePlayer_mix_node_set_amount: -- void **mix_node_set_amount** **(** :ref:`String` id, :ref:`float` ratio **)** +- void **mix_node_set_amount** **(** :ref:`String` id, :ref:`float` ratio **)** Sets mix amount of a Mix node given its name and value. .. _class_AnimationTreePlayer_node_exists: -- :ref:`bool` **node_exists** **(** :ref:`String` node **)** const +- :ref:`bool` **node_exists** **(** :ref:`String` node **)** const Check if a node exists (by name). .. _class_AnimationTreePlayer_node_get_input_count: -- :ref:`int` **node_get_input_count** **(** :ref:`String` id **)** const +- :ref:`int` **node_get_input_count** **(** :ref:`String` id **)** const Return the input count for a given node. Different types of nodes have different amount of inputs. .. _class_AnimationTreePlayer_node_get_input_source: -- :ref:`String` **node_get_input_source** **(** :ref:`String` id, :ref:`int` idx **)** const +- :ref:`String` **node_get_input_source** **(** :ref:`String` id, :ref:`int` idx **)** const Return the input source for a given node input. .. _class_AnimationTreePlayer_node_get_position: -- :ref:`Vector2` **node_get_position** **(** :ref:`String` id **)** const +- :ref:`Vector2` **node_get_position** **(** :ref:`String` id **)** const Returns position of a node in the graph given its name. .. _class_AnimationTreePlayer_node_get_type: -- :ref:`int` **node_get_type** **(** :ref:`String` id **)** const +- :ref:`int` **node_get_type** **(** :ref:`String` id **)** const Get the node type, will return from NODE\_\* enum. .. _class_AnimationTreePlayer_node_rename: -- :ref:`int` **node_rename** **(** :ref:`String` node, :ref:`String` new_name **)** +- :ref:`int` **node_rename** **(** :ref:`String` node, :ref:`String` new_name **)** Rename a node in the graph. .. _class_AnimationTreePlayer_node_set_position: -- void **node_set_position** **(** :ref:`String` id, :ref:`Vector2` screen_position **)** +- void **node_set_position** **(** :ref:`String` id, :ref:`Vector2` screen_position **)** Sets position of a node in the graph given its name and position. .. _class_AnimationTreePlayer_oneshot_node_get_autorestart_delay: -- :ref:`float` **oneshot_node_get_autorestart_delay** **(** :ref:`String` id **)** const +- :ref:`float` **oneshot_node_get_autorestart_delay** **(** :ref:`String` id **)** const Returns autostart delay of a OneShot node given its name. .. _class_AnimationTreePlayer_oneshot_node_get_autorestart_random_delay: -- :ref:`float` **oneshot_node_get_autorestart_random_delay** **(** :ref:`String` id **)** const +- :ref:`float` **oneshot_node_get_autorestart_random_delay** **(** :ref:`String` id **)** const Returns autostart random delay of a OneShot node given its name. .. _class_AnimationTreePlayer_oneshot_node_get_fadein_time: -- :ref:`float` **oneshot_node_get_fadein_time** **(** :ref:`String` id **)** const +- :ref:`float` **oneshot_node_get_fadein_time** **(** :ref:`String` id **)** const Returns fade in time of a OneShot node given its name. .. _class_AnimationTreePlayer_oneshot_node_get_fadeout_time: -- :ref:`float` **oneshot_node_get_fadeout_time** **(** :ref:`String` id **)** const +- :ref:`float` **oneshot_node_get_fadeout_time** **(** :ref:`String` id **)** const Returns fade out time of a OneShot node given its name. .. _class_AnimationTreePlayer_oneshot_node_has_autorestart: -- :ref:`bool` **oneshot_node_has_autorestart** **(** :ref:`String` id **)** const +- :ref:`bool` **oneshot_node_has_autorestart** **(** :ref:`String` id **)** const Returns whether a OneShot node will auto restart given its name. .. _class_AnimationTreePlayer_oneshot_node_is_active: -- :ref:`bool` **oneshot_node_is_active** **(** :ref:`String` id **)** const +- :ref:`bool` **oneshot_node_is_active** **(** :ref:`String` id **)** const Returns whether a OneShot node is active given its name. .. _class_AnimationTreePlayer_oneshot_node_set_autorestart: -- void **oneshot_node_set_autorestart** **(** :ref:`String` id, :ref:`bool` enable **)** +- void **oneshot_node_set_autorestart** **(** :ref:`String` id, :ref:`bool` enable **)** Sets autorestart property of a OneShot node given its name and value. .. _class_AnimationTreePlayer_oneshot_node_set_autorestart_delay: -- void **oneshot_node_set_autorestart_delay** **(** :ref:`String` id, :ref:`float` delay_sec **)** +- void **oneshot_node_set_autorestart_delay** **(** :ref:`String` id, :ref:`float` delay_sec **)** Sets autorestart delay of a OneShot node given its name and value in seconds. .. _class_AnimationTreePlayer_oneshot_node_set_autorestart_random_delay: -- void **oneshot_node_set_autorestart_random_delay** **(** :ref:`String` id, :ref:`float` rand_sec **)** +- void **oneshot_node_set_autorestart_random_delay** **(** :ref:`String` id, :ref:`float` rand_sec **)** Sets autorestart random delay of a OneShot node given its name and value in seconds. .. _class_AnimationTreePlayer_oneshot_node_set_fadein_time: -- void **oneshot_node_set_fadein_time** **(** :ref:`String` id, :ref:`float` time_sec **)** +- void **oneshot_node_set_fadein_time** **(** :ref:`String` id, :ref:`float` time_sec **)** Sets fade in time of a OneShot node given its name and value in seconds. .. _class_AnimationTreePlayer_oneshot_node_set_fadeout_time: -- void **oneshot_node_set_fadeout_time** **(** :ref:`String` id, :ref:`float` time_sec **)** +- void **oneshot_node_set_fadeout_time** **(** :ref:`String` id, :ref:`float` time_sec **)** Sets fade out time of a OneShot node given its name and value in seconds. .. _class_AnimationTreePlayer_oneshot_node_set_filter_path: -- void **oneshot_node_set_filter_path** **(** :ref:`String` id, :ref:`NodePath` path, :ref:`bool` enable **)** +- void **oneshot_node_set_filter_path** **(** :ref:`String` id, :ref:`NodePath` path, :ref:`bool` enable **)** .. _class_AnimationTreePlayer_oneshot_node_start: -- void **oneshot_node_start** **(** :ref:`String` id **)** +- void **oneshot_node_start** **(** :ref:`String` id **)** Starts a OneShot node given its name. .. _class_AnimationTreePlayer_oneshot_node_stop: -- void **oneshot_node_stop** **(** :ref:`String` id **)** +- void **oneshot_node_stop** **(** :ref:`String` id **)** Stops a OneShot node given its name. .. _class_AnimationTreePlayer_recompute_caches: -- void **recompute_caches** **(** **)** +- void **recompute_caches** **(** **)** .. _class_AnimationTreePlayer_remove_node: -- void **remove_node** **(** :ref:`String` id **)** +- void **remove_node** **(** :ref:`String` id **)** .. _class_AnimationTreePlayer_reset: -- void **reset** **(** **)** +- void **reset** **(** **)** Resets this AnimationTreePlayer. .. _class_AnimationTreePlayer_set_active: -- void **set_active** **(** :ref:`bool` enabled **)** +- void **set_active** **(** :ref:`bool` enabled **)** Sets whether this AnimationTreePlayer is active. AnimationTreePlayer will start processing if set to active. .. _class_AnimationTreePlayer_set_animation_process_mode: -- void **set_animation_process_mode** **(** :ref:`int` mode **)** +- void **set_animation_process_mode** **(** :ref:`int` mode **)** Sets process mode (ANIMATION_PROCESS\_\*) of this AnimationTreePlayer. .. _class_AnimationTreePlayer_set_base_path: -- void **set_base_path** **(** :ref:`NodePath` path **)** +- void **set_base_path** **(** :ref:`NodePath` path **)** Sets base path of this AnimationTreePlayer. .. _class_AnimationTreePlayer_set_master_player: -- void **set_master_player** **(** :ref:`NodePath` nodepath **)** +- void **set_master_player** **(** :ref:`NodePath` nodepath **)** .. _class_AnimationTreePlayer_timescale_node_get_scale: -- :ref:`float` **timescale_node_get_scale** **(** :ref:`String` id **)** const +- :ref:`float` **timescale_node_get_scale** **(** :ref:`String` id **)** const Returns time scale value of a TimeScale node given its name. .. _class_AnimationTreePlayer_timescale_node_set_scale: -- void **timescale_node_set_scale** **(** :ref:`String` id, :ref:`float` scale **)** +- void **timescale_node_set_scale** **(** :ref:`String` id, :ref:`float` scale **)** Sets time scale value of a TimeScale node given its name and value. .. _class_AnimationTreePlayer_timeseek_node_seek: -- void **timeseek_node_seek** **(** :ref:`String` id, :ref:`float` seconds **)** +- void **timeseek_node_seek** **(** :ref:`String` id, :ref:`float` seconds **)** Sets time seek value of a TimeSeek node given its name and value. .. _class_AnimationTreePlayer_transition_node_delete_input: -- void **transition_node_delete_input** **(** :ref:`String` id, :ref:`int` input_idx **)** +- void **transition_node_delete_input** **(** :ref:`String` id, :ref:`int` input_idx **)** .. _class_AnimationTreePlayer_transition_node_get_current: -- :ref:`int` **transition_node_get_current** **(** :ref:`String` id **)** const +- :ref:`int` **transition_node_get_current** **(** :ref:`String` id **)** const .. _class_AnimationTreePlayer_transition_node_get_input_count: -- :ref:`int` **transition_node_get_input_count** **(** :ref:`String` id **)** const +- :ref:`int` **transition_node_get_input_count** **(** :ref:`String` id **)** const .. _class_AnimationTreePlayer_transition_node_get_xfade_time: -- :ref:`float` **transition_node_get_xfade_time** **(** :ref:`String` id **)** const +- :ref:`float` **transition_node_get_xfade_time** **(** :ref:`String` id **)** const .. _class_AnimationTreePlayer_transition_node_has_input_auto_advance: -- :ref:`bool` **transition_node_has_input_auto_advance** **(** :ref:`String` id, :ref:`int` input_idx **)** const +- :ref:`bool` **transition_node_has_input_auto_advance** **(** :ref:`String` id, :ref:`int` input_idx **)** const .. _class_AnimationTreePlayer_transition_node_set_current: -- void **transition_node_set_current** **(** :ref:`String` id, :ref:`int` input_idx **)** +- void **transition_node_set_current** **(** :ref:`String` id, :ref:`int` input_idx **)** .. _class_AnimationTreePlayer_transition_node_set_input_auto_advance: -- void **transition_node_set_input_auto_advance** **(** :ref:`String` id, :ref:`int` input_idx, :ref:`bool` enable **)** +- void **transition_node_set_input_auto_advance** **(** :ref:`String` id, :ref:`int` input_idx, :ref:`bool` enable **)** .. _class_AnimationTreePlayer_transition_node_set_input_count: -- void **transition_node_set_input_count** **(** :ref:`String` id, :ref:`int` count **)** +- void **transition_node_set_input_count** **(** :ref:`String` id, :ref:`int` count **)** .. _class_AnimationTreePlayer_transition_node_set_xfade_time: -- void **transition_node_set_xfade_time** **(** :ref:`String` id, :ref:`float` time_sec **)** +- void **transition_node_set_xfade_time** **(** :ref:`String` id, :ref:`float` time_sec **)** diff --git a/classes/class_area.rst b/classes/class_area.rst index 9f111ef61..b8484ac80 100644 --- a/classes/class_area.rst +++ b/classes/class_area.rst @@ -19,144 +19,144 @@ General purpose area node for detection and 3D physics influence. Member Functions ---------------- -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_angular_damp` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_audio_bus` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_layer` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_mask` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_gravity` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_gravity_distance_scale` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_gravity_vector` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_linear_damp` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_overlapping_areas` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_overlapping_bodies` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_priority` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_reverb_amount` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_reverb_bus` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_reverb_uniformity` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_space_override_mode` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_gravity_a_point` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_monitorable` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_monitoring` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_overriding_audio_bus` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_using_reverb_bus` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`overlaps_area` **(** :ref:`Node` area **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`overlaps_body` **(** :ref:`Node` body **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_angular_damp` **(** :ref:`float` angular_damp **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_audio_bus` **(** :ref:`String` name **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_audio_bus_override` **(** :ref:`bool` enable **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_layer` **(** :ref:`int` collision_layer **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_mask` **(** :ref:`int` collision_mask **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_gravity` **(** :ref:`float` gravity **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_gravity_distance_scale` **(** :ref:`float` distance_scale **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_gravity_is_point` **(** :ref:`bool` enable **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_gravity_vector` **(** :ref:`Vector3` vector **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_linear_damp` **(** :ref:`float` linear_damp **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_monitorable` **(** :ref:`bool` enable **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_monitoring` **(** :ref:`bool` enable **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_priority` **(** :ref:`float` priority **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_reverb_amount` **(** :ref:`float` amount **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_reverb_bus` **(** :ref:`String` name **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_reverb_uniformity` **(** :ref:`float` amount **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_space_override_mode` **(** :ref:`int` enable **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_reverb_bus` **(** :ref:`bool` enable **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_angular_damp` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_audio_bus` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_layer` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_mask` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_gravity` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_gravity_distance_scale` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_gravity_vector` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_linear_damp` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_overlapping_areas` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_overlapping_bodies` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_priority` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_reverb_amount` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_reverb_bus` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_reverb_uniformity` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_space_override_mode` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_gravity_a_point` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_monitorable` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_monitoring` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_overriding_audio_bus` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_using_reverb_bus` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`overlaps_area` **(** :ref:`Node` area **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`overlaps_body` **(** :ref:`Node` body **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_angular_damp` **(** :ref:`float` angular_damp **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_audio_bus` **(** :ref:`String` name **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_audio_bus_override` **(** :ref:`bool` enable **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_layer` **(** :ref:`int` collision_layer **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_mask` **(** :ref:`int` collision_mask **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_gravity` **(** :ref:`float` gravity **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_gravity_distance_scale` **(** :ref:`float` distance_scale **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_gravity_is_point` **(** :ref:`bool` enable **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_gravity_vector` **(** :ref:`Vector3` vector **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_linear_damp` **(** :ref:`float` linear_damp **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_monitorable` **(** :ref:`bool` enable **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_monitoring` **(** :ref:`bool` enable **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_priority` **(** :ref:`float` priority **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_reverb_amount` **(** :ref:`float` amount **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_reverb_bus` **(** :ref:`String` name **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_reverb_uniformity` **(** :ref:`float` amount **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_space_override_mode` **(** :ref:`int` enable **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_reverb_bus` **(** :ref:`bool` enable **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_Area_area_entered: -- **area_entered** **(** :ref:`Object` area **)** +- **area_entered** **(** :ref:`Object` area **)** Emitted when another area enters. .. _class_Area_area_exited: -- **area_exited** **(** :ref:`Object` area **)** +- **area_exited** **(** :ref:`Object` area **)** Emitted when another area exits. .. _class_Area_area_shape_entered: -- **area_shape_entered** **(** :ref:`int` area_id, :ref:`Object` area, :ref:`int` area_shape, :ref:`int` self_shape **)** +- **area_shape_entered** **(** :ref:`int` area_id, :ref:`Object` area, :ref:`int` area_shape, :ref:`int` self_shape **)** Emitted when another area enters, reporting which areas overlapped. .. _class_Area_area_shape_exited: -- **area_shape_exited** **(** :ref:`int` area_id, :ref:`Object` area, :ref:`int` area_shape, :ref:`int` self_shape **)** +- **area_shape_exited** **(** :ref:`int` area_id, :ref:`Object` area, :ref:`int` area_shape, :ref:`int` self_shape **)** Emitted when another area exits, reporting which areas were overlapping. .. _class_Area_body_entered: -- **body_entered** **(** :ref:`Object` body **)** +- **body_entered** **(** :ref:`Object` body **)** Emitted when a :ref:`PhysicsBody` object enters. .. _class_Area_body_exited: -- **body_exited** **(** :ref:`Object` body **)** +- **body_exited** **(** :ref:`Object` body **)** Emitted when a :ref:`PhysicsBody2D` object exits. .. _class_Area_body_shape_entered: -- **body_shape_entered** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` area_shape **)** +- **body_shape_entered** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` area_shape **)** Emitted when a :ref:`PhysicsBody2D` object enters, reporting which shapes overlapped. .. _class_Area_body_shape_exited: -- **body_shape_exited** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` area_shape **)** +- **body_shape_exited** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` area_shape **)** Emitted when a :ref:`PhysicsBody2D` object exits, reporting which shapes were overlapping. @@ -256,139 +256,139 @@ Member Function Description .. _class_Area_get_angular_damp: -- :ref:`float` **get_angular_damp** **(** **)** const +- :ref:`float` **get_angular_damp** **(** **)** const Return the angular damp rate. .. _class_Area_get_audio_bus: -- :ref:`String` **get_audio_bus** **(** **)** const +- :ref:`String` **get_audio_bus** **(** **)** const .. _class_Area_get_collision_layer: -- :ref:`int` **get_collision_layer** **(** **)** const +- :ref:`int` **get_collision_layer** **(** **)** const Return the physics layer this area is in. .. _class_Area_get_collision_layer_bit: -- :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const +- :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const Return an individual bit on the layer mask. .. _class_Area_get_collision_mask: -- :ref:`int` **get_collision_mask** **(** **)** const +- :ref:`int` **get_collision_mask** **(** **)** const Return the physics layers this area can scan for collisions. .. _class_Area_get_collision_mask_bit: -- :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const +- :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const Return an individual bit on the collision mask. .. _class_Area_get_gravity: -- :ref:`float` **get_gravity** **(** **)** const +- :ref:`float` **get_gravity** **(** **)** const Return the gravity intensity. .. _class_Area_get_gravity_distance_scale: -- :ref:`float` **get_gravity_distance_scale** **(** **)** const +- :ref:`float` **get_gravity_distance_scale** **(** **)** const Return the falloff factor for point gravity. .. _class_Area_get_gravity_vector: -- :ref:`Vector3` **get_gravity_vector** **(** **)** const +- :ref:`Vector3` **get_gravity_vector** **(** **)** const Return the gravity vector. If gravity is a point (see :ref:`is_gravity_a_point`), this will be the attraction center. .. _class_Area_get_linear_damp: -- :ref:`float` **get_linear_damp** **(** **)** const +- :ref:`float` **get_linear_damp** **(** **)** const Return the linear damp rate. .. _class_Area_get_overlapping_areas: -- :ref:`Array` **get_overlapping_areas** **(** **)** const +- :ref:`Array` **get_overlapping_areas** **(** **)** const Returns a list of intersecting :ref:`Area`\ s. .. _class_Area_get_overlapping_bodies: -- :ref:`Array` **get_overlapping_bodies** **(** **)** const +- :ref:`Array` **get_overlapping_bodies** **(** **)** const Returns a list of intersecting :ref:`PhysicsBody`\ s. .. _class_Area_get_priority: -- :ref:`float` **get_priority** **(** **)** const +- :ref:`float` **get_priority** **(** **)** const Return the processing order of this area. .. _class_Area_get_reverb_amount: -- :ref:`float` **get_reverb_amount** **(** **)** const +- :ref:`float` **get_reverb_amount** **(** **)** const .. _class_Area_get_reverb_bus: -- :ref:`String` **get_reverb_bus** **(** **)** const +- :ref:`String` **get_reverb_bus** **(** **)** const .. _class_Area_get_reverb_uniformity: -- :ref:`float` **get_reverb_uniformity** **(** **)** const +- :ref:`float` **get_reverb_uniformity** **(** **)** const .. _class_Area_get_space_override_mode: -- :ref:`int` **get_space_override_mode** **(** **)** const +- :ref:`int` **get_space_override_mode** **(** **)** const Return the space override mode. .. _class_Area_is_gravity_a_point: -- :ref:`bool` **is_gravity_a_point** **(** **)** const +- :ref:`bool` **is_gravity_a_point** **(** **)** const Return whether gravity is a point. A point gravity will attract objects towards it, as opposed to a gravity vector, which moves them in a given direction. .. _class_Area_is_monitorable: -- :ref:`bool` **is_monitorable** **(** **)** const +- :ref:`bool` **is_monitorable** **(** **)** const Return whether this area can be detected by other, monitoring, areas. .. _class_Area_is_monitoring: -- :ref:`bool` **is_monitoring** **(** **)** const +- :ref:`bool` **is_monitoring** **(** **)** const Return whether this area detects bodies/areas entering/exiting it. .. _class_Area_is_overriding_audio_bus: -- :ref:`bool` **is_overriding_audio_bus** **(** **)** const +- :ref:`bool` **is_overriding_audio_bus** **(** **)** const .. _class_Area_is_using_reverb_bus: -- :ref:`bool` **is_using_reverb_bus** **(** **)** const +- :ref:`bool` **is_using_reverb_bus** **(** **)** const .. _class_Area_overlaps_area: -- :ref:`bool` **overlaps_area** **(** :ref:`Node` area **)** const +- :ref:`bool` **overlaps_area** **(** :ref:`Node` area **)** const If ``true`` the given area overlaps the Area. .. _class_Area_overlaps_body: -- :ref:`bool` **overlaps_body** **(** :ref:`Node` body **)** const +- :ref:`bool` **overlaps_body** **(** :ref:`Node` body **)** const If ``true`` the given body overlaps the Area. .. _class_Area_set_angular_damp: -- void **set_angular_damp** **(** :ref:`float` angular_damp **)** +- void **set_angular_damp** **(** :ref:`float` angular_damp **)** Set the rate at which objects stop spinning in this area, if there are not any other forces making it spin. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops. @@ -396,15 +396,15 @@ In practice, as the fraction of speed lost gets smaller with each frame, a value .. _class_Area_set_audio_bus: -- void **set_audio_bus** **(** :ref:`String` name **)** +- void **set_audio_bus** **(** :ref:`String` name **)** .. _class_Area_set_audio_bus_override: -- void **set_audio_bus_override** **(** :ref:`bool` enable **)** +- void **set_audio_bus_override** **(** :ref:`bool` enable **)** .. _class_Area_set_collision_layer: -- void **set_collision_layer** **(** :ref:`int` collision_layer **)** +- void **set_collision_layer** **(** :ref:`int` collision_layer **)** Set the physics layers this area is in. @@ -414,25 +414,25 @@ A contact is detected if object A is in any of the layers that object B scans, o .. _class_Area_set_collision_layer_bit: -- void **set_collision_layer_bit** **(** :ref:`int` bit, :ref:`bool` value **)** +- void **set_collision_layer_bit** **(** :ref:`int` bit, :ref:`bool` value **)** Set/clear individual bits on the layer mask. This makes getting an area in/out of only one layer easier. .. _class_Area_set_collision_mask: -- void **set_collision_mask** **(** :ref:`int` collision_mask **)** +- void **set_collision_mask** **(** :ref:`int` collision_mask **)** Set the physics layers this area can scan for collisions. .. _class_Area_set_collision_mask_bit: -- void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** +- void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier. .. _class_Area_set_gravity: -- void **set_gravity** **(** :ref:`float` gravity **)** +- void **set_gravity** **(** :ref:`float` gravity **)** Set the gravity intensity. This is useful to alter the force of gravity without altering its direction. @@ -440,19 +440,19 @@ This value multiplies the gravity vector, whether it is the given vector (:ref:` .. _class_Area_set_gravity_distance_scale: -- void **set_gravity_distance_scale** **(** :ref:`float` distance_scale **)** +- void **set_gravity_distance_scale** **(** :ref:`float` distance_scale **)** Set the falloff factor for point gravity. The greater this value is, the faster the strength of gravity decreases with the square of distance. .. _class_Area_set_gravity_is_point: -- void **set_gravity_is_point** **(** :ref:`bool` enable **)** +- void **set_gravity_is_point** **(** :ref:`bool` enable **)** When overriding space parameters, this method sets whether this area has a center of gravity. To set/get the location of the center of gravity, use :ref:`set_gravity_vector`/:ref:`get_gravity_vector`. .. _class_Area_set_gravity_vector: -- void **set_gravity_vector** **(** :ref:`Vector3` vector **)** +- void **set_gravity_vector** **(** :ref:`Vector3` vector **)** Set the gravity vector. This vector does not have to be normalized. @@ -460,7 +460,7 @@ If gravity is a point (see :ref:`is_gravity_a_point` linear_damp **)** +- void **set_linear_damp** **(** :ref:`float` linear_damp **)** Set the rate at which objects stop moving in this area, if there are not any other forces moving it. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops. @@ -468,19 +468,19 @@ In practice, as the fraction of speed lost gets smaller with each frame, a value .. _class_Area_set_monitorable: -- void **set_monitorable** **(** :ref:`bool` enable **)** +- void **set_monitorable** **(** :ref:`bool` enable **)** Set whether this area can be detected by other, monitoring, areas. Only areas need to be marked as monitorable. Bodies are always so. .. _class_Area_set_monitoring: -- void **set_monitoring** **(** :ref:`bool` enable **)** +- void **set_monitoring** **(** :ref:`bool` enable **)** Set whether this area can detect bodies/areas entering/exiting it. .. _class_Area_set_priority: -- void **set_priority** **(** :ref:`float` priority **)** +- void **set_priority** **(** :ref:`float` priority **)** Set the order in which the area is processed. Greater values mean the area gets processed first. This is useful for areas which have a space override different from AREA_SPACE_OVERRIDE_DISABLED or AREA_SPACE_OVERRIDE_COMBINE, as they replace values, and are thus order-dependent. @@ -488,19 +488,19 @@ Areas with the same priority value get evaluated in an unpredictable order, and .. _class_Area_set_reverb_amount: -- void **set_reverb_amount** **(** :ref:`float` amount **)** +- void **set_reverb_amount** **(** :ref:`float` amount **)** .. _class_Area_set_reverb_bus: -- void **set_reverb_bus** **(** :ref:`String` name **)** +- void **set_reverb_bus** **(** :ref:`String` name **)** .. _class_Area_set_reverb_uniformity: -- void **set_reverb_uniformity** **(** :ref:`float` amount **)** +- void **set_reverb_uniformity** **(** :ref:`float` amount **)** .. _class_Area_set_space_override_mode: -- void **set_space_override_mode** **(** :ref:`int` enable **)** +- void **set_space_override_mode** **(** :ref:`int` enable **)** Set the space override mode. This mode controls how an area affects gravity and damp. @@ -516,6 +516,6 @@ AREA_SPACE_OVERRIDE_REPLACE_COMBINE: This area replaces any gravity/damp calcula .. _class_Area_set_use_reverb_bus: -- void **set_use_reverb_bus** **(** :ref:`bool` enable **)** +- void **set_use_reverb_bus** **(** :ref:`bool` enable **)** diff --git a/classes/class_area2d.rst b/classes/class_area2d.rst index b4b28e4bc..0418597ea 100644 --- a/classes/class_area2d.rst +++ b/classes/class_area2d.rst @@ -19,128 +19,128 @@ Brief Description Member Functions ---------------- -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_angular_damp` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_audio_bus_name` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_layer` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_mask` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_gravity` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_gravity_distance_scale` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_gravity_vector` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_linear_damp` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_overlapping_areas` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_overlapping_bodies` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_priority` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_space_override_mode` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_gravity_a_point` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_monitorable` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_monitoring` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_overriding_audio_bus` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`overlaps_area` **(** :ref:`Node` area **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`overlaps_body` **(** :ref:`Node` body **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_angular_damp` **(** :ref:`float` angular_damp **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_audio_bus_name` **(** :ref:`String` name **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_audio_bus_override` **(** :ref:`bool` enable **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_layer` **(** :ref:`int` collision_layer **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_mask` **(** :ref:`int` collision_mask **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_gravity` **(** :ref:`float` gravity **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_gravity_distance_scale` **(** :ref:`float` distance_scale **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_gravity_is_point` **(** :ref:`bool` enable **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_gravity_vector` **(** :ref:`Vector2` vector **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_linear_damp` **(** :ref:`float` linear_damp **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_monitorable` **(** :ref:`bool` enable **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_monitoring` **(** :ref:`bool` enable **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_priority` **(** :ref:`float` priority **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_space_override_mode` **(** :ref:`int` space_override_mode **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_angular_damp` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_audio_bus_name` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_layer` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_mask` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_gravity` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_gravity_distance_scale` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_gravity_vector` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_linear_damp` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_overlapping_areas` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_overlapping_bodies` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_priority` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_space_override_mode` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_gravity_a_point` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_monitorable` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_monitoring` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_overriding_audio_bus` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`overlaps_area` **(** :ref:`Node` area **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`overlaps_body` **(** :ref:`Node` body **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_angular_damp` **(** :ref:`float` angular_damp **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_audio_bus_name` **(** :ref:`String` name **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_audio_bus_override` **(** :ref:`bool` enable **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_layer` **(** :ref:`int` collision_layer **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_mask` **(** :ref:`int` collision_mask **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_gravity` **(** :ref:`float` gravity **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_gravity_distance_scale` **(** :ref:`float` distance_scale **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_gravity_is_point` **(** :ref:`bool` enable **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_gravity_vector` **(** :ref:`Vector2` vector **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_linear_damp` **(** :ref:`float` linear_damp **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_monitorable` **(** :ref:`bool` enable **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_monitoring` **(** :ref:`bool` enable **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_priority` **(** :ref:`float` priority **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_space_override_mode` **(** :ref:`int` space_override_mode **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_Area2D_area_entered: -- **area_entered** **(** :ref:`Object` area **)** +- **area_entered** **(** :ref:`Object` area **)** Emitted when another area enters. .. _class_Area2D_area_exited: -- **area_exited** **(** :ref:`Object` area **)** +- **area_exited** **(** :ref:`Object` area **)** Emitted when another area exits. .. _class_Area2D_area_shape_entered: -- **area_shape_entered** **(** :ref:`int` area_id, :ref:`Object` area, :ref:`int` area_shape, :ref:`int` self_shape **)** +- **area_shape_entered** **(** :ref:`int` area_id, :ref:`Object` area, :ref:`int` area_shape, :ref:`int` self_shape **)** Emitted when another area enters, reporting which shapes overlapped. .. _class_Area2D_area_shape_exited: -- **area_shape_exited** **(** :ref:`int` area_id, :ref:`Object` area, :ref:`int` area_shape, :ref:`int` self_shape **)** +- **area_shape_exited** **(** :ref:`int` area_id, :ref:`Object` area, :ref:`int` area_shape, :ref:`int` self_shape **)** Emitted when another area exits, reporting which shapes were overlapping. .. _class_Area2D_body_entered: -- **body_entered** **(** :ref:`Object` body **)** +- **body_entered** **(** :ref:`Object` body **)** Emitted when a :ref:`PhysicsBody2D` object enters. .. _class_Area2D_body_exited: -- **body_exited** **(** :ref:`Object` body **)** +- **body_exited** **(** :ref:`Object` body **)** Emitted when a :ref:`PhysicsBody2D` object exits. .. _class_Area2D_body_shape_entered: -- **body_shape_entered** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` area_shape **)** +- **body_shape_entered** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` area_shape **)** Emitted when a :ref:`PhysicsBody2D` object enters, reporting which shapes overlapped. .. _class_Area2D_body_shape_exited: -- **body_shape_exited** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` area_shape **)** +- **body_shape_exited** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` area_shape **)** Emitted when a :ref:`PhysicsBody2D` object exits, reporting which shapes were overlapping. @@ -224,123 +224,123 @@ Member Function Description .. _class_Area2D_get_angular_damp: -- :ref:`float` **get_angular_damp** **(** **)** const +- :ref:`float` **get_angular_damp** **(** **)** const Return the angular damp rate. .. _class_Area2D_get_audio_bus_name: -- :ref:`String` **get_audio_bus_name** **(** **)** const +- :ref:`String` **get_audio_bus_name** **(** **)** const .. _class_Area2D_get_collision_layer: -- :ref:`int` **get_collision_layer** **(** **)** const +- :ref:`int` **get_collision_layer** **(** **)** const Return the physics layer this area is in. .. _class_Area2D_get_collision_layer_bit: -- :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const +- :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const Return an individual bit on the layer mask. Describes whether other areas will collide with this one on the given layer. .. _class_Area2D_get_collision_mask: -- :ref:`int` **get_collision_mask** **(** **)** const +- :ref:`int` **get_collision_mask** **(** **)** const Return the physics layers this area will scan to determine collisions. .. _class_Area2D_get_collision_mask_bit: -- :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const +- :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const Return an individual bit on the collision mask. Describes whether this area will collide with others on the given layer. .. _class_Area2D_get_gravity: -- :ref:`float` **get_gravity** **(** **)** const +- :ref:`float` **get_gravity** **(** **)** const Return the gravity intensity. .. _class_Area2D_get_gravity_distance_scale: -- :ref:`float` **get_gravity_distance_scale** **(** **)** const +- :ref:`float` **get_gravity_distance_scale** **(** **)** const Return the falloff factor for point gravity. .. _class_Area2D_get_gravity_vector: -- :ref:`Vector2` **get_gravity_vector** **(** **)** const +- :ref:`Vector2` **get_gravity_vector** **(** **)** const Return the gravity vector. If gravity is a point (see :ref:`is_gravity_a_point`), this will be the attraction center. .. _class_Area2D_get_linear_damp: -- :ref:`float` **get_linear_damp** **(** **)** const +- :ref:`float` **get_linear_damp** **(** **)** const Return the linear damp rate. .. _class_Area2D_get_overlapping_areas: -- :ref:`Array` **get_overlapping_areas** **(** **)** const +- :ref:`Array` **get_overlapping_areas** **(** **)** const Returns a list of intersecting :ref:`Area2D`\ s. .. _class_Area2D_get_overlapping_bodies: -- :ref:`Array` **get_overlapping_bodies** **(** **)** const +- :ref:`Array` **get_overlapping_bodies** **(** **)** const Returns a list of intersecting :ref:`PhysicsBody2D`\ s. .. _class_Area2D_get_priority: -- :ref:`float` **get_priority** **(** **)** const +- :ref:`float` **get_priority** **(** **)** const Return the processing order of this area. .. _class_Area2D_get_space_override_mode: -- :ref:`int` **get_space_override_mode** **(** **)** const +- :ref:`int` **get_space_override_mode** **(** **)** const Return the space override mode. .. _class_Area2D_is_gravity_a_point: -- :ref:`bool` **is_gravity_a_point** **(** **)** const +- :ref:`bool` **is_gravity_a_point** **(** **)** const Return whether gravity is a point. A point gravity will attract objects towards it, as opposed to a gravity vector, which moves them in a given direction. .. _class_Area2D_is_monitorable: -- :ref:`bool` **is_monitorable** **(** **)** const +- :ref:`bool` **is_monitorable** **(** **)** const Return whether this area can be detected by other, monitoring, areas. .. _class_Area2D_is_monitoring: -- :ref:`bool` **is_monitoring** **(** **)** const +- :ref:`bool` **is_monitoring** **(** **)** const Return whether this area detects bodies/areas entering/exiting it. .. _class_Area2D_is_overriding_audio_bus: -- :ref:`bool` **is_overriding_audio_bus** **(** **)** const +- :ref:`bool` **is_overriding_audio_bus** **(** **)** const .. _class_Area2D_overlaps_area: -- :ref:`bool` **overlaps_area** **(** :ref:`Node` area **)** const +- :ref:`bool` **overlaps_area** **(** :ref:`Node` area **)** const If ``true`` the given area overlaps the Area2D. .. _class_Area2D_overlaps_body: -- :ref:`bool` **overlaps_body** **(** :ref:`Node` body **)** const +- :ref:`bool` **overlaps_body** **(** :ref:`Node` body **)** const If ``true`` the given body overlaps the Area2D. .. _class_Area2D_set_angular_damp: -- void **set_angular_damp** **(** :ref:`float` angular_damp **)** +- void **set_angular_damp** **(** :ref:`float` angular_damp **)** Set the rate at which objects stop spinning in this area, if there are not any other forces making it spin. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops. @@ -348,15 +348,15 @@ In practice, as the fraction of speed lost gets smaller with each frame, a value .. _class_Area2D_set_audio_bus_name: -- void **set_audio_bus_name** **(** :ref:`String` name **)** +- void **set_audio_bus_name** **(** :ref:`String` name **)** .. _class_Area2D_set_audio_bus_override: -- void **set_audio_bus_override** **(** :ref:`bool` enable **)** +- void **set_audio_bus_override** **(** :ref:`bool` enable **)** .. _class_Area2D_set_collision_layer: -- void **set_collision_layer** **(** :ref:`int` collision_layer **)** +- void **set_collision_layer** **(** :ref:`int` collision_layer **)** Set the physics layers this area is in. @@ -366,25 +366,25 @@ A contact is detected if object A is in any of the layers that object B scans, o .. _class_Area2D_set_collision_layer_bit: -- void **set_collision_layer_bit** **(** :ref:`int` bit, :ref:`bool` value **)** +- void **set_collision_layer_bit** **(** :ref:`int` bit, :ref:`bool` value **)** Set/clear individual bits on the layer mask. This makes getting an area in/out of only one layer easier. .. _class_Area2D_set_collision_mask: -- void **set_collision_mask** **(** :ref:`int` collision_mask **)** +- void **set_collision_mask** **(** :ref:`int` collision_mask **)** Set the physics layers this area can scan for collisions. .. _class_Area2D_set_collision_mask_bit: -- void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** +- void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier. .. _class_Area2D_set_gravity: -- void **set_gravity** **(** :ref:`float` gravity **)** +- void **set_gravity** **(** :ref:`float` gravity **)** Set the gravity intensity. This is useful to alter the force of gravity without altering its direction. @@ -392,19 +392,19 @@ This value multiplies the gravity vector, whether it is the given vector (:ref:` .. _class_Area2D_set_gravity_distance_scale: -- void **set_gravity_distance_scale** **(** :ref:`float` distance_scale **)** +- void **set_gravity_distance_scale** **(** :ref:`float` distance_scale **)** Set the falloff factor for point gravity. The greater this value is, the faster the strength of gravity decreases with the square of distance. .. _class_Area2D_set_gravity_is_point: -- void **set_gravity_is_point** **(** :ref:`bool` enable **)** +- void **set_gravity_is_point** **(** :ref:`bool` enable **)** When overriding space parameters, this method sets whether this area has a center of gravity. To set/get the location of the center of gravity, use :ref:`set_gravity_vector`/:ref:`get_gravity_vector`. .. _class_Area2D_set_gravity_vector: -- void **set_gravity_vector** **(** :ref:`Vector2` vector **)** +- void **set_gravity_vector** **(** :ref:`Vector2` vector **)** Set the gravity vector. This vector does not have to be normalized. @@ -412,7 +412,7 @@ If gravity is a point (see :ref:`is_gravity_a_point` linear_damp **)** +- void **set_linear_damp** **(** :ref:`float` linear_damp **)** Set the rate at which objects stop moving in this area, if there are not any other forces moving it. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops. @@ -420,19 +420,19 @@ In practice, as the fraction of speed lost gets smaller with each frame, a value .. _class_Area2D_set_monitorable: -- void **set_monitorable** **(** :ref:`bool` enable **)** +- void **set_monitorable** **(** :ref:`bool` enable **)** Set whether this area can be detected by other, monitoring, areas. Only areas need to be marked as monitorable. Bodies are always so. .. _class_Area2D_set_monitoring: -- void **set_monitoring** **(** :ref:`bool` enable **)** +- void **set_monitoring** **(** :ref:`bool` enable **)** Set whether this area can detect bodies/areas entering/exiting it. .. _class_Area2D_set_priority: -- void **set_priority** **(** :ref:`float` priority **)** +- void **set_priority** **(** :ref:`float` priority **)** Set the order in which the area is processed. Greater values mean the area gets processed first. This is useful for areas which have a space override different from AREA_SPACE_OVERRIDE_DISABLED or AREA_SPACE_OVERRIDE_COMBINE, as they replace values, and are thus order-dependent. @@ -440,7 +440,7 @@ Areas with the same priority value get evaluated in an unpredictable order, and .. _class_Area2D_set_space_override_mode: -- void **set_space_override_mode** **(** :ref:`int` space_override_mode **)** +- void **set_space_override_mode** **(** :ref:`int` space_override_mode **)** Set the space override mode. This mode controls how an area affects gravity and damp. diff --git a/classes/class_array.rst b/classes/class_array.rst index b963c3f01..559faf556 100644 --- a/classes/class_array.rst +++ b/classes/class_array.rst @@ -17,69 +17,69 @@ Generic array datatype. Member Functions ---------------- -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`Array` **(** :ref:`PoolColorArray` from **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`Array` **(** :ref:`PoolVector3Array` from **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`Array` **(** :ref:`PoolVector2Array` from **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`Array` **(** :ref:`PoolStringArray` from **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`Array` **(** :ref:`PoolRealArray` from **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`Array` **(** :ref:`PoolIntArray` from **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`Array` **(** :ref:`PoolByteArray` from **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append` **(** var value **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`back` **(** **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`count` **(** var value **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`duplicate` **(** **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`empty` **(** **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase` **(** var value **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find` **(** var what, :ref:`int` from=0 **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_last` **(** var value **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`front` **(** **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has` **(** var value **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`hash` **(** **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`insert` **(** :ref:`int` position, var value **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`invert` **(** **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`pop_back` **(** **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`pop_front` **(** **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_back` **(** var value **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_front` **(** var value **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove` **(** :ref:`int` position **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resize` **(** :ref:`int` size **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rfind` **(** var what, :ref:`int` from=-1 **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` **(** **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sort` **(** **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sort_custom` **(** :ref:`Object` obj, :ref:`String` func **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`Array` **(** :ref:`PoolColorArray` from **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`Array` **(** :ref:`PoolVector3Array` from **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`Array` **(** :ref:`PoolVector2Array` from **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`Array` **(** :ref:`PoolStringArray` from **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`Array` **(** :ref:`PoolRealArray` from **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`Array` **(** :ref:`PoolIntArray` from **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`Array` **(** :ref:`PoolByteArray` from **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append` **(** var value **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`back` **(** **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`count` **(** var value **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`duplicate` **(** **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`empty` **(** **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`erase` **(** var value **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find` **(** var what, :ref:`int` from=0 **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find_last` **(** var value **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`front` **(** **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has` **(** var value **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`hash` **(** **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`insert` **(** :ref:`int` position, var value **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`invert` **(** **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`pop_back` **(** **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`pop_front` **(** **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_back` **(** var value **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_front` **(** var value **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove` **(** :ref:`int` position **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resize` **(** :ref:`int` size **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rfind` **(** var what, :ref:`int` from=-1 **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` **(** **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`sort` **(** **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`sort_custom` **(** :ref:`Object` obj, :ref:`String` func **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -91,109 +91,109 @@ Member Function Description .. _class_Array_Array: -- :ref:`Array` **Array** **(** :ref:`PoolColorArray` from **)** +- :ref:`Array` **Array** **(** :ref:`PoolColorArray` from **)** Construct an array from a :ref:`PoolColorArray`. .. _class_Array_Array: -- :ref:`Array` **Array** **(** :ref:`PoolVector3Array` from **)** +- :ref:`Array` **Array** **(** :ref:`PoolVector3Array` from **)** Construct an array from a :ref:`PoolVector3Array`. .. _class_Array_Array: -- :ref:`Array` **Array** **(** :ref:`PoolVector2Array` from **)** +- :ref:`Array` **Array** **(** :ref:`PoolVector2Array` from **)** Construct an array from a :ref:`PoolVector2Array`. .. _class_Array_Array: -- :ref:`Array` **Array** **(** :ref:`PoolStringArray` from **)** +- :ref:`Array` **Array** **(** :ref:`PoolStringArray` from **)** Construct an array from a :ref:`PoolStringArray`. .. _class_Array_Array: -- :ref:`Array` **Array** **(** :ref:`PoolRealArray` from **)** +- :ref:`Array` **Array** **(** :ref:`PoolRealArray` from **)** Construct an array from a :ref:`PoolRealArray`. .. _class_Array_Array: -- :ref:`Array` **Array** **(** :ref:`PoolIntArray` from **)** +- :ref:`Array` **Array** **(** :ref:`PoolIntArray` from **)** Construct an array from a :ref:`PoolIntArray`. .. _class_Array_Array: -- :ref:`Array` **Array** **(** :ref:`PoolByteArray` from **)** +- :ref:`Array` **Array** **(** :ref:`PoolByteArray` from **)** Construct an array from a :ref:`PoolByteArray`. .. _class_Array_append: -- void **append** **(** var value **)** +- void **append** **(** var value **)** Append an element at the end of the array (alias of :ref:`push_back`). .. _class_Array_back: -- void **back** **(** **)** +- void **back** **(** **)** Returns the last element of the array if the array is not empty (size>0). .. _class_Array_clear: -- void **clear** **(** **)** +- void **clear** **(** **)** Clear the array (resize to 0). .. _class_Array_count: -- :ref:`int` **count** **(** var value **)** +- :ref:`int` **count** **(** var value **)** Return the amount of times an element is in the array. .. _class_Array_duplicate: -- :ref:`Array` **duplicate** **(** **)** +- :ref:`Array` **duplicate** **(** **)** Returns a copy of this ``Array``. .. _class_Array_empty: -- :ref:`bool` **empty** **(** **)** +- :ref:`bool` **empty** **(** **)** Return true if the array is empty (size==0). .. _class_Array_erase: -- void **erase** **(** var value **)** +- void **erase** **(** var value **)** Remove the first occurrence of a value from the array. .. _class_Array_find: -- :ref:`int` **find** **(** var what, :ref:`int` from=0 **)** +- :ref:`int` **find** **(** var what, :ref:`int` from=0 **)** Searches the array for a value and returns its index or -1 if not found. Optionally, the initial search index can be passed. .. _class_Array_find_last: -- :ref:`int` **find_last** **(** var value **)** +- :ref:`int` **find_last** **(** var value **)** Searches the array in reverse order for a value and returns its index or -1 if not found. .. _class_Array_front: -- void **front** **(** **)** +- void **front** **(** **)** Returns the first element of the array if the array is not empty (size>0). .. _class_Array_has: -- :ref:`bool` **has** **(** var value **)** +- :ref:`bool` **has** **(** var value **)** Return true if the array contains given value. @@ -206,79 +206,79 @@ Return true if the array contains given value. .. _class_Array_hash: -- :ref:`int` **hash** **(** **)** +- :ref:`int` **hash** **(** **)** Return a hashed integer value representing the array contents. .. _class_Array_insert: -- void **insert** **(** :ref:`int` position, var value **)** +- void **insert** **(** :ref:`int` position, var value **)** Insert a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()). .. _class_Array_invert: -- void **invert** **(** **)** +- void **invert** **(** **)** Reverse the order of the elements in the array (so first element will now be the last) and return reference to the array. .. _class_Array_pop_back: -- void **pop_back** **(** **)** +- void **pop_back** **(** **)** Remove the last element of the array. .. _class_Array_pop_front: -- void **pop_front** **(** **)** +- void **pop_front** **(** **)** Remove the first element of the array. .. _class_Array_push_back: -- void **push_back** **(** var value **)** +- void **push_back** **(** var value **)** Append an element at the end of the array. .. _class_Array_push_front: -- void **push_front** **(** var value **)** +- void **push_front** **(** var value **)** Add an element at the beginning of the array. .. _class_Array_remove: -- void **remove** **(** :ref:`int` position **)** +- void **remove** **(** :ref:`int` position **)** Remove an element from the array by index. .. _class_Array_resize: -- void **resize** **(** :ref:`int` size **)** +- void **resize** **(** :ref:`int` size **)** Resize the array to contain a different number of elements. If the array size is smaller, elements are cleared, if bigger, new elements are Null. .. _class_Array_rfind: -- :ref:`int` **rfind** **(** var what, :ref:`int` from=-1 **)** +- :ref:`int` **rfind** **(** var what, :ref:`int` from=-1 **)** Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array. .. _class_Array_size: -- :ref:`int` **size** **(** **)** +- :ref:`int` **size** **(** **)** Return the amount of elements in the array. .. _class_Array_sort: -- void **sort** **(** **)** +- void **sort** **(** **)** Sort the array using natural order and return reference to the array. .. _class_Array_sort_custom: -- void **sort_custom** **(** :ref:`Object` obj, :ref:`String` func **)** +- void **sort_custom** **(** :ref:`Object` obj, :ref:`String` func **)** Sort the array using a custom method and return reference to the array. The arguments are an object that holds the method and the name of such method. The custom method receives two arguments (a pair of elements from the array) and must return true if the first argument is less than the second, and return false otherwise. Note: you cannot randomize the return value as the heapsort algorithm expects a deterministic result. Doing so will result in unexpected behavior. diff --git a/classes/class_arraymesh.rst b/classes/class_arraymesh.rst index e35580642..6d70b51eb 100644 --- a/classes/class_arraymesh.rst +++ b/classes/class_arraymesh.rst @@ -19,53 +19,53 @@ Brief Description Member Functions ---------------- -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_blend_shape` **(** :ref:`String` name **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_surface_from_arrays` **(** :ref:`int` primitive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[ ], :ref:`int` compress_flags=97792 **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`center_geometry` **(** **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_blend_shapes` **(** **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_blend_shape_count` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_blend_shape_mode` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_blend_shape_name` **(** :ref:`int` index **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect3` | :ref:`get_custom_aabb` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_surface_count` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`regen_normalmaps` **(** **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_blend_shape_mode` **(** :ref:`int` mode **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_aabb` **(** :ref:`Rect3` aabb **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`surface_get_array_index_len` **(** :ref:`int` surf_idx **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`surface_get_array_len` **(** :ref:`int` surf_idx **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`surface_get_arrays` **(** :ref:`int` surf_idx **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`surface_get_blend_shape_arrays` **(** :ref:`int` surf_idx **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`surface_get_format` **(** :ref:`int` surf_idx **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Material` | :ref:`surface_get_material` **(** :ref:`int` surf_idx **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`surface_get_name` **(** :ref:`int` surf_idx **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`surface_get_primitive_type` **(** :ref:`int` surf_idx **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`surface_remove` **(** :ref:`int` surf_idx **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`surface_set_material` **(** :ref:`int` surf_idx, :ref:`Material` material **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`surface_set_name` **(** :ref:`int` surf_idx, :ref:`String` name **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_blend_shape` **(** :ref:`String` name **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_surface_from_arrays` **(** :ref:`int` primitive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[ ], :ref:`int` compress_flags=97792 **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`center_geometry` **(** **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_blend_shapes` **(** **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_blend_shape_count` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_blend_shape_mode` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_blend_shape_name` **(** :ref:`int` index **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect3` | :ref:`get_custom_aabb` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_surface_count` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`regen_normalmaps` **(** **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_blend_shape_mode` **(** :ref:`int` mode **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_aabb` **(** :ref:`Rect3` aabb **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`surface_get_array_index_len` **(** :ref:`int` surf_idx **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`surface_get_array_len` **(** :ref:`int` surf_idx **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`surface_get_arrays` **(** :ref:`int` surf_idx **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`surface_get_blend_shape_arrays` **(** :ref:`int` surf_idx **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`surface_get_format` **(** :ref:`int` surf_idx **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Material` | :ref:`surface_get_material` **(** :ref:`int` surf_idx **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`surface_get_name` **(** :ref:`int` surf_idx **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`surface_get_primitive_type` **(** :ref:`int` surf_idx **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`surface_remove` **(** :ref:`int` surf_idx **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`surface_set_material` **(** :ref:`int` surf_idx, :ref:`Material` material **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`surface_set_name` **(** :ref:`int` surf_idx, :ref:`String` name **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -97,11 +97,11 @@ Member Function Description .. _class_ArrayMesh_add_blend_shape: -- void **add_blend_shape** **(** :ref:`String` name **)** +- void **add_blend_shape** **(** :ref:`String` name **)** .. _class_ArrayMesh_add_surface_from_arrays: -- void **add_surface_from_arrays** **(** :ref:`int` primitive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[ ], :ref:`int` compress_flags=97792 **)** +- void **add_surface_from_arrays** **(** :ref:`int` primitive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[ ], :ref:`int` compress_flags=97792 **)** Create a new surface (:ref:`get_surface_count` that will become surf_idx for this. @@ -109,101 +109,101 @@ Surfaces are created to be rendered using a "primitive", which may be PRIMITIVE_ .. _class_ArrayMesh_center_geometry: -- void **center_geometry** **(** **)** +- void **center_geometry** **(** **)** .. _class_ArrayMesh_clear_blend_shapes: -- void **clear_blend_shapes** **(** **)** +- void **clear_blend_shapes** **(** **)** .. _class_ArrayMesh_get_blend_shape_count: -- :ref:`int` **get_blend_shape_count** **(** **)** const +- :ref:`int` **get_blend_shape_count** **(** **)** const .. _class_ArrayMesh_get_blend_shape_mode: -- :ref:`int` **get_blend_shape_mode** **(** **)** const +- :ref:`int` **get_blend_shape_mode** **(** **)** const .. _class_ArrayMesh_get_blend_shape_name: -- :ref:`String` **get_blend_shape_name** **(** :ref:`int` index **)** const +- :ref:`String` **get_blend_shape_name** **(** :ref:`int` index **)** const .. _class_ArrayMesh_get_custom_aabb: -- :ref:`Rect3` **get_custom_aabb** **(** **)** const +- :ref:`Rect3` **get_custom_aabb** **(** **)** const .. _class_ArrayMesh_get_surface_count: -- :ref:`int` **get_surface_count** **(** **)** const +- :ref:`int` **get_surface_count** **(** **)** const Return the amount of surfaces that the :ref:`ArrayMesh` holds. .. _class_ArrayMesh_regen_normalmaps: -- void **regen_normalmaps** **(** **)** +- void **regen_normalmaps** **(** **)** .. _class_ArrayMesh_set_blend_shape_mode: -- void **set_blend_shape_mode** **(** :ref:`int` mode **)** +- void **set_blend_shape_mode** **(** :ref:`int` mode **)** .. _class_ArrayMesh_set_custom_aabb: -- void **set_custom_aabb** **(** :ref:`Rect3` aabb **)** +- void **set_custom_aabb** **(** :ref:`Rect3` aabb **)** .. _class_ArrayMesh_surface_get_array_index_len: -- :ref:`int` **surface_get_array_index_len** **(** :ref:`int` surf_idx **)** const +- :ref:`int` **surface_get_array_index_len** **(** :ref:`int` surf_idx **)** const Return the length in indices of the index array in the requested surface (see :ref:`add_surface`). .. _class_ArrayMesh_surface_get_array_len: -- :ref:`int` **surface_get_array_len** **(** :ref:`int` surf_idx **)** const +- :ref:`int` **surface_get_array_len** **(** :ref:`int` surf_idx **)** const Return the length in vertices of the vertex array in the requested surface (see :ref:`add_surface`). .. _class_ArrayMesh_surface_get_arrays: -- :ref:`Array` **surface_get_arrays** **(** :ref:`int` surf_idx **)** const +- :ref:`Array` **surface_get_arrays** **(** :ref:`int` surf_idx **)** const .. _class_ArrayMesh_surface_get_blend_shape_arrays: -- :ref:`Array` **surface_get_blend_shape_arrays** **(** :ref:`int` surf_idx **)** const +- :ref:`Array` **surface_get_blend_shape_arrays** **(** :ref:`int` surf_idx **)** const .. _class_ArrayMesh_surface_get_format: -- :ref:`int` **surface_get_format** **(** :ref:`int` surf_idx **)** const +- :ref:`int` **surface_get_format** **(** :ref:`int` surf_idx **)** const Return the format mask of the requested surface (see :ref:`add_surface`). .. _class_ArrayMesh_surface_get_material: -- :ref:`Material` **surface_get_material** **(** :ref:`int` surf_idx **)** const +- :ref:`Material` **surface_get_material** **(** :ref:`int` surf_idx **)** const Return a :ref:`Material` in a given surface. Surface is rendered using this material. .. _class_ArrayMesh_surface_get_name: -- :ref:`String` **surface_get_name** **(** :ref:`int` surf_idx **)** const +- :ref:`String` **surface_get_name** **(** :ref:`int` surf_idx **)** const .. _class_ArrayMesh_surface_get_primitive_type: -- :ref:`int` **surface_get_primitive_type** **(** :ref:`int` surf_idx **)** const +- :ref:`int` **surface_get_primitive_type** **(** :ref:`int` surf_idx **)** const Return the primitive type of the requested surface (see :ref:`add_surface`). .. _class_ArrayMesh_surface_remove: -- void **surface_remove** **(** :ref:`int` surf_idx **)** +- void **surface_remove** **(** :ref:`int` surf_idx **)** Remove a surface at position surf_idx, shifting greater surfaces one surf_idx slot down. .. _class_ArrayMesh_surface_set_material: -- void **surface_set_material** **(** :ref:`int` surf_idx, :ref:`Material` material **)** +- void **surface_set_material** **(** :ref:`int` surf_idx, :ref:`Material` material **)** .. _class_ArrayMesh_surface_set_name: -- void **surface_set_name** **(** :ref:`int` surf_idx, :ref:`String` name **)** +- void **surface_set_name** **(** :ref:`int` surf_idx, :ref:`String` name **)** Set a :ref:`Material` for a given surface. Surface will be rendered using this material. diff --git a/classes/class_arvranchor.rst b/classes/class_arvranchor.rst index dc3651083..0f40c1484 100644 --- a/classes/class_arvranchor.rst +++ b/classes/class_arvranchor.rst @@ -19,19 +19,19 @@ Anchor point in AR Space Member Functions ---------------- -+--------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_anchor_id` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_anchor_name` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_is_active` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`Plane` | :ref:`get_plane` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_size` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------+ -| void | :ref:`set_anchor_id` **(** :ref:`int` anchor_id **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------+ ++--------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_anchor_id` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_anchor_name` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_is_active` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Plane` | :ref:`get_plane` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_size` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------+ +| void | :ref:`set_anchor_id` **(** :ref:`int` anchor_id **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -55,37 +55,37 @@ Member Function Description .. _class_ARVRAnchor_get_anchor_id: -- :ref:`int` **get_anchor_id** **(** **)** const +- :ref:`int` **get_anchor_id** **(** **)** const Returns the anchor id for this anchor. .. _class_ARVRAnchor_get_anchor_name: -- :ref:`String` **get_anchor_name** **(** **)** const +- :ref:`String` **get_anchor_name** **(** **)** const Returns the name given to this anchor. .. _class_ARVRAnchor_get_is_active: -- :ref:`bool` **get_is_active** **(** **)** const +- :ref:`bool` **get_is_active** **(** **)** const Returns true if the anchor is being tracked and false if no anchor with this id is currently known. .. _class_ARVRAnchor_get_plane: -- :ref:`Plane` **get_plane** **(** **)** const +- :ref:`Plane` **get_plane** **(** **)** const Returns a plane aligned with our anchor, handy for intersection testing .. _class_ARVRAnchor_get_size: -- :ref:`Vector3` **get_size** **(** **)** const +- :ref:`Vector3` **get_size** **(** **)** const Returns the estimated size of the plane that was detected. Say when the anchor relates to a table in the real world, this is the estimated size of the surface of that table. .. _class_ARVRAnchor_set_anchor_id: -- void **set_anchor_id** **(** :ref:`int` anchor_id **)** +- void **set_anchor_id** **(** :ref:`int` anchor_id **)** Binds this anchor node to an anchor with this id. You can set this before the anchor itself exists. The first anchor that is identified gets id 1, the second id 2, etc. When anchors get removed that slot remains free and can be assigned to the next anchor that is identified. The most common situation where anchors 'disappear' is when the AR server identifies that two anchors represent different parts of the same plane and merge them. diff --git a/classes/class_arvrcontroller.rst b/classes/class_arvrcontroller.rst index 75f6a7f90..b947e7a72 100644 --- a/classes/class_arvrcontroller.rst +++ b/classes/class_arvrcontroller.rst @@ -19,36 +19,36 @@ A spatial node representing a spatially tracked controller. Member Functions ---------------- -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_controller_id` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_controller_name` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_hand` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_is_active` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_joystick_axis` **(** :ref:`int` axis **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_joystick_id` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`is_button_pressed` **(** :ref:`int` button **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_controller_id` **(** :ref:`int` controller_id **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ ++------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_controller_id` **(** **)** const | ++------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_controller_name` **(** **)** const | ++------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_hand` **(** **)** const | ++------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_is_active` **(** **)** const | ++------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_joystick_axis` **(** :ref:`int` axis **)** const | ++------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_joystick_id` **(** **)** const | ++------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`is_button_pressed` **(** :ref:`int` button **)** const | ++------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_controller_id` **(** :ref:`int` controller_id **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_ARVRController_button_pressed: -- **button_pressed** **(** :ref:`int` button **)** +- **button_pressed** **(** :ref:`int` button **)** When a button on this controller is pressed, this signal is given. .. _class_ARVRController_button_release: -- **button_release** **(** :ref:`int` button **)** +- **button_release** **(** :ref:`int` button **)** When a button on this controller is released, this signal is given. @@ -75,47 +75,47 @@ Member Function Description .. _class_ARVRController_get_controller_id: -- :ref:`int` **get_controller_id** **(** **)** const +- :ref:`int` **get_controller_id** **(** **)** const Returns the controller id currently assigned to this node. .. _class_ARVRController_get_controller_name: -- :ref:`String` **get_controller_name** **(** **)** const +- :ref:`String` **get_controller_name** **(** **)** const If active, returns the name of the associated controller if provided by the AR/VR SDK used. .. _class_ARVRController_get_hand: -- :ref:`int` **get_hand** **(** **)** const +- :ref:`int` **get_hand** **(** **)** const .. _class_ARVRController_get_is_active: -- :ref:`bool` **get_is_active** **(** **)** const +- :ref:`bool` **get_is_active** **(** **)** const Returns true if the controller bound to this node is currently active and being tracked. .. _class_ARVRController_get_joystick_axis: -- :ref:`float` **get_joystick_axis** **(** :ref:`int` axis **)** const +- :ref:`float` **get_joystick_axis** **(** :ref:`int` axis **)** const Returns the value of the given axis for things like triggers, touchpads, etc. that are embedded into the controller. .. _class_ARVRController_get_joystick_id: -- :ref:`int` **get_joystick_id** **(** **)** const +- :ref:`int` **get_joystick_id** **(** **)** const Returns the ID of the joystick object bound to this. Every controller tracked by the ARVR Server that has buttons and axis will also be registered as a joystick within Godot. This means that all the normal joystick tracking and input mapping will work for buttons and axis found on the AR/VR controllers. This ID is purely offered as information so you can link up the controller with its joystick entry. .. _class_ARVRController_is_button_pressed: -- :ref:`int` **is_button_pressed** **(** :ref:`int` button **)** const +- :ref:`int` **is_button_pressed** **(** :ref:`int` button **)** const Is the given button currently pressed? .. _class_ARVRController_set_controller_id: -- void **set_controller_id** **(** :ref:`int` controller_id **)** +- void **set_controller_id** **(** :ref:`int` controller_id **)** Changes the id that identifies the controller bound to this node. The first controller that the ARVR Server detects will have id 1, the second id 2, the third id 3, etc. When a controller is turned off that slot is freed ensuring that controllers will keep the same id while it is turned on even when controllers with lower ids are turned off. diff --git a/classes/class_arvrinterface.rst b/classes/class_arvrinterface.rst index 4da9f9d15..281d78764 100644 --- a/classes/class_arvrinterface.rst +++ b/classes/class_arvrinterface.rst @@ -21,33 +21,33 @@ Base class for ARVR interface implementation. Member Functions ---------------- -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_anchor_detection_is_enabled` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_capabilities` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_name` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_recommended_render_targetsize` **(** **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_tracking_status` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`initialize` **(** **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_initialized` **(** **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_primary` **(** **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_stereo` **(** **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_anchor_detection_is_enabled` **(** :ref:`bool` enable **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_is_initialized` **(** :ref:`bool` initialized **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_is_primary` **(** :ref:`bool` enable **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`uninitialize` **(** **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_anchor_detection_is_enabled` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_capabilities` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_name` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_recommended_render_targetsize` **(** **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_tracking_status` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`initialize` **(** **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_initialized` **(** **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_primary` **(** **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_stereo` **(** **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_anchor_detection_is_enabled` **(** :ref:`bool` enable **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_is_initialized` **(** :ref:`bool` initialized **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_is_primary` **(** :ref:`bool` enable **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`uninitialize` **(** **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -94,37 +94,37 @@ Member Function Description .. _class_ARVRInterface_get_anchor_detection_is_enabled: -- :ref:`bool` **get_anchor_detection_is_enabled** **(** **)** const +- :ref:`bool` **get_anchor_detection_is_enabled** **(** **)** const Returns true if achor detection is enabled (AR only). .. _class_ARVRInterface_get_capabilities: -- :ref:`int` **get_capabilities** **(** **)** const +- :ref:`int` **get_capabilities** **(** **)** const Returns a combination of flags providing information about the capabilities of this interface. .. _class_ARVRInterface_get_name: -- :ref:`String` **get_name** **(** **)** const +- :ref:`String` **get_name** **(** **)** const Returns the name of this interface (OpenVR, OpenHMD, ARKit, etc). .. _class_ARVRInterface_get_recommended_render_targetsize: -- :ref:`Vector2` **get_recommended_render_targetsize** **(** **)** +- :ref:`Vector2` **get_recommended_render_targetsize** **(** **)** Returns the resolution at which we should render our intermediate results before things like lens distortion are applied by the VR platform. .. _class_ARVRInterface_get_tracking_status: -- :ref:`int` **get_tracking_status** **(** **)** const +- :ref:`int` **get_tracking_status** **(** **)** const If supported, returns the status of our tracking. This will allow you to provide feedback to the user whether there are issues with positional tracking. .. _class_ARVRInterface_initialize: -- :ref:`bool` **initialize** **(** **)** +- :ref:`bool` **initialize** **(** **)** Call this to initialize this interface. The first interface that is initialized is identified as the primary interface and it will be used for rendering output. @@ -138,43 +138,43 @@ While currently not used you can activate additional interfaces, you may wish to .. _class_ARVRInterface_is_initialized: -- :ref:`bool` **is_initialized** **(** **)** +- :ref:`bool` **is_initialized** **(** **)** Returns true if this interface is active. .. _class_ARVRInterface_is_primary: -- :ref:`bool` **is_primary** **(** **)** +- :ref:`bool` **is_primary** **(** **)** Returns true if this interface is currently the primary interface (the interface responsible for showing the output). .. _class_ARVRInterface_is_stereo: -- :ref:`bool` **is_stereo** **(** **)** +- :ref:`bool` **is_stereo** **(** **)** Returns true if the current output of this interface is in stereo. .. _class_ARVRInterface_set_anchor_detection_is_enabled: -- void **set_anchor_detection_is_enabled** **(** :ref:`bool` enable **)** +- void **set_anchor_detection_is_enabled** **(** :ref:`bool` enable **)** Enables anchor detection, this is used on AR interfaces and enables the extra logic that will detect planes, features, objects, etc. and adds/modifies anchor points. .. _class_ARVRInterface_set_is_initialized: -- void **set_is_initialized** **(** :ref:`bool` initialized **)** +- void **set_is_initialized** **(** :ref:`bool` initialized **)** Initialize/uninitialize this interface (same effect as calling initialize/uninitialize). .. _class_ARVRInterface_set_is_primary: -- void **set_is_primary** **(** :ref:`bool` enable **)** +- void **set_is_primary** **(** :ref:`bool` enable **)** Set this interface to the primary interface (unset the old one). .. _class_ARVRInterface_uninitialize: -- void **uninitialize** **(** **)** +- void **uninitialize** **(** **)** Turns the interface off. diff --git a/classes/class_arvrorigin.rst b/classes/class_arvrorigin.rst index e3ea54692..562a11e76 100644 --- a/classes/class_arvrorigin.rst +++ b/classes/class_arvrorigin.rst @@ -19,11 +19,11 @@ Our origin point in AR/VR. Member Functions ---------------- -+----------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_world_scale` **(** **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_world_scale` **(** :ref:`float` world_scale **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------+ ++----------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_world_scale` **(** **)** const | ++----------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_world_scale` **(** :ref:`float` world_scale **)** | ++----------------------------+------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -49,13 +49,13 @@ Member Function Description .. _class_ARVROrigin_get_world_scale: -- :ref:`float` **get_world_scale** **(** **)** const +- :ref:`float` **get_world_scale** **(** **)** const Get the world scale applied to our positioning. .. _class_ARVROrigin_set_world_scale: -- void **set_world_scale** **(** :ref:`float` world_scale **)** +- void **set_world_scale** **(** :ref:`float` world_scale **)** Changes the world scaling factor. diff --git a/classes/class_arvrpositionaltracker.rst b/classes/class_arvrpositionaltracker.rst index 9ba9b5f52..d54bac662 100644 --- a/classes/class_arvrpositionaltracker.rst +++ b/classes/class_arvrpositionaltracker.rst @@ -19,25 +19,25 @@ A tracked object Member Functions ---------------- -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_hand` **(** **)** const | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_joy_id` **(** **)** const | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_name` **(** **)** const | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`get_orientation` **(** **)** const | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_position` **(** **)** const | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_tracks_orientation` **(** **)** const | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_tracks_position` **(** **)** const | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_transform` **(** :ref:`bool` adjust_by_reference_frame **)** const | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_type` **(** **)** const | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_hand` **(** **)** const | ++------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_joy_id` **(** **)** const | ++------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_name` **(** **)** const | ++------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`get_orientation` **(** **)** const | ++------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_position` **(** **)** const | ++------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_tracks_orientation` **(** **)** const | ++------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_tracks_position` **(** **)** const | ++------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`get_transform` **(** :ref:`bool` adjust_by_reference_frame **)** const | ++------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_type` **(** **)** const | ++------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -60,53 +60,53 @@ Member Function Description .. _class_ARVRPositionalTracker_get_hand: -- :ref:`int` **get_hand** **(** **)** const +- :ref:`int` **get_hand** **(** **)** const .. _class_ARVRPositionalTracker_get_joy_id: -- :ref:`int` **get_joy_id** **(** **)** const +- :ref:`int` **get_joy_id** **(** **)** const If this is a controller that is being tracked the controller will also be represented by a joystick entry with this id. .. _class_ARVRPositionalTracker_get_name: -- :ref:`String` **get_name** **(** **)** const +- :ref:`String` **get_name** **(** **)** const If available this returns the name of the controller or anchor point. .. _class_ARVRPositionalTracker_get_orientation: -- :ref:`Basis` **get_orientation** **(** **)** const +- :ref:`Basis` **get_orientation** **(** **)** const Returns the orientation matrix of the controller. .. _class_ARVRPositionalTracker_get_position: -- :ref:`Vector3` **get_position** **(** **)** const +- :ref:`Vector3` **get_position** **(** **)** const Returns the position of the controller adjusted by world scale. .. _class_ARVRPositionalTracker_get_tracks_orientation: -- :ref:`bool` **get_tracks_orientation** **(** **)** const +- :ref:`bool` **get_tracks_orientation** **(** **)** const Returns true if the orientation of this device is being tracked. .. _class_ARVRPositionalTracker_get_tracks_position: -- :ref:`bool` **get_tracks_position** **(** **)** const +- :ref:`bool` **get_tracks_position** **(** **)** const Returns true if the position of this device is being tracked. .. _class_ARVRPositionalTracker_get_transform: -- :ref:`Transform` **get_transform** **(** :ref:`bool` adjust_by_reference_frame **)** const +- :ref:`Transform` **get_transform** **(** :ref:`bool` adjust_by_reference_frame **)** const Returns the transform combining the orientation and position of this device. .. _class_ARVRPositionalTracker_get_type: -- :ref:`int` **get_type** **(** **)** const +- :ref:`int` **get_type** **(** **)** const Type of tracker. diff --git a/classes/class_arvrserver.rst b/classes/class_arvrserver.rst index 024e2e136..729cd9bd6 100644 --- a/classes/class_arvrserver.rst +++ b/classes/class_arvrserver.rst @@ -19,56 +19,56 @@ This is our AR/VR Server. Member Functions ---------------- -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_interface` **(** :ref:`ARVRInterface` interface **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`center_on_hmd` **(** :ref:`bool` ignore_tilt, :ref:`bool` keep_height **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ARVRInterface` | :ref:`find_interface` **(** :ref:`String` name **)** const | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ARVRInterface` | :ref:`get_interface` **(** :ref:`int` idx **)** const | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_interface_count` **(** **)** const | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_reference_frame` **(** **)** const | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ARVRPositionalTracker` | :ref:`get_tracker` **(** :ref:`int` idx **)** const | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_tracker_count` **(** **)** const | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_world_scale` **(** **)** const | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_interface` **(** :ref:`ARVRInterface` interface **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_primary_interface` **(** :ref:`ARVRInterface` interface **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_world_scale` **(** :ref:`float` arg0 **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_interface` **(** :ref:`ARVRInterface` interface **)** | ++------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`center_on_hmd` **(** :ref:`bool` ignore_tilt, :ref:`bool` keep_height **)** | ++------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ARVRInterface` | :ref:`find_interface` **(** :ref:`String` name **)** const | ++------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ARVRInterface` | :ref:`get_interface` **(** :ref:`int` idx **)** const | ++------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_interface_count` **(** **)** const | ++------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`get_reference_frame` **(** **)** const | ++------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ARVRPositionalTracker` | :ref:`get_tracker` **(** :ref:`int` idx **)** const | ++------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_tracker_count` **(** **)** const | ++------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_world_scale` **(** **)** const | ++------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_interface` **(** :ref:`ARVRInterface` interface **)** | ++------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_primary_interface` **(** :ref:`ARVRInterface` interface **)** | ++------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_world_scale` **(** :ref:`float` arg0 **)** | ++------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_ARVRServer_interface_added: -- **interface_added** **(** :ref:`String` name **)** +- **interface_added** **(** :ref:`String` name **)** Signal send when a new interface has been added. .. _class_ARVRServer_interface_removed: -- **interface_removed** **(** :ref:`String` name **)** +- **interface_removed** **(** :ref:`String` name **)** Signal send when an interface is removed. .. _class_ARVRServer_tracker_added: -- **tracker_added** **(** :ref:`String` name, :ref:`int` type, :ref:`int` id **)** +- **tracker_added** **(** :ref:`String` name, :ref:`int` type, :ref:`int` id **)** Signal send when a new tracker has been added. If you don't use a fixed number of controllers or if you're using ARVRAnchors for an AR solution it is important to react to this signal and add the appropriate ARVRController or ARVRAnchor node related to this new tracker. .. _class_ARVRServer_tracker_removed: -- **tracker_removed** **(** :ref:`String` name, :ref:`int` type, :ref:`int` id **)** +- **tracker_removed** **(** :ref:`String` name, :ref:`int` type, :ref:`int` id **)** Signal send when a tracker is removed, you should remove any ARVRController or ARVRAnchor points if applicable. This is not mandatory, the nodes simply become inactive and will be made active again when a new tracker becomes available (i.e. a new controller is switched on that takes the place of the previous one). @@ -101,13 +101,13 @@ Member Function Description .. _class_ARVRServer_add_interface: -- void **add_interface** **(** :ref:`ARVRInterface` interface **)** +- void **add_interface** **(** :ref:`ARVRInterface` interface **)** Mostly exposed for GDNative based interfaces, this is called to register an available interface with the AR/VR server. .. _class_ARVRServer_center_on_hmd: -- void **center_on_hmd** **(** :ref:`bool` ignore_tilt, :ref:`bool` keep_height **)** +- void **center_on_hmd** **(** :ref:`bool` ignore_tilt, :ref:`bool` keep_height **)** This is a really important function to understand correctly. AR and VR platforms all handle positioning slightly differently. @@ -123,61 +123,61 @@ You should call this method after a few seconds have passed, when the user reque .. _class_ARVRServer_find_interface: -- :ref:`ARVRInterface` **find_interface** **(** :ref:`String` name **)** const +- :ref:`ARVRInterface` **find_interface** **(** :ref:`String` name **)** const Find an interface by its name. Say that you're making a game that uses specific capabilities of an AR/VR platform you can find the interface for that platform by name and initialize it. .. _class_ARVRServer_get_interface: -- :ref:`ARVRInterface` **get_interface** **(** :ref:`int` idx **)** const +- :ref:`ARVRInterface` **get_interface** **(** :ref:`int` idx **)** const Get the interface registered at a given index in our list of interfaces. .. _class_ARVRServer_get_interface_count: -- :ref:`int` **get_interface_count** **(** **)** const +- :ref:`int` **get_interface_count** **(** **)** const Get the number of interfaces currently registered with the AR/VR server. If you're game supports multiple AR/VR platforms you can look throught the available interface and either present the user with a selection or simply try an initialize each interface and use the first one that returns true. .. _class_ARVRServer_get_reference_frame: -- :ref:`Transform` **get_reference_frame** **(** **)** const +- :ref:`Transform` **get_reference_frame** **(** **)** const Gets our reference frame transform, mostly used internally and exposed for GDNative build interfaces. .. _class_ARVRServer_get_tracker: -- :ref:`ARVRPositionalTracker` **get_tracker** **(** :ref:`int` idx **)** const +- :ref:`ARVRPositionalTracker` **get_tracker** **(** :ref:`int` idx **)** const Get the positional tracker at the given ID. .. _class_ARVRServer_get_tracker_count: -- :ref:`int` **get_tracker_count** **(** **)** const +- :ref:`int` **get_tracker_count** **(** **)** const Get the number of trackers currently registered. .. _class_ARVRServer_get_world_scale: -- :ref:`float` **get_world_scale** **(** **)** const +- :ref:`float` **get_world_scale** **(** **)** const Returns our world scale (see ARVROrigin for more information). .. _class_ARVRServer_remove_interface: -- void **remove_interface** **(** :ref:`ARVRInterface` interface **)** +- void **remove_interface** **(** :ref:`ARVRInterface` interface **)** Removes a registered interface, again exposed mostly for GDNative based interfaces. .. _class_ARVRServer_set_primary_interface: -- void **set_primary_interface** **(** :ref:`ARVRInterface` interface **)** +- void **set_primary_interface** **(** :ref:`ARVRInterface` interface **)** Changes the primary interface to the specified interface. Again mostly exposed for GDNative interfaces. .. _class_ARVRServer_set_world_scale: -- void **set_world_scale** **(** :ref:`float` arg0 **)** +- void **set_world_scale** **(** :ref:`float` arg0 **)** Changing the world scale, see the ARVROrigin documentation for more information. diff --git a/classes/class_astar.rst b/classes/class_astar.rst index b5a032b20..0506c88ca 100644 --- a/classes/class_astar.rst +++ b/classes/class_astar.rst @@ -19,41 +19,41 @@ AStar class representation that uses vectors as edges. Member Functions ---------------- -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_compute_cost` **(** :ref:`int` from_id, :ref:`int` to_id **)** virtual | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_estimate_cost` **(** :ref:`int` from_id, :ref:`int` to_id **)** virtual | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_point` **(** :ref:`int` id, :ref:`Vector3` position, :ref:`float` weight_scale=1.0 **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`are_points_connected` **(** :ref:`int` id, :ref:`int` to_id **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`connect_points` **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`disconnect_points` **(** :ref:`int` id, :ref:`int` to_id **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_available_point_id` **(** **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_closest_point` **(** :ref:`Vector3` to_position **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_closest_position_in_segment` **(** :ref:`Vector3` to_position **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_id_path` **(** :ref:`int` from_id, :ref:`int` to_id **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`get_point_path` **(** :ref:`int` from_id, :ref:`int` to_id **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_point_position` **(** :ref:`int` id **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_point_weight_scale` **(** :ref:`int` id **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_points` **(** **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_point` **(** :ref:`int` id **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_point` **(** :ref:`int` id **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_compute_cost` **(** :ref:`int` from_id, :ref:`int` to_id **)** virtual | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_estimate_cost` **(** :ref:`int` from_id, :ref:`int` to_id **)** virtual | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_point` **(** :ref:`int` id, :ref:`Vector3` position, :ref:`float` weight_scale=1.0 **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`are_points_connected` **(** :ref:`int` id, :ref:`int` to_id **)** const | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`connect_points` **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`disconnect_points` **(** :ref:`int` id, :ref:`int` to_id **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_available_point_id` **(** **)** const | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_closest_point` **(** :ref:`Vector3` to_position **)** const | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_closest_position_in_segment` **(** :ref:`Vector3` to_position **)** const | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`get_id_path` **(** :ref:`int` from_id, :ref:`int` to_id **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`get_point_path` **(** :ref:`int` from_id, :ref:`int` to_id **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_point_position` **(** :ref:`int` id **)** const | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_point_weight_scale` **(** :ref:`int` id **)** const | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_points` **(** **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_point` **(** :ref:`int` id **)** const | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_point` **(** :ref:`int` id **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -67,19 +67,19 @@ Member Function Description .. _class_AStar__compute_cost: -- void **_compute_cost** **(** :ref:`int` from_id, :ref:`int` to_id **)** virtual +- void **_compute_cost** **(** :ref:`int` from_id, :ref:`int` to_id **)** virtual Called when computing the cost between two connected points. .. _class_AStar__estimate_cost: -- void **_estimate_cost** **(** :ref:`int` from_id, :ref:`int` to_id **)** virtual +- void **_estimate_cost** **(** :ref:`int` from_id, :ref:`int` to_id **)** virtual Called when estimating the cost between a point and the path's ending point. .. _class_AStar_add_point: -- void **add_point** **(** :ref:`int` id, :ref:`Vector3` position, :ref:`float` weight_scale=1.0 **)** +- void **add_point** **(** :ref:`int` id, :ref:`Vector3` position, :ref:`float` weight_scale=1.0 **)** Adds a new point at the given position with the given identifier. The algorithm prefers points with lower ``weight_scale`` to form a path. The ``id`` must be 0 or larger, and the ``weight_scale`` must be 1 or larger. @@ -91,19 +91,19 @@ Adds a new point at the given position with the given identifier. The algorithm .. _class_AStar_are_points_connected: -- :ref:`bool` **are_points_connected** **(** :ref:`int` id, :ref:`int` to_id **)** const +- :ref:`bool` **are_points_connected** **(** :ref:`int` id, :ref:`int` to_id **)** const Returns whether there is a connection/segment between the given points. .. _class_AStar_clear: -- void **clear** **(** **)** +- void **clear** **(** **)** Clears all the points and segments. .. _class_AStar_connect_points: -- void **connect_points** **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** +- void **connect_points** **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** Creates a segment between the given points. @@ -119,25 +119,25 @@ Creates a segment between the given points. .. _class_AStar_disconnect_points: -- void **disconnect_points** **(** :ref:`int` id, :ref:`int` to_id **)** +- void **disconnect_points** **(** :ref:`int` id, :ref:`int` to_id **)** Deletes the segment between the given points. .. _class_AStar_get_available_point_id: -- :ref:`int` **get_available_point_id** **(** **)** const +- :ref:`int` **get_available_point_id** **(** **)** const Returns an id with no point associated to it. .. _class_AStar_get_closest_point: -- :ref:`int` **get_closest_point** **(** :ref:`Vector3` to_position **)** const +- :ref:`int` **get_closest_point** **(** :ref:`Vector3` to_position **)** const Returns the id of the closest point to ``to_position``. Returns -1 if there are no points in the points pool. .. _class_AStar_get_closest_position_in_segment: -- :ref:`Vector3` **get_closest_position_in_segment** **(** :ref:`Vector3` to_position **)** const +- :ref:`Vector3` **get_closest_position_in_segment** **(** :ref:`Vector3` to_position **)** const Returns the closest position to ``to_position`` that resides inside a segment between two connected points. @@ -156,7 +156,7 @@ The result is in the segment that goes from ``y=0`` to ``y=5``. It's the closest .. _class_AStar_get_id_path: -- :ref:`PoolIntArray` **get_id_path** **(** :ref:`int` from_id, :ref:`int` to_id **)** +- :ref:`PoolIntArray` **get_id_path** **(** :ref:`int` from_id, :ref:`int` to_id **)** Returns an array with the ids of the points that form the path found by AStar between the given points. The array is ordered from the starting point to the ending point of the path. @@ -181,35 +181,35 @@ If you change the 2nd point's weight to 3, then the result will be ``[1, 4, 3]`` .. _class_AStar_get_point_path: -- :ref:`PoolVector3Array` **get_point_path** **(** :ref:`int` from_id, :ref:`int` to_id **)** +- :ref:`PoolVector3Array` **get_point_path** **(** :ref:`int` from_id, :ref:`int` to_id **)** Returns an array with the points that are in the path found by AStar between the given points. The array is ordered from the starting point to the ending point of the path. .. _class_AStar_get_point_position: -- :ref:`Vector3` **get_point_position** **(** :ref:`int` id **)** const +- :ref:`Vector3` **get_point_position** **(** :ref:`int` id **)** const Returns the position of the point associated with the given id. .. _class_AStar_get_point_weight_scale: -- :ref:`float` **get_point_weight_scale** **(** :ref:`int` id **)** const +- :ref:`float` **get_point_weight_scale** **(** :ref:`int` id **)** const Returns the weight scale of the point associated with the given id. .. _class_AStar_get_points: -- :ref:`Array` **get_points** **(** **)** +- :ref:`Array` **get_points** **(** **)** .. _class_AStar_has_point: -- :ref:`bool` **has_point** **(** :ref:`int` id **)** const +- :ref:`bool` **has_point** **(** :ref:`int` id **)** const Returns whether a point associated with the given id exists. .. _class_AStar_remove_point: -- void **remove_point** **(** :ref:`int` id **)** +- void **remove_point** **(** :ref:`int` id **)** Removes the point associated with the given id from the points pool. diff --git a/classes/class_atlastexture.rst b/classes/class_atlastexture.rst index a0001c008..43824dfff 100644 --- a/classes/class_atlastexture.rst +++ b/classes/class_atlastexture.rst @@ -19,19 +19,19 @@ Packs multiple small textures in a single, bigger one. Helps to optimize video m Member Functions ---------------- -+--------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_atlas` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_margin` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_region` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------+ -| void | :ref:`set_atlas` **(** :ref:`Texture` atlas **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------+ -| void | :ref:`set_margin` **(** :ref:`Rect2` margin **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------+ -| void | :ref:`set_region` **(** :ref:`Rect2` region **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------+ ++--------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_atlas` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_margin` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_region` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------+ +| void | :ref:`set_atlas` **(** :ref:`Texture` atlas **)** | ++--------------------------------+------------------------------------------------------------------------------------------------+ +| void | :ref:`set_margin` **(** :ref:`Rect2` margin **)** | ++--------------------------------+------------------------------------------------------------------------------------------------+ +| void | :ref:`set_region` **(** :ref:`Rect2` region **)** | ++--------------------------------+------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -61,26 +61,26 @@ Member Function Description .. _class_AtlasTexture_get_atlas: -- :ref:`Texture` **get_atlas** **(** **)** const +- :ref:`Texture` **get_atlas** **(** **)** const .. _class_AtlasTexture_get_margin: -- :ref:`Rect2` **get_margin** **(** **)** const +- :ref:`Rect2` **get_margin** **(** **)** const .. _class_AtlasTexture_get_region: -- :ref:`Rect2` **get_region** **(** **)** const +- :ref:`Rect2` **get_region** **(** **)** const .. _class_AtlasTexture_set_atlas: -- void **set_atlas** **(** :ref:`Texture` atlas **)** +- void **set_atlas** **(** :ref:`Texture` atlas **)** .. _class_AtlasTexture_set_margin: -- void **set_margin** **(** :ref:`Rect2` margin **)** +- void **set_margin** **(** :ref:`Rect2` margin **)** .. _class_AtlasTexture_set_region: -- void **set_region** **(** :ref:`Rect2` region **)** +- void **set_region** **(** :ref:`Rect2` region **)** diff --git a/classes/class_audioeffectamplify.rst b/classes/class_audioeffectamplify.rst index 5e521e3a3..c565e4017 100644 --- a/classes/class_audioeffectamplify.rst +++ b/classes/class_audioeffectamplify.rst @@ -21,11 +21,11 @@ Increases or decreases the volume of the selected audio bus. Member Functions ---------------- -+----------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_volume_db` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_volume_db` **(** :ref:`float` volume **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------+ ++----------------------------+-----------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_volume_db` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_volume_db` **(** :ref:`float` volume **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -45,10 +45,10 @@ Member Function Description .. _class_AudioEffectAmplify_get_volume_db: -- :ref:`float` **get_volume_db** **(** **)** const +- :ref:`float` **get_volume_db** **(** **)** const .. _class_AudioEffectAmplify_set_volume_db: -- void **set_volume_db** **(** :ref:`float` volume **)** +- void **set_volume_db** **(** :ref:`float` volume **)** diff --git a/classes/class_audioeffectchorus.rst b/classes/class_audioeffectchorus.rst index 37b1be792..050169542 100644 --- a/classes/class_audioeffectchorus.rst +++ b/classes/class_audioeffectchorus.rst @@ -19,43 +19,43 @@ Adds a chorus audio effect. Member Functions ---------------- -+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_dry` **(** **)** const | -+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_voice_count` **(** **)** const | -+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_voice_cutoff_hz` **(** :ref:`int` voice_idx **)** const | -+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_voice_delay_ms` **(** :ref:`int` voice_idx **)** const | -+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_voice_depth_ms` **(** :ref:`int` voice_idx **)** const | -+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_voice_level_db` **(** :ref:`int` voice_idx **)** const | -+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_voice_pan` **(** :ref:`int` voice_idx **)** const | -+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_voice_rate_hz` **(** :ref:`int` voice_idx **)** const | -+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_wet` **(** **)** const | -+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_dry` **(** :ref:`float` amount **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_voice_count` **(** :ref:`int` voices **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_voice_cutoff_hz` **(** :ref:`int` voice_idx, :ref:`float` cutoff_hz **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_voice_delay_ms` **(** :ref:`int` voice_idx, :ref:`float` delay_ms **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_voice_depth_ms` **(** :ref:`int` voice_idx, :ref:`float` depth_ms **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_voice_level_db` **(** :ref:`int` voice_idx, :ref:`float` level_db **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_voice_pan` **(** :ref:`int` voice_idx, :ref:`float` pan **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_voice_rate_hz` **(** :ref:`int` voice_idx, :ref:`float` rate_hz **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_wet` **(** :ref:`float` amount **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_dry` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_voice_count` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_voice_cutoff_hz` **(** :ref:`int` voice_idx **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_voice_delay_ms` **(** :ref:`int` voice_idx **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_voice_depth_ms` **(** :ref:`int` voice_idx **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_voice_level_db` **(** :ref:`int` voice_idx **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_voice_pan` **(** :ref:`int` voice_idx **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_voice_rate_hz` **(** :ref:`int` voice_idx **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_wet` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_dry` **(** :ref:`float` amount **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_voice_count` **(** :ref:`int` voices **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_voice_cutoff_hz` **(** :ref:`int` voice_idx, :ref:`float` cutoff_hz **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_voice_delay_ms` **(** :ref:`int` voice_idx, :ref:`float` delay_ms **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_voice_depth_ms` **(** :ref:`int` voice_idx, :ref:`float` depth_ms **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_voice_level_db` **(** :ref:`int` voice_idx, :ref:`float` level_db **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_voice_pan` **(** :ref:`int` voice_idx, :ref:`float` pan **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_voice_rate_hz` **(** :ref:`int` voice_idx, :ref:`float` rate_hz **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_wet` **(** :ref:`float` amount **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -179,109 +179,109 @@ Member Function Description .. _class_AudioEffectChorus_get_dry: -- :ref:`float` **get_dry** **(** **)** const +- :ref:`float` **get_dry** **(** **)** const Returns the set dry ratio. .. _class_AudioEffectChorus_get_voice_count: -- :ref:`int` **get_voice_count** **(** **)** const +- :ref:`int` **get_voice_count** **(** **)** const Returns the set voice count. .. _class_AudioEffectChorus_get_voice_cutoff_hz: -- :ref:`float` **get_voice_cutoff_hz** **(** :ref:`int` voice_idx **)** const +- :ref:`float` **get_voice_cutoff_hz** **(** :ref:`int` voice_idx **)** const Returns the voice's set cutoff frequency. .. _class_AudioEffectChorus_get_voice_delay_ms: -- :ref:`float` **get_voice_delay_ms** **(** :ref:`int` voice_idx **)** const +- :ref:`float` **get_voice_delay_ms** **(** :ref:`int` voice_idx **)** const Returns the voice's set delay. .. _class_AudioEffectChorus_get_voice_depth_ms: -- :ref:`float` **get_voice_depth_ms** **(** :ref:`int` voice_idx **)** const +- :ref:`float` **get_voice_depth_ms** **(** :ref:`int` voice_idx **)** const Returns the voice's set filter depth. .. _class_AudioEffectChorus_get_voice_level_db: -- :ref:`float` **get_voice_level_db** **(** :ref:`int` voice_idx **)** const +- :ref:`float` **get_voice_level_db** **(** :ref:`int` voice_idx **)** const Returns the voice's set maximum volume. .. _class_AudioEffectChorus_get_voice_pan: -- :ref:`float` **get_voice_pan** **(** :ref:`int` voice_idx **)** const +- :ref:`float` **get_voice_pan** **(** :ref:`int` voice_idx **)** const Returns the voice's set pan. .. _class_AudioEffectChorus_get_voice_rate_hz: -- :ref:`float` **get_voice_rate_hz** **(** :ref:`int` voice_idx **)** const +- :ref:`float` **get_voice_rate_hz** **(** :ref:`int` voice_idx **)** const Returns the voice filter's set rate in cycles. .. _class_AudioEffectChorus_get_wet: -- :ref:`float` **get_wet** **(** **)** const +- :ref:`float` **get_wet** **(** **)** const Returns the set applied wetness of the effect. .. _class_AudioEffectChorus_set_dry: -- void **set_dry** **(** :ref:`float` amount **)** +- void **set_dry** **(** :ref:`float` amount **)** Returns the set applied dryness of the effect. .. _class_AudioEffectChorus_set_voice_count: -- void **set_voice_count** **(** :ref:`int` voices **)** +- void **set_voice_count** **(** :ref:`int` voices **)** Set the number of voices in the effect's filter. .. _class_AudioEffectChorus_set_voice_cutoff_hz: -- void **set_voice_cutoff_hz** **(** :ref:`int` voice_idx, :ref:`float` cutoff_hz **)** +- void **set_voice_cutoff_hz** **(** :ref:`int` voice_idx, :ref:`float` cutoff_hz **)** Set the cutoff frequency of the voice. The maximum frequency the voice may affect. .. _class_AudioEffectChorus_set_voice_delay_ms: -- void **set_voice_delay_ms** **(** :ref:`int` voice_idx, :ref:`float` delay_ms **)** +- void **set_voice_delay_ms** **(** :ref:`int` voice_idx, :ref:`float` delay_ms **)** Set the delay of the voice's signal. .. _class_AudioEffectChorus_set_voice_depth_ms: -- void **set_voice_depth_ms** **(** :ref:`int` voice_idx, :ref:`float` depth_ms **)** +- void **set_voice_depth_ms** **(** :ref:`int` voice_idx, :ref:`float` depth_ms **)** Set the filter depth of the voice's signal. .. _class_AudioEffectChorus_set_voice_level_db: -- void **set_voice_level_db** **(** :ref:`int` voice_idx, :ref:`float` level_db **)** +- void **set_voice_level_db** **(** :ref:`int` voice_idx, :ref:`float` level_db **)** Set the volume level of the voice. .. _class_AudioEffectChorus_set_voice_pan: -- void **set_voice_pan** **(** :ref:`int` voice_idx, :ref:`float` pan **)** +- void **set_voice_pan** **(** :ref:`int` voice_idx, :ref:`float` pan **)** Set the pan level of the voice. .. _class_AudioEffectChorus_set_voice_rate_hz: -- void **set_voice_rate_hz** **(** :ref:`int` voice_idx, :ref:`float` rate_hz **)** +- void **set_voice_rate_hz** **(** :ref:`int` voice_idx, :ref:`float` rate_hz **)** Set the voice filter's rate. .. _class_AudioEffectChorus_set_wet: -- void **set_wet** **(** :ref:`float` amount **)** +- void **set_wet** **(** :ref:`float` amount **)** Set the amount of effect. diff --git a/classes/class_audioeffectcompressor.rst b/classes/class_audioeffectcompressor.rst index 561bbe7a2..bb3faf94a 100644 --- a/classes/class_audioeffectcompressor.rst +++ b/classes/class_audioeffectcompressor.rst @@ -21,35 +21,35 @@ Reduces sounds that exceed a certain threshold level, smooths out the dynamics a Member Functions ---------------- -+------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_attack_us` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_gain` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_mix` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ratio` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_release_ms` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_sidechain` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_threshold` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_attack_us` **(** :ref:`float` attack_us **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_gain` **(** :ref:`float` gain **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mix` **(** :ref:`float` mix **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ratio` **(** :ref:`float` ratio **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_release_ms` **(** :ref:`float` release_ms **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sidechain` **(** :ref:`String` sidechain **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_threshold` **(** :ref:`float` threshold **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------+ ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_attack_us` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_gain` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_mix` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_ratio` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_release_ms` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_sidechain` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_threshold` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_attack_us` **(** :ref:`float` attack_us **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_gain` **(** :ref:`float` gain **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_mix` **(** :ref:`float` mix **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ratio` **(** :ref:`float` ratio **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_release_ms` **(** :ref:`float` release_ms **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_sidechain` **(** :ref:`String` sidechain **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_threshold` **(** :ref:`float` threshold **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -103,58 +103,58 @@ Member Function Description .. _class_AudioEffectCompressor_get_attack_us: -- :ref:`float` **get_attack_us** **(** **)** const +- :ref:`float` **get_attack_us** **(** **)** const .. _class_AudioEffectCompressor_get_gain: -- :ref:`float` **get_gain** **(** **)** const +- :ref:`float` **get_gain** **(** **)** const .. _class_AudioEffectCompressor_get_mix: -- :ref:`float` **get_mix** **(** **)** const +- :ref:`float` **get_mix** **(** **)** const .. _class_AudioEffectCompressor_get_ratio: -- :ref:`float` **get_ratio** **(** **)** const +- :ref:`float` **get_ratio** **(** **)** const .. _class_AudioEffectCompressor_get_release_ms: -- :ref:`float` **get_release_ms** **(** **)** const +- :ref:`float` **get_release_ms** **(** **)** const .. _class_AudioEffectCompressor_get_sidechain: -- :ref:`String` **get_sidechain** **(** **)** const +- :ref:`String` **get_sidechain** **(** **)** const .. _class_AudioEffectCompressor_get_threshold: -- :ref:`float` **get_threshold** **(** **)** const +- :ref:`float` **get_threshold** **(** **)** const .. _class_AudioEffectCompressor_set_attack_us: -- void **set_attack_us** **(** :ref:`float` attack_us **)** +- void **set_attack_us** **(** :ref:`float` attack_us **)** .. _class_AudioEffectCompressor_set_gain: -- void **set_gain** **(** :ref:`float` gain **)** +- void **set_gain** **(** :ref:`float` gain **)** .. _class_AudioEffectCompressor_set_mix: -- void **set_mix** **(** :ref:`float` mix **)** +- void **set_mix** **(** :ref:`float` mix **)** .. _class_AudioEffectCompressor_set_ratio: -- void **set_ratio** **(** :ref:`float` ratio **)** +- void **set_ratio** **(** :ref:`float` ratio **)** .. _class_AudioEffectCompressor_set_release_ms: -- void **set_release_ms** **(** :ref:`float` release_ms **)** +- void **set_release_ms** **(** :ref:`float` release_ms **)** .. _class_AudioEffectCompressor_set_sidechain: -- void **set_sidechain** **(** :ref:`String` sidechain **)** +- void **set_sidechain** **(** :ref:`String` sidechain **)** .. _class_AudioEffectCompressor_set_threshold: -- void **set_threshold** **(** :ref:`float` threshold **)** +- void **set_threshold** **(** :ref:`float` threshold **)** diff --git a/classes/class_audioeffectdelay.rst b/classes/class_audioeffectdelay.rst index 71f71fb09..c2c407c50 100644 --- a/classes/class_audioeffectdelay.rst +++ b/classes/class_audioeffectdelay.rst @@ -21,59 +21,59 @@ Two tap delay and feedback options. Member Functions ---------------- -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_dry` **(** **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_feedback_delay_ms` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_feedback_level_db` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_feedback_lowpass` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_tap1_delay_ms` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_tap1_level_db` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_tap1_pan` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_tap2_delay_ms` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_tap2_level_db` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_tap2_pan` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_feedback_active` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_tap1_active` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_tap2_active` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_dry` **(** :ref:`float` amount **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_feedback_active` **(** :ref:`bool` amount **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_feedback_delay_ms` **(** :ref:`float` amount **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_feedback_level_db` **(** :ref:`float` amount **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_feedback_lowpass` **(** :ref:`float` amount **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tap1_active` **(** :ref:`bool` amount **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tap1_delay_ms` **(** :ref:`float` amount **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tap1_level_db` **(** :ref:`float` amount **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tap1_pan` **(** :ref:`float` amount **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tap2_active` **(** :ref:`bool` amount **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tap2_delay_ms` **(** :ref:`float` amount **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tap2_level_db` **(** :ref:`float` amount **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tap2_pan` **(** :ref:`float` amount **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ ++----------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_dry` **(** **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_feedback_delay_ms` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_feedback_level_db` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_feedback_lowpass` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_tap1_delay_ms` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_tap1_level_db` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_tap1_pan` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_tap2_delay_ms` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_tap2_level_db` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_tap2_pan` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_feedback_active` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_tap1_active` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_tap2_active` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_dry` **(** :ref:`float` amount **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_feedback_active` **(** :ref:`bool` amount **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_feedback_delay_ms` **(** :ref:`float` amount **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_feedback_level_db` **(** :ref:`float` amount **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_feedback_lowpass` **(** :ref:`float` amount **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tap1_active` **(** :ref:`bool` amount **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tap1_delay_ms` **(** :ref:`float` amount **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tap1_level_db` **(** :ref:`float` amount **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tap1_pan` **(** :ref:`float` amount **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tap2_active` **(** :ref:`bool` amount **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tap2_delay_ms` **(** :ref:`float` amount **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tap2_level_db` **(** :ref:`float` amount **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tap2_pan` **(** :ref:`float` amount **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -141,106 +141,106 @@ Member Function Description .. _class_AudioEffectDelay_get_dry: -- :ref:`float` **get_dry** **(** **)** +- :ref:`float` **get_dry** **(** **)** .. _class_AudioEffectDelay_get_feedback_delay_ms: -- :ref:`float` **get_feedback_delay_ms** **(** **)** const +- :ref:`float` **get_feedback_delay_ms** **(** **)** const .. _class_AudioEffectDelay_get_feedback_level_db: -- :ref:`float` **get_feedback_level_db** **(** **)** const +- :ref:`float` **get_feedback_level_db** **(** **)** const .. _class_AudioEffectDelay_get_feedback_lowpass: -- :ref:`float` **get_feedback_lowpass** **(** **)** const +- :ref:`float` **get_feedback_lowpass** **(** **)** const .. _class_AudioEffectDelay_get_tap1_delay_ms: -- :ref:`float` **get_tap1_delay_ms** **(** **)** const +- :ref:`float` **get_tap1_delay_ms** **(** **)** const .. _class_AudioEffectDelay_get_tap1_level_db: -- :ref:`float` **get_tap1_level_db** **(** **)** const +- :ref:`float` **get_tap1_level_db** **(** **)** const .. _class_AudioEffectDelay_get_tap1_pan: -- :ref:`float` **get_tap1_pan** **(** **)** const +- :ref:`float` **get_tap1_pan** **(** **)** const .. _class_AudioEffectDelay_get_tap2_delay_ms: -- :ref:`float` **get_tap2_delay_ms** **(** **)** const +- :ref:`float` **get_tap2_delay_ms** **(** **)** const .. _class_AudioEffectDelay_get_tap2_level_db: -- :ref:`float` **get_tap2_level_db** **(** **)** const +- :ref:`float` **get_tap2_level_db** **(** **)** const .. _class_AudioEffectDelay_get_tap2_pan: -- :ref:`float` **get_tap2_pan** **(** **)** const +- :ref:`float` **get_tap2_pan** **(** **)** const .. _class_AudioEffectDelay_is_feedback_active: -- :ref:`bool` **is_feedback_active** **(** **)** const +- :ref:`bool` **is_feedback_active** **(** **)** const .. _class_AudioEffectDelay_is_tap1_active: -- :ref:`bool` **is_tap1_active** **(** **)** const +- :ref:`bool` **is_tap1_active** **(** **)** const .. _class_AudioEffectDelay_is_tap2_active: -- :ref:`bool` **is_tap2_active** **(** **)** const +- :ref:`bool` **is_tap2_active** **(** **)** const .. _class_AudioEffectDelay_set_dry: -- void **set_dry** **(** :ref:`float` amount **)** +- void **set_dry** **(** :ref:`float` amount **)** .. _class_AudioEffectDelay_set_feedback_active: -- void **set_feedback_active** **(** :ref:`bool` amount **)** +- void **set_feedback_active** **(** :ref:`bool` amount **)** .. _class_AudioEffectDelay_set_feedback_delay_ms: -- void **set_feedback_delay_ms** **(** :ref:`float` amount **)** +- void **set_feedback_delay_ms** **(** :ref:`float` amount **)** .. _class_AudioEffectDelay_set_feedback_level_db: -- void **set_feedback_level_db** **(** :ref:`float` amount **)** +- void **set_feedback_level_db** **(** :ref:`float` amount **)** .. _class_AudioEffectDelay_set_feedback_lowpass: -- void **set_feedback_lowpass** **(** :ref:`float` amount **)** +- void **set_feedback_lowpass** **(** :ref:`float` amount **)** .. _class_AudioEffectDelay_set_tap1_active: -- void **set_tap1_active** **(** :ref:`bool` amount **)** +- void **set_tap1_active** **(** :ref:`bool` amount **)** .. _class_AudioEffectDelay_set_tap1_delay_ms: -- void **set_tap1_delay_ms** **(** :ref:`float` amount **)** +- void **set_tap1_delay_ms** **(** :ref:`float` amount **)** .. _class_AudioEffectDelay_set_tap1_level_db: -- void **set_tap1_level_db** **(** :ref:`float` amount **)** +- void **set_tap1_level_db** **(** :ref:`float` amount **)** .. _class_AudioEffectDelay_set_tap1_pan: -- void **set_tap1_pan** **(** :ref:`float` amount **)** +- void **set_tap1_pan** **(** :ref:`float` amount **)** .. _class_AudioEffectDelay_set_tap2_active: -- void **set_tap2_active** **(** :ref:`bool` amount **)** +- void **set_tap2_active** **(** :ref:`bool` amount **)** .. _class_AudioEffectDelay_set_tap2_delay_ms: -- void **set_tap2_delay_ms** **(** :ref:`float` amount **)** +- void **set_tap2_delay_ms** **(** :ref:`float` amount **)** .. _class_AudioEffectDelay_set_tap2_level_db: -- void **set_tap2_level_db** **(** :ref:`float` amount **)** +- void **set_tap2_level_db** **(** :ref:`float` amount **)** .. _class_AudioEffectDelay_set_tap2_pan: -- void **set_tap2_pan** **(** :ref:`float` amount **)** +- void **set_tap2_pan** **(** :ref:`float` amount **)** diff --git a/classes/class_audioeffectdistortion.rst b/classes/class_audioeffectdistortion.rst index a87ea934e..465bcc038 100644 --- a/classes/class_audioeffectdistortion.rst +++ b/classes/class_audioeffectdistortion.rst @@ -21,27 +21,27 @@ Modify the sound to make it dirty. Member Functions ---------------- -+----------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_drive` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_keep_hf_hz` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_mode` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_post_gain` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_pre_gain` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_drive` **(** :ref:`float` drive **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_keep_hf_hz` **(** :ref:`float` keep_hf_hz **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mode` **(** :ref:`int` mode **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_post_gain` **(** :ref:`float` post_gain **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pre_gain` **(** :ref:`float` pre_gain **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------+ ++----------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_drive` **(** **)** const | ++----------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_keep_hf_hz` **(** **)** const | ++----------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_mode` **(** **)** const | ++----------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_post_gain` **(** **)** const | ++----------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_pre_gain` **(** **)** const | ++----------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_drive` **(** :ref:`float` drive **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_keep_hf_hz` **(** :ref:`float` keep_hf_hz **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_mode` **(** :ref:`int` mode **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_post_gain` **(** :ref:`float` post_gain **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pre_gain` **(** :ref:`float` pre_gain **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -88,42 +88,42 @@ Member Function Description .. _class_AudioEffectDistortion_get_drive: -- :ref:`float` **get_drive** **(** **)** const +- :ref:`float` **get_drive** **(** **)** const .. _class_AudioEffectDistortion_get_keep_hf_hz: -- :ref:`float` **get_keep_hf_hz** **(** **)** const +- :ref:`float` **get_keep_hf_hz** **(** **)** const .. _class_AudioEffectDistortion_get_mode: -- :ref:`int` **get_mode** **(** **)** const +- :ref:`int` **get_mode** **(** **)** const .. _class_AudioEffectDistortion_get_post_gain: -- :ref:`float` **get_post_gain** **(** **)** const +- :ref:`float` **get_post_gain** **(** **)** const .. _class_AudioEffectDistortion_get_pre_gain: -- :ref:`float` **get_pre_gain** **(** **)** const +- :ref:`float` **get_pre_gain** **(** **)** const .. _class_AudioEffectDistortion_set_drive: -- void **set_drive** **(** :ref:`float` drive **)** +- void **set_drive** **(** :ref:`float` drive **)** .. _class_AudioEffectDistortion_set_keep_hf_hz: -- void **set_keep_hf_hz** **(** :ref:`float` keep_hf_hz **)** +- void **set_keep_hf_hz** **(** :ref:`float` keep_hf_hz **)** .. _class_AudioEffectDistortion_set_mode: -- void **set_mode** **(** :ref:`int` mode **)** +- void **set_mode** **(** :ref:`int` mode **)** .. _class_AudioEffectDistortion_set_post_gain: -- void **set_post_gain** **(** :ref:`float` post_gain **)** +- void **set_post_gain** **(** :ref:`float` post_gain **)** .. _class_AudioEffectDistortion_set_pre_gain: -- void **set_pre_gain** **(** :ref:`float` pre_gain **)** +- void **set_pre_gain** **(** :ref:`float` pre_gain **)** diff --git a/classes/class_audioeffecteq.rst b/classes/class_audioeffecteq.rst index df8847cd2..367702af5 100644 --- a/classes/class_audioeffecteq.rst +++ b/classes/class_audioeffecteq.rst @@ -23,13 +23,13 @@ Use it to create a custom equalizer if :ref:`AudioEffectEQ6` | :ref:`get_band_count` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_band_gain_db` **(** :ref:`int` band_idx **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_band_gain_db` **(** :ref:`int` band_idx, :ref:`float` volume_db **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_band_count` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_band_gain_db` **(** :ref:`int` band_idx **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_band_gain_db` **(** :ref:`int` band_idx, :ref:`float` volume_db **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -41,19 +41,19 @@ Member Function Description .. _class_AudioEffectEQ_get_band_count: -- :ref:`int` **get_band_count** **(** **)** const +- :ref:`int` **get_band_count** **(** **)** const Returns the number of bands of the equalizer. .. _class_AudioEffectEQ_get_band_gain_db: -- :ref:`float` **get_band_gain_db** **(** :ref:`int` band_idx **)** const +- :ref:`float` **get_band_gain_db** **(** :ref:`int` band_idx **)** const Returns the band's gain at the specified index, in dB. .. _class_AudioEffectEQ_set_band_gain_db: -- void **set_band_gain_db** **(** :ref:`int` band_idx, :ref:`float` volume_db **)** +- void **set_band_gain_db** **(** :ref:`int` band_idx, :ref:`float` volume_db **)** Sets band's gain at the specified index, in dB. diff --git a/classes/class_audioeffectfilter.rst b/classes/class_audioeffectfilter.rst index c4f96fe6a..61a496fa5 100644 --- a/classes/class_audioeffectfilter.rst +++ b/classes/class_audioeffectfilter.rst @@ -21,23 +21,23 @@ Brief Description Member Functions ---------------- -+----------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_cutoff` **(** **)** const | -+----------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_db` **(** **)** const | -+----------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_gain` **(** **)** const | -+----------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_resonance` **(** **)** const | -+----------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cutoff` **(** :ref:`float` freq **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_db` **(** :ref:`int` amount **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_gain` **(** :ref:`float` amount **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_resonance` **(** :ref:`float` amount **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------+ ++----------------------------+----------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_cutoff` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_db` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_gain` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_resonance` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cutoff` **(** :ref:`float` freq **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_db` **(** :ref:`int` amount **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_gain` **(** :ref:`float` amount **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_resonance` **(** :ref:`float` amount **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -72,34 +72,34 @@ Member Function Description .. _class_AudioEffectFilter_get_cutoff: -- :ref:`float` **get_cutoff** **(** **)** const +- :ref:`float` **get_cutoff** **(** **)** const .. _class_AudioEffectFilter_get_db: -- :ref:`int` **get_db** **(** **)** const +- :ref:`int` **get_db** **(** **)** const .. _class_AudioEffectFilter_get_gain: -- :ref:`float` **get_gain** **(** **)** const +- :ref:`float` **get_gain** **(** **)** const .. _class_AudioEffectFilter_get_resonance: -- :ref:`float` **get_resonance** **(** **)** const +- :ref:`float` **get_resonance** **(** **)** const .. _class_AudioEffectFilter_set_cutoff: -- void **set_cutoff** **(** :ref:`float` freq **)** +- void **set_cutoff** **(** :ref:`float` freq **)** .. _class_AudioEffectFilter_set_db: -- void **set_db** **(** :ref:`int` amount **)** +- void **set_db** **(** :ref:`int` amount **)** .. _class_AudioEffectFilter_set_gain: -- void **set_gain** **(** :ref:`float` amount **)** +- void **set_gain** **(** :ref:`float` amount **)** .. _class_AudioEffectFilter_set_resonance: -- void **set_resonance** **(** :ref:`float` amount **)** +- void **set_resonance** **(** :ref:`float` amount **)** diff --git a/classes/class_audioeffectlimiter.rst b/classes/class_audioeffectlimiter.rst index b44d7b928..444ab2bc2 100644 --- a/classes/class_audioeffectlimiter.rst +++ b/classes/class_audioeffectlimiter.rst @@ -19,23 +19,23 @@ Adds a soft clip Limiter audio effect to an Audio bus. Member Functions ---------------- -+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ceiling_db` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_soft_clip_db` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_soft_clip_ratio` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_threshold_db` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ceiling_db` **(** :ref:`float` ceiling **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_soft_clip_db` **(** :ref:`float` soft_clip **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_soft_clip_ratio` **(** :ref:`float` soft_clip **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_threshold_db` **(** :ref:`float` threshold **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ ++----------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_ceiling_db` **(** **)** const | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_soft_clip_db` **(** **)** const | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_soft_clip_ratio` **(** **)** const | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_threshold_db` **(** **)** const | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ceiling_db` **(** :ref:`float` ceiling **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_soft_clip_db` **(** :ref:`float` soft_clip **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_soft_clip_ratio` **(** :ref:`float` soft_clip **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_threshold_db` **(** :ref:`float` threshold **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -69,34 +69,34 @@ Member Function Description .. _class_AudioEffectLimiter_get_ceiling_db: -- :ref:`float` **get_ceiling_db** **(** **)** const +- :ref:`float` **get_ceiling_db** **(** **)** const .. _class_AudioEffectLimiter_get_soft_clip_db: -- :ref:`float` **get_soft_clip_db** **(** **)** const +- :ref:`float` **get_soft_clip_db** **(** **)** const .. _class_AudioEffectLimiter_get_soft_clip_ratio: -- :ref:`float` **get_soft_clip_ratio** **(** **)** const +- :ref:`float` **get_soft_clip_ratio** **(** **)** const .. _class_AudioEffectLimiter_get_threshold_db: -- :ref:`float` **get_threshold_db** **(** **)** const +- :ref:`float` **get_threshold_db** **(** **)** const .. _class_AudioEffectLimiter_set_ceiling_db: -- void **set_ceiling_db** **(** :ref:`float` ceiling **)** +- void **set_ceiling_db** **(** :ref:`float` ceiling **)** .. _class_AudioEffectLimiter_set_soft_clip_db: -- void **set_soft_clip_db** **(** :ref:`float` soft_clip **)** +- void **set_soft_clip_db** **(** :ref:`float` soft_clip **)** .. _class_AudioEffectLimiter_set_soft_clip_ratio: -- void **set_soft_clip_ratio** **(** :ref:`float` soft_clip **)** +- void **set_soft_clip_ratio** **(** :ref:`float` soft_clip **)** .. _class_AudioEffectLimiter_set_threshold_db: -- void **set_threshold_db** **(** :ref:`float` threshold **)** +- void **set_threshold_db** **(** :ref:`float` threshold **)** diff --git a/classes/class_audioeffectpanner.rst b/classes/class_audioeffectpanner.rst index a1ff1997e..f9e552b04 100644 --- a/classes/class_audioeffectpanner.rst +++ b/classes/class_audioeffectpanner.rst @@ -19,11 +19,11 @@ Adds a Panner audio effect to an Audio bus. Pans sound left or right. Member Functions ---------------- -+----------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_pan` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pan` **(** :ref:`float` cpanume **)** | -+----------------------------+-------------------------------------------------------------------------------------------------+ ++----------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_pan` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------+ +| void | :ref:`set_pan` **(** :ref:`float` cpanume **)** | ++----------------------------+-----------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -43,10 +43,10 @@ Member Function Description .. _class_AudioEffectPanner_get_pan: -- :ref:`float` **get_pan** **(** **)** const +- :ref:`float` **get_pan** **(** **)** const .. _class_AudioEffectPanner_set_pan: -- void **set_pan** **(** :ref:`float` cpanume **)** +- void **set_pan** **(** :ref:`float` cpanume **)** diff --git a/classes/class_audioeffectphaser.rst b/classes/class_audioeffectphaser.rst index 4d1f3e137..3858a6b59 100644 --- a/classes/class_audioeffectphaser.rst +++ b/classes/class_audioeffectphaser.rst @@ -21,27 +21,27 @@ Combines the original signal with a copy that is slightly out of phase with the Member Functions ---------------- -+----------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_depth` **(** **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_feedback` **(** **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_range_max_hz` **(** **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_range_min_hz` **(** **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_rate_hz` **(** **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_depth` **(** :ref:`float` depth **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_feedback` **(** :ref:`float` fbk **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_range_max_hz` **(** :ref:`float` hz **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_range_min_hz` **(** :ref:`float` hz **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rate_hz` **(** :ref:`float` hz **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------+ ++----------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_depth` **(** **)** const | ++----------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_feedback` **(** **)** const | ++----------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_range_max_hz` **(** **)** const | ++----------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_range_min_hz` **(** **)** const | ++----------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_rate_hz` **(** **)** const | ++----------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_depth` **(** :ref:`float` depth **)** | ++----------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_feedback` **(** :ref:`float` fbk **)** | ++----------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_range_max_hz` **(** :ref:`float` hz **)** | ++----------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_range_min_hz` **(** :ref:`float` hz **)** | ++----------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rate_hz` **(** :ref:`float` hz **)** | ++----------------------------+------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -77,42 +77,42 @@ Member Function Description .. _class_AudioEffectPhaser_get_depth: -- :ref:`float` **get_depth** **(** **)** const +- :ref:`float` **get_depth** **(** **)** const .. _class_AudioEffectPhaser_get_feedback: -- :ref:`float` **get_feedback** **(** **)** const +- :ref:`float` **get_feedback** **(** **)** const .. _class_AudioEffectPhaser_get_range_max_hz: -- :ref:`float` **get_range_max_hz** **(** **)** const +- :ref:`float` **get_range_max_hz** **(** **)** const .. _class_AudioEffectPhaser_get_range_min_hz: -- :ref:`float` **get_range_min_hz** **(** **)** const +- :ref:`float` **get_range_min_hz** **(** **)** const .. _class_AudioEffectPhaser_get_rate_hz: -- :ref:`float` **get_rate_hz** **(** **)** const +- :ref:`float` **get_rate_hz** **(** **)** const .. _class_AudioEffectPhaser_set_depth: -- void **set_depth** **(** :ref:`float` depth **)** +- void **set_depth** **(** :ref:`float` depth **)** .. _class_AudioEffectPhaser_set_feedback: -- void **set_feedback** **(** :ref:`float` fbk **)** +- void **set_feedback** **(** :ref:`float` fbk **)** .. _class_AudioEffectPhaser_set_range_max_hz: -- void **set_range_max_hz** **(** :ref:`float` hz **)** +- void **set_range_max_hz** **(** :ref:`float` hz **)** .. _class_AudioEffectPhaser_set_range_min_hz: -- void **set_range_min_hz** **(** :ref:`float` hz **)** +- void **set_range_min_hz** **(** :ref:`float` hz **)** .. _class_AudioEffectPhaser_set_rate_hz: -- void **set_rate_hz** **(** :ref:`float` hz **)** +- void **set_rate_hz** **(** :ref:`float` hz **)** diff --git a/classes/class_audioeffectpitchshift.rst b/classes/class_audioeffectpitchshift.rst index 1d4f32d56..40deafa6d 100644 --- a/classes/class_audioeffectpitchshift.rst +++ b/classes/class_audioeffectpitchshift.rst @@ -21,11 +21,11 @@ Raises or lowers the pitch of original sound. Member Functions ---------------- -+----------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_pitch_scale` **(** **)** const | -+----------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pitch_scale` **(** :ref:`float` rate **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------------+ ++----------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_pitch_scale` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pitch_scale` **(** :ref:`float` rate **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -45,10 +45,10 @@ Member Function Description .. _class_AudioEffectPitchShift_get_pitch_scale: -- :ref:`float` **get_pitch_scale** **(** **)** const +- :ref:`float` **get_pitch_scale** **(** **)** const .. _class_AudioEffectPitchShift_set_pitch_scale: -- void **set_pitch_scale** **(** :ref:`float` rate **)** +- void **set_pitch_scale** **(** :ref:`float` rate **)** diff --git a/classes/class_audioeffectreverb.rst b/classes/class_audioeffectreverb.rst index 01d74d76c..d7eaa99f9 100644 --- a/classes/class_audioeffectreverb.rst +++ b/classes/class_audioeffectreverb.rst @@ -21,39 +21,39 @@ Simulates the sound of acoustic environments such as rooms, concert halls, caver Member Functions ---------------- -+----------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_damping` **(** **)** const | -+----------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_dry` **(** **)** const | -+----------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_hpf` **(** **)** const | -+----------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_predelay_feedback` **(** **)** const | -+----------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_predelay_msec` **(** **)** const | -+----------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_room_size` **(** **)** const | -+----------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_spread` **(** **)** const | -+----------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_wet` **(** **)** const | -+----------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_damping` **(** :ref:`float` amount **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_dry` **(** :ref:`float` amount **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_hpf` **(** :ref:`float` amount **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_predelay_feedback` **(** :ref:`float` feedback **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_predelay_msec` **(** :ref:`float` msec **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_room_size` **(** :ref:`float` size **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_spread` **(** :ref:`float` amount **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_wet` **(** :ref:`float` amount **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_damping` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_dry` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_hpf` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_predelay_feedback` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_predelay_msec` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_room_size` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_spread` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_wet` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_damping` **(** :ref:`float` amount **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_dry` **(** :ref:`float` amount **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_hpf` **(** :ref:`float` amount **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_predelay_feedback` **(** :ref:`float` feedback **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_predelay_msec` **(** :ref:`float` msec **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_room_size` **(** :ref:`float` size **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_spread` **(** :ref:`float` amount **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_wet` **(** :ref:`float` amount **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -101,66 +101,66 @@ Member Function Description .. _class_AudioEffectReverb_get_damping: -- :ref:`float` **get_damping** **(** **)** const +- :ref:`float` **get_damping** **(** **)** const .. _class_AudioEffectReverb_get_dry: -- :ref:`float` **get_dry** **(** **)** const +- :ref:`float` **get_dry** **(** **)** const .. _class_AudioEffectReverb_get_hpf: -- :ref:`float` **get_hpf** **(** **)** const +- :ref:`float` **get_hpf** **(** **)** const .. _class_AudioEffectReverb_get_predelay_feedback: -- :ref:`float` **get_predelay_feedback** **(** **)** const +- :ref:`float` **get_predelay_feedback** **(** **)** const .. _class_AudioEffectReverb_get_predelay_msec: -- :ref:`float` **get_predelay_msec** **(** **)** const +- :ref:`float` **get_predelay_msec** **(** **)** const .. _class_AudioEffectReverb_get_room_size: -- :ref:`float` **get_room_size** **(** **)** const +- :ref:`float` **get_room_size** **(** **)** const .. _class_AudioEffectReverb_get_spread: -- :ref:`float` **get_spread** **(** **)** const +- :ref:`float` **get_spread** **(** **)** const .. _class_AudioEffectReverb_get_wet: -- :ref:`float` **get_wet** **(** **)** const +- :ref:`float` **get_wet** **(** **)** const .. _class_AudioEffectReverb_set_damping: -- void **set_damping** **(** :ref:`float` amount **)** +- void **set_damping** **(** :ref:`float` amount **)** .. _class_AudioEffectReverb_set_dry: -- void **set_dry** **(** :ref:`float` amount **)** +- void **set_dry** **(** :ref:`float` amount **)** .. _class_AudioEffectReverb_set_hpf: -- void **set_hpf** **(** :ref:`float` amount **)** +- void **set_hpf** **(** :ref:`float` amount **)** .. _class_AudioEffectReverb_set_predelay_feedback: -- void **set_predelay_feedback** **(** :ref:`float` feedback **)** +- void **set_predelay_feedback** **(** :ref:`float` feedback **)** .. _class_AudioEffectReverb_set_predelay_msec: -- void **set_predelay_msec** **(** :ref:`float` msec **)** +- void **set_predelay_msec** **(** :ref:`float` msec **)** .. _class_AudioEffectReverb_set_room_size: -- void **set_room_size** **(** :ref:`float` size **)** +- void **set_room_size** **(** :ref:`float` size **)** .. _class_AudioEffectReverb_set_spread: -- void **set_spread** **(** :ref:`float` amount **)** +- void **set_spread** **(** :ref:`float` amount **)** .. _class_AudioEffectReverb_set_wet: -- void **set_wet** **(** :ref:`float` amount **)** +- void **set_wet** **(** :ref:`float` amount **)** diff --git a/classes/class_audioeffectstereoenhance.rst b/classes/class_audioeffectstereoenhance.rst index ca13372c2..1921e5e88 100644 --- a/classes/class_audioeffectstereoenhance.rst +++ b/classes/class_audioeffectstereoenhance.rst @@ -19,19 +19,19 @@ Brief Description Member Functions ---------------- -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_pan_pullout` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_surround` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_time_pullout` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pan_pullout` **(** :ref:`float` amount **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_surround` **(** :ref:`float` amount **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_time_pullout` **(** :ref:`float` amount **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ ++----------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_pan_pullout` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_surround` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_time_pullout` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pan_pullout` **(** :ref:`float` amount **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_surround` **(** :ref:`float` amount **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_time_pullout` **(** :ref:`float` amount **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -54,26 +54,26 @@ Member Function Description .. _class_AudioEffectStereoEnhance_get_pan_pullout: -- :ref:`float` **get_pan_pullout** **(** **)** const +- :ref:`float` **get_pan_pullout** **(** **)** const .. _class_AudioEffectStereoEnhance_get_surround: -- :ref:`float` **get_surround** **(** **)** const +- :ref:`float` **get_surround** **(** **)** const .. _class_AudioEffectStereoEnhance_get_time_pullout: -- :ref:`float` **get_time_pullout** **(** **)** const +- :ref:`float` **get_time_pullout** **(** **)** const .. _class_AudioEffectStereoEnhance_set_pan_pullout: -- void **set_pan_pullout** **(** :ref:`float` amount **)** +- void **set_pan_pullout** **(** :ref:`float` amount **)** .. _class_AudioEffectStereoEnhance_set_surround: -- void **set_surround** **(** :ref:`float` amount **)** +- void **set_surround** **(** :ref:`float` amount **)** .. _class_AudioEffectStereoEnhance_set_time_pullout: -- void **set_time_pullout** **(** :ref:`float` amount **)** +- void **set_time_pullout** **(** :ref:`float` amount **)** diff --git a/classes/class_audioserver.rst b/classes/class_audioserver.rst index 93836e51f..01b0721b7 100644 --- a/classes/class_audioserver.rst +++ b/classes/class_audioserver.rst @@ -19,80 +19,80 @@ Server interface for low level audio access. Member Functions ---------------- -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_bus` **(** :ref:`int` at_position=-1 **)** | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_bus_effect` **(** :ref:`int` bus_idx, :ref:`AudioEffect` effect, :ref:`int` at_position=-1 **)** | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AudioBusLayout` | :ref:`generate_bus_layout` **(** **)** const | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_bus_count` **(** **)** const | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AudioEffect` | :ref:`get_bus_effect` **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_bus_effect_count` **(** :ref:`int` bus_idx **)** | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_bus_index` **(** :ref:`String` bus_name **)** const | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_bus_name` **(** :ref:`int` bus_idx **)** const | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_bus_peak_volume_left_db` **(** :ref:`int` bus_idx, :ref:`int` channel **)** const | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_bus_peak_volume_right_db` **(** :ref:`int` bus_idx, :ref:`int` channel **)** const | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_bus_send` **(** :ref:`int` bus_idx **)** const | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_bus_volume_db` **(** :ref:`int` bus_idx **)** const | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_mix_rate` **(** **)** const | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_speaker_mode` **(** **)** const | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_bus_bypassing_effects` **(** :ref:`int` bus_idx **)** const | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_bus_effect_enabled` **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** const | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_bus_mute` **(** :ref:`int` bus_idx **)** const | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_bus_solo` **(** :ref:`int` bus_idx **)** const | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`lock` **(** **)** | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`move_bus` **(** :ref:`int` index, :ref:`int` to_index **)** | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_bus` **(** :ref:`int` index **)** | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_bus_effect` **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bus_bypass_effects` **(** :ref:`int` bus_idx, :ref:`bool` enable **)** | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bus_count` **(** :ref:`int` amount **)** | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bus_effect_enabled` **(** :ref:`int` bus_idx, :ref:`int` effect_idx, :ref:`bool` enabled **)** | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bus_layout` **(** :ref:`AudioBusLayout` bus_layout **)** | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bus_mute` **(** :ref:`int` bus_idx, :ref:`bool` enable **)** | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bus_name` **(** :ref:`int` bus_idx, :ref:`String` name **)** | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bus_send` **(** :ref:`int` bus_idx, :ref:`String` send **)** | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bus_solo` **(** :ref:`int` bus_idx, :ref:`bool` enable **)** | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bus_volume_db` **(** :ref:`int` bus_idx, :ref:`float` volume_db **)** | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`swap_bus_effects` **(** :ref:`int` bus_idx, :ref:`int` effect_idx, :ref:`int` by_effect_idx **)** | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`unlock` **(** **)** | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_bus` **(** :ref:`int` at_position=-1 **)** | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_bus_effect` **(** :ref:`int` bus_idx, :ref:`AudioEffect` effect, :ref:`int` at_position=-1 **)** | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AudioBusLayout` | :ref:`generate_bus_layout` **(** **)** const | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_bus_count` **(** **)** const | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AudioEffect` | :ref:`get_bus_effect` **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_bus_effect_count` **(** :ref:`int` bus_idx **)** | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_bus_index` **(** :ref:`String` bus_name **)** const | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_bus_name` **(** :ref:`int` bus_idx **)** const | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_bus_peak_volume_left_db` **(** :ref:`int` bus_idx, :ref:`int` channel **)** const | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_bus_peak_volume_right_db` **(** :ref:`int` bus_idx, :ref:`int` channel **)** const | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_bus_send` **(** :ref:`int` bus_idx **)** const | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_bus_volume_db` **(** :ref:`int` bus_idx **)** const | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_mix_rate` **(** **)** const | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_speaker_mode` **(** **)** const | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_bus_bypassing_effects` **(** :ref:`int` bus_idx **)** const | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_bus_effect_enabled` **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** const | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_bus_mute` **(** :ref:`int` bus_idx **)** const | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_bus_solo` **(** :ref:`int` bus_idx **)** const | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`lock` **(** **)** | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`move_bus` **(** :ref:`int` index, :ref:`int` to_index **)** | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_bus` **(** :ref:`int` index **)** | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_bus_effect` **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus_bypass_effects` **(** :ref:`int` bus_idx, :ref:`bool` enable **)** | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus_count` **(** :ref:`int` amount **)** | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus_effect_enabled` **(** :ref:`int` bus_idx, :ref:`int` effect_idx, :ref:`bool` enabled **)** | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus_layout` **(** :ref:`AudioBusLayout` bus_layout **)** | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus_mute` **(** :ref:`int` bus_idx, :ref:`bool` enable **)** | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus_name` **(** :ref:`int` bus_idx, :ref:`String` name **)** | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus_send` **(** :ref:`int` bus_idx, :ref:`String` send **)** | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus_solo` **(** :ref:`int` bus_idx, :ref:`bool` enable **)** | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus_volume_db` **(** :ref:`int` bus_idx, :ref:`float` volume_db **)** | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`swap_bus_effects` **(** :ref:`int` bus_idx, :ref:`int` effect_idx, :ref:`int` by_effect_idx **)** | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`unlock` **(** **)** | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_AudioServer_bus_layout_changed: -- **bus_layout_changed** **(** **)** +- **bus_layout_changed** **(** **)** Emitted when the :ref:`AudioBusLayout` changes. @@ -114,199 +114,199 @@ Member Function Description .. _class_AudioServer_add_bus: -- void **add_bus** **(** :ref:`int` at_position=-1 **)** +- void **add_bus** **(** :ref:`int` at_position=-1 **)** Adds a bus at ``at_position``. .. _class_AudioServer_add_bus_effect: -- void **add_bus_effect** **(** :ref:`int` bus_idx, :ref:`AudioEffect` effect, :ref:`int` at_position=-1 **)** +- void **add_bus_effect** **(** :ref:`int` bus_idx, :ref:`AudioEffect` effect, :ref:`int` at_position=-1 **)** Adds an :ref:`AudioEffect` effect to the bus ``bus_idx`` at ``at_position``. .. _class_AudioServer_generate_bus_layout: -- :ref:`AudioBusLayout` **generate_bus_layout** **(** **)** const +- :ref:`AudioBusLayout` **generate_bus_layout** **(** **)** const Generates an :ref:`AudioBusLayout` using the available busses and effects. .. _class_AudioServer_get_bus_count: -- :ref:`int` **get_bus_count** **(** **)** const +- :ref:`int` **get_bus_count** **(** **)** const Returns the number of available busses. .. _class_AudioServer_get_bus_effect: -- :ref:`AudioEffect` **get_bus_effect** **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** +- :ref:`AudioEffect` **get_bus_effect** **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** Returns the :ref:`AudioEffect` at position ``effect_idx`` in bus ``bus_idx``. .. _class_AudioServer_get_bus_effect_count: -- :ref:`int` **get_bus_effect_count** **(** :ref:`int` bus_idx **)** +- :ref:`int` **get_bus_effect_count** **(** :ref:`int` bus_idx **)** Returns the number of effects on the bus at ``bus_idx``. .. _class_AudioServer_get_bus_index: -- :ref:`int` **get_bus_index** **(** :ref:`String` bus_name **)** const +- :ref:`int` **get_bus_index** **(** :ref:`String` bus_name **)** const Returns the index of the bus with the name ``bus_name``. .. _class_AudioServer_get_bus_name: -- :ref:`String` **get_bus_name** **(** :ref:`int` bus_idx **)** const +- :ref:`String` **get_bus_name** **(** :ref:`int` bus_idx **)** const Returns the name of the bus with the index ``bus_idx``. .. _class_AudioServer_get_bus_peak_volume_left_db: -- :ref:`float` **get_bus_peak_volume_left_db** **(** :ref:`int` bus_idx, :ref:`int` channel **)** const +- :ref:`float` **get_bus_peak_volume_left_db** **(** :ref:`int` bus_idx, :ref:`int` channel **)** const Returns the peak volume of the left speaker at bus index ``bus_idx`` and channel index ``channel``. .. _class_AudioServer_get_bus_peak_volume_right_db: -- :ref:`float` **get_bus_peak_volume_right_db** **(** :ref:`int` bus_idx, :ref:`int` channel **)** const +- :ref:`float` **get_bus_peak_volume_right_db** **(** :ref:`int` bus_idx, :ref:`int` channel **)** const Returns the peak volume of the right speaker at bus index ``bus_idx`` and channel index ``channel``. .. _class_AudioServer_get_bus_send: -- :ref:`String` **get_bus_send** **(** :ref:`int` bus_idx **)** const +- :ref:`String` **get_bus_send** **(** :ref:`int` bus_idx **)** const Returns the name of the bus that the bus at index ``bus_idx`` sends to. .. _class_AudioServer_get_bus_volume_db: -- :ref:`float` **get_bus_volume_db** **(** :ref:`int` bus_idx **)** const +- :ref:`float` **get_bus_volume_db** **(** :ref:`int` bus_idx **)** const Returns the volume of the bus at index ``bus_idx`` in dB. .. _class_AudioServer_get_mix_rate: -- :ref:`float` **get_mix_rate** **(** **)** const +- :ref:`float` **get_mix_rate** **(** **)** const Returns the sample rate at the output of the audioserver. .. _class_AudioServer_get_speaker_mode: -- :ref:`int` **get_speaker_mode** **(** **)** const +- :ref:`int` **get_speaker_mode** **(** **)** const Returns the speaker configuration. .. _class_AudioServer_is_bus_bypassing_effects: -- :ref:`bool` **is_bus_bypassing_effects** **(** :ref:`int` bus_idx **)** const +- :ref:`bool` **is_bus_bypassing_effects** **(** :ref:`int` bus_idx **)** const If ``true`` the bus at index ``bus_idx`` is bypassing effects. .. _class_AudioServer_is_bus_effect_enabled: -- :ref:`bool` **is_bus_effect_enabled** **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** const +- :ref:`bool` **is_bus_effect_enabled** **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** const If ``true`` the effect at index ``effect_idx`` on the bus at index ``bus_idx`` is enabled. .. _class_AudioServer_is_bus_mute: -- :ref:`bool` **is_bus_mute** **(** :ref:`int` bus_idx **)** const +- :ref:`bool` **is_bus_mute** **(** :ref:`int` bus_idx **)** const If ``true`` the bus at index ``bus_idx`` is muted. .. _class_AudioServer_is_bus_solo: -- :ref:`bool` **is_bus_solo** **(** :ref:`int` bus_idx **)** const +- :ref:`bool` **is_bus_solo** **(** :ref:`int` bus_idx **)** const If ``true`` the bus at index ``bus_idx`` is in solo mode. .. _class_AudioServer_lock: -- void **lock** **(** **)** +- void **lock** **(** **)** Locks the audio drivers mainloop. Remember to unlock it afterwards. .. _class_AudioServer_move_bus: -- void **move_bus** **(** :ref:`int` index, :ref:`int` to_index **)** +- void **move_bus** **(** :ref:`int` index, :ref:`int` to_index **)** Moves the bus from index ``index`` to index ``to_index``. .. _class_AudioServer_remove_bus: -- void **remove_bus** **(** :ref:`int` index **)** +- void **remove_bus** **(** :ref:`int` index **)** Removes the bus at index ``index``. .. _class_AudioServer_remove_bus_effect: -- void **remove_bus_effect** **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** +- void **remove_bus_effect** **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** Removes the effect at index ``effect_idx`` from the bus at index ``bus_idx``. .. _class_AudioServer_set_bus_bypass_effects: -- void **set_bus_bypass_effects** **(** :ref:`int` bus_idx, :ref:`bool` enable **)** +- void **set_bus_bypass_effects** **(** :ref:`int` bus_idx, :ref:`bool` enable **)** If ``true`` the bus at index ``bus_idx`` is bypassing effects. .. _class_AudioServer_set_bus_count: -- void **set_bus_count** **(** :ref:`int` amount **)** +- void **set_bus_count** **(** :ref:`int` amount **)** Adds and removes busses to make the number of busses match ``amount``. .. _class_AudioServer_set_bus_effect_enabled: -- void **set_bus_effect_enabled** **(** :ref:`int` bus_idx, :ref:`int` effect_idx, :ref:`bool` enabled **)** +- void **set_bus_effect_enabled** **(** :ref:`int` bus_idx, :ref:`int` effect_idx, :ref:`bool` enabled **)** If ``true`` the effect at index ``effect_idx`` on the bus at index ``bus_idx`` is enabled. .. _class_AudioServer_set_bus_layout: -- void **set_bus_layout** **(** :ref:`AudioBusLayout` bus_layout **)** +- void **set_bus_layout** **(** :ref:`AudioBusLayout` bus_layout **)** Overwrites the currently used :ref:`AudioBusLayout`. .. _class_AudioServer_set_bus_mute: -- void **set_bus_mute** **(** :ref:`int` bus_idx, :ref:`bool` enable **)** +- void **set_bus_mute** **(** :ref:`int` bus_idx, :ref:`bool` enable **)** If ``true`` the bus at index ``bus_idx`` is muted. .. _class_AudioServer_set_bus_name: -- void **set_bus_name** **(** :ref:`int` bus_idx, :ref:`String` name **)** +- void **set_bus_name** **(** :ref:`int` bus_idx, :ref:`String` name **)** Sets the name of the bus at index ``bus_idx`` to ``name``. .. _class_AudioServer_set_bus_send: -- void **set_bus_send** **(** :ref:`int` bus_idx, :ref:`String` send **)** +- void **set_bus_send** **(** :ref:`int` bus_idx, :ref:`String` send **)** Connects the output of the bus at ``bus_idx`` to the bus named ``send[/send]. .. _class_AudioServer_set_bus_solo: -- void **set_bus_solo** **(** :ref:`int` bus_idx, :ref:`bool` enable **)** +- void **set_bus_solo** **(** :ref:`int` bus_idx, :ref:`bool` enable **)** If ``true`` the bus at index ``bus_idx`` is in solo mode. .. _class_AudioServer_set_bus_volume_db: -- void **set_bus_volume_db** **(** :ref:`int` bus_idx, :ref:`float` volume_db **)** +- void **set_bus_volume_db** **(** :ref:`int` bus_idx, :ref:`float` volume_db **)** Sets the volume of the bus at index ``bus_idx`` to ``volume_db``. .. _class_AudioServer_swap_bus_effects: -- void **swap_bus_effects** **(** :ref:`int` bus_idx, :ref:`int` effect_idx, :ref:`int` by_effect_idx **)** +- void **swap_bus_effects** **(** :ref:`int` bus_idx, :ref:`int` effect_idx, :ref:`int` by_effect_idx **)** Swaps the position of two effects in bus ``bus_idx``. .. _class_AudioServer_unlock: -- void **unlock** **(** **)** +- void **unlock** **(** **)** Unlocks the audiodriver's main loop. After locking it always unlock it. diff --git a/classes/class_audiostreamoggvorbis.rst b/classes/class_audiostreamoggvorbis.rst index 304a23c31..3878817b9 100644 --- a/classes/class_audiostreamoggvorbis.rst +++ b/classes/class_audiostreamoggvorbis.rst @@ -19,19 +19,19 @@ OGG Vorbis audio stream driver. Member Functions ---------------- -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`get_data` **(** **)** const | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_loop_offset` **(** **)** const | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_loop` **(** **)** const | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_data` **(** :ref:`PoolByteArray` data **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_loop` **(** :ref:`bool` enable **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_loop_offset` **(** :ref:`float` seconds **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`get_data` **(** **)** const | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_loop_offset` **(** **)** const | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_loop` **(** **)** const | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_data` **(** :ref:`PoolByteArray` data **)** | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_loop` **(** :ref:`bool` enable **)** | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_loop_offset` **(** :ref:`float` seconds **)** | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -59,26 +59,26 @@ Member Function Description .. _class_AudioStreamOGGVorbis_get_data: -- :ref:`PoolByteArray` **get_data** **(** **)** const +- :ref:`PoolByteArray` **get_data** **(** **)** const .. _class_AudioStreamOGGVorbis_get_loop_offset: -- :ref:`float` **get_loop_offset** **(** **)** const +- :ref:`float` **get_loop_offset** **(** **)** const .. _class_AudioStreamOGGVorbis_has_loop: -- :ref:`bool` **has_loop** **(** **)** const +- :ref:`bool` **has_loop** **(** **)** const .. _class_AudioStreamOGGVorbis_set_data: -- void **set_data** **(** :ref:`PoolByteArray` data **)** +- void **set_data** **(** :ref:`PoolByteArray` data **)** .. _class_AudioStreamOGGVorbis_set_loop: -- void **set_loop** **(** :ref:`bool` enable **)** +- void **set_loop** **(** :ref:`bool` enable **)** .. _class_AudioStreamOGGVorbis_set_loop_offset: -- void **set_loop_offset** **(** :ref:`float` seconds **)** +- void **set_loop_offset** **(** :ref:`float` seconds **)** diff --git a/classes/class_audiostreamplayer.rst b/classes/class_audiostreamplayer.rst index cca6643c3..ee2b80d88 100644 --- a/classes/class_audiostreamplayer.rst +++ b/classes/class_audiostreamplayer.rst @@ -19,44 +19,44 @@ Plays back audio. Member Functions ---------------- -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_bus` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_mix_target` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_playback_position` **(** **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`AudioStream` | :ref:`get_stream` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_volume_db` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_autoplay_enabled` **(** **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_playing` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`play` **(** :ref:`float` from_position=0.0 **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`seek` **(** :ref:`float` to_position **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_autoplay` **(** :ref:`bool` enable **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bus` **(** :ref:`String` bus **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mix_target` **(** :ref:`int` mix_target **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_stream` **(** :ref:`AudioStream` stream **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_volume_db` **(** :ref:`float` volume_db **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_bus` **(** **)** const | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_mix_target` **(** **)** const | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_playback_position` **(** **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`AudioStream` | :ref:`get_stream` **(** **)** const | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_volume_db` **(** **)** const | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_autoplay_enabled` **(** **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_playing` **(** **)** const | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`play` **(** :ref:`float` from_position=0.0 **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`seek` **(** :ref:`float` to_position **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_autoplay` **(** :ref:`bool` enable **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus` **(** :ref:`String` bus **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_mix_target` **(** :ref:`int` mix_target **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_stream` **(** :ref:`AudioStream` stream **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_volume_db` **(** :ref:`float` volume_db **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_AudioStreamPlayer_finished: -- **finished** **(** **)** +- **finished** **(** **)** Emitted when the audio stops playing. @@ -106,69 +106,69 @@ Member Function Description .. _class_AudioStreamPlayer_get_bus: -- :ref:`String` **get_bus** **(** **)** const +- :ref:`String` **get_bus** **(** **)** const .. _class_AudioStreamPlayer_get_mix_target: -- :ref:`int` **get_mix_target** **(** **)** const +- :ref:`int` **get_mix_target** **(** **)** const .. _class_AudioStreamPlayer_get_playback_position: -- :ref:`float` **get_playback_position** **(** **)** +- :ref:`float` **get_playback_position** **(** **)** Returns the position in the :ref:`AudioStream`. .. _class_AudioStreamPlayer_get_stream: -- :ref:`AudioStream` **get_stream** **(** **)** const +- :ref:`AudioStream` **get_stream** **(** **)** const .. _class_AudioStreamPlayer_get_volume_db: -- :ref:`float` **get_volume_db** **(** **)** const +- :ref:`float` **get_volume_db** **(** **)** const .. _class_AudioStreamPlayer_is_autoplay_enabled: -- :ref:`bool` **is_autoplay_enabled** **(** **)** +- :ref:`bool` **is_autoplay_enabled** **(** **)** .. _class_AudioStreamPlayer_is_playing: -- :ref:`bool` **is_playing** **(** **)** const +- :ref:`bool` **is_playing** **(** **)** const .. _class_AudioStreamPlayer_play: -- void **play** **(** :ref:`float` from_position=0.0 **)** +- void **play** **(** :ref:`float` from_position=0.0 **)** Plays the audio from the given position 'from_position', in seconds. .. _class_AudioStreamPlayer_seek: -- void **seek** **(** :ref:`float` to_position **)** +- void **seek** **(** :ref:`float` to_position **)** Sets the position from which audio will be played, in seconds. .. _class_AudioStreamPlayer_set_autoplay: -- void **set_autoplay** **(** :ref:`bool` enable **)** +- void **set_autoplay** **(** :ref:`bool` enable **)** .. _class_AudioStreamPlayer_set_bus: -- void **set_bus** **(** :ref:`String` bus **)** +- void **set_bus** **(** :ref:`String` bus **)** .. _class_AudioStreamPlayer_set_mix_target: -- void **set_mix_target** **(** :ref:`int` mix_target **)** +- void **set_mix_target** **(** :ref:`int` mix_target **)** .. _class_AudioStreamPlayer_set_stream: -- void **set_stream** **(** :ref:`AudioStream` stream **)** +- void **set_stream** **(** :ref:`AudioStream` stream **)** .. _class_AudioStreamPlayer_set_volume_db: -- void **set_volume_db** **(** :ref:`float` volume_db **)** +- void **set_volume_db** **(** :ref:`float` volume_db **)** .. _class_AudioStreamPlayer_stop: -- void **stop** **(** **)** +- void **stop** **(** **)** Stops the audio. diff --git a/classes/class_audiostreamplayer2d.rst b/classes/class_audiostreamplayer2d.rst index 78058a29c..b5356b34b 100644 --- a/classes/class_audiostreamplayer2d.rst +++ b/classes/class_audiostreamplayer2d.rst @@ -19,52 +19,52 @@ Plays audio in 2D. Member Functions ---------------- -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_area_mask` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_attenuation` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_bus` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_max_distance` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_playback_position` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`AudioStream` | :ref:`get_stream` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_volume_db` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_autoplay_enabled` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_playing` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`play` **(** :ref:`float` from_position=0.0 **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`seek` **(** :ref:`float` to_position **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_area_mask` **(** :ref:`int` mask **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_attenuation` **(** :ref:`float` curve **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_autoplay` **(** :ref:`bool` enable **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bus` **(** :ref:`String` bus **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_max_distance` **(** :ref:`float` pixels **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_stream` **(** :ref:`AudioStream` stream **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_volume_db` **(** :ref:`float` volume_db **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_area_mask` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_attenuation` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_bus` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_max_distance` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_playback_position` **(** **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`AudioStream` | :ref:`get_stream` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_volume_db` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_autoplay_enabled` **(** **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_playing` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`play` **(** :ref:`float` from_position=0.0 **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`seek` **(** :ref:`float` to_position **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_area_mask` **(** :ref:`int` mask **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_attenuation` **(** :ref:`float` curve **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_autoplay` **(** :ref:`bool` enable **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus` **(** :ref:`String` bus **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_max_distance` **(** :ref:`float` pixels **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_stream` **(** :ref:`AudioStream` stream **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_volume_db` **(** :ref:`float` volume_db **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_AudioStreamPlayer2D_finished: -- **finished** **(** **)** +- **finished** **(** **)** Emitted when the audio stops playing. @@ -115,85 +115,85 @@ Member Function Description .. _class_AudioStreamPlayer2D_get_area_mask: -- :ref:`int` **get_area_mask** **(** **)** const +- :ref:`int` **get_area_mask** **(** **)** const .. _class_AudioStreamPlayer2D_get_attenuation: -- :ref:`float` **get_attenuation** **(** **)** const +- :ref:`float` **get_attenuation** **(** **)** const .. _class_AudioStreamPlayer2D_get_bus: -- :ref:`String` **get_bus** **(** **)** const +- :ref:`String` **get_bus** **(** **)** const .. _class_AudioStreamPlayer2D_get_max_distance: -- :ref:`float` **get_max_distance** **(** **)** const +- :ref:`float` **get_max_distance** **(** **)** const .. _class_AudioStreamPlayer2D_get_playback_position: -- :ref:`float` **get_playback_position** **(** **)** +- :ref:`float` **get_playback_position** **(** **)** Returns the position in the :ref:`AudioStream`. .. _class_AudioStreamPlayer2D_get_stream: -- :ref:`AudioStream` **get_stream** **(** **)** const +- :ref:`AudioStream` **get_stream** **(** **)** const .. _class_AudioStreamPlayer2D_get_volume_db: -- :ref:`float` **get_volume_db** **(** **)** const +- :ref:`float` **get_volume_db** **(** **)** const .. _class_AudioStreamPlayer2D_is_autoplay_enabled: -- :ref:`bool` **is_autoplay_enabled** **(** **)** +- :ref:`bool` **is_autoplay_enabled** **(** **)** .. _class_AudioStreamPlayer2D_is_playing: -- :ref:`bool` **is_playing** **(** **)** const +- :ref:`bool` **is_playing** **(** **)** const .. _class_AudioStreamPlayer2D_play: -- void **play** **(** :ref:`float` from_position=0.0 **)** +- void **play** **(** :ref:`float` from_position=0.0 **)** Plays the audio from the given position 'from_position', in seconds. .. _class_AudioStreamPlayer2D_seek: -- void **seek** **(** :ref:`float` to_position **)** +- void **seek** **(** :ref:`float` to_position **)** Sets the position from which audio will be played, in seconds. .. _class_AudioStreamPlayer2D_set_area_mask: -- void **set_area_mask** **(** :ref:`int` mask **)** +- void **set_area_mask** **(** :ref:`int` mask **)** .. _class_AudioStreamPlayer2D_set_attenuation: -- void **set_attenuation** **(** :ref:`float` curve **)** +- void **set_attenuation** **(** :ref:`float` curve **)** .. _class_AudioStreamPlayer2D_set_autoplay: -- void **set_autoplay** **(** :ref:`bool` enable **)** +- void **set_autoplay** **(** :ref:`bool` enable **)** .. _class_AudioStreamPlayer2D_set_bus: -- void **set_bus** **(** :ref:`String` bus **)** +- void **set_bus** **(** :ref:`String` bus **)** .. _class_AudioStreamPlayer2D_set_max_distance: -- void **set_max_distance** **(** :ref:`float` pixels **)** +- void **set_max_distance** **(** :ref:`float` pixels **)** .. _class_AudioStreamPlayer2D_set_stream: -- void **set_stream** **(** :ref:`AudioStream` stream **)** +- void **set_stream** **(** :ref:`AudioStream` stream **)** .. _class_AudioStreamPlayer2D_set_volume_db: -- void **set_volume_db** **(** :ref:`float` volume_db **)** +- void **set_volume_db** **(** :ref:`float` volume_db **)** .. _class_AudioStreamPlayer2D_stop: -- void **stop** **(** **)** +- void **stop** **(** **)** Stops the audio. diff --git a/classes/class_audiostreamplayer3d.rst b/classes/class_audiostreamplayer3d.rst index 2feef0c67..b7b0b21bc 100644 --- a/classes/class_audiostreamplayer3d.rst +++ b/classes/class_audiostreamplayer3d.rst @@ -19,88 +19,88 @@ Plays 3D sound in 3D space Member Functions ---------------- -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_area_mask` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_attenuation_filter_cutoff_hz` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_attenuation_filter_db` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_attenuation_model` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_bus` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_doppler_tracking` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_emission_angle` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_emission_angle_filter_attenuation_db` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_max_db` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_max_distance` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_out_of_range_mode` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_playback_position` **(** **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AudioStream` | :ref:`get_stream` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_unit_db` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_unit_size` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_autoplay_enabled` **(** **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_emission_angle_enabled` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_playing` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`play` **(** :ref:`float` from_position=0.0 **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`seek` **(** :ref:`float` to_position **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_area_mask` **(** :ref:`int` mask **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_attenuation_filter_cutoff_hz` **(** :ref:`float` degrees **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_attenuation_filter_db` **(** :ref:`float` db **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_attenuation_model` **(** :ref:`int` model **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_autoplay` **(** :ref:`bool` enable **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bus` **(** :ref:`String` bus **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_doppler_tracking` **(** :ref:`int` mode **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_emission_angle` **(** :ref:`float` degrees **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_emission_angle_enabled` **(** :ref:`bool` enabled **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_emission_angle_filter_attenuation_db` **(** :ref:`float` db **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_max_db` **(** :ref:`float` max_db **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_max_distance` **(** :ref:`float` metres **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_out_of_range_mode` **(** :ref:`int` mode **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_stream` **(** :ref:`AudioStream` stream **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_unit_db` **(** :ref:`float` unit_db **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_unit_size` **(** :ref:`float` unit_size **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_area_mask` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_attenuation_filter_cutoff_hz` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_attenuation_filter_db` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_attenuation_model` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_bus` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_doppler_tracking` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_emission_angle` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_emission_angle_filter_attenuation_db` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_max_db` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_max_distance` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_out_of_range_mode` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_playback_position` **(** **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AudioStream` | :ref:`get_stream` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_unit_db` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_unit_size` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_autoplay_enabled` **(** **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_emission_angle_enabled` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_playing` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`play` **(** :ref:`float` from_position=0.0 **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`seek` **(** :ref:`float` to_position **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_area_mask` **(** :ref:`int` mask **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_attenuation_filter_cutoff_hz` **(** :ref:`float` degrees **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_attenuation_filter_db` **(** :ref:`float` db **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_attenuation_model` **(** :ref:`int` model **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_autoplay` **(** :ref:`bool` enable **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus` **(** :ref:`String` bus **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_doppler_tracking` **(** :ref:`int` mode **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_emission_angle` **(** :ref:`float` degrees **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_emission_angle_enabled` **(** :ref:`bool` enabled **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_emission_angle_filter_attenuation_db` **(** :ref:`float` db **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_max_db` **(** :ref:`float` max_db **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_max_distance` **(** :ref:`float` metres **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_out_of_range_mode` **(** :ref:`int` mode **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_stream` **(** :ref:`AudioStream` stream **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_unit_db` **(** :ref:`float` unit_db **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_unit_size` **(** :ref:`float` unit_size **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_AudioStreamPlayer3D_finished: -- **finished** **(** **)** +- **finished** **(** **)** Fires when the audio stops playing. @@ -199,157 +199,157 @@ Member Function Description .. _class_AudioStreamPlayer3D_get_area_mask: -- :ref:`int` **get_area_mask** **(** **)** const +- :ref:`int` **get_area_mask** **(** **)** const .. _class_AudioStreamPlayer3D_get_attenuation_filter_cutoff_hz: -- :ref:`float` **get_attenuation_filter_cutoff_hz** **(** **)** const +- :ref:`float` **get_attenuation_filter_cutoff_hz** **(** **)** const .. _class_AudioStreamPlayer3D_get_attenuation_filter_db: -- :ref:`float` **get_attenuation_filter_db** **(** **)** const +- :ref:`float` **get_attenuation_filter_db** **(** **)** const .. _class_AudioStreamPlayer3D_get_attenuation_model: -- :ref:`int` **get_attenuation_model** **(** **)** const +- :ref:`int` **get_attenuation_model** **(** **)** const .. _class_AudioStreamPlayer3D_get_bus: -- :ref:`String` **get_bus** **(** **)** const +- :ref:`String` **get_bus** **(** **)** const .. _class_AudioStreamPlayer3D_get_doppler_tracking: -- :ref:`int` **get_doppler_tracking** **(** **)** const +- :ref:`int` **get_doppler_tracking** **(** **)** const .. _class_AudioStreamPlayer3D_get_emission_angle: -- :ref:`float` **get_emission_angle** **(** **)** const +- :ref:`float` **get_emission_angle** **(** **)** const .. _class_AudioStreamPlayer3D_get_emission_angle_filter_attenuation_db: -- :ref:`float` **get_emission_angle_filter_attenuation_db** **(** **)** const +- :ref:`float` **get_emission_angle_filter_attenuation_db** **(** **)** const .. _class_AudioStreamPlayer3D_get_max_db: -- :ref:`float` **get_max_db** **(** **)** const +- :ref:`float` **get_max_db** **(** **)** const .. _class_AudioStreamPlayer3D_get_max_distance: -- :ref:`float` **get_max_distance** **(** **)** const +- :ref:`float` **get_max_distance** **(** **)** const .. _class_AudioStreamPlayer3D_get_out_of_range_mode: -- :ref:`int` **get_out_of_range_mode** **(** **)** const +- :ref:`int` **get_out_of_range_mode** **(** **)** const .. _class_AudioStreamPlayer3D_get_playback_position: -- :ref:`float` **get_playback_position** **(** **)** +- :ref:`float` **get_playback_position** **(** **)** Returns the position in the :ref:`AudioStream`. .. _class_AudioStreamPlayer3D_get_stream: -- :ref:`AudioStream` **get_stream** **(** **)** const +- :ref:`AudioStream` **get_stream** **(** **)** const .. _class_AudioStreamPlayer3D_get_unit_db: -- :ref:`float` **get_unit_db** **(** **)** const +- :ref:`float` **get_unit_db** **(** **)** const .. _class_AudioStreamPlayer3D_get_unit_size: -- :ref:`float` **get_unit_size** **(** **)** const +- :ref:`float` **get_unit_size** **(** **)** const .. _class_AudioStreamPlayer3D_is_autoplay_enabled: -- :ref:`bool` **is_autoplay_enabled** **(** **)** +- :ref:`bool` **is_autoplay_enabled** **(** **)** .. _class_AudioStreamPlayer3D_is_emission_angle_enabled: -- :ref:`bool` **is_emission_angle_enabled** **(** **)** const +- :ref:`bool` **is_emission_angle_enabled** **(** **)** const .. _class_AudioStreamPlayer3D_is_playing: -- :ref:`bool` **is_playing** **(** **)** const +- :ref:`bool` **is_playing** **(** **)** const .. _class_AudioStreamPlayer3D_play: -- void **play** **(** :ref:`float` from_position=0.0 **)** +- void **play** **(** :ref:`float` from_position=0.0 **)** Plays the audio from the given position 'from_position', in seconds. .. _class_AudioStreamPlayer3D_seek: -- void **seek** **(** :ref:`float` to_position **)** +- void **seek** **(** :ref:`float` to_position **)** Sets the position from which audio will be played, in seconds. .. _class_AudioStreamPlayer3D_set_area_mask: -- void **set_area_mask** **(** :ref:`int` mask **)** +- void **set_area_mask** **(** :ref:`int` mask **)** .. _class_AudioStreamPlayer3D_set_attenuation_filter_cutoff_hz: -- void **set_attenuation_filter_cutoff_hz** **(** :ref:`float` degrees **)** +- void **set_attenuation_filter_cutoff_hz** **(** :ref:`float` degrees **)** .. _class_AudioStreamPlayer3D_set_attenuation_filter_db: -- void **set_attenuation_filter_db** **(** :ref:`float` db **)** +- void **set_attenuation_filter_db** **(** :ref:`float` db **)** .. _class_AudioStreamPlayer3D_set_attenuation_model: -- void **set_attenuation_model** **(** :ref:`int` model **)** +- void **set_attenuation_model** **(** :ref:`int` model **)** .. _class_AudioStreamPlayer3D_set_autoplay: -- void **set_autoplay** **(** :ref:`bool` enable **)** +- void **set_autoplay** **(** :ref:`bool` enable **)** .. _class_AudioStreamPlayer3D_set_bus: -- void **set_bus** **(** :ref:`String` bus **)** +- void **set_bus** **(** :ref:`String` bus **)** .. _class_AudioStreamPlayer3D_set_doppler_tracking: -- void **set_doppler_tracking** **(** :ref:`int` mode **)** +- void **set_doppler_tracking** **(** :ref:`int` mode **)** .. _class_AudioStreamPlayer3D_set_emission_angle: -- void **set_emission_angle** **(** :ref:`float` degrees **)** +- void **set_emission_angle** **(** :ref:`float` degrees **)** .. _class_AudioStreamPlayer3D_set_emission_angle_enabled: -- void **set_emission_angle_enabled** **(** :ref:`bool` enabled **)** +- void **set_emission_angle_enabled** **(** :ref:`bool` enabled **)** .. _class_AudioStreamPlayer3D_set_emission_angle_filter_attenuation_db: -- void **set_emission_angle_filter_attenuation_db** **(** :ref:`float` db **)** +- void **set_emission_angle_filter_attenuation_db** **(** :ref:`float` db **)** .. _class_AudioStreamPlayer3D_set_max_db: -- void **set_max_db** **(** :ref:`float` max_db **)** +- void **set_max_db** **(** :ref:`float` max_db **)** .. _class_AudioStreamPlayer3D_set_max_distance: -- void **set_max_distance** **(** :ref:`float` metres **)** +- void **set_max_distance** **(** :ref:`float` metres **)** .. _class_AudioStreamPlayer3D_set_out_of_range_mode: -- void **set_out_of_range_mode** **(** :ref:`int` mode **)** +- void **set_out_of_range_mode** **(** :ref:`int` mode **)** .. _class_AudioStreamPlayer3D_set_stream: -- void **set_stream** **(** :ref:`AudioStream` stream **)** +- void **set_stream** **(** :ref:`AudioStream` stream **)** .. _class_AudioStreamPlayer3D_set_unit_db: -- void **set_unit_db** **(** :ref:`float` unit_db **)** +- void **set_unit_db** **(** :ref:`float` unit_db **)** .. _class_AudioStreamPlayer3D_set_unit_size: -- void **set_unit_size** **(** :ref:`float` unit_size **)** +- void **set_unit_size** **(** :ref:`float` unit_size **)** .. _class_AudioStreamPlayer3D_stop: -- void **stop** **(** **)** +- void **stop** **(** **)** Stops the audio. diff --git a/classes/class_audiostreamrandompitch.rst b/classes/class_audiostreamrandompitch.rst index 754c1a0cd..003822ca3 100644 --- a/classes/class_audiostreamrandompitch.rst +++ b/classes/class_audiostreamrandompitch.rst @@ -19,15 +19,15 @@ Plays audio with random pitch tweaking. Member Functions ---------------- -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AudioStream` | :ref:`get_audio_stream` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_random_pitch` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_audio_stream` **(** :ref:`AudioStream` stream **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_random_pitch` **(** :ref:`float` scale **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AudioStream` | :ref:`get_audio_stream` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_random_pitch` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_audio_stream` **(** :ref:`AudioStream` stream **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_random_pitch` **(** :ref:`float` scale **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -51,18 +51,18 @@ Member Function Description .. _class_AudioStreamRandomPitch_get_audio_stream: -- :ref:`AudioStream` **get_audio_stream** **(** **)** const +- :ref:`AudioStream` **get_audio_stream** **(** **)** const .. _class_AudioStreamRandomPitch_get_random_pitch: -- :ref:`float` **get_random_pitch** **(** **)** const +- :ref:`float` **get_random_pitch** **(** **)** const .. _class_AudioStreamRandomPitch_set_audio_stream: -- void **set_audio_stream** **(** :ref:`AudioStream` stream **)** +- void **set_audio_stream** **(** :ref:`AudioStream` stream **)** .. _class_AudioStreamRandomPitch_set_random_pitch: -- void **set_random_pitch** **(** :ref:`float` scale **)** +- void **set_random_pitch** **(** :ref:`float` scale **)** diff --git a/classes/class_audiostreamsample.rst b/classes/class_audiostreamsample.rst index 023d1b4cd..394fed1b5 100644 --- a/classes/class_audiostreamsample.rst +++ b/classes/class_audiostreamsample.rst @@ -19,35 +19,35 @@ Plays audio. Member Functions ---------------- -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`get_data` **(** **)** const | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_format` **(** **)** const | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_loop_begin` **(** **)** const | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_loop_end` **(** **)** const | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_loop_mode` **(** **)** const | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_mix_rate` **(** **)** const | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_stereo` **(** **)** const | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_data` **(** :ref:`PoolByteArray` data **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_format` **(** :ref:`int` format **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_loop_begin` **(** :ref:`int` loop_begin **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_loop_end` **(** :ref:`int` loop_end **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_loop_mode` **(** :ref:`int` loop_mode **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mix_rate` **(** :ref:`int` mix_rate **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_stereo` **(** :ref:`bool` stereo **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`get_data` **(** **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_format` **(** **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_loop_begin` **(** **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_loop_end` **(** **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_loop_mode` **(** **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_mix_rate` **(** **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_stereo` **(** **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_data` **(** :ref:`PoolByteArray` data **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_format` **(** :ref:`int` format **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_loop_begin` **(** :ref:`int` loop_begin **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_loop_end` **(** :ref:`int` loop_end **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_loop_mode` **(** :ref:`int` loop_mode **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_mix_rate` **(** :ref:`int` mix_rate **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_stereo` **(** :ref:`bool` stereo **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -101,58 +101,58 @@ Member Function Description .. _class_AudioStreamSample_get_data: -- :ref:`PoolByteArray` **get_data** **(** **)** const +- :ref:`PoolByteArray` **get_data** **(** **)** const .. _class_AudioStreamSample_get_format: -- :ref:`int` **get_format** **(** **)** const +- :ref:`int` **get_format** **(** **)** const .. _class_AudioStreamSample_get_loop_begin: -- :ref:`int` **get_loop_begin** **(** **)** const +- :ref:`int` **get_loop_begin** **(** **)** const .. _class_AudioStreamSample_get_loop_end: -- :ref:`int` **get_loop_end** **(** **)** const +- :ref:`int` **get_loop_end** **(** **)** const .. _class_AudioStreamSample_get_loop_mode: -- :ref:`int` **get_loop_mode** **(** **)** const +- :ref:`int` **get_loop_mode** **(** **)** const .. _class_AudioStreamSample_get_mix_rate: -- :ref:`int` **get_mix_rate** **(** **)** const +- :ref:`int` **get_mix_rate** **(** **)** const .. _class_AudioStreamSample_is_stereo: -- :ref:`bool` **is_stereo** **(** **)** const +- :ref:`bool` **is_stereo** **(** **)** const .. _class_AudioStreamSample_set_data: -- void **set_data** **(** :ref:`PoolByteArray` data **)** +- void **set_data** **(** :ref:`PoolByteArray` data **)** .. _class_AudioStreamSample_set_format: -- void **set_format** **(** :ref:`int` format **)** +- void **set_format** **(** :ref:`int` format **)** .. _class_AudioStreamSample_set_loop_begin: -- void **set_loop_begin** **(** :ref:`int` loop_begin **)** +- void **set_loop_begin** **(** :ref:`int` loop_begin **)** .. _class_AudioStreamSample_set_loop_end: -- void **set_loop_end** **(** :ref:`int` loop_end **)** +- void **set_loop_end** **(** :ref:`int` loop_end **)** .. _class_AudioStreamSample_set_loop_mode: -- void **set_loop_mode** **(** :ref:`int` loop_mode **)** +- void **set_loop_mode** **(** :ref:`int` loop_mode **)** .. _class_AudioStreamSample_set_mix_rate: -- void **set_mix_rate** **(** :ref:`int` mix_rate **)** +- void **set_mix_rate** **(** :ref:`int` mix_rate **)** .. _class_AudioStreamSample_set_stereo: -- void **set_stereo** **(** :ref:`bool` stereo **)** +- void **set_stereo** **(** :ref:`bool` stereo **)** diff --git a/classes/class_backbuffercopy.rst b/classes/class_backbuffercopy.rst index 4ce8886fa..f8f49ce20 100644 --- a/classes/class_backbuffercopy.rst +++ b/classes/class_backbuffercopy.rst @@ -19,15 +19,15 @@ Copies a region of the screen (or the whole screen) to a buffer so it can be acc Member Functions ---------------- -+----------------------------+--------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_copy_mode` **(** **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_rect` **(** **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_copy_mode` **(** :ref:`int` copy_mode **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rect` **(** :ref:`Rect2` rect **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------+ ++----------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_copy_mode` **(** **)** const | ++----------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_rect` **(** **)** const | ++----------------------------+------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_copy_mode` **(** :ref:`int` copy_mode **)** | ++----------------------------+------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rect` **(** :ref:`Rect2` rect **)** | ++----------------------------+------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -58,25 +58,25 @@ Member Function Description .. _class_BackBufferCopy_get_copy_mode: -- :ref:`int` **get_copy_mode** **(** **)** const +- :ref:`int` **get_copy_mode** **(** **)** const Return the copy mode currently applied to the BackBufferCopy. See ``COPY_MODE\_\*`` constants. .. _class_BackBufferCopy_get_rect: -- :ref:`Rect2` **get_rect** **(** **)** const +- :ref:`Rect2` **get_rect** **(** **)** const Return the area covered by the BackBufferCopy. .. _class_BackBufferCopy_set_copy_mode: -- void **set_copy_mode** **(** :ref:`int` copy_mode **)** +- void **set_copy_mode** **(** :ref:`int` copy_mode **)** Set the copy mode of the BackBufferCopy. See ``COPY_MODE\_\*`` constants. .. _class_BackBufferCopy_set_rect: -- void **set_rect** **(** :ref:`Rect2` rect **)** +- void **set_rect** **(** :ref:`Rect2` rect **)** Defines the area covered by the BackBufferCopy. diff --git a/classes/class_basebutton.rst b/classes/class_basebutton.rst index 8aac58831..92542ceba 100644 --- a/classes/class_basebutton.rst +++ b/classes/class_basebutton.rst @@ -21,68 +21,68 @@ Provides a base class for different kinds of buttons. Member Functions ---------------- -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_pressed` **(** **)** virtual | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_toggled` **(** :ref:`bool` pressed **)** virtual | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_action_mode` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ButtonGroup` | :ref:`get_button_group` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_draw_mode` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_enabled_focus_mode` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ShortCut` | :ref:`get_shortcut` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_disabled` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_hovered` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_pressed` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_toggle_mode` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_action_mode` **(** :ref:`int` mode **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_button_group` **(** :ref:`ButtonGroup` button_group **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_disabled` **(** :ref:`bool` disabled **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_enabled_focus_mode` **(** :ref:`int` mode **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pressed` **(** :ref:`bool` pressed **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shortcut` **(** :ref:`ShortCut` shortcut **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_toggle_mode` **(** :ref:`bool` enabled **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_pressed` **(** **)** virtual | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_toggled` **(** :ref:`bool` pressed **)** virtual | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_action_mode` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ButtonGroup` | :ref:`get_button_group` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_draw_mode` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_enabled_focus_mode` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ShortCut` | :ref:`get_shortcut` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_disabled` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_hovered` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_pressed` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_toggle_mode` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_action_mode` **(** :ref:`int` mode **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_button_group` **(** :ref:`ButtonGroup` button_group **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_disabled` **(** :ref:`bool` disabled **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_enabled_focus_mode` **(** :ref:`int` mode **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pressed` **(** :ref:`bool` pressed **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shortcut` **(** :ref:`ShortCut` shortcut **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_toggle_mode` **(** :ref:`bool` enabled **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_BaseButton_button_down: -- **button_down** **(** **)** +- **button_down** **(** **)** Emitted when the button starts being held down. .. _class_BaseButton_button_up: -- **button_up** **(** **)** +- **button_up** **(** **)** Emitted when the button stops being held down. .. _class_BaseButton_pressed: -- **pressed** **(** **)** +- **pressed** **(** **)** This signal is emitted every time the button is toggled or pressed (i.e. activated, so on ``button_down`` if "Click on press" is active and on ``button_up`` otherwise). .. _class_BaseButton_toggled: -- **toggled** **(** :ref:`bool` pressed **)** +- **toggled** **(** :ref:`bool` pressed **)** This signal is emitted when the button was just toggled between pressed and normal states (only if toggle_mode is active). The new state is contained in the *pressed* argument. @@ -139,101 +139,101 @@ Member Function Description .. _class_BaseButton__pressed: -- void **_pressed** **(** **)** virtual +- void **_pressed** **(** **)** virtual Called when button is pressed. .. _class_BaseButton__toggled: -- void **_toggled** **(** :ref:`bool` pressed **)** virtual +- void **_toggled** **(** :ref:`bool` pressed **)** virtual Called when button is toggled (only if toggle_mode is active). .. _class_BaseButton_get_action_mode: -- :ref:`int` **get_action_mode** **(** **)** const +- :ref:`int` **get_action_mode** **(** **)** const Return the current mode of action (see :ref:`set_action_mode`) (one of the ACTION_MODE\_\* constants). .. _class_BaseButton_get_button_group: -- :ref:`ButtonGroup` **get_button_group** **(** **)** const +- :ref:`ButtonGroup` **get_button_group** **(** **)** const .. _class_BaseButton_get_draw_mode: -- :ref:`int` **get_draw_mode** **(** **)** const +- :ref:`int` **get_draw_mode** **(** **)** const Return the visual state used to draw the button. This is useful mainly when implementing your own draw code by either overriding _draw() or connecting to "draw" signal. The visual state of the button is defined by the DRAW\_\* enum. .. _class_BaseButton_get_enabled_focus_mode: -- :ref:`int` **get_enabled_focus_mode** **(** **)** const +- :ref:`int` **get_enabled_focus_mode** **(** **)** const Returns focus access mode used when switching between enabled/disabled (see :ref:`Control.set_focus_mode` and :ref:`set_disabled`). .. _class_BaseButton_get_shortcut: -- :ref:`ShortCut` **get_shortcut** **(** **)** const +- :ref:`ShortCut` **get_shortcut** **(** **)** const .. _class_BaseButton_is_disabled: -- :ref:`bool` **is_disabled** **(** **)** const +- :ref:`bool` **is_disabled** **(** **)** const Return whether the button is in disabled state (see :ref:`set_disabled`). .. _class_BaseButton_is_hovered: -- :ref:`bool` **is_hovered** **(** **)** const +- :ref:`bool` **is_hovered** **(** **)** const Return true if mouse entered the button before it exit. .. _class_BaseButton_is_pressed: -- :ref:`bool` **is_pressed** **(** **)** const +- :ref:`bool` **is_pressed** **(** **)** const If toggle_mode is active, return whether the button is toggled. If toggle_mode is not active, return whether the button is pressed down. .. _class_BaseButton_is_toggle_mode: -- :ref:`bool` **is_toggle_mode** **(** **)** const +- :ref:`bool` **is_toggle_mode** **(** **)** const Return the toggle_mode property (see :ref:`set_toggle_mode`). .. _class_BaseButton_set_action_mode: -- void **set_action_mode** **(** :ref:`int` mode **)** +- void **set_action_mode** **(** :ref:`int` mode **)** Set the current mode of action, determining when the button is considered clicked (see the ACTION_MODE\_\* constants). .. _class_BaseButton_set_button_group: -- void **set_button_group** **(** :ref:`ButtonGroup` button_group **)** +- void **set_button_group** **(** :ref:`ButtonGroup` button_group **)** .. _class_BaseButton_set_disabled: -- void **set_disabled** **(** :ref:`bool` disabled **)** +- void **set_disabled** **(** :ref:`bool` disabled **)** Set the button into disabled state. When a button is disabled, it can't be clicked or toggled. .. _class_BaseButton_set_enabled_focus_mode: -- void **set_enabled_focus_mode** **(** :ref:`int` mode **)** +- void **set_enabled_focus_mode** **(** :ref:`int` mode **)** Sets the focus access mode to use when switching between enabled/disabled (see :ref:`Control.set_focus_mode` and :ref:`set_disabled`). .. _class_BaseButton_set_pressed: -- void **set_pressed** **(** :ref:`bool` pressed **)** +- void **set_pressed** **(** :ref:`bool` pressed **)** Set the button to pressed state (only if toggle_mode is active). .. _class_BaseButton_set_shortcut: -- void **set_shortcut** **(** :ref:`ShortCut` shortcut **)** +- void **set_shortcut** **(** :ref:`ShortCut` shortcut **)** .. _class_BaseButton_set_toggle_mode: -- void **set_toggle_mode** **(** :ref:`bool` enabled **)** +- void **set_toggle_mode** **(** :ref:`bool` enabled **)** Set the button toggle_mode property. Toggle mode makes the button flip state between pressed and unpressed each time its area is clicked. diff --git a/classes/class_basis.rst b/classes/class_basis.rst index c13bc1223..5dc9da888 100644 --- a/classes/class_basis.rst +++ b/classes/class_basis.rst @@ -17,43 +17,43 @@ Brief Description Member Functions ---------------- -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`Basis` **(** :ref:`Quat` from **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`Basis` **(** :ref:`Vector3` euler **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`Basis` **(** :ref:`Vector3` axis, :ref:`float` phi **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`Basis` **(** :ref:`Vector3` x_axis, :ref:`Vector3` y_axis, :ref:`Vector3` z_axis **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`determinant` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_euler` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_orthogonal_index` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_scale` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`inverse` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`orthonormalized` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`rotated` **(** :ref:`Vector3` axis, :ref:`float` phi **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`scaled` **(** :ref:`Vector3` scale **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`tdotx` **(** :ref:`Vector3` with **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`tdoty` **(** :ref:`Vector3` with **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`tdotz` **(** :ref:`Vector3` with **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`transposed` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`xform` **(** :ref:`Vector3` v **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`xform_inv` **(** :ref:`Vector3` v **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`Basis` **(** :ref:`Quat` from **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`Basis` **(** :ref:`Vector3` euler **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`Basis` **(** :ref:`Vector3` axis, :ref:`float` phi **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`Basis` **(** :ref:`Vector3` x_axis, :ref:`Vector3` y_axis, :ref:`Vector3` z_axis **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`determinant` **(** **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_euler` **(** **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_orthogonal_index` **(** **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_scale` **(** **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`inverse` **(** **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`orthonormalized` **(** **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`rotated` **(** :ref:`Vector3` axis, :ref:`float` phi **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`scaled` **(** :ref:`Vector3` scale **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`tdotx` **(** :ref:`Vector3` with **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`tdoty` **(** :ref:`Vector3` with **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`tdotz` **(** :ref:`Vector3` with **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`transposed` **(** **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`xform` **(** :ref:`Vector3` v **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`xform_inv` **(** :ref:`Vector3` v **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -83,109 +83,109 @@ Member Function Description .. _class_Basis_Basis: -- :ref:`Basis` **Basis** **(** :ref:`Quat` from **)** +- :ref:`Basis` **Basis** **(** :ref:`Quat` from **)** Create a rotation matrix from the given quaternion. .. _class_Basis_Basis: -- :ref:`Basis` **Basis** **(** :ref:`Vector3` euler **)** +- :ref:`Basis` **Basis** **(** :ref:`Vector3` euler **)** Create a rotation matrix (in the YXZ convention: first Z, then X, and Y last) from the specified Euler angles, given in the vector format as (X-angle, Y-angle, Z-angle). .. _class_Basis_Basis: -- :ref:`Basis` **Basis** **(** :ref:`Vector3` axis, :ref:`float` phi **)** +- :ref:`Basis` **Basis** **(** :ref:`Vector3` axis, :ref:`float` phi **)** Create a rotation matrix which rotates around the given axis by the specified angle. The axis must be a normalized vector. .. _class_Basis_Basis: -- :ref:`Basis` **Basis** **(** :ref:`Vector3` x_axis, :ref:`Vector3` y_axis, :ref:`Vector3` z_axis **)** +- :ref:`Basis` **Basis** **(** :ref:`Vector3` x_axis, :ref:`Vector3` y_axis, :ref:`Vector3` z_axis **)** Create a matrix from 3 axis vectors. .. _class_Basis_determinant: -- :ref:`float` **determinant** **(** **)** +- :ref:`float` **determinant** **(** **)** Return the determinant of the matrix. .. _class_Basis_get_euler: -- :ref:`Vector3` **get_euler** **(** **)** +- :ref:`Vector3` **get_euler** **(** **)** Assuming that the matrix is a proper rotation matrix (orthonormal matrix with determinant +1), return Euler angles (in the YXZ convention: first Z, then X, and Y last). Returned vector contains the rotation angles in the format (X-angle, Y-angle, Z-angle). .. _class_Basis_get_orthogonal_index: -- :ref:`int` **get_orthogonal_index** **(** **)** +- :ref:`int` **get_orthogonal_index** **(** **)** This function considers a discretization of rotations into 24 points on unit sphere, lying along the vectors (x,y,z) with each component being either -1,0 or 1, and returns the index of the point best representing the orientation of the object. It is mainly used by the grid map editor. For further details, refer to Godot source code. .. _class_Basis_get_scale: -- :ref:`Vector3` **get_scale** **(** **)** +- :ref:`Vector3` **get_scale** **(** **)** Assuming that the matrix is the combination of a rotation and scaling, return the absolute value of scaling factors along each axis. .. _class_Basis_inverse: -- :ref:`Basis` **inverse** **(** **)** +- :ref:`Basis` **inverse** **(** **)** Return the inverse of the matrix. .. _class_Basis_orthonormalized: -- :ref:`Basis` **orthonormalized** **(** **)** +- :ref:`Basis` **orthonormalized** **(** **)** Return the orthonormalized version of the matrix (useful to call from time to time to avoid rounding error for orthogonal matrices). This performs a Gram-Schmidt orthonormalization on the basis of the matrix. .. _class_Basis_rotated: -- :ref:`Basis` **rotated** **(** :ref:`Vector3` axis, :ref:`float` phi **)** +- :ref:`Basis` **rotated** **(** :ref:`Vector3` axis, :ref:`float` phi **)** Introduce an additional rotation around the given axis by phi (radians). Only relevant when the matrix is being used as a part of :ref:`Transform`. The axis must be a normalized vector. .. _class_Basis_scaled: -- :ref:`Basis` **scaled** **(** :ref:`Vector3` scale **)** +- :ref:`Basis` **scaled** **(** :ref:`Vector3` scale **)** Introduce an additional scaling specified by the given 3D scaling factor. Only relevant when the matrix is being used as a part of :ref:`Transform`. .. _class_Basis_tdotx: -- :ref:`float` **tdotx** **(** :ref:`Vector3` with **)** +- :ref:`float` **tdotx** **(** :ref:`Vector3` with **)** Transposed dot product with the x axis of the matrix. .. _class_Basis_tdoty: -- :ref:`float` **tdoty** **(** :ref:`Vector3` with **)** +- :ref:`float` **tdoty** **(** :ref:`Vector3` with **)** Transposed dot product with the y axis of the matrix. .. _class_Basis_tdotz: -- :ref:`float` **tdotz** **(** :ref:`Vector3` with **)** +- :ref:`float` **tdotz** **(** :ref:`Vector3` with **)** Transposed dot product with the z axis of the matrix. .. _class_Basis_transposed: -- :ref:`Basis` **transposed** **(** **)** +- :ref:`Basis` **transposed** **(** **)** Return the transposed version of the matrix. .. _class_Basis_xform: -- :ref:`Vector3` **xform** **(** :ref:`Vector3` v **)** +- :ref:`Vector3` **xform** **(** :ref:`Vector3` v **)** Return a vector transformed (multiplied) by the matrix. .. _class_Basis_xform_inv: -- :ref:`Vector3` **xform_inv** **(** :ref:`Vector3` v **)** +- :ref:`Vector3` **xform_inv** **(** :ref:`Vector3` v **)** Return a vector transformed (multiplied) by the transposed matrix. Note that this results in a multiplication by the inverse of the matrix only if it represents a rotation-reflection. diff --git a/classes/class_bitmap.rst b/classes/class_bitmap.rst index 2fe1dd749..d2949a0e7 100644 --- a/classes/class_bitmap.rst +++ b/classes/class_bitmap.rst @@ -19,21 +19,21 @@ Boolean matrix. Member Functions ---------------- -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create` **(** :ref:`Vector2` size **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_from_image_alpha` **(** :ref:`Image` image **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_bit` **(** :ref:`Vector2` position **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_size` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_true_bit_count` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bit` **(** :ref:`Vector2` position, :ref:`bool` bit **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bit_rect` **(** :ref:`Rect2` p_rect, :ref:`bool` bit **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create` **(** :ref:`Vector2` size **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create_from_image_alpha` **(** :ref:`Image` image **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_bit` **(** :ref:`Vector2` position **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_size` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_true_bit_count` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bit` **(** :ref:`Vector2` position, :ref:`bool` bit **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bit_rect` **(** :ref:`Rect2` p_rect, :ref:`bool` bit **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -57,43 +57,43 @@ Member Function Description .. _class_BitMap_create: -- void **create** **(** :ref:`Vector2` size **)** +- void **create** **(** :ref:`Vector2` size **)** Creates a bitmap with the specified size, filled with false. .. _class_BitMap_create_from_image_alpha: -- void **create_from_image_alpha** **(** :ref:`Image` image **)** +- void **create_from_image_alpha** **(** :ref:`Image` image **)** Creates a bitmap that matches the given image dimensions, every element of the bitmap is set to false if the alpha value of the image at that position is 0, and true in other case. .. _class_BitMap_get_bit: -- :ref:`bool` **get_bit** **(** :ref:`Vector2` position **)** const +- :ref:`bool` **get_bit** **(** :ref:`Vector2` position **)** const Returns bitmap's value at the specified position. .. _class_BitMap_get_size: -- :ref:`Vector2` **get_size** **(** **)** const +- :ref:`Vector2` **get_size** **(** **)** const Returns bitmap's dimensions. .. _class_BitMap_get_true_bit_count: -- :ref:`int` **get_true_bit_count** **(** **)** const +- :ref:`int` **get_true_bit_count** **(** **)** const Returns the amount of bitmap elements that are set to true. .. _class_BitMap_set_bit: -- void **set_bit** **(** :ref:`Vector2` position, :ref:`bool` bit **)** +- void **set_bit** **(** :ref:`Vector2` position, :ref:`bool` bit **)** Sets the bitmap's element at the specified position, to the specified value. .. _class_BitMap_set_bit_rect: -- void **set_bit_rect** **(** :ref:`Rect2` p_rect, :ref:`bool` bit **)** +- void **set_bit_rect** **(** :ref:`Rect2` p_rect, :ref:`bool` bit **)** Sets a rectangular portion of the bitmap to the specified value. diff --git a/classes/class_bitmapfont.rst b/classes/class_bitmapfont.rst index 07dad619d..1a40facad 100644 --- a/classes/class_bitmapfont.rst +++ b/classes/class_bitmapfont.rst @@ -19,35 +19,35 @@ Renders text using ``\*.fnt`` fonts. Member Functions ---------------- -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_char` **(** :ref:`int` character, :ref:`int` texture, :ref:`Rect2` rect, :ref:`Vector2` align=Vector2( 0, 0 ), :ref:`float` advance=-1 **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_kerning_pair` **(** :ref:`int` char_a, :ref:`int` char_b, :ref:`int` kerning **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_texture` **(** :ref:`Texture` texture **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`create_from_fnt` **(** :ref:`String` path **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_char_size` **(** :ref:`int` char, :ref:`int` next=0 **)** const | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`BitmapFont` | :ref:`get_fallback` **(** **)** const | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_kerning_pair` **(** :ref:`int` char_a, :ref:`int` char_b **)** const | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_texture` **(** :ref:`int` idx **)** const | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_texture_count` **(** **)** const | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ascent` **(** :ref:`float` px **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_distance_field_hint` **(** :ref:`bool` enable **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fallback` **(** :ref:`BitmapFont` fallback **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_height` **(** :ref:`float` px **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_char` **(** :ref:`int` character, :ref:`int` texture, :ref:`Rect2` rect, :ref:`Vector2` align=Vector2( 0, 0 ), :ref:`float` advance=-1 **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_kerning_pair` **(** :ref:`int` char_a, :ref:`int` char_b, :ref:`int` kerning **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_texture` **(** :ref:`Texture` texture **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`create_from_fnt` **(** :ref:`String` path **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_char_size` **(** :ref:`int` char, :ref:`int` next=0 **)** const | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`BitmapFont` | :ref:`get_fallback` **(** **)** const | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_kerning_pair` **(** :ref:`int` char_a, :ref:`int` char_b **)** const | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_texture` **(** :ref:`int` idx **)** const | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_texture_count` **(** **)** const | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ascent` **(** :ref:`float` px **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_distance_field_hint` **(** :ref:`bool` enable **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fallback` **(** :ref:`BitmapFont` fallback **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_height` **(** :ref:`float` px **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -91,85 +91,85 @@ Member Function Description .. _class_BitmapFont_add_char: -- void **add_char** **(** :ref:`int` character, :ref:`int` texture, :ref:`Rect2` rect, :ref:`Vector2` align=Vector2( 0, 0 ), :ref:`float` advance=-1 **)** +- void **add_char** **(** :ref:`int` character, :ref:`int` texture, :ref:`Rect2` rect, :ref:`Vector2` align=Vector2( 0, 0 ), :ref:`float` advance=-1 **)** Adds a character to the font, where ``character`` is the unicode value, ``texture`` is the texture index, ``rect`` is the region in the texture (in pixels!), ``align`` is the (optional) alignment for the character and ``advance`` is the (optional) advance. .. _class_BitmapFont_add_kerning_pair: -- void **add_kerning_pair** **(** :ref:`int` char_a, :ref:`int` char_b, :ref:`int` kerning **)** +- void **add_kerning_pair** **(** :ref:`int` char_a, :ref:`int` char_b, :ref:`int` kerning **)** Adds a kerning pair to the :ref:`BitmapFont` as a difference. Kerning pairs are special cases where a typeface advance is determined by the next character. .. _class_BitmapFont_add_texture: -- void **add_texture** **(** :ref:`Texture` texture **)** +- void **add_texture** **(** :ref:`Texture` texture **)** Adds a texture to the :ref:`BitmapFont`. .. _class_BitmapFont_clear: -- void **clear** **(** **)** +- void **clear** **(** **)** Clears all the font data and settings. .. _class_BitmapFont_create_from_fnt: -- :ref:`int` **create_from_fnt** **(** :ref:`String` path **)** +- :ref:`int` **create_from_fnt** **(** :ref:`String` path **)** Creates a BitmapFont from the ``\*.fnt`` file at ``path``. .. _class_BitmapFont_get_char_size: -- :ref:`Vector2` **get_char_size** **(** :ref:`int` char, :ref:`int` next=0 **)** const +- :ref:`Vector2` **get_char_size** **(** :ref:`int` char, :ref:`int` next=0 **)** const Returns the size of a character, optionally taking kerning into account if the next character is provided. .. _class_BitmapFont_get_fallback: -- :ref:`BitmapFont` **get_fallback** **(** **)** const +- :ref:`BitmapFont` **get_fallback** **(** **)** const Returns the fallback BitmapFont. .. _class_BitmapFont_get_kerning_pair: -- :ref:`int` **get_kerning_pair** **(** :ref:`int` char_a, :ref:`int` char_b **)** const +- :ref:`int` **get_kerning_pair** **(** :ref:`int` char_a, :ref:`int` char_b **)** const Returns a kerning pair as a difference. .. _class_BitmapFont_get_texture: -- :ref:`Texture` **get_texture** **(** :ref:`int` idx **)** const +- :ref:`Texture` **get_texture** **(** :ref:`int` idx **)** const Returns the font atlas texture at index ``idx``. .. _class_BitmapFont_get_texture_count: -- :ref:`int` **get_texture_count** **(** **)** const +- :ref:`int` **get_texture_count** **(** **)** const Returns the number of textures in the BitmapFont atlas. .. _class_BitmapFont_set_ascent: -- void **set_ascent** **(** :ref:`float` px **)** +- void **set_ascent** **(** :ref:`float` px **)** Sets the font ascent (number of pixels above the baseline). .. _class_BitmapFont_set_distance_field_hint: -- void **set_distance_field_hint** **(** :ref:`bool` enable **)** +- void **set_distance_field_hint** **(** :ref:`bool` enable **)** If ``true`` distance field hint is enabled. .. _class_BitmapFont_set_fallback: -- void **set_fallback** **(** :ref:`BitmapFont` fallback **)** +- void **set_fallback** **(** :ref:`BitmapFont` fallback **)** Sets the fallback BitmapFont. .. _class_BitmapFont_set_height: -- void **set_height** **(** :ref:`float` px **)** +- void **set_height** **(** :ref:`float` px **)** Sets the total font height (ascent plus descent) in pixels. diff --git a/classes/class_boneattachment.rst b/classes/class_boneattachment.rst index 609ece128..c1509a604 100644 --- a/classes/class_boneattachment.rst +++ b/classes/class_boneattachment.rst @@ -19,11 +19,11 @@ A node that will attach to a bone. Member Functions ---------------- -+------------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_bone_name` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bone_name` **(** :ref:`String` bone_name **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------+ ++------------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_bone_name` **(** **)** const | ++------------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bone_name` **(** :ref:`String` bone_name **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -35,13 +35,13 @@ Member Function Description .. _class_BoneAttachment_get_bone_name: -- :ref:`String` **get_bone_name** **(** **)** const +- :ref:`String` **get_bone_name** **(** **)** const Returns the name of the bone node attached to. .. _class_BoneAttachment_set_bone_name: -- void **set_bone_name** **(** :ref:`String` bone_name **)** +- void **set_bone_name** **(** :ref:`String` bone_name **)** Changes the name of the bone node diff --git a/classes/class_bool.rst b/classes/class_bool.rst index 988ccd20b..a5ebb4517 100644 --- a/classes/class_bool.rst +++ b/classes/class_bool.rst @@ -17,13 +17,13 @@ Boolean built-in type Member Functions ---------------- -+--------------------------+-----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`bool` **(** :ref:`int` from **)** | -+--------------------------+-----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`bool` **(** :ref:`float` from **)** | -+--------------------------+-----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`bool` **(** :ref:`String` from **)** | -+--------------------------+-----------------------------------------------------------------------------+ ++--------------------------+---------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`bool` **(** :ref:`int` from **)** | ++--------------------------+---------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`bool` **(** :ref:`float` from **)** | ++--------------------------+---------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`bool` **(** :ref:`String` from **)** | ++--------------------------+---------------------------------------------------------------------------+ Description ----------- @@ -35,19 +35,19 @@ Member Function Description .. _class_bool_bool: -- :ref:`bool` **bool** **(** :ref:`int` from **)** +- :ref:`bool` **bool** **(** :ref:`int` from **)** Cast an :ref:`int` value to a boolean value, this method will return true if called with an integer value different to 0 and false in other case. .. _class_bool_bool: -- :ref:`bool` **bool** **(** :ref:`float` from **)** +- :ref:`bool` **bool** **(** :ref:`float` from **)** Cast a :ref:`float` value to a boolean value, this method will return true if called with a floating point value different to 0 and false in other case. .. _class_bool_bool: -- :ref:`bool` **bool** **(** :ref:`String` from **)** +- :ref:`bool` **bool** **(** :ref:`String` from **)** Cast a :ref:`String` value to a boolean value, this method will return true if called with a non empty string and false in other case. Examples: ``bool('False')`` returns true, ``bool('')``. returns false diff --git a/classes/class_boxcontainer.rst b/classes/class_boxcontainer.rst index fae210003..ee771b9e3 100644 --- a/classes/class_boxcontainer.rst +++ b/classes/class_boxcontainer.rst @@ -21,13 +21,13 @@ Base class for box containers. Member Functions ---------------- -+------------------------+------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_spacer` **(** :ref:`bool` begin **)** | -+------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_alignment` **(** **)** const | -+------------------------+------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_alignment` **(** :ref:`int` alignment **)** | -+------------------------+------------------------------------------------------------------------------------------------------+ ++------------------------+----------------------------------------------------------------------------------------------------+ +| void | :ref:`add_spacer` **(** :ref:`bool` begin **)** | ++------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_alignment` **(** **)** const | ++------------------------+----------------------------------------------------------------------------------------------------+ +| void | :ref:`set_alignment` **(** :ref:`int` alignment **)** | ++------------------------+----------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -54,19 +54,19 @@ Member Function Description .. _class_BoxContainer_add_spacer: -- void **add_spacer** **(** :ref:`bool` begin **)** +- void **add_spacer** **(** :ref:`bool` begin **)** Adds a control to the box as a spacer. If ``true``, *begin* will insert the spacer control in front of other children. .. _class_BoxContainer_get_alignment: -- :ref:`int` **get_alignment** **(** **)** const +- :ref:`int` **get_alignment** **(** **)** const Return the alignment of children in the container. .. _class_BoxContainer_set_alignment: -- void **set_alignment** **(** :ref:`int` alignment **)** +- void **set_alignment** **(** :ref:`int` alignment **)** Set the alignment of children in the container(Must be one of ALIGN_BEGIN, ALIGN_CENTER or ALIGN_END). diff --git a/classes/class_boxshape.rst b/classes/class_boxshape.rst index e39612715..ceef5f9c1 100644 --- a/classes/class_boxshape.rst +++ b/classes/class_boxshape.rst @@ -19,11 +19,11 @@ Box shape resource. Member Functions ---------------- -+--------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_extents` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------+ -| void | :ref:`set_extents` **(** :ref:`Vector3` extents **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------+ ++--------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_extents` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------+ +| void | :ref:`set_extents` **(** :ref:`Vector3` extents **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -43,13 +43,13 @@ Member Function Description .. _class_BoxShape_get_extents: -- :ref:`Vector3` **get_extents** **(** **)** const +- :ref:`Vector3` **get_extents** **(** **)** const Return the half extents of the shape. .. _class_BoxShape_set_extents: -- void **set_extents** **(** :ref:`Vector3` extents **)** +- void **set_extents** **(** :ref:`Vector3` extents **)** Set the half extents for the shape. diff --git a/classes/class_button.rst b/classes/class_button.rst index cdfad8c08..b74d078c5 100644 --- a/classes/class_button.rst +++ b/classes/class_button.rst @@ -21,27 +21,27 @@ Standard themed Button. Member Functions ---------------- -+--------------------------------+----------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_button_icon` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_clip_text` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_text` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_text_align` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_flat` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_button_icon` **(** :ref:`Texture` texture **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_clip_text` **(** :ref:`bool` enabled **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_flat` **(** :ref:`bool` enabled **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_text` **(** :ref:`String` text **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_text_align` **(** :ref:`int` align **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------+ ++--------------------------------+--------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_button_icon` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_clip_text` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_text` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_text_align` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_flat` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_button_icon` **(** :ref:`Texture` texture **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_clip_text` **(** :ref:`bool` enabled **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_flat` **(** :ref:`bool` enabled **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_text` **(** :ref:`String` text **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_text_align` **(** :ref:`int` align **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -84,42 +84,42 @@ Member Function Description .. _class_Button_get_button_icon: -- :ref:`Texture` **get_button_icon** **(** **)** const +- :ref:`Texture` **get_button_icon** **(** **)** const .. _class_Button_get_clip_text: -- :ref:`bool` **get_clip_text** **(** **)** const +- :ref:`bool` **get_clip_text** **(** **)** const .. _class_Button_get_text: -- :ref:`String` **get_text** **(** **)** const +- :ref:`String` **get_text** **(** **)** const .. _class_Button_get_text_align: -- :ref:`int` **get_text_align** **(** **)** const +- :ref:`int` **get_text_align** **(** **)** const .. _class_Button_is_flat: -- :ref:`bool` **is_flat** **(** **)** const +- :ref:`bool` **is_flat** **(** **)** const .. _class_Button_set_button_icon: -- void **set_button_icon** **(** :ref:`Texture` texture **)** +- void **set_button_icon** **(** :ref:`Texture` texture **)** .. _class_Button_set_clip_text: -- void **set_clip_text** **(** :ref:`bool` enabled **)** +- void **set_clip_text** **(** :ref:`bool` enabled **)** .. _class_Button_set_flat: -- void **set_flat** **(** :ref:`bool` enabled **)** +- void **set_flat** **(** :ref:`bool` enabled **)** .. _class_Button_set_text: -- void **set_text** **(** :ref:`String` text **)** +- void **set_text** **(** :ref:`String` text **)** .. _class_Button_set_text_align: -- void **set_text_align** **(** :ref:`int` align **)** +- void **set_text_align** **(** :ref:`int` align **)** diff --git a/classes/class_buttongroup.rst b/classes/class_buttongroup.rst index e6fded9ca..c94fd95e8 100644 --- a/classes/class_buttongroup.rst +++ b/classes/class_buttongroup.rst @@ -19,9 +19,9 @@ Group of Buttons. Member Functions ---------------- -+--------------------------------------+------------------------------------------------------------------------------+ -| :ref:`BaseButton` | :ref:`get_pressed_button` **(** **)** | -+--------------------------------------+------------------------------------------------------------------------------+ ++--------------------------------------+-----------------------------------------------------------------------------+ +| :ref:`BaseButton` | :ref:`get_pressed_button` **(** **)** | ++--------------------------------------+-----------------------------------------------------------------------------+ Description ----------- @@ -33,7 +33,7 @@ Member Function Description .. _class_ButtonGroup_get_pressed_button: -- :ref:`BaseButton` **get_pressed_button** **(** **)** +- :ref:`BaseButton` **get_pressed_button** **(** **)** Return the pressed button. diff --git a/classes/class_camera.rst b/classes/class_camera.rst index 27fc4cf53..adafaffcf 100644 --- a/classes/class_camera.rst +++ b/classes/class_camera.rst @@ -21,65 +21,65 @@ Camera node, displays from a point of view. Member Functions ---------------- -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_current` **(** **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_camera_transform` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_cull_mask` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_doppler_tracking` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Environment` | :ref:`get_environment` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_fov` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_h_offset` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_keep_aspect_mode` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_projection` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_size` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_v_offset` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_zfar` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_znear` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_current` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_position_behind` **(** :ref:`Vector3` world_point **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`make_current` **(** **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`project_local_ray_normal` **(** :ref:`Vector2` screen_point **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`project_position` **(** :ref:`Vector2` screen_point **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`project_ray_normal` **(** :ref:`Vector2` screen_point **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`project_ray_origin` **(** :ref:`Vector2` screen_point **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cull_mask` **(** :ref:`int` mask **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_doppler_tracking` **(** :ref:`int` mode **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_environment` **(** :ref:`Environment` env **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_h_offset` **(** :ref:`float` ofs **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_keep_aspect_mode` **(** :ref:`int` mode **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_orthogonal` **(** :ref:`float` size, :ref:`float` z_near, :ref:`float` z_far **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_perspective` **(** :ref:`float` fov, :ref:`float` z_near, :ref:`float` z_far **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_v_offset` **(** :ref:`float` ofs **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`unproject_position` **(** :ref:`Vector3` world_point **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_current` **(** **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`get_camera_transform` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_cull_mask` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_doppler_tracking` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Environment` | :ref:`get_environment` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_fov` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_h_offset` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_keep_aspect_mode` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_projection` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_size` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_v_offset` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_zfar` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_znear` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_current` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_position_behind` **(** :ref:`Vector3` world_point **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`make_current` **(** **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`project_local_ray_normal` **(** :ref:`Vector2` screen_point **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`project_position` **(** :ref:`Vector2` screen_point **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`project_ray_normal` **(** :ref:`Vector2` screen_point **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`project_ray_origin` **(** :ref:`Vector2` screen_point **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cull_mask` **(** :ref:`int` mask **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_doppler_tracking` **(** :ref:`int` mode **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_environment` **(** :ref:`Environment` env **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_h_offset` **(** :ref:`float` ofs **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_keep_aspect_mode` **(** :ref:`int` mode **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_orthogonal` **(** :ref:`float` size, :ref:`float` z_near, :ref:`float` z_far **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_perspective` **(** :ref:`float` fov, :ref:`float` z_near, :ref:`float` z_far **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_v_offset` **(** :ref:`float` ofs **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`unproject_position` **(** :ref:`Vector3` world_point **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -102,169 +102,169 @@ Member Function Description .. _class_Camera_clear_current: -- void **clear_current** **(** **)** +- void **clear_current** **(** **)** If this is the current Camera, remove it from being current. If it is inside the node tree, request to make the next Camera current, if any. .. _class_Camera_get_camera_transform: -- :ref:`Transform` **get_camera_transform** **(** **)** const +- :ref:`Transform` **get_camera_transform** **(** **)** const Get the camera transform. Subclassed cameras (such as CharacterCamera) may provide different transforms than the :ref:`Node` transform. .. _class_Camera_get_cull_mask: -- :ref:`int` **get_cull_mask** **(** **)** const +- :ref:`int` **get_cull_mask** **(** **)** const Returns the culling mask, describing which 3D render layers are rendered by this Camera. .. _class_Camera_get_doppler_tracking: -- :ref:`int` **get_doppler_tracking** **(** **)** const +- :ref:`int` **get_doppler_tracking** **(** **)** const .. _class_Camera_get_environment: -- :ref:`Environment` **get_environment** **(** **)** const +- :ref:`Environment` **get_environment** **(** **)** const Returns the :ref:`Environment` used by this Camera. .. _class_Camera_get_fov: -- :ref:`float` **get_fov** **(** **)** const +- :ref:`float` **get_fov** **(** **)** const Returns the *FOV* Y angle in degrees (FOV means Field of View). .. _class_Camera_get_h_offset: -- :ref:`float` **get_h_offset** **(** **)** const +- :ref:`float` **get_h_offset** **(** **)** const Returns the horizontal (X) offset of the Camera viewport. .. _class_Camera_get_keep_aspect_mode: -- :ref:`int` **get_keep_aspect_mode** **(** **)** const +- :ref:`int` **get_keep_aspect_mode** **(** **)** const Returns the current mode for keeping the aspect ratio. See ``KEEP\_\*`` constants. .. _class_Camera_get_projection: -- :ref:`int` **get_projection** **(** **)** const +- :ref:`int` **get_projection** **(** **)** const Returns the Camera's projection. See PROJECTION\_\* constants. .. _class_Camera_get_size: -- :ref:`float` **get_size** **(** **)** const +- :ref:`float` **get_size** **(** **)** const .. _class_Camera_get_v_offset: -- :ref:`float` **get_v_offset** **(** **)** const +- :ref:`float` **get_v_offset** **(** **)** const Returns the vertical (Y) offset of the Camera viewport. .. _class_Camera_get_zfar: -- :ref:`float` **get_zfar** **(** **)** const +- :ref:`float` **get_zfar** **(** **)** const Returns the far clip plane in world space units. .. _class_Camera_get_znear: -- :ref:`float` **get_znear** **(** **)** const +- :ref:`float` **get_znear** **(** **)** const Returns the near clip plane in world space units. .. _class_Camera_is_current: -- :ref:`bool` **is_current** **(** **)** const +- :ref:`bool` **is_current** **(** **)** const Returns ``true`` if the Camera is the current one in the :ref:`Viewport`, or plans to become current (if outside the scene tree). .. _class_Camera_is_position_behind: -- :ref:`bool` **is_position_behind** **(** :ref:`Vector3` world_point **)** const +- :ref:`bool` **is_position_behind** **(** :ref:`Vector3` world_point **)** const Returns ``true`` if the given position is behind the Camera. .. _class_Camera_make_current: -- void **make_current** **(** **)** +- void **make_current** **(** **)** Make this camera the current Camera for the :ref:`Viewport` (see class description). If the Camera Node is outside the scene tree, it will attempt to become current once it's added. .. _class_Camera_project_local_ray_normal: -- :ref:`Vector3` **project_local_ray_normal** **(** :ref:`Vector2` screen_point **)** const +- :ref:`Vector3` **project_local_ray_normal** **(** :ref:`Vector2` screen_point **)** const .. _class_Camera_project_position: -- :ref:`Vector3` **project_position** **(** :ref:`Vector2` screen_point **)** const +- :ref:`Vector3` **project_position** **(** :ref:`Vector2` screen_point **)** const Returns how a 2D coordinate in the Viewport rectangle maps to a 3D point in worldspace. .. _class_Camera_project_ray_normal: -- :ref:`Vector3` **project_ray_normal** **(** :ref:`Vector2` screen_point **)** const +- :ref:`Vector3` **project_ray_normal** **(** :ref:`Vector2` screen_point **)** const Returns a normal vector in worldspace, that is the result of projecting a point on the :ref:`Viewport` rectangle by the camera projection. This is useful for casting rays in the form of (origin, normal) for object intersection or picking. .. _class_Camera_project_ray_origin: -- :ref:`Vector3` **project_ray_origin** **(** :ref:`Vector2` screen_point **)** const +- :ref:`Vector3` **project_ray_origin** **(** :ref:`Vector2` screen_point **)** const Returns a 3D position in worldspace, that is the result of projecting a point on the :ref:`Viewport` rectangle by the camera projection. This is useful for casting rays in the form of (origin, normal) for object intersection or picking. .. _class_Camera_set_cull_mask: -- void **set_cull_mask** **(** :ref:`int` mask **)** +- void **set_cull_mask** **(** :ref:`int` mask **)** Sets the cull mask, describing which 3D render layers are rendered by this Camera. .. _class_Camera_set_doppler_tracking: -- void **set_doppler_tracking** **(** :ref:`int` mode **)** +- void **set_doppler_tracking** **(** :ref:`int` mode **)** Changes Doppler effect tracking. See ``DOPPLER\_\*`` constants. .. _class_Camera_set_environment: -- void **set_environment** **(** :ref:`Environment` env **)** +- void **set_environment** **(** :ref:`Environment` env **)** Sets the :ref:`Environment` to use for this Camera. .. _class_Camera_set_h_offset: -- void **set_h_offset** **(** :ref:`float` ofs **)** +- void **set_h_offset** **(** :ref:`float` ofs **)** Sets the horizontal (X) offset of the Camera viewport. .. _class_Camera_set_keep_aspect_mode: -- void **set_keep_aspect_mode** **(** :ref:`int` mode **)** +- void **set_keep_aspect_mode** **(** :ref:`int` mode **)** Sets the mode for keeping the aspect ratio. See ``KEEP\_\*`` constants. .. _class_Camera_set_orthogonal: -- void **set_orthogonal** **(** :ref:`float` size, :ref:`float` z_near, :ref:`float` z_far **)** +- void **set_orthogonal** **(** :ref:`float` size, :ref:`float` z_near, :ref:`float` z_far **)** Set the camera projection to orthogonal mode, by specifying a width and the *near* and *far* clip planes in worldspace units. (As a hint, 2D games often use this projection, with values specified in pixels) .. _class_Camera_set_perspective: -- void **set_perspective** **(** :ref:`float` fov, :ref:`float` z_near, :ref:`float` z_far **)** +- void **set_perspective** **(** :ref:`float` fov, :ref:`float` z_near, :ref:`float` z_far **)** Set the camera projection to perspective mode, by specifying a *FOV* Y angle in degrees (FOV means Field of View), and the *near* and *far* clip planes in worldspace units. .. _class_Camera_set_v_offset: -- void **set_v_offset** **(** :ref:`float` ofs **)** +- void **set_v_offset** **(** :ref:`float` ofs **)** Sets the vertical (Y) offset of the Camera viewport. .. _class_Camera_unproject_position: -- :ref:`Vector2` **unproject_position** **(** :ref:`Vector3` world_point **)** const +- :ref:`Vector2` **unproject_position** **(** :ref:`Vector3` world_point **)** const Returns how a 3D point in worldspace maps to a 2D coordinate in the :ref:`Viewport` rectangle. diff --git a/classes/class_camera2d.rst b/classes/class_camera2d.rst index aa58cade1..471e60951 100644 --- a/classes/class_camera2d.rst +++ b/classes/class_camera2d.rst @@ -19,91 +19,91 @@ Camera node for 2D scenes. Member Functions ---------------- -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`align` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_current` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`force_update_scroll` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_anchor_mode` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_camera_position` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_camera_screen_center` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_custom_viewport` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_drag_margin` **(** :ref:`int` margin **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_follow_smoothing` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_h_offset` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_limit` **(** :ref:`int` margin **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_offset` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_v_offset` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_zoom` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_current` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_follow_smoothing_enabled` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_h_drag_enabled` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_limit_drawing_enabled` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_limit_smoothing_enabled` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_margin_drawing_enabled` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_rotating` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_screen_drawing_enabled` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_v_drag_enabled` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`make_current` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reset_smoothing` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_anchor_mode` **(** :ref:`int` anchor_mode **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_viewport` **(** :ref:`Node` viewport **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_drag_margin` **(** :ref:`int` margin, :ref:`float` drag_margin **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_enable_follow_smoothing` **(** :ref:`bool` follow_smoothing **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_follow_smoothing` **(** :ref:`float` follow_smoothing **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_h_drag_enabled` **(** :ref:`bool` enabled **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_h_offset` **(** :ref:`float` ofs **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_limit` **(** :ref:`int` margin, :ref:`int` limit **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_limit_drawing_enabled` **(** :ref:`bool` limit_drawing_enabled **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_limit_smoothing_enabled` **(** :ref:`bool` limit_smoothing_enabled **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_margin_drawing_enabled` **(** :ref:`bool` margin_drawing_enabled **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_offset` **(** :ref:`Vector2` offset **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rotating` **(** :ref:`bool` rotating **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_screen_drawing_enabled` **(** :ref:`bool` screen_drawing_enabled **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_v_drag_enabled` **(** :ref:`bool` enabled **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_v_offset` **(** :ref:`float` ofs **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_zoom` **(** :ref:`Vector2` zoom **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`align` **(** **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_current` **(** **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`force_update_scroll` **(** **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_anchor_mode` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_camera_position` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_camera_screen_center` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`get_custom_viewport` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_drag_margin` **(** :ref:`int` margin **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_follow_smoothing` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_h_offset` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_limit` **(** :ref:`int` margin **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_offset` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_v_offset` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_zoom` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_current` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_follow_smoothing_enabled` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_h_drag_enabled` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_limit_drawing_enabled` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_limit_smoothing_enabled` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_margin_drawing_enabled` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_rotating` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_screen_drawing_enabled` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_v_drag_enabled` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`make_current` **(** **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reset_smoothing` **(** **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_anchor_mode` **(** :ref:`int` anchor_mode **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_viewport` **(** :ref:`Node` viewport **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_drag_margin` **(** :ref:`int` margin, :ref:`float` drag_margin **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_enable_follow_smoothing` **(** :ref:`bool` follow_smoothing **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_follow_smoothing` **(** :ref:`float` follow_smoothing **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_h_drag_enabled` **(** :ref:`bool` enabled **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_h_offset` **(** :ref:`float` ofs **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_limit` **(** :ref:`int` margin, :ref:`int` limit **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_limit_drawing_enabled` **(** :ref:`bool` limit_drawing_enabled **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_limit_smoothing_enabled` **(** :ref:`bool` limit_smoothing_enabled **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_margin_drawing_enabled` **(** :ref:`bool` margin_drawing_enabled **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_offset` **(** :ref:`Vector2` offset **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rotating` **(** :ref:`bool` rotating **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_screen_drawing_enabled` **(** :ref:`bool` screen_drawing_enabled **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_v_drag_enabled` **(** :ref:`bool` enabled **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_v_offset` **(** :ref:`float` ofs **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_zoom` **(** :ref:`Vector2` zoom **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -211,119 +211,119 @@ Member Function Description .. _class_Camera2D_align: -- void **align** **(** **)** +- void **align** **(** **)** Align the camera to the tracked node .. _class_Camera2D_clear_current: -- void **clear_current** **(** **)** +- void **clear_current** **(** **)** .. _class_Camera2D_force_update_scroll: -- void **force_update_scroll** **(** **)** +- void **force_update_scroll** **(** **)** Force the camera to update scroll immediately. .. _class_Camera2D_get_anchor_mode: -- :ref:`int` **get_anchor_mode** **(** **)** const +- :ref:`int` **get_anchor_mode** **(** **)** const .. _class_Camera2D_get_camera_position: -- :ref:`Vector2` **get_camera_position** **(** **)** const +- :ref:`Vector2` **get_camera_position** **(** **)** const Return the camera position. .. _class_Camera2D_get_camera_screen_center: -- :ref:`Vector2` **get_camera_screen_center** **(** **)** const +- :ref:`Vector2` **get_camera_screen_center** **(** **)** const .. _class_Camera2D_get_custom_viewport: -- :ref:`Node` **get_custom_viewport** **(** **)** const +- :ref:`Node` **get_custom_viewport** **(** **)** const .. _class_Camera2D_get_drag_margin: -- :ref:`float` **get_drag_margin** **(** :ref:`int` margin **)** const +- :ref:`float` **get_drag_margin** **(** :ref:`int` margin **)** const Return the margins needed to drag the camera (see :ref:`set_drag_margin`). .. _class_Camera2D_get_follow_smoothing: -- :ref:`float` **get_follow_smoothing** **(** **)** const +- :ref:`float` **get_follow_smoothing** **(** **)** const .. _class_Camera2D_get_h_offset: -- :ref:`float` **get_h_offset** **(** **)** const +- :ref:`float` **get_h_offset** **(** **)** const .. _class_Camera2D_get_limit: -- :ref:`int` **get_limit** **(** :ref:`int` margin **)** const +- :ref:`int` **get_limit** **(** :ref:`int` margin **)** const Return the scrolling limit in pixels. .. _class_Camera2D_get_offset: -- :ref:`Vector2` **get_offset** **(** **)** const +- :ref:`Vector2` **get_offset** **(** **)** const Return the scroll offset. .. _class_Camera2D_get_v_offset: -- :ref:`float` **get_v_offset** **(** **)** const +- :ref:`float` **get_v_offset** **(** **)** const .. _class_Camera2D_get_zoom: -- :ref:`Vector2` **get_zoom** **(** **)** const +- :ref:`Vector2` **get_zoom** **(** **)** const .. _class_Camera2D_is_current: -- :ref:`bool` **is_current** **(** **)** const +- :ref:`bool` **is_current** **(** **)** const Return true of this is the current camera (see :ref:`make_current`). .. _class_Camera2D_is_follow_smoothing_enabled: -- :ref:`bool` **is_follow_smoothing_enabled** **(** **)** const +- :ref:`bool` **is_follow_smoothing_enabled** **(** **)** const .. _class_Camera2D_is_h_drag_enabled: -- :ref:`bool` **is_h_drag_enabled** **(** **)** const +- :ref:`bool` **is_h_drag_enabled** **(** **)** const .. _class_Camera2D_is_limit_drawing_enabled: -- :ref:`bool` **is_limit_drawing_enabled** **(** **)** const +- :ref:`bool` **is_limit_drawing_enabled** **(** **)** const .. _class_Camera2D_is_limit_smoothing_enabled: -- :ref:`bool` **is_limit_smoothing_enabled** **(** **)** const +- :ref:`bool` **is_limit_smoothing_enabled** **(** **)** const .. _class_Camera2D_is_margin_drawing_enabled: -- :ref:`bool` **is_margin_drawing_enabled** **(** **)** const +- :ref:`bool` **is_margin_drawing_enabled** **(** **)** const .. _class_Camera2D_is_rotating: -- :ref:`bool` **is_rotating** **(** **)** const +- :ref:`bool` **is_rotating** **(** **)** const .. _class_Camera2D_is_screen_drawing_enabled: -- :ref:`bool` **is_screen_drawing_enabled** **(** **)** const +- :ref:`bool` **is_screen_drawing_enabled** **(** **)** const .. _class_Camera2D_is_v_drag_enabled: -- :ref:`bool` **is_v_drag_enabled** **(** **)** const +- :ref:`bool` **is_v_drag_enabled** **(** **)** const .. _class_Camera2D_make_current: -- void **make_current** **(** **)** +- void **make_current** **(** **)** Make this the current 2D camera for the scene (viewport and layer), in case there's many cameras in the scene. .. _class_Camera2D_reset_smoothing: -- void **reset_smoothing** **(** **)** +- void **reset_smoothing** **(** **)** Set the camera's position immediately to its current smoothing destination. @@ -331,47 +331,47 @@ This has no effect if smoothing is disabled. .. _class_Camera2D_set_anchor_mode: -- void **set_anchor_mode** **(** :ref:`int` anchor_mode **)** +- void **set_anchor_mode** **(** :ref:`int` anchor_mode **)** .. _class_Camera2D_set_custom_viewport: -- void **set_custom_viewport** **(** :ref:`Node` viewport **)** +- void **set_custom_viewport** **(** :ref:`Node` viewport **)** .. _class_Camera2D_set_drag_margin: -- void **set_drag_margin** **(** :ref:`int` margin, :ref:`float` drag_margin **)** +- void **set_drag_margin** **(** :ref:`int` margin, :ref:`float` drag_margin **)** Set the margins needed to drag the camera (relative to the screen size). Margin uses the MARGIN\_\* enum. Drag margins of 0,0,0,0 will keep the camera at the center of the screen, while drag margins of 1,1,1,1 will only move when the camera is at the edges. .. _class_Camera2D_set_enable_follow_smoothing: -- void **set_enable_follow_smoothing** **(** :ref:`bool` follow_smoothing **)** +- void **set_enable_follow_smoothing** **(** :ref:`bool` follow_smoothing **)** .. _class_Camera2D_set_follow_smoothing: -- void **set_follow_smoothing** **(** :ref:`float` follow_smoothing **)** +- void **set_follow_smoothing** **(** :ref:`float` follow_smoothing **)** .. _class_Camera2D_set_h_drag_enabled: -- void **set_h_drag_enabled** **(** :ref:`bool` enabled **)** +- void **set_h_drag_enabled** **(** :ref:`bool` enabled **)** .. _class_Camera2D_set_h_offset: -- void **set_h_offset** **(** :ref:`float` ofs **)** +- void **set_h_offset** **(** :ref:`float` ofs **)** .. _class_Camera2D_set_limit: -- void **set_limit** **(** :ref:`int` margin, :ref:`int` limit **)** +- void **set_limit** **(** :ref:`int` margin, :ref:`int` limit **)** Set the scrolling limit in pixels. .. _class_Camera2D_set_limit_drawing_enabled: -- void **set_limit_drawing_enabled** **(** :ref:`bool` limit_drawing_enabled **)** +- void **set_limit_drawing_enabled** **(** :ref:`bool` limit_drawing_enabled **)** .. _class_Camera2D_set_limit_smoothing_enabled: -- void **set_limit_smoothing_enabled** **(** :ref:`bool` limit_smoothing_enabled **)** +- void **set_limit_smoothing_enabled** **(** :ref:`bool` limit_smoothing_enabled **)** Smooth camera when reaching camera limits. @@ -379,32 +379,32 @@ This requires camera smoothing being enabled to have a noticeable effect. .. _class_Camera2D_set_margin_drawing_enabled: -- void **set_margin_drawing_enabled** **(** :ref:`bool` margin_drawing_enabled **)** +- void **set_margin_drawing_enabled** **(** :ref:`bool` margin_drawing_enabled **)** .. _class_Camera2D_set_offset: -- void **set_offset** **(** :ref:`Vector2` offset **)** +- void **set_offset** **(** :ref:`Vector2` offset **)** Set the scroll offset. Useful for looking around or camera shake animations. .. _class_Camera2D_set_rotating: -- void **set_rotating** **(** :ref:`bool` rotating **)** +- void **set_rotating** **(** :ref:`bool` rotating **)** .. _class_Camera2D_set_screen_drawing_enabled: -- void **set_screen_drawing_enabled** **(** :ref:`bool` screen_drawing_enabled **)** +- void **set_screen_drawing_enabled** **(** :ref:`bool` screen_drawing_enabled **)** .. _class_Camera2D_set_v_drag_enabled: -- void **set_v_drag_enabled** **(** :ref:`bool` enabled **)** +- void **set_v_drag_enabled** **(** :ref:`bool` enabled **)** .. _class_Camera2D_set_v_offset: -- void **set_v_offset** **(** :ref:`float` ofs **)** +- void **set_v_offset** **(** :ref:`float` ofs **)** .. _class_Camera2D_set_zoom: -- void **set_zoom** **(** :ref:`Vector2` zoom **)** +- void **set_zoom** **(** :ref:`Vector2` zoom **)** diff --git a/classes/class_canvasitem.rst b/classes/class_canvasitem.rst index a9f5f9b88..3e244317e 100644 --- a/classes/class_canvasitem.rst +++ b/classes/class_canvasitem.rst @@ -21,152 +21,152 @@ Base class of anything 2D. Member Functions ---------------- -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_draw` **(** **)** virtual | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`draw_char` **(** :ref:`Font` font, :ref:`Vector2` position, :ref:`String` char, :ref:`String` next, :ref:`Color` modulate=Color( 1, 1, 1, 1 ) **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_circle` **(** :ref:`Vector2` position, :ref:`float` radius, :ref:`Color` color **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_colored_polygon` **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`Texture` texture=null, :ref:`Texture` normal_map=null, :ref:`bool` antialiased=false **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_line` **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_polygon` **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`Texture` texture=null, :ref:`Texture` normal_map=null, :ref:`bool` antialiased=false **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_polyline` **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_polyline_colors` **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_primitive` **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs, :ref:`Texture` texture=null, :ref:`float` width=1.0, :ref:`Texture` normal_map=null **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_rect` **(** :ref:`Rect2` rect, :ref:`Color` color, :ref:`bool` filled=true **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_set_transform` **(** :ref:`Vector2` position, :ref:`float` rotation, :ref:`Vector2` scale **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_set_transform_matrix` **(** :ref:`Transform2D` xform **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_string` **(** :ref:`Font` font, :ref:`Vector2` position, :ref:`String` text, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`int` clip_w=-1 **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_style_box` **(** :ref:`StyleBox` style_box, :ref:`Rect2` rect **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_texture` **(** :ref:`Texture` texture, :ref:`Vector2` position, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`Texture` normal_map=null **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_texture_rect` **(** :ref:`Texture` texture, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_texture_rect_region` **(** :ref:`Texture` texture, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null, :ref:`bool` clip_uv=true **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`edit_get_state` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`edit_rotate` **(** :ref:`float` degrees **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`edit_set_rect` **(** :ref:`Rect2` rect **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`edit_set_state` **(** :ref:`Variant` state **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_canvas` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_canvas_item` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_canvas_transform` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_global_mouse_position` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_global_transform` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_global_transform_with_canvas` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_item_and_children_rect` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_item_rect` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_light_mask` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_local_mouse_position` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Material` | :ref:`get_material` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_modulate` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_self_modulate` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_transform` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_use_parent_material` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_viewport_rect` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_viewport_transform` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`World2D` | :ref:`get_world_2d` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`hide` **(** **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_draw_behind_parent_enabled` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_local_transform_notification_enabled` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_set_as_toplevel` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_transform_notification_enabled` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_visible` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_visible_in_tree` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`make_canvas_position_local` **(** :ref:`Vector2` screen_point **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`InputEvent` | :ref:`make_input_local` **(** :ref:`InputEvent` event **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_as_toplevel` **(** :ref:`bool` enable **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_draw_behind_parent` **(** :ref:`bool` enable **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_light_mask` **(** :ref:`int` light_mask **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_material` **(** :ref:`Material` material **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_modulate` **(** :ref:`Color` modulate **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_notify_local_transform` **(** :ref:`bool` enable **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_notify_transform` **(** :ref:`bool` enable **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_self_modulate` **(** :ref:`Color` self_modulate **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_parent_material` **(** :ref:`bool` enable **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_visible` **(** :ref:`bool` visible **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`show` **(** **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`update` **(** **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_draw` **(** **)** virtual | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`draw_char` **(** :ref:`Font` font, :ref:`Vector2` position, :ref:`String` char, :ref:`String` next, :ref:`Color` modulate=Color( 1, 1, 1, 1 ) **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_circle` **(** :ref:`Vector2` position, :ref:`float` radius, :ref:`Color` color **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_colored_polygon` **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`Texture` texture=null, :ref:`Texture` normal_map=null, :ref:`bool` antialiased=false **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_line` **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_polygon` **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`Texture` texture=null, :ref:`Texture` normal_map=null, :ref:`bool` antialiased=false **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_polyline` **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_polyline_colors` **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_primitive` **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs, :ref:`Texture` texture=null, :ref:`float` width=1.0, :ref:`Texture` normal_map=null **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_rect` **(** :ref:`Rect2` rect, :ref:`Color` color, :ref:`bool` filled=true **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_set_transform` **(** :ref:`Vector2` position, :ref:`float` rotation, :ref:`Vector2` scale **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_set_transform_matrix` **(** :ref:`Transform2D` xform **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_string` **(** :ref:`Font` font, :ref:`Vector2` position, :ref:`String` text, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`int` clip_w=-1 **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_style_box` **(** :ref:`StyleBox` style_box, :ref:`Rect2` rect **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_texture` **(** :ref:`Texture` texture, :ref:`Vector2` position, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`Texture` normal_map=null **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_texture_rect` **(** :ref:`Texture` texture, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_texture_rect_region` **(** :ref:`Texture` texture, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null, :ref:`bool` clip_uv=true **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`edit_get_state` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`edit_rotate` **(** :ref:`float` degrees **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`edit_set_rect` **(** :ref:`Rect2` rect **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`edit_set_state` **(** :ref:`Variant` state **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_canvas` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_canvas_item` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_canvas_transform` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_global_mouse_position` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_global_transform` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_global_transform_with_canvas` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_item_and_children_rect` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_item_rect` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_light_mask` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_local_mouse_position` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Material` | :ref:`get_material` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_modulate` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_self_modulate` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_transform` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_use_parent_material` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_viewport_rect` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_viewport_transform` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`World2D` | :ref:`get_world_2d` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`hide` **(** **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_draw_behind_parent_enabled` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_local_transform_notification_enabled` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_set_as_toplevel` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_transform_notification_enabled` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_visible` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_visible_in_tree` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`make_canvas_position_local` **(** :ref:`Vector2` screen_point **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`InputEvent` | :ref:`make_input_local` **(** :ref:`InputEvent` event **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_as_toplevel` **(** :ref:`bool` enable **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_draw_behind_parent` **(** :ref:`bool` enable **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_light_mask` **(** :ref:`int` light_mask **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_material` **(** :ref:`Material` material **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_modulate` **(** :ref:`Color` modulate **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_notify_local_transform` **(** :ref:`bool` enable **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_notify_transform` **(** :ref:`bool` enable **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_self_modulate` **(** :ref:`Color` self_modulate **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_parent_material` **(** :ref:`bool` enable **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_visible` **(** :ref:`bool` visible **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`show` **(** **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`update` **(** **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_CanvasItem_draw: -- **draw** **(** **)** +- **draw** **(** **)** Emitted when the CanvasItem must redraw. This can only be connected realtime, as deferred will not allow drawing. .. _class_CanvasItem_hide: -- **hide** **(** **)** +- **hide** **(** **)** Emitted when becoming hidden. .. _class_CanvasItem_item_rect_changed: -- **item_rect_changed** **(** **)** +- **item_rect_changed** **(** **)** Emitted when the item rect has changed. .. _class_CanvasItem_visibility_changed: -- **visibility_changed** **(** **)** +- **visibility_changed** **(** **)** Emitted when the visibility (hidden/visible) changes. @@ -239,327 +239,327 @@ Member Function Description .. _class_CanvasItem__draw: -- void **_draw** **(** **)** virtual +- void **_draw** **(** **)** virtual Called (if exists) to draw the canvas item. .. _class_CanvasItem_draw_char: -- :ref:`float` **draw_char** **(** :ref:`Font` font, :ref:`Vector2` position, :ref:`String` char, :ref:`String` next, :ref:`Color` modulate=Color( 1, 1, 1, 1 ) **)** +- :ref:`float` **draw_char** **(** :ref:`Font` font, :ref:`Vector2` position, :ref:`String` char, :ref:`String` next, :ref:`Color` modulate=Color( 1, 1, 1, 1 ) **)** Draw a string character using a custom font. Returns the advance, depending on the char width and kerning with an optional next char. .. _class_CanvasItem_draw_circle: -- void **draw_circle** **(** :ref:`Vector2` position, :ref:`float` radius, :ref:`Color` color **)** +- void **draw_circle** **(** :ref:`Vector2` position, :ref:`float` radius, :ref:`Color` color **)** Draw a colored circle. .. _class_CanvasItem_draw_colored_polygon: -- void **draw_colored_polygon** **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`Texture` texture=null, :ref:`Texture` normal_map=null, :ref:`bool` antialiased=false **)** +- void **draw_colored_polygon** **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`Texture` texture=null, :ref:`Texture` normal_map=null, :ref:`bool` antialiased=false **)** Draw a colored polygon of any amount of points, convex or concave. .. _class_CanvasItem_draw_line: -- void **draw_line** **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** +- void **draw_line** **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** Draw a line from a 2D point to another, with a given color and width. It can be optionally antialiased. .. _class_CanvasItem_draw_polygon: -- void **draw_polygon** **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`Texture` texture=null, :ref:`Texture` normal_map=null, :ref:`bool` antialiased=false **)** +- void **draw_polygon** **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`Texture` texture=null, :ref:`Texture` normal_map=null, :ref:`bool` antialiased=false **)** Draw a polygon of any amount of points, convex or concave. .. _class_CanvasItem_draw_polyline: -- void **draw_polyline** **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** +- void **draw_polyline** **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** .. _class_CanvasItem_draw_polyline_colors: -- void **draw_polyline_colors** **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** +- void **draw_polyline_colors** **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** .. _class_CanvasItem_draw_primitive: -- void **draw_primitive** **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs, :ref:`Texture` texture=null, :ref:`float` width=1.0, :ref:`Texture` normal_map=null **)** +- void **draw_primitive** **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs, :ref:`Texture` texture=null, :ref:`float` width=1.0, :ref:`Texture` normal_map=null **)** Draw a custom primitive, 1 point for a point, 2 points for a line, 3 points for a triangle and 4 points for a quad. .. _class_CanvasItem_draw_rect: -- void **draw_rect** **(** :ref:`Rect2` rect, :ref:`Color` color, :ref:`bool` filled=true **)** +- void **draw_rect** **(** :ref:`Rect2` rect, :ref:`Color` color, :ref:`bool` filled=true **)** Draw a colored rectangle. .. _class_CanvasItem_draw_set_transform: -- void **draw_set_transform** **(** :ref:`Vector2` position, :ref:`float` rotation, :ref:`Vector2` scale **)** +- void **draw_set_transform** **(** :ref:`Vector2` position, :ref:`float` rotation, :ref:`Vector2` scale **)** Set a custom transform for drawing. Anything drawn afterwards will be transformed by this. .. _class_CanvasItem_draw_set_transform_matrix: -- void **draw_set_transform_matrix** **(** :ref:`Transform2D` xform **)** +- void **draw_set_transform_matrix** **(** :ref:`Transform2D` xform **)** .. _class_CanvasItem_draw_string: -- void **draw_string** **(** :ref:`Font` font, :ref:`Vector2` position, :ref:`String` text, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`int` clip_w=-1 **)** +- void **draw_string** **(** :ref:`Font` font, :ref:`Vector2` position, :ref:`String` text, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`int` clip_w=-1 **)** Draw a string using a custom font. .. _class_CanvasItem_draw_style_box: -- void **draw_style_box** **(** :ref:`StyleBox` style_box, :ref:`Rect2` rect **)** +- void **draw_style_box** **(** :ref:`StyleBox` style_box, :ref:`Rect2` rect **)** Draw a styled rectangle. .. _class_CanvasItem_draw_texture: -- void **draw_texture** **(** :ref:`Texture` texture, :ref:`Vector2` position, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`Texture` normal_map=null **)** +- void **draw_texture** **(** :ref:`Texture` texture, :ref:`Vector2` position, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`Texture` normal_map=null **)** Draw a texture at a given position. .. _class_CanvasItem_draw_texture_rect: -- void **draw_texture_rect** **(** :ref:`Texture` texture, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** +- void **draw_texture_rect** **(** :ref:`Texture` texture, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** Draw a textured rectangle at a given position, optionally modulated by a color. Transpose swaps the x and y coordinates when reading the texture. .. _class_CanvasItem_draw_texture_rect_region: -- void **draw_texture_rect_region** **(** :ref:`Texture` texture, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null, :ref:`bool` clip_uv=true **)** +- void **draw_texture_rect_region** **(** :ref:`Texture` texture, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null, :ref:`bool` clip_uv=true **)** Draw a textured rectangle region at a given position, optionally modulated by a color. Transpose swaps the x and y coordinates when reading the texture. .. _class_CanvasItem_edit_get_state: -- :ref:`Variant` **edit_get_state** **(** **)** const +- :ref:`Variant` **edit_get_state** **(** **)** const Used for editing, returns an opaque value representing the transform state. .. _class_CanvasItem_edit_rotate: -- void **edit_rotate** **(** :ref:`float` degrees **)** +- void **edit_rotate** **(** :ref:`float` degrees **)** Used for editing, handle rotation. .. _class_CanvasItem_edit_set_rect: -- void **edit_set_rect** **(** :ref:`Rect2` rect **)** +- void **edit_set_rect** **(** :ref:`Rect2` rect **)** .. _class_CanvasItem_edit_set_state: -- void **edit_set_state** **(** :ref:`Variant` state **)** +- void **edit_set_state** **(** :ref:`Variant` state **)** Set the transform state of this CanvasItem. For :ref:`Node2D`, this is an :ref:`Array` with (in order) a :ref:`Vector2` for position, a float for rotation (radians) and another :ref:`Vector2` for scale. For :ref:`Control` this is a :ref:`Rect2` with the position and size. .. _class_CanvasItem_get_canvas: -- :ref:`RID` **get_canvas** **(** **)** const +- :ref:`RID` **get_canvas** **(** **)** const Return the :ref:`RID` of the :ref:`World2D` canvas where this item is in. .. _class_CanvasItem_get_canvas_item: -- :ref:`RID` **get_canvas_item** **(** **)** const +- :ref:`RID` **get_canvas_item** **(** **)** const Return the canvas item RID used by :ref:`VisualServer` for this item. .. _class_CanvasItem_get_canvas_transform: -- :ref:`Transform2D` **get_canvas_transform** **(** **)** const +- :ref:`Transform2D` **get_canvas_transform** **(** **)** const Get the transform matrix of this item's canvas. .. _class_CanvasItem_get_global_mouse_position: -- :ref:`Vector2` **get_global_mouse_position** **(** **)** const +- :ref:`Vector2` **get_global_mouse_position** **(** **)** const Get the global position of the mouse. .. _class_CanvasItem_get_global_transform: -- :ref:`Transform2D` **get_global_transform** **(** **)** const +- :ref:`Transform2D` **get_global_transform** **(** **)** const Get the global transform matrix of this item. .. _class_CanvasItem_get_global_transform_with_canvas: -- :ref:`Transform2D` **get_global_transform_with_canvas** **(** **)** const +- :ref:`Transform2D` **get_global_transform_with_canvas** **(** **)** const Get the global transform matrix of this item in relation to the canvas. .. _class_CanvasItem_get_item_and_children_rect: -- :ref:`Rect2` **get_item_and_children_rect** **(** **)** const +- :ref:`Rect2` **get_item_and_children_rect** **(** **)** const Get a :ref:`Rect2` with the boundaries of this item and its children. .. _class_CanvasItem_get_item_rect: -- :ref:`Rect2` **get_item_rect** **(** **)** const +- :ref:`Rect2` **get_item_rect** **(** **)** const Return a rect containing the editable boundaries of the item. .. _class_CanvasItem_get_light_mask: -- :ref:`int` **get_light_mask** **(** **)** const +- :ref:`int` **get_light_mask** **(** **)** const Get this item's light mask number. .. _class_CanvasItem_get_local_mouse_position: -- :ref:`Vector2` **get_local_mouse_position** **(** **)** const +- :ref:`Vector2` **get_local_mouse_position** **(** **)** const Get the mouse position relative to this item's position. .. _class_CanvasItem_get_material: -- :ref:`Material` **get_material** **(** **)** const +- :ref:`Material` **get_material** **(** **)** const Get the material of this item. .. _class_CanvasItem_get_modulate: -- :ref:`Color` **get_modulate** **(** **)** const +- :ref:`Color` **get_modulate** **(** **)** const Get the modulate of the CanvasItem, which affects children items too. .. _class_CanvasItem_get_self_modulate: -- :ref:`Color` **get_self_modulate** **(** **)** const +- :ref:`Color` **get_self_modulate** **(** **)** const Get the self-modulate of the CanvasItem. .. _class_CanvasItem_get_transform: -- :ref:`Transform2D` **get_transform** **(** **)** const +- :ref:`Transform2D` **get_transform** **(** **)** const Get the transform matrix of this item. .. _class_CanvasItem_get_use_parent_material: -- :ref:`bool` **get_use_parent_material** **(** **)** const +- :ref:`bool` **get_use_parent_material** **(** **)** const Get whether this item uses its parent's material. .. _class_CanvasItem_get_viewport_rect: -- :ref:`Rect2` **get_viewport_rect** **(** **)** const +- :ref:`Rect2` **get_viewport_rect** **(** **)** const Get the viewport's boundaries as a :ref:`Rect2`. .. _class_CanvasItem_get_viewport_transform: -- :ref:`Transform2D` **get_viewport_transform** **(** **)** const +- :ref:`Transform2D` **get_viewport_transform** **(** **)** const Get this item's transform in relation to the viewport. .. _class_CanvasItem_get_world_2d: -- :ref:`World2D` **get_world_2d** **(** **)** const +- :ref:`World2D` **get_world_2d** **(** **)** const Get the :ref:`World2D` where this item is in. .. _class_CanvasItem_hide: -- void **hide** **(** **)** +- void **hide** **(** **)** Hide the CanvasItem currently visible. .. _class_CanvasItem_is_draw_behind_parent_enabled: -- :ref:`bool` **is_draw_behind_parent_enabled** **(** **)** const +- :ref:`bool` **is_draw_behind_parent_enabled** **(** **)** const Return whether the item is drawn behind its parent. .. _class_CanvasItem_is_local_transform_notification_enabled: -- :ref:`bool` **is_local_transform_notification_enabled** **(** **)** const +- :ref:`bool` **is_local_transform_notification_enabled** **(** **)** const .. _class_CanvasItem_is_set_as_toplevel: -- :ref:`bool` **is_set_as_toplevel** **(** **)** const +- :ref:`bool` **is_set_as_toplevel** **(** **)** const Return if set as toplevel. See :ref:`set_as_toplevel`. .. _class_CanvasItem_is_transform_notification_enabled: -- :ref:`bool` **is_transform_notification_enabled** **(** **)** const +- :ref:`bool` **is_transform_notification_enabled** **(** **)** const .. _class_CanvasItem_is_visible: -- :ref:`bool` **is_visible** **(** **)** const +- :ref:`bool` **is_visible** **(** **)** const Return true if this CanvasItem is visible. It may be invisible because itself or a parent canvas item is hidden. .. _class_CanvasItem_is_visible_in_tree: -- :ref:`bool` **is_visible_in_tree** **(** **)** const +- :ref:`bool` **is_visible_in_tree** **(** **)** const .. _class_CanvasItem_make_canvas_position_local: -- :ref:`Vector2` **make_canvas_position_local** **(** :ref:`Vector2` screen_point **)** const +- :ref:`Vector2` **make_canvas_position_local** **(** :ref:`Vector2` screen_point **)** const .. _class_CanvasItem_make_input_local: -- :ref:`InputEvent` **make_input_local** **(** :ref:`InputEvent` event **)** const +- :ref:`InputEvent` **make_input_local** **(** :ref:`InputEvent` event **)** const .. _class_CanvasItem_set_as_toplevel: -- void **set_as_toplevel** **(** :ref:`bool` enable **)** +- void **set_as_toplevel** **(** :ref:`bool` enable **)** Set as top level. This means that it will not inherit transform from parent canvas items. .. _class_CanvasItem_set_draw_behind_parent: -- void **set_draw_behind_parent** **(** :ref:`bool` enable **)** +- void **set_draw_behind_parent** **(** :ref:`bool` enable **)** Set whether the canvas item is drawn behind its parent. .. _class_CanvasItem_set_light_mask: -- void **set_light_mask** **(** :ref:`int` light_mask **)** +- void **set_light_mask** **(** :ref:`int` light_mask **)** Set the ligtht mask number of this item. .. _class_CanvasItem_set_material: -- void **set_material** **(** :ref:`Material` material **)** +- void **set_material** **(** :ref:`Material` material **)** Set the material of this item. .. _class_CanvasItem_set_modulate: -- void **set_modulate** **(** :ref:`Color` modulate **)** +- void **set_modulate** **(** :ref:`Color` modulate **)** Set the modulate of the CanvasItem. This *affects* the modulation of children items. .. _class_CanvasItem_set_notify_local_transform: -- void **set_notify_local_transform** **(** :ref:`bool` enable **)** +- void **set_notify_local_transform** **(** :ref:`bool` enable **)** .. _class_CanvasItem_set_notify_transform: -- void **set_notify_transform** **(** :ref:`bool` enable **)** +- void **set_notify_transform** **(** :ref:`bool` enable **)** .. _class_CanvasItem_set_self_modulate: -- void **set_self_modulate** **(** :ref:`Color` self_modulate **)** +- void **set_self_modulate** **(** :ref:`Color` self_modulate **)** Set the self-modulate of the CanvasItem. This does not affect the modulation of children items. .. _class_CanvasItem_set_use_parent_material: -- void **set_use_parent_material** **(** :ref:`bool` enable **)** +- void **set_use_parent_material** **(** :ref:`bool` enable **)** Set whether or not this item should use its parent's material. .. _class_CanvasItem_set_visible: -- void **set_visible** **(** :ref:`bool` visible **)** +- void **set_visible** **(** :ref:`bool` visible **)** Set whether this item should be visible or not. @@ -567,13 +567,13 @@ Note that a hidden CanvasItem will make all children hidden too, so no matter wh .. _class_CanvasItem_show: -- void **show** **(** **)** +- void **show** **(** **)** Show the CanvasItem currently hidden. .. _class_CanvasItem_update: -- void **update** **(** **)** +- void **update** **(** **)** Queue the CanvasItem for update. ``NOTIFICATION_DRAW`` will be called on idle time to request redraw. diff --git a/classes/class_canvasitemmaterial.rst b/classes/class_canvasitemmaterial.rst index fefa4bc81..1807f5eb8 100644 --- a/classes/class_canvasitemmaterial.rst +++ b/classes/class_canvasitemmaterial.rst @@ -19,15 +19,15 @@ Brief Description Member Functions ---------------- -+------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_blend_mode` **(** **)** const | -+------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_light_mode` **(** **)** const | -+------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_blend_mode` **(** :ref:`int` blend_mode **)** | -+------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_light_mode` **(** :ref:`int` light_mode **)** | -+------------------------+---------------------------------------------------------------------------------------------------------------+ ++------------------------+-------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_blend_mode` **(** **)** const | ++------------------------+-------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_light_mode` **(** **)** const | ++------------------------+-------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_blend_mode` **(** :ref:`int` blend_mode **)** | ++------------------------+-------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_light_mode` **(** :ref:`int` light_mode **)** | ++------------------------+-------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -58,18 +58,18 @@ Member Function Description .. _class_CanvasItemMaterial_get_blend_mode: -- :ref:`int` **get_blend_mode** **(** **)** const +- :ref:`int` **get_blend_mode** **(** **)** const .. _class_CanvasItemMaterial_get_light_mode: -- :ref:`int` **get_light_mode** **(** **)** const +- :ref:`int` **get_light_mode** **(** **)** const .. _class_CanvasItemMaterial_set_blend_mode: -- void **set_blend_mode** **(** :ref:`int` blend_mode **)** +- void **set_blend_mode** **(** :ref:`int` blend_mode **)** .. _class_CanvasItemMaterial_set_light_mode: -- void **set_light_mode** **(** :ref:`int` light_mode **)** +- void **set_light_mode** **(** :ref:`int` light_mode **)** diff --git a/classes/class_canvaslayer.rst b/classes/class_canvaslayer.rst index c7ed53850..451b5cc75 100644 --- a/classes/class_canvaslayer.rst +++ b/classes/class_canvaslayer.rst @@ -21,37 +21,37 @@ Canvas drawing layer. Member Functions ---------------- -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_custom_viewport` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_layer` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_offset` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_rotation` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_rotationd` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_scale` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_transform` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`World2D` | :ref:`get_world_2d` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_viewport` **(** :ref:`Node` viewport **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_layer` **(** :ref:`int` layer **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_offset` **(** :ref:`Vector2` offset **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rotation` **(** :ref:`float` radians **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rotationd` **(** :ref:`float` degrees **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_scale` **(** :ref:`Vector2` scale **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_transform` **(** :ref:`Transform2D` transform **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`get_custom_viewport` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_layer` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_offset` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_rotation` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_rotationd` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_scale` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_transform` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`World2D` | :ref:`get_world_2d` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_viewport` **(** :ref:`Node` viewport **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_layer` **(** :ref:`int` layer **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_offset` **(** :ref:`Vector2` offset **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rotation` **(** :ref:`float` radians **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rotationd` **(** :ref:`float` degrees **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_scale` **(** :ref:`Vector2` scale **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_transform` **(** :ref:`Transform2D` transform **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -83,87 +83,87 @@ Member Function Description .. _class_CanvasLayer_get_custom_viewport: -- :ref:`Node` **get_custom_viewport** **(** **)** const +- :ref:`Node` **get_custom_viewport** **(** **)** const .. _class_CanvasLayer_get_layer: -- :ref:`int` **get_layer** **(** **)** const +- :ref:`int` **get_layer** **(** **)** const Return the layer index, determines the draw order, a lower value will be below a higher one. .. _class_CanvasLayer_get_offset: -- :ref:`Vector2` **get_offset** **(** **)** const +- :ref:`Vector2` **get_offset** **(** **)** const Return the base offset for this layer (helper). .. _class_CanvasLayer_get_rotation: -- :ref:`float` **get_rotation** **(** **)** const +- :ref:`float` **get_rotation** **(** **)** const Return the base rotation for this layer in radians (helper). .. _class_CanvasLayer_get_rotationd: -- :ref:`float` **get_rotationd** **(** **)** const +- :ref:`float` **get_rotationd** **(** **)** const Return the base rotation for this layer in degrees. .. _class_CanvasLayer_get_scale: -- :ref:`Vector2` **get_scale** **(** **)** const +- :ref:`Vector2` **get_scale** **(** **)** const Return the base scale for this layer (helper). .. _class_CanvasLayer_get_transform: -- :ref:`Transform2D` **get_transform** **(** **)** const +- :ref:`Transform2D` **get_transform** **(** **)** const Return the base transform for this layer. .. _class_CanvasLayer_get_world_2d: -- :ref:`World2D` **get_world_2d** **(** **)** const +- :ref:`World2D` **get_world_2d** **(** **)** const Return the :ref:`World2D` used by this layer. .. _class_CanvasLayer_set_custom_viewport: -- void **set_custom_viewport** **(** :ref:`Node` viewport **)** +- void **set_custom_viewport** **(** :ref:`Node` viewport **)** .. _class_CanvasLayer_set_layer: -- void **set_layer** **(** :ref:`int` layer **)** +- void **set_layer** **(** :ref:`int` layer **)** Set the layer index, determines the draw order, a lower value will be below a higher one. .. _class_CanvasLayer_set_offset: -- void **set_offset** **(** :ref:`Vector2` offset **)** +- void **set_offset** **(** :ref:`Vector2` offset **)** Set the base offset for this layer (helper). .. _class_CanvasLayer_set_rotation: -- void **set_rotation** **(** :ref:`float` radians **)** +- void **set_rotation** **(** :ref:`float` radians **)** Set the base rotation for this layer in radians (helper). .. _class_CanvasLayer_set_rotationd: -- void **set_rotationd** **(** :ref:`float` degrees **)** +- void **set_rotationd** **(** :ref:`float` degrees **)** Set the base rotation for this layer in degrees (helper). .. _class_CanvasLayer_set_scale: -- void **set_scale** **(** :ref:`Vector2` scale **)** +- void **set_scale** **(** :ref:`Vector2` scale **)** Set the base scale for this layer (helper). .. _class_CanvasLayer_set_transform: -- void **set_transform** **(** :ref:`Transform2D` transform **)** +- void **set_transform** **(** :ref:`Transform2D` transform **)** Set the base transform for this layer. diff --git a/classes/class_canvasmodulate.rst b/classes/class_canvasmodulate.rst index cb71e6e80..a8198a31e 100644 --- a/classes/class_canvasmodulate.rst +++ b/classes/class_canvasmodulate.rst @@ -19,11 +19,11 @@ Tint the entire canvas. Member Functions ---------------- -+----------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_color` **(** **)** const | -+----------------------------+------------------------------------------------------------------------------------------------+ -| void | :ref:`set_color` **(** :ref:`Color` color **)** | -+----------------------------+------------------------------------------------------------------------------------------------+ ++----------------------------+----------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_color` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------+ +| void | :ref:`set_color` **(** :ref:`Color` color **)** | ++----------------------------+----------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -43,13 +43,13 @@ Member Function Description .. _class_CanvasModulate_get_color: -- :ref:`Color` **get_color** **(** **)** const +- :ref:`Color` **get_color** **(** **)** const Gets the canvas tint color .. _class_CanvasModulate_set_color: -- void **set_color** **(** :ref:`Color` color **)** +- void **set_color** **(** :ref:`Color` color **)** Sets the canvas tint color diff --git a/classes/class_capsulemesh.rst b/classes/class_capsulemesh.rst index 11119becc..bf569f63c 100644 --- a/classes/class_capsulemesh.rst +++ b/classes/class_capsulemesh.rst @@ -19,23 +19,23 @@ Class representing a capsule-shaped :ref:`PrimitiveMesh`. Member Functions ---------------- -+----------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_mid_height` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_radial_segments` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_radius` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_rings` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mid_height` **(** :ref:`float` mid_height **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_radial_segments` **(** :ref:`int` segments **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_radius` **(** :ref:`float` radius **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rings` **(** :ref:`int` rings **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------+ ++----------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_mid_height` **(** **)** const | ++----------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_radial_segments` **(** **)** const | ++----------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_radius` **(** **)** const | ++----------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_rings` **(** **)** const | ++----------------------------+--------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_mid_height` **(** :ref:`float` mid_height **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_radial_segments` **(** :ref:`int` segments **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_radius` **(** :ref:`float` radius **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rings` **(** :ref:`int` rings **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -67,34 +67,34 @@ Member Function Description .. _class_CapsuleMesh_get_mid_height: -- :ref:`float` **get_mid_height** **(** **)** const +- :ref:`float` **get_mid_height** **(** **)** const .. _class_CapsuleMesh_get_radial_segments: -- :ref:`int` **get_radial_segments** **(** **)** const +- :ref:`int` **get_radial_segments** **(** **)** const .. _class_CapsuleMesh_get_radius: -- :ref:`float` **get_radius** **(** **)** const +- :ref:`float` **get_radius** **(** **)** const .. _class_CapsuleMesh_get_rings: -- :ref:`int` **get_rings** **(** **)** const +- :ref:`int` **get_rings** **(** **)** const .. _class_CapsuleMesh_set_mid_height: -- void **set_mid_height** **(** :ref:`float` mid_height **)** +- void **set_mid_height** **(** :ref:`float` mid_height **)** .. _class_CapsuleMesh_set_radial_segments: -- void **set_radial_segments** **(** :ref:`int` segments **)** +- void **set_radial_segments** **(** :ref:`int` segments **)** .. _class_CapsuleMesh_set_radius: -- void **set_radius** **(** :ref:`float` radius **)** +- void **set_radius** **(** :ref:`float` radius **)** .. _class_CapsuleMesh_set_rings: -- void **set_rings** **(** :ref:`int` rings **)** +- void **set_rings** **(** :ref:`int` rings **)** diff --git a/classes/class_capsuleshape.rst b/classes/class_capsuleshape.rst index 3f6b1913b..0b772397c 100644 --- a/classes/class_capsuleshape.rst +++ b/classes/class_capsuleshape.rst @@ -19,15 +19,15 @@ Capsule shape for collisions. Member Functions ---------------- -+----------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_height` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_radius` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------+ -| void | :ref:`set_height` **(** :ref:`float` height **)** | -+----------------------------+-------------------------------------------------------------------------------------------------+ -| void | :ref:`set_radius` **(** :ref:`float` radius **)** | -+----------------------------+-------------------------------------------------------------------------------------------------+ ++----------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_height` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_radius` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------+ +| void | :ref:`set_height` **(** :ref:`float` height **)** | ++----------------------------+-----------------------------------------------------------------------------------------------+ +| void | :ref:`set_radius` **(** :ref:`float` radius **)** | ++----------------------------+-----------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -51,25 +51,25 @@ Member Function Description .. _class_CapsuleShape_get_height: -- :ref:`float` **get_height** **(** **)** const +- :ref:`float` **get_height** **(** **)** const Return the capsule height. .. _class_CapsuleShape_get_radius: -- :ref:`float` **get_radius** **(** **)** const +- :ref:`float` **get_radius** **(** **)** const Return the capsule radius. .. _class_CapsuleShape_set_height: -- void **set_height** **(** :ref:`float` height **)** +- void **set_height** **(** :ref:`float` height **)** Set the capsule height. .. _class_CapsuleShape_set_radius: -- void **set_radius** **(** :ref:`float` radius **)** +- void **set_radius** **(** :ref:`float` radius **)** Set the capsule radius. diff --git a/classes/class_capsuleshape2d.rst b/classes/class_capsuleshape2d.rst index 235e01c3b..0addc3a71 100644 --- a/classes/class_capsuleshape2d.rst +++ b/classes/class_capsuleshape2d.rst @@ -19,15 +19,15 @@ Capsule shape for 2D collisions. Member Functions ---------------- -+----------------------------+---------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_height` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_radius` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`set_height` **(** :ref:`float` height **)** | -+----------------------------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`set_radius` **(** :ref:`float` radius **)** | -+----------------------------+---------------------------------------------------------------------------------------------------+ ++----------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_height` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_radius` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------+ +| void | :ref:`set_height` **(** :ref:`float` height **)** | ++----------------------------+-------------------------------------------------------------------------------------------------+ +| void | :ref:`set_radius` **(** :ref:`float` radius **)** | ++----------------------------+-------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -51,25 +51,25 @@ Member Function Description .. _class_CapsuleShape2D_get_height: -- :ref:`float` **get_height** **(** **)** const +- :ref:`float` **get_height** **(** **)** const Return the height of the :ref:`CapsuleShape2D`. .. _class_CapsuleShape2D_get_radius: -- :ref:`float` **get_radius** **(** **)** const +- :ref:`float` **get_radius** **(** **)** const Return the radius of the :ref:`CapsuleShape2D`. .. _class_CapsuleShape2D_set_height: -- void **set_height** **(** :ref:`float` height **)** +- void **set_height** **(** :ref:`float` height **)** Set the height of the :ref:`CapsuleShape2D`. .. _class_CapsuleShape2D_set_radius: -- void **set_radius** **(** :ref:`float` radius **)** +- void **set_radius** **(** :ref:`float` radius **)** Set the radius of the :ref:`CapsuleShape2D`. diff --git a/classes/class_centercontainer.rst b/classes/class_centercontainer.rst index 2826a9bfe..a1ff09bdc 100644 --- a/classes/class_centercontainer.rst +++ b/classes/class_centercontainer.rst @@ -19,11 +19,11 @@ Keeps children controls centered. Member Functions ---------------- -+--------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_using_top_left` **(** **)** const | -+--------------------------+--------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_top_left` **(** :ref:`bool` enable **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------+ ++--------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_using_top_left` **(** **)** const | ++--------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_top_left` **(** :ref:`bool` enable **)** | ++--------------------------+------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -43,13 +43,13 @@ Member Function Description .. _class_CenterContainer_is_using_top_left: -- :ref:`bool` **is_using_top_left** **(** **)** const +- :ref:`bool` **is_using_top_left** **(** **)** const Should put children to the top left corner instead of center of the container. .. _class_CenterContainer_set_use_top_left: -- void **set_use_top_left** **(** :ref:`bool` enable **)** +- void **set_use_top_left** **(** :ref:`bool` enable **)** This function will anchor the container children to the top left corner of the the container boundaries, moving all its children to that position, (the children new center will be the top left corner of the container). diff --git a/classes/class_circleshape2d.rst b/classes/class_circleshape2d.rst index 1dbf904dd..620e8171e 100644 --- a/classes/class_circleshape2d.rst +++ b/classes/class_circleshape2d.rst @@ -19,11 +19,11 @@ Circular shape for 2D collisions. Member Functions ---------------- -+----------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_radius` **(** **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------+ -| void | :ref:`set_radius` **(** :ref:`float` radius **)** | -+----------------------------+--------------------------------------------------------------------------------------------------+ ++----------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_radius` **(** **)** const | ++----------------------------+------------------------------------------------------------------------------------------------+ +| void | :ref:`set_radius` **(** :ref:`float` radius **)** | ++----------------------------+------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -43,13 +43,13 @@ Member Function Description .. _class_CircleShape2D_get_radius: -- :ref:`float` **get_radius** **(** **)** const +- :ref:`float` **get_radius** **(** **)** const Return the radius of the circle shape. .. _class_CircleShape2D_set_radius: -- void **set_radius** **(** :ref:`float` radius **)** +- void **set_radius** **(** :ref:`float` radius **)** Set the radius of the circle shape. diff --git a/classes/class_classdb.rst b/classes/class_classdb.rst index 81052f584..0abbb5194 100644 --- a/classes/class_classdb.rst +++ b/classes/class_classdb.rst @@ -19,47 +19,47 @@ Class information repository. Member Functions ---------------- -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_instance` **(** :ref:`String` class **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`class_exists` **(** :ref:`String` class **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`class_get_category` **(** :ref:`String` class **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`class_get_integer_constant` **(** :ref:`String` class, :ref:`String` name **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`class_get_integer_constant_list` **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`class_get_method_list` **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`class_get_property` **(** :ref:`Object` object, :ref:`String` property **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`class_get_property_list` **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`class_get_signal` **(** :ref:`String` class, :ref:`String` signal **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`class_get_signal_list` **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`class_has_integer_constant` **(** :ref:`String` class, :ref:`String` name **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`class_has_method` **(** :ref:`String` class, :ref:`String` method, :ref:`bool` no_inheritance=false **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`class_has_signal` **(** :ref:`String` class, :ref:`String` signal **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`class_set_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_class_list` **(** **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_inheriters_from_class` **(** :ref:`String` class **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_parent_class` **(** :ref:`String` class **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`instance` **(** :ref:`String` class **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_class_enabled` **(** :ref:`String` class **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_parent_class` **(** :ref:`String` class, :ref:`String` inherits **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_instance` **(** :ref:`String` class **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`class_exists` **(** :ref:`String` class **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`class_get_category` **(** :ref:`String` class **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`class_get_integer_constant` **(** :ref:`String` class, :ref:`String` name **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`class_get_integer_constant_list` **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`class_get_method_list` **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`class_get_property` **(** :ref:`Object` object, :ref:`String` property **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`class_get_property_list` **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`class_get_signal` **(** :ref:`String` class, :ref:`String` signal **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`class_get_signal_list` **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`class_has_integer_constant` **(** :ref:`String` class, :ref:`String` name **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`class_has_method` **(** :ref:`String` class, :ref:`String` method, :ref:`bool` no_inheritance=false **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`class_has_signal` **(** :ref:`String` class, :ref:`String` signal **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`class_set_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_class_list` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_inheriters_from_class` **(** :ref:`String` class **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_parent_class` **(** :ref:`String` class **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`instance` **(** :ref:`String` class **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_class_enabled` **(** :ref:`String` class **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_parent_class` **(** :ref:`String` class, :ref:`String` inherits **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -71,119 +71,119 @@ Member Function Description .. _class_ClassDB_can_instance: -- :ref:`bool` **can_instance** **(** :ref:`String` class **)** const +- :ref:`bool` **can_instance** **(** :ref:`String` class **)** const Returns true if you can instance objects from the specified 'class', false in other case. .. _class_ClassDB_class_exists: -- :ref:`bool` **class_exists** **(** :ref:`String` class **)** const +- :ref:`bool` **class_exists** **(** :ref:`String` class **)** const Returns whether the specified 'class' is available or not. .. _class_ClassDB_class_get_category: -- :ref:`String` **class_get_category** **(** :ref:`String` class **)** const +- :ref:`String` **class_get_category** **(** :ref:`String` class **)** const .. _class_ClassDB_class_get_integer_constant: -- :ref:`int` **class_get_integer_constant** **(** :ref:`String` class, :ref:`String` name **)** const +- :ref:`int` **class_get_integer_constant** **(** :ref:`String` class, :ref:`String` name **)** const Returns the value of the integer constant 'name' of 'class' or its ancestry. Always returns 0 when the constant could not be found. .. _class_ClassDB_class_get_integer_constant_list: -- :ref:`PoolStringArray` **class_get_integer_constant_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const +- :ref:`PoolStringArray` **class_get_integer_constant_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const Returns an array with the names all the integer constants of 'class' or its ancestry. .. _class_ClassDB_class_get_method_list: -- :ref:`Array` **class_get_method_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const +- :ref:`Array` **class_get_method_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const Returns an array with all the methods of 'class' or its ancestry if 'no_inheritance' is false. Every element of the array is a :ref:`Dictionary` with the following keys: args, default_args, flags, id, name, return: (class_name, hint, hint_string, name, type, usage). .. _class_ClassDB_class_get_property: -- :ref:`Variant` **class_get_property** **(** :ref:`Object` object, :ref:`String` property **)** const +- :ref:`Variant` **class_get_property** **(** :ref:`Object` object, :ref:`String` property **)** const Returns the value of 'property' of 'class' or its ancestry. .. _class_ClassDB_class_get_property_list: -- :ref:`Array` **class_get_property_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const +- :ref:`Array` **class_get_property_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const Returns an array with all the properties of 'class' or its ancestry if 'no_inheritance' is false. .. _class_ClassDB_class_get_signal: -- :ref:`Dictionary` **class_get_signal** **(** :ref:`String` class, :ref:`String` signal **)** const +- :ref:`Dictionary` **class_get_signal** **(** :ref:`String` class, :ref:`String` signal **)** const Returns the 'signal' data of 'class' or its ancestry. The returned value is a :ref:`Dictionary` with the following keys: args, default_args, flags, id, name, return: (class_name, hint, hint_string, name, type, usage). .. _class_ClassDB_class_get_signal_list: -- :ref:`Array` **class_get_signal_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const +- :ref:`Array` **class_get_signal_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const Returns an array with all the signals of 'class' or its ancestry if 'no_inheritance' is false. Every element of the array is a :ref:`Dictionary` as described in class_get_signal. .. _class_ClassDB_class_has_integer_constant: -- :ref:`bool` **class_has_integer_constant** **(** :ref:`String` class, :ref:`String` name **)** const +- :ref:`bool` **class_has_integer_constant** **(** :ref:`String` class, :ref:`String` name **)** const Return whether 'class' or its ancestry has an integer constant called 'name' or not. .. _class_ClassDB_class_has_method: -- :ref:`bool` **class_has_method** **(** :ref:`String` class, :ref:`String` method, :ref:`bool` no_inheritance=false **)** const +- :ref:`bool` **class_has_method** **(** :ref:`String` class, :ref:`String` method, :ref:`bool` no_inheritance=false **)** const Return whether 'class' (or its ancestry if 'no_inheritance' is false) has a method called 'method' or not. .. _class_ClassDB_class_has_signal: -- :ref:`bool` **class_has_signal** **(** :ref:`String` class, :ref:`String` signal **)** const +- :ref:`bool` **class_has_signal** **(** :ref:`String` class, :ref:`String` signal **)** const Return whether 'class' or its ancestry has a signal called 'signal' or not. .. _class_ClassDB_class_set_property: -- :ref:`int` **class_set_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** const +- :ref:`int` **class_set_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** const Sets 'property' value of 'class' to 'value'. .. _class_ClassDB_get_class_list: -- :ref:`PoolStringArray` **get_class_list** **(** **)** const +- :ref:`PoolStringArray` **get_class_list** **(** **)** const Returns the names of all the classes available. .. _class_ClassDB_get_inheriters_from_class: -- :ref:`PoolStringArray` **get_inheriters_from_class** **(** :ref:`String` class **)** const +- :ref:`PoolStringArray` **get_inheriters_from_class** **(** :ref:`String` class **)** const Returns the names of all the classes that directly or indirectly inherit from 'class'. .. _class_ClassDB_get_parent_class: -- :ref:`String` **get_parent_class** **(** :ref:`String` class **)** const +- :ref:`String` **get_parent_class** **(** :ref:`String` class **)** const Returns the parent class of 'class'. .. _class_ClassDB_instance: -- :ref:`Variant` **instance** **(** :ref:`String` class **)** const +- :ref:`Variant` **instance** **(** :ref:`String` class **)** const Creates an instance of 'class'. .. _class_ClassDB_is_class_enabled: -- :ref:`bool` **is_class_enabled** **(** :ref:`String` class **)** const +- :ref:`bool` **is_class_enabled** **(** :ref:`String` class **)** const Returns whether this class is enabled or not. .. _class_ClassDB_is_parent_class: -- :ref:`bool` **is_parent_class** **(** :ref:`String` class, :ref:`String` inherits **)** const +- :ref:`bool` **is_parent_class** **(** :ref:`String` class, :ref:`String` inherits **)** const Returns whether 'inherits' is an ancestor of 'class' or not. diff --git a/classes/class_collisionobject.rst b/classes/class_collisionobject.rst index aeac08c34..24c325ec6 100644 --- a/classes/class_collisionobject.rst +++ b/classes/class_collisionobject.rst @@ -21,66 +21,66 @@ Base node for collision objects. Member Functions ---------------- -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_input_event` **(** :ref:`Object` camera, :ref:`InputEvent` event, :ref:`Vector3` click_position, :ref:`Vector3` click_normal, :ref:`int` shape_idx **)** virtual | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`create_shape_owner` **(** :ref:`Object` owner **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_capture_input_on_drag` **(** **)** const | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_rid` **(** **)** const | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_shape_owners` **(** **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_ray_pickable` **(** **)** const | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_shape_owner_disabled` **(** :ref:`int` owner_id **)** const | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_shape_owner` **(** :ref:`int` owner_id **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_capture_input_on_drag` **(** :ref:`bool` enable **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ray_pickable` **(** :ref:`bool` ray_pickable **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`shape_find_owner` **(** :ref:`int` shape_index **)** const | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shape_owner_add_shape` **(** :ref:`int` owner_id, :ref:`Shape` shape **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shape_owner_clear_shapes` **(** :ref:`int` owner_id **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`shape_owner_get_owner` **(** :ref:`int` owner_id **)** const | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Shape` | :ref:`shape_owner_get_shape` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`shape_owner_get_shape_count` **(** :ref:`int` owner_id **)** const | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`shape_owner_get_shape_index` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`shape_owner_get_transform` **(** :ref:`int` owner_id **)** const | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shape_owner_remove_shape` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shape_owner_set_disabled` **(** :ref:`int` owner_id, :ref:`bool` disabled **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shape_owner_set_transform` **(** :ref:`int` owner_id, :ref:`Transform` transform **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_input_event` **(** :ref:`Object` camera, :ref:`InputEvent` event, :ref:`Vector3` click_position, :ref:`Vector3` click_normal, :ref:`int` shape_idx **)** virtual | ++------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`create_shape_owner` **(** :ref:`Object` owner **)** | ++------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_capture_input_on_drag` **(** **)** const | ++------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_rid` **(** **)** const | ++------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_shape_owners` **(** **)** | ++------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_ray_pickable` **(** **)** const | ++------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_shape_owner_disabled` **(** :ref:`int` owner_id **)** const | ++------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_shape_owner` **(** :ref:`int` owner_id **)** | ++------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_capture_input_on_drag` **(** :ref:`bool` enable **)** | ++------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ray_pickable` **(** :ref:`bool` ray_pickable **)** | ++------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`shape_find_owner` **(** :ref:`int` shape_index **)** const | ++------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shape_owner_add_shape` **(** :ref:`int` owner_id, :ref:`Shape` shape **)** | ++------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shape_owner_clear_shapes` **(** :ref:`int` owner_id **)** | ++------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`shape_owner_get_owner` **(** :ref:`int` owner_id **)** const | ++------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Shape` | :ref:`shape_owner_get_shape` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const | ++------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`shape_owner_get_shape_count` **(** :ref:`int` owner_id **)** const | ++------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`shape_owner_get_shape_index` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const | ++------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`shape_owner_get_transform` **(** :ref:`int` owner_id **)** const | ++------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shape_owner_remove_shape` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** | ++------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shape_owner_set_disabled` **(** :ref:`int` owner_id, :ref:`bool` disabled **)** | ++------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shape_owner_set_transform` **(** :ref:`int` owner_id, :ref:`Transform` transform **)** | ++------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_CollisionObject_input_event: -- **input_event** **(** :ref:`Object` camera, :ref:`Object` event, :ref:`Vector3` click_position, :ref:`Vector3` click_normal, :ref:`int` shape_idx **)** +- **input_event** **(** :ref:`Object` camera, :ref:`Object` event, :ref:`Vector3` click_position, :ref:`Vector3` click_normal, :ref:`int` shape_idx **)** .. _class_CollisionObject_mouse_entered: -- **mouse_entered** **(** **)** +- **mouse_entered** **(** **)** Emitted when the mouse pointer enters any of this object's shapes. .. _class_CollisionObject_mouse_exited: -- **mouse_exited** **(** **)** +- **mouse_exited** **(** **)** Emitted when the mouse pointer exits all this object's shapes. @@ -107,115 +107,115 @@ Member Function Description .. _class_CollisionObject__input_event: -- void **_input_event** **(** :ref:`Object` camera, :ref:`InputEvent` event, :ref:`Vector3` click_position, :ref:`Vector3` click_normal, :ref:`int` shape_idx **)** virtual +- void **_input_event** **(** :ref:`Object` camera, :ref:`InputEvent` event, :ref:`Vector3` click_position, :ref:`Vector3` click_normal, :ref:`int` shape_idx **)** virtual .. _class_CollisionObject_create_shape_owner: -- :ref:`int` **create_shape_owner** **(** :ref:`Object` owner **)** +- :ref:`int` **create_shape_owner** **(** :ref:`Object` owner **)** Creates a new shape owner for the given object. Returns ``owner_id`` of the new owner for future reference. .. _class_CollisionObject_get_capture_input_on_drag: -- :ref:`bool` **get_capture_input_on_drag** **(** **)** const +- :ref:`bool` **get_capture_input_on_drag** **(** **)** const .. _class_CollisionObject_get_rid: -- :ref:`RID` **get_rid** **(** **)** const +- :ref:`RID` **get_rid** **(** **)** const Returns the object's :ref:`RID`. .. _class_CollisionObject_get_shape_owners: -- :ref:`Array` **get_shape_owners** **(** **)** +- :ref:`Array` **get_shape_owners** **(** **)** Returns an :ref:`Array` of ``owner_id`` identifiers. You can use these ids in other methods that take ``owner_id`` as an argument. .. _class_CollisionObject_is_ray_pickable: -- :ref:`bool` **is_ray_pickable** **(** **)** const +- :ref:`bool` **is_ray_pickable** **(** **)** const .. _class_CollisionObject_is_shape_owner_disabled: -- :ref:`bool` **is_shape_owner_disabled** **(** :ref:`int` owner_id **)** const +- :ref:`bool` **is_shape_owner_disabled** **(** :ref:`int` owner_id **)** const If ``true`` the shape owner and its shapes are disabled. .. _class_CollisionObject_remove_shape_owner: -- void **remove_shape_owner** **(** :ref:`int` owner_id **)** +- void **remove_shape_owner** **(** :ref:`int` owner_id **)** Removes the given shape owner. .. _class_CollisionObject_set_capture_input_on_drag: -- void **set_capture_input_on_drag** **(** :ref:`bool` enable **)** +- void **set_capture_input_on_drag** **(** :ref:`bool` enable **)** .. _class_CollisionObject_set_ray_pickable: -- void **set_ray_pickable** **(** :ref:`bool` ray_pickable **)** +- void **set_ray_pickable** **(** :ref:`bool` ray_pickable **)** .. _class_CollisionObject_shape_find_owner: -- :ref:`int` **shape_find_owner** **(** :ref:`int` shape_index **)** const +- :ref:`int` **shape_find_owner** **(** :ref:`int` shape_index **)** const Returns the ``owner_id`` of the given shape. .. _class_CollisionObject_shape_owner_add_shape: -- void **shape_owner_add_shape** **(** :ref:`int` owner_id, :ref:`Shape` shape **)** +- void **shape_owner_add_shape** **(** :ref:`int` owner_id, :ref:`Shape` shape **)** Adds a :ref:`Shape` to the shape owner. .. _class_CollisionObject_shape_owner_clear_shapes: -- void **shape_owner_clear_shapes** **(** :ref:`int` owner_id **)** +- void **shape_owner_clear_shapes** **(** :ref:`int` owner_id **)** Removes all shapes from the shape owner. .. _class_CollisionObject_shape_owner_get_owner: -- :ref:`Object` **shape_owner_get_owner** **(** :ref:`int` owner_id **)** const +- :ref:`Object` **shape_owner_get_owner** **(** :ref:`int` owner_id **)** const Returns the parent object of the given shape owner. .. _class_CollisionObject_shape_owner_get_shape: -- :ref:`Shape` **shape_owner_get_shape** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const +- :ref:`Shape` **shape_owner_get_shape** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const Returns the :ref:`Shape` with the given id from the given shape owner. .. _class_CollisionObject_shape_owner_get_shape_count: -- :ref:`int` **shape_owner_get_shape_count** **(** :ref:`int` owner_id **)** const +- :ref:`int` **shape_owner_get_shape_count** **(** :ref:`int` owner_id **)** const Returns the number of shapes the given shape owner contains. .. _class_CollisionObject_shape_owner_get_shape_index: -- :ref:`int` **shape_owner_get_shape_index** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const +- :ref:`int` **shape_owner_get_shape_index** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const .. _class_CollisionObject_shape_owner_get_transform: -- :ref:`Transform` **shape_owner_get_transform** **(** :ref:`int` owner_id **)** const +- :ref:`Transform` **shape_owner_get_transform** **(** :ref:`int` owner_id **)** const Returns the shape owner's :ref:`Transform`. .. _class_CollisionObject_shape_owner_remove_shape: -- void **shape_owner_remove_shape** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** +- void **shape_owner_remove_shape** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** Removes a shape from the given shape owner. .. _class_CollisionObject_shape_owner_set_disabled: -- void **shape_owner_set_disabled** **(** :ref:`int` owner_id, :ref:`bool` disabled **)** +- void **shape_owner_set_disabled** **(** :ref:`int` owner_id, :ref:`bool` disabled **)** If ``true`` disables the given shape owner. .. _class_CollisionObject_shape_owner_set_transform: -- void **shape_owner_set_transform** **(** :ref:`int` owner_id, :ref:`Transform` transform **)** +- void **shape_owner_set_transform** **(** :ref:`int` owner_id, :ref:`Transform` transform **)** Sets the :ref:`Transform` of the given shape owner. diff --git a/classes/class_collisionobject2d.rst b/classes/class_collisionobject2d.rst index 4a86dcd58..9da1b9396 100644 --- a/classes/class_collisionobject2d.rst +++ b/classes/class_collisionobject2d.rst @@ -21,68 +21,68 @@ Base node for 2D collision objects. Member Functions ---------------- -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_input_event` **(** :ref:`Object` viewport, :ref:`InputEvent` event, :ref:`int` shape_idx **)** virtual | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`create_shape_owner` **(** :ref:`Object` owner **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_rid` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_shape_owners` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_pickable` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_shape_owner_disabled` **(** :ref:`int` owner_id **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_shape_owner_one_way_collision_enabled` **(** :ref:`int` owner_id **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_shape_owner` **(** :ref:`int` owner_id **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pickable` **(** :ref:`bool` enabled **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`shape_find_owner` **(** :ref:`int` shape_index **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shape_owner_add_shape` **(** :ref:`int` owner_id, :ref:`Shape2D` shape **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shape_owner_clear_shapes` **(** :ref:`int` owner_id **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`shape_owner_get_owner` **(** :ref:`int` owner_id **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Shape2D` | :ref:`shape_owner_get_shape` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`shape_owner_get_shape_count` **(** :ref:`int` owner_id **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`shape_owner_get_shape_index` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`shape_owner_get_transform` **(** :ref:`int` owner_id **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shape_owner_remove_shape` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shape_owner_set_disabled` **(** :ref:`int` owner_id, :ref:`bool` disabled **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shape_owner_set_one_way_collision` **(** :ref:`int` owner_id, :ref:`bool` enable **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shape_owner_set_transform` **(** :ref:`int` owner_id, :ref:`Transform2D` transform **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_input_event` **(** :ref:`Object` viewport, :ref:`InputEvent` event, :ref:`int` shape_idx **)** virtual | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`create_shape_owner` **(** :ref:`Object` owner **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_rid` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_shape_owners` **(** **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_pickable` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_shape_owner_disabled` **(** :ref:`int` owner_id **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_shape_owner_one_way_collision_enabled` **(** :ref:`int` owner_id **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_shape_owner` **(** :ref:`int` owner_id **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pickable` **(** :ref:`bool` enabled **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`shape_find_owner` **(** :ref:`int` shape_index **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shape_owner_add_shape` **(** :ref:`int` owner_id, :ref:`Shape2D` shape **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shape_owner_clear_shapes` **(** :ref:`int` owner_id **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`shape_owner_get_owner` **(** :ref:`int` owner_id **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Shape2D` | :ref:`shape_owner_get_shape` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`shape_owner_get_shape_count` **(** :ref:`int` owner_id **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`shape_owner_get_shape_index` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`shape_owner_get_transform` **(** :ref:`int` owner_id **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shape_owner_remove_shape` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shape_owner_set_disabled` **(** :ref:`int` owner_id, :ref:`bool` disabled **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shape_owner_set_one_way_collision` **(** :ref:`int` owner_id, :ref:`bool` enable **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shape_owner_set_transform` **(** :ref:`int` owner_id, :ref:`Transform2D` transform **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_CollisionObject2D_input_event: -- **input_event** **(** :ref:`Object` viewport, :ref:`Object` event, :ref:`int` shape_idx **)** +- **input_event** **(** :ref:`Object` viewport, :ref:`Object` event, :ref:`int` shape_idx **)** Emitted when an input event occurs and ``input_pickable`` is ``true``. .. _class_CollisionObject2D_mouse_entered: -- **mouse_entered** **(** **)** +- **mouse_entered** **(** **)** Emitted when the mouse pointer enters any of this object's shapes. .. _class_CollisionObject2D_mouse_exited: -- **mouse_exited** **(** **)** +- **mouse_exited** **(** **)** Emitted when the mouse pointer exits all this object's shapes. @@ -105,119 +105,119 @@ Member Function Description .. _class_CollisionObject2D__input_event: -- void **_input_event** **(** :ref:`Object` viewport, :ref:`InputEvent` event, :ref:`int` shape_idx **)** virtual +- void **_input_event** **(** :ref:`Object` viewport, :ref:`InputEvent` event, :ref:`int` shape_idx **)** virtual .. _class_CollisionObject2D_create_shape_owner: -- :ref:`int` **create_shape_owner** **(** :ref:`Object` owner **)** +- :ref:`int` **create_shape_owner** **(** :ref:`Object` owner **)** Creates a new shape owner for the given object. Returns ``owner_id`` of the new owner for future reference. .. _class_CollisionObject2D_get_rid: -- :ref:`RID` **get_rid** **(** **)** const +- :ref:`RID` **get_rid** **(** **)** const Returns the object's :ref:`RID`. .. _class_CollisionObject2D_get_shape_owners: -- :ref:`Array` **get_shape_owners** **(** **)** +- :ref:`Array` **get_shape_owners** **(** **)** Returns an :ref:`Array` of ``owner_id`` identifiers. You can use these ids in other methods that take ``owner_id`` as an argument. .. _class_CollisionObject2D_is_pickable: -- :ref:`bool` **is_pickable** **(** **)** const +- :ref:`bool` **is_pickable** **(** **)** const Return whether this object is pickable. .. _class_CollisionObject2D_is_shape_owner_disabled: -- :ref:`bool` **is_shape_owner_disabled** **(** :ref:`int` owner_id **)** const +- :ref:`bool` **is_shape_owner_disabled** **(** :ref:`int` owner_id **)** const If ``true`` the shape owner and its shapes are disabled. .. _class_CollisionObject2D_is_shape_owner_one_way_collision_enabled: -- :ref:`bool` **is_shape_owner_one_way_collision_enabled** **(** :ref:`int` owner_id **)** const +- :ref:`bool` **is_shape_owner_one_way_collision_enabled** **(** :ref:`int` owner_id **)** const .. _class_CollisionObject2D_remove_shape_owner: -- void **remove_shape_owner** **(** :ref:`int` owner_id **)** +- void **remove_shape_owner** **(** :ref:`int` owner_id **)** Removes the given shape owner. .. _class_CollisionObject2D_set_pickable: -- void **set_pickable** **(** :ref:`bool` enabled **)** +- void **set_pickable** **(** :ref:`bool` enabled **)** Set whether this object is pickable. A pickable object can detect the mouse pointer enter/leave it and, if the mouse is inside it, report input events. .. _class_CollisionObject2D_shape_find_owner: -- :ref:`int` **shape_find_owner** **(** :ref:`int` shape_index **)** const +- :ref:`int` **shape_find_owner** **(** :ref:`int` shape_index **)** const Returns the ``owner_id`` of the given shape. .. _class_CollisionObject2D_shape_owner_add_shape: -- void **shape_owner_add_shape** **(** :ref:`int` owner_id, :ref:`Shape2D` shape **)** +- void **shape_owner_add_shape** **(** :ref:`int` owner_id, :ref:`Shape2D` shape **)** Adds a :ref:`Shape2D` to the shape owner. .. _class_CollisionObject2D_shape_owner_clear_shapes: -- void **shape_owner_clear_shapes** **(** :ref:`int` owner_id **)** +- void **shape_owner_clear_shapes** **(** :ref:`int` owner_id **)** Removes all shapes from the shape owner. .. _class_CollisionObject2D_shape_owner_get_owner: -- :ref:`Object` **shape_owner_get_owner** **(** :ref:`int` owner_id **)** const +- :ref:`Object` **shape_owner_get_owner** **(** :ref:`int` owner_id **)** const Returns the parent object of the given shape owner. .. _class_CollisionObject2D_shape_owner_get_shape: -- :ref:`Shape2D` **shape_owner_get_shape** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const +- :ref:`Shape2D` **shape_owner_get_shape** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const Returns the :ref:`Shape2D` with the given id from the given shape owner. .. _class_CollisionObject2D_shape_owner_get_shape_count: -- :ref:`int` **shape_owner_get_shape_count** **(** :ref:`int` owner_id **)** const +- :ref:`int` **shape_owner_get_shape_count** **(** :ref:`int` owner_id **)** const Returns the number of shapes the given shape owner contains. .. _class_CollisionObject2D_shape_owner_get_shape_index: -- :ref:`int` **shape_owner_get_shape_index** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const +- :ref:`int` **shape_owner_get_shape_index** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const .. _class_CollisionObject2D_shape_owner_get_transform: -- :ref:`Transform2D` **shape_owner_get_transform** **(** :ref:`int` owner_id **)** const +- :ref:`Transform2D` **shape_owner_get_transform** **(** :ref:`int` owner_id **)** const Returns the shape owner's :ref:`Transform2D`. .. _class_CollisionObject2D_shape_owner_remove_shape: -- void **shape_owner_remove_shape** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** +- void **shape_owner_remove_shape** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** Removes a shape from the given shape owner. .. _class_CollisionObject2D_shape_owner_set_disabled: -- void **shape_owner_set_disabled** **(** :ref:`int` owner_id, :ref:`bool` disabled **)** +- void **shape_owner_set_disabled** **(** :ref:`int` owner_id, :ref:`bool` disabled **)** If ``true`` disables the given shape owner. .. _class_CollisionObject2D_shape_owner_set_one_way_collision: -- void **shape_owner_set_one_way_collision** **(** :ref:`int` owner_id, :ref:`bool` enable **)** +- void **shape_owner_set_one_way_collision** **(** :ref:`int` owner_id, :ref:`bool` enable **)** .. _class_CollisionObject2D_shape_owner_set_transform: -- void **shape_owner_set_transform** **(** :ref:`int` owner_id, :ref:`Transform2D` transform **)** +- void **shape_owner_set_transform** **(** :ref:`int` owner_id, :ref:`Transform2D` transform **)** Sets the :ref:`Transform2D` of the given shape owner. diff --git a/classes/class_collisionpolygon.rst b/classes/class_collisionpolygon.rst index 5600b7bf6..9f545413b 100644 --- a/classes/class_collisionpolygon.rst +++ b/classes/class_collisionpolygon.rst @@ -19,19 +19,19 @@ Editor-only class for defining a collision polygon in 3D space. Member Functions ---------------- -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_depth` **(** **)** const | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_polygon` **(** **)** const | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_disabled` **(** **)** const | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_depth` **(** :ref:`float` depth **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_disabled` **(** :ref:`bool` disabled **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_polygon` **(** :ref:`PoolVector2Array` polygon **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_depth` **(** **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`get_polygon` **(** **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_disabled` **(** **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_depth` **(** :ref:`float` depth **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_disabled` **(** :ref:`bool` disabled **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_polygon` **(** :ref:`PoolVector2Array` polygon **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -59,26 +59,26 @@ Member Function Description .. _class_CollisionPolygon_get_depth: -- :ref:`float` **get_depth** **(** **)** const +- :ref:`float` **get_depth** **(** **)** const .. _class_CollisionPolygon_get_polygon: -- :ref:`PoolVector2Array` **get_polygon** **(** **)** const +- :ref:`PoolVector2Array` **get_polygon** **(** **)** const .. _class_CollisionPolygon_is_disabled: -- :ref:`bool` **is_disabled** **(** **)** const +- :ref:`bool` **is_disabled** **(** **)** const .. _class_CollisionPolygon_set_depth: -- void **set_depth** **(** :ref:`float` depth **)** +- void **set_depth** **(** :ref:`float` depth **)** .. _class_CollisionPolygon_set_disabled: -- void **set_disabled** **(** :ref:`bool` disabled **)** +- void **set_disabled** **(** :ref:`bool` disabled **)** .. _class_CollisionPolygon_set_polygon: -- void **set_polygon** **(** :ref:`PoolVector2Array` polygon **)** +- void **set_polygon** **(** :ref:`PoolVector2Array` polygon **)** diff --git a/classes/class_collisionpolygon2d.rst b/classes/class_collisionpolygon2d.rst index a8db5e1cd..5e21d04a2 100644 --- a/classes/class_collisionpolygon2d.rst +++ b/classes/class_collisionpolygon2d.rst @@ -19,23 +19,23 @@ Defines a 2D collision polygon. Member Functions ---------------- -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_build_mode` **(** **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_polygon` **(** **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_disabled` **(** **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_one_way_collision_enabled` **(** **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_build_mode` **(** :ref:`int` build_mode **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_disabled` **(** :ref:`bool` disabled **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_one_way_collision` **(** :ref:`bool` enabled **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_polygon` **(** :ref:`PoolVector2Array` polygon **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_build_mode` **(** **)** const | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`get_polygon` **(** **)** const | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_disabled` **(** **)** const | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_one_way_collision_enabled` **(** **)** const | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_build_mode` **(** :ref:`int` build_mode **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_disabled` **(** :ref:`bool` disabled **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_one_way_collision` **(** :ref:`bool` enabled **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_polygon` **(** :ref:`PoolVector2Array` polygon **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -73,41 +73,41 @@ Member Function Description .. _class_CollisionPolygon2D_get_build_mode: -- :ref:`int` **get_build_mode** **(** **)** const +- :ref:`int` **get_build_mode** **(** **)** const Return whether the polygon is a :ref:`ConvexPolygonShape2D` (``build_mode==0``), or a :ref:`ConcavePolygonShape2D` (``build_mode==1``). .. _class_CollisionPolygon2D_get_polygon: -- :ref:`PoolVector2Array` **get_polygon** **(** **)** const +- :ref:`PoolVector2Array` **get_polygon** **(** **)** const Return the list of points that define the polygon. .. _class_CollisionPolygon2D_is_disabled: -- :ref:`bool` **is_disabled** **(** **)** const +- :ref:`bool` **is_disabled** **(** **)** const .. _class_CollisionPolygon2D_is_one_way_collision_enabled: -- :ref:`bool` **is_one_way_collision_enabled** **(** **)** const +- :ref:`bool` **is_one_way_collision_enabled** **(** **)** const .. _class_CollisionPolygon2D_set_build_mode: -- void **set_build_mode** **(** :ref:`int` build_mode **)** +- void **set_build_mode** **(** :ref:`int` build_mode **)** Set whether the polygon is to be a :ref:`ConvexPolygonShape2D` (``build_mode==0``), or a :ref:`ConcavePolygonShape2D` (``build_mode==1``). .. _class_CollisionPolygon2D_set_disabled: -- void **set_disabled** **(** :ref:`bool` disabled **)** +- void **set_disabled** **(** :ref:`bool` disabled **)** .. _class_CollisionPolygon2D_set_one_way_collision: -- void **set_one_way_collision** **(** :ref:`bool` enabled **)** +- void **set_one_way_collision** **(** :ref:`bool` enabled **)** .. _class_CollisionPolygon2D_set_polygon: -- void **set_polygon** **(** :ref:`PoolVector2Array` polygon **)** +- void **set_polygon** **(** :ref:`PoolVector2Array` polygon **)** Set the array of points forming the polygon. diff --git a/classes/class_collisionshape.rst b/classes/class_collisionshape.rst index 7617d0368..3095b019d 100644 --- a/classes/class_collisionshape.rst +++ b/classes/class_collisionshape.rst @@ -19,19 +19,19 @@ Node that represents collision shape data in 3D space. Member Functions ---------------- -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`Shape` | :ref:`get_shape` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_disabled` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`make_convex_from_brothers` **(** **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resource_changed` **(** :ref:`Resource` resource **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_disabled` **(** :ref:`bool` enable **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shape` **(** :ref:`Shape` shape **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ ++----------------------------+---------------------------------------------------------------------------------------------------------------------+ +| :ref:`Shape` | :ref:`get_shape` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_disabled` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`make_convex_from_brothers` **(** **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resource_changed` **(** :ref:`Resource` resource **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_disabled` **(** :ref:`bool` enable **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shape` **(** :ref:`Shape` shape **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -55,30 +55,30 @@ Member Function Description .. _class_CollisionShape_get_shape: -- :ref:`Shape` **get_shape** **(** **)** const +- :ref:`Shape` **get_shape** **(** **)** const .. _class_CollisionShape_is_disabled: -- :ref:`bool` **is_disabled** **(** **)** const +- :ref:`bool` **is_disabled** **(** **)** const .. _class_CollisionShape_make_convex_from_brothers: -- void **make_convex_from_brothers** **(** **)** +- void **make_convex_from_brothers** **(** **)** Sets the collision shape's shape to the addition of all its convexed :ref:`MeshInstance` siblings geometry. .. _class_CollisionShape_resource_changed: -- void **resource_changed** **(** :ref:`Resource` resource **)** +- void **resource_changed** **(** :ref:`Resource` resource **)** If this method exists within a script it will be called whenever the shape resource has been modified. .. _class_CollisionShape_set_disabled: -- void **set_disabled** **(** :ref:`bool` enable **)** +- void **set_disabled** **(** :ref:`bool` enable **)** .. _class_CollisionShape_set_shape: -- void **set_shape** **(** :ref:`Shape` shape **)** +- void **set_shape** **(** :ref:`Shape` shape **)** diff --git a/classes/class_collisionshape2d.rst b/classes/class_collisionshape2d.rst index b166f7a02..1623c6601 100644 --- a/classes/class_collisionshape2d.rst +++ b/classes/class_collisionshape2d.rst @@ -19,19 +19,19 @@ Node that represents collision shape data in 2D space. Member Functions ---------------- -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Shape2D` | :ref:`get_shape` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_disabled` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_one_way_collision_enabled` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_disabled` **(** :ref:`bool` disabled **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_one_way_collision` **(** :ref:`bool` enabled **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shape` **(** :ref:`Shape2D` shape **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Shape2D` | :ref:`get_shape` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_disabled` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_one_way_collision_enabled` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_disabled` **(** :ref:`bool` disabled **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_one_way_collision` **(** :ref:`bool` enabled **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shape` **(** :ref:`Shape2D` shape **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -59,26 +59,26 @@ Member Function Description .. _class_CollisionShape2D_get_shape: -- :ref:`Shape2D` **get_shape** **(** **)** const +- :ref:`Shape2D` **get_shape** **(** **)** const .. _class_CollisionShape2D_is_disabled: -- :ref:`bool` **is_disabled** **(** **)** const +- :ref:`bool` **is_disabled** **(** **)** const .. _class_CollisionShape2D_is_one_way_collision_enabled: -- :ref:`bool` **is_one_way_collision_enabled** **(** **)** const +- :ref:`bool` **is_one_way_collision_enabled** **(** **)** const .. _class_CollisionShape2D_set_disabled: -- void **set_disabled** **(** :ref:`bool` disabled **)** +- void **set_disabled** **(** :ref:`bool` disabled **)** .. _class_CollisionShape2D_set_one_way_collision: -- void **set_one_way_collision** **(** :ref:`bool` enabled **)** +- void **set_one_way_collision** **(** :ref:`bool` enabled **)** .. _class_CollisionShape2D_set_shape: -- void **set_shape** **(** :ref:`Shape2D` shape **)** +- void **set_shape** **(** :ref:`Shape2D` shape **)** diff --git a/classes/class_color.rst b/classes/class_color.rst index 0f69050d6..a80d17c87 100644 --- a/classes/class_color.rst +++ b/classes/class_color.rst @@ -17,31 +17,31 @@ Color in RGBA format with some support for ARGB format. Member Functions ---------------- -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`Color` **(** :ref:`float` r, :ref:`float` g, :ref:`float` b, :ref:`float` a **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`Color` **(** :ref:`float` r, :ref:`float` g, :ref:`float` b **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`Color` **(** :ref:`int` from **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`Color` **(** :ref:`String` from **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`blend` **(** :ref:`Color` over **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`contrasted` **(** **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`gray` **(** **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`inverted` **(** **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`linear_interpolate` **(** :ref:`Color` b, :ref:`float` t **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`to_argb32` **(** **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`to_html` **(** :ref:`bool` with_alpha=True **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`to_rgba32` **(** **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`Color` **(** :ref:`float` r, :ref:`float` g, :ref:`float` b, :ref:`float` a **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`Color` **(** :ref:`float` r, :ref:`float` g, :ref:`float` b **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`Color` **(** :ref:`int` from **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`Color` **(** :ref:`String` from **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`blend` **(** :ref:`Color` over **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`contrasted` **(** **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`gray` **(** **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`inverted` **(** **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`linear_interpolate` **(** :ref:`Color` b, :ref:`float` t **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`to_argb32` **(** **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`to_html` **(** :ref:`bool` with_alpha=True **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`to_rgba32` **(** **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -101,7 +101,7 @@ Member Function Description .. _class_Color_Color: -- :ref:`Color` **Color** **(** :ref:`float` r, :ref:`float` g, :ref:`float` b, :ref:`float` a **)** +- :ref:`Color` **Color** **(** :ref:`float` r, :ref:`float` g, :ref:`float` b, :ref:`float` a **)** Constructs a color from an RGBA profile using values between 0 and 1 (float). @@ -111,7 +111,7 @@ Constructs a color from an RGBA profile using values between 0 and 1 (float). .. _class_Color_Color: -- :ref:`Color` **Color** **(** :ref:`float` r, :ref:`float` g, :ref:`float` b **)** +- :ref:`Color` **Color** **(** :ref:`float` r, :ref:`float` g, :ref:`float` b **)** Constructs a color from an RGB profile using values between 0 and 1 (float). Alpha will always be 1. @@ -121,7 +121,7 @@ Constructs a color from an RGB profile using values between 0 and 1 (float). Alp .. _class_Color_Color: -- :ref:`Color` **Color** **(** :ref:`int` from **)** +- :ref:`Color` **Color** **(** :ref:`int` from **)** Constructs a color from a 32-bit integer (each byte represents a component of the RGBA profile). @@ -131,7 +131,7 @@ Constructs a color from a 32-bit integer (each byte represents a component of th .. _class_Color_Color: -- :ref:`Color` **Color** **(** :ref:`String` from **)** +- :ref:`Color` **Color** **(** :ref:`String` from **)** Constructs a color from an HTML hexadecimal color string in ARGB or RGB format. @@ -155,7 +155,7 @@ The following string formats are supported: .. _class_Color_blend: -- :ref:`Color` **blend** **(** :ref:`Color` over **)** +- :ref:`Color` **blend** **(** :ref:`Color` over **)** Returns a new color resulting from blending this color over another color. If the color is opaque, the result would also be opaque. The other color could then take a range of values with different alpha values. @@ -167,7 +167,7 @@ Returns a new color resulting from blending this color over another color. If th .. _class_Color_contrasted: -- :ref:`Color` **contrasted** **(** **)** +- :ref:`Color` **contrasted** **(** **)** Returns the most contrasting color. @@ -178,7 +178,7 @@ Returns the most contrasting color. .. _class_Color_gray: -- :ref:`float` **gray** **(** **)** +- :ref:`float` **gray** **(** **)** Returns the color's grayscale. @@ -191,7 +191,7 @@ The gray is calculated by (r + g + b) / 3. .. _class_Color_inverted: -- :ref:`Color` **inverted** **(** **)** +- :ref:`Color` **inverted** **(** **)** Returns the inverted color (1-r, 1-g, 1-b, 1-a). @@ -202,7 +202,7 @@ Returns the inverted color (1-r, 1-g, 1-b, 1-a). .. _class_Color_linear_interpolate: -- :ref:`Color` **linear_interpolate** **(** :ref:`Color` b, :ref:`float` t **)** +- :ref:`Color` **linear_interpolate** **(** :ref:`Color` b, :ref:`float` t **)** Returns the color of the linear interpolation with another color. The value t is between 0 and 1 (float). @@ -214,7 +214,7 @@ Returns the color of the linear interpolation with another color. The value t is .. _class_Color_to_argb32: -- :ref:`int` **to_argb32** **(** **)** +- :ref:`int` **to_argb32** **(** **)** Returns the color's 32-bit integer in ARGB format (each byte represents a component of the ARGB profile). More compatible with DirectX. @@ -225,7 +225,7 @@ Returns the color's 32-bit integer in ARGB format (each byte represents a compon .. _class_Color_to_html: -- :ref:`String` **to_html** **(** :ref:`bool` with_alpha=True **)** +- :ref:`String` **to_html** **(** :ref:`bool` with_alpha=True **)** Returns the color's HTML hexadecimal color string in ARGB format (ex: ``ff34f822``). @@ -239,7 +239,7 @@ Optionally flag 'false' to not include alpha in hexadecimal string. .. _class_Color_to_rgba32: -- :ref:`int` **to_rgba32** **(** **)** +- :ref:`int` **to_rgba32** **(** **)** Returns the color's 32-bit integer in ARGB format (each byte represents a component of the ARGB profile). diff --git a/classes/class_colorpicker.rst b/classes/class_colorpicker.rst index 0f71962c3..6f856ed95 100644 --- a/classes/class_colorpicker.rst +++ b/classes/class_colorpicker.rst @@ -19,28 +19,28 @@ Color picker control. Member Functions ---------------- -+----------------------------+-------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_preset` **(** :ref:`Color` color **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_pick_color` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_editing_alpha` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_raw_mode` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_edit_alpha` **(** :ref:`bool` show **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pick_color` **(** :ref:`Color` color **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_raw_mode` **(** :ref:`bool` mode **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------+ ++----------------------------+-----------------------------------------------------------------------------------------------------+ +| void | :ref:`add_preset` **(** :ref:`Color` color **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_pick_color` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_editing_alpha` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_raw_mode` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------+ +| void | :ref:`set_edit_alpha` **(** :ref:`bool` show **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pick_color` **(** :ref:`Color` color **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------+ +| void | :ref:`set_raw_mode` **(** :ref:`bool` mode **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------+ Signals ------- .. _class_ColorPicker_color_changed: -- **color_changed** **(** :ref:`Color` color **)** +- **color_changed** **(** :ref:`Color` color **)** Emitted when the color is changed. @@ -55,43 +55,43 @@ Member Function Description .. _class_ColorPicker_add_preset: -- void **add_preset** **(** :ref:`Color` color **)** +- void **add_preset** **(** :ref:`Color` color **)** Adds the current selected to color to a list of colors (presets), the presets will be displayed in the color picker and the user will be able to select them, notice that the presets list is only for this color picker. .. _class_ColorPicker_get_pick_color: -- :ref:`Color` **get_pick_color** **(** **)** const +- :ref:`Color` **get_pick_color** **(** **)** const Gets the current color. .. _class_ColorPicker_is_editing_alpha: -- :ref:`bool` **is_editing_alpha** **(** **)** const +- :ref:`bool` **is_editing_alpha** **(** **)** const Returns whether the color has transparency or not. .. _class_ColorPicker_is_raw_mode: -- :ref:`bool` **is_raw_mode** **(** **)** const +- :ref:`bool` **is_raw_mode** **(** **)** const Returns whether this color picker is in raw mode or not, raw mode will allow the color R, G, B component values to go beyond 1, you have to consider that the max value for color components is 1, going beyond that value will not have effect in the color, but can be used for special operations that require it (like tinting without darkening or rendering sprites in HDR). .. _class_ColorPicker_set_edit_alpha: -- void **set_edit_alpha** **(** :ref:`bool` show **)** +- void **set_edit_alpha** **(** :ref:`bool` show **)** Set true if you want the color to have an alpha channel (transparency), or false if you want a solid color. .. _class_ColorPicker_set_pick_color: -- void **set_pick_color** **(** :ref:`Color` color **)** +- void **set_pick_color** **(** :ref:`Color` color **)** Select the current color. .. _class_ColorPicker_set_raw_mode: -- void **set_raw_mode** **(** :ref:`bool` mode **)** +- void **set_raw_mode** **(** :ref:`bool` mode **)** Set whether this color picker is using raw mode or not, see :ref:`is_raw_mode`. diff --git a/classes/class_colorpickerbutton.rst b/classes/class_colorpickerbutton.rst index 01a971009..45b7f3a63 100644 --- a/classes/class_colorpickerbutton.rst +++ b/classes/class_colorpickerbutton.rst @@ -19,24 +19,24 @@ Button that pops out a :ref:`ColorPicker` Member Functions ---------------- -+----------------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_pick_color` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`ColorPicker` | :ref:`get_picker` **(** **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_editing_alpha` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_edit_alpha` **(** :ref:`bool` show **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pick_color` **(** :ref:`Color` color **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------+ ++----------------------------------------+-----------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_pick_color` **(** **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------+ +| :ref:`ColorPicker` | :ref:`get_picker` **(** **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_editing_alpha` **(** **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_edit_alpha` **(** :ref:`bool` show **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pick_color` **(** :ref:`Color` color **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_ColorPickerButton_color_changed: -- **color_changed** **(** :ref:`Color` color **)** +- **color_changed** **(** :ref:`Color` color **)** Emitted when the color is changed. @@ -63,27 +63,27 @@ Member Function Description .. _class_ColorPickerButton_get_pick_color: -- :ref:`Color` **get_pick_color** **(** **)** const +- :ref:`Color` **get_pick_color** **(** **)** const .. _class_ColorPickerButton_get_picker: -- :ref:`ColorPicker` **get_picker** **(** **)** +- :ref:`ColorPicker` **get_picker** **(** **)** .. _class_ColorPickerButton_is_editing_alpha: -- :ref:`bool` **is_editing_alpha** **(** **)** const +- :ref:`bool` **is_editing_alpha** **(** **)** const See :ref:`ColorPicker.is_edit_alpha` .. _class_ColorPickerButton_set_edit_alpha: -- void **set_edit_alpha** **(** :ref:`bool` show **)** +- void **set_edit_alpha** **(** :ref:`bool` show **)** See :ref:`ColorPicker.set_edit_alpha` .. _class_ColorPickerButton_set_pick_color: -- void **set_pick_color** **(** :ref:`Color` color **)** +- void **set_pick_color** **(** :ref:`Color` color **)** Set new color to ColorRect. diff --git a/classes/class_colorrect.rst b/classes/class_colorrect.rst index 1a6eec857..af2c42423 100644 --- a/classes/class_colorrect.rst +++ b/classes/class_colorrect.rst @@ -19,11 +19,11 @@ Colored rect for canvas. Member Functions ---------------- -+----------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_frame_color` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_frame_color` **(** :ref:`Color` color **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------+ ++----------------------------+-----------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_frame_color` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------+ +| void | :ref:`set_frame_color` **(** :ref:`Color` color **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -47,7 +47,7 @@ Member Function Description .. _class_ColorRect_get_frame_color: -- :ref:`Color` **get_frame_color** **(** **)** const +- :ref:`Color` **get_frame_color** **(** **)** const Return the color in RGBA format. @@ -58,7 +58,7 @@ Return the color in RGBA format. .. _class_ColorRect_set_frame_color: -- void **set_frame_color** **(** :ref:`Color` color **)** +- void **set_frame_color** **(** :ref:`Color` color **)** Set new color to ColorRect. diff --git a/classes/class_concavepolygonshape.rst b/classes/class_concavepolygonshape.rst index 094989632..e7285c778 100644 --- a/classes/class_concavepolygonshape.rst +++ b/classes/class_concavepolygonshape.rst @@ -19,11 +19,11 @@ Concave polygon shape. Member Functions ---------------- -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`get_faces` **(** **)** const | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_faces` **(** :ref:`PoolVector3Array` faces **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`get_faces` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_faces` **(** :ref:`PoolVector3Array` faces **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -35,13 +35,13 @@ Member Function Description .. _class_ConcavePolygonShape_get_faces: -- :ref:`PoolVector3Array` **get_faces** **(** **)** const +- :ref:`PoolVector3Array` **get_faces** **(** **)** const Return the faces (an array of triangles). .. _class_ConcavePolygonShape_set_faces: -- void **set_faces** **(** :ref:`PoolVector3Array` faces **)** +- void **set_faces** **(** :ref:`PoolVector3Array` faces **)** Set the faces (an array of triangles). diff --git a/classes/class_concavepolygonshape2d.rst b/classes/class_concavepolygonshape2d.rst index 260c2cf81..d4afc2e6d 100644 --- a/classes/class_concavepolygonshape2d.rst +++ b/classes/class_concavepolygonshape2d.rst @@ -19,11 +19,11 @@ Concave polygon 2D shape resource for physics. Member Functions ---------------- -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_segments` **(** **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_segments` **(** :ref:`PoolVector2Array` segments **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`get_segments` **(** **)** const | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_segments` **(** :ref:`PoolVector2Array` segments **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -45,13 +45,13 @@ Member Function Description .. _class_ConcavePolygonShape2D_get_segments: -- :ref:`PoolVector2Array` **get_segments** **(** **)** const +- :ref:`PoolVector2Array` **get_segments** **(** **)** const Return the array of segments. .. _class_ConcavePolygonShape2D_set_segments: -- void **set_segments** **(** :ref:`PoolVector2Array` segments **)** +- void **set_segments** **(** :ref:`PoolVector2Array` segments **)** Set the array of segments. diff --git a/classes/class_conetwistjoint.rst b/classes/class_conetwistjoint.rst index f81bc28a6..7850a7517 100644 --- a/classes/class_conetwistjoint.rst +++ b/classes/class_conetwistjoint.rst @@ -19,11 +19,11 @@ A twist joint between two 3D bodies Member Functions ---------------- -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_param` **(** :ref:`int` param **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_param` **(** :ref:`int` param, :ref:`float` value **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_param` **(** :ref:`int` param **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_param` **(** :ref:`int` param, :ref:`float` value **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -93,10 +93,10 @@ Member Function Description .. _class_ConeTwistJoint_get_param: -- :ref:`float` **get_param** **(** :ref:`int` param **)** const +- :ref:`float` **get_param** **(** :ref:`int` param **)** const .. _class_ConeTwistJoint_set_param: -- void **set_param** **(** :ref:`int` param, :ref:`float` value **)** +- void **set_param** **(** :ref:`int` param, :ref:`float` value **)** diff --git a/classes/class_configfile.rst b/classes/class_configfile.rst index 9e4659257..799e51e74 100644 --- a/classes/class_configfile.rst +++ b/classes/class_configfile.rst @@ -19,25 +19,25 @@ Helper class to handle INI-style files. Member Functions ---------------- -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase_section` **(** :ref:`String` section **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_section_keys` **(** :ref:`String` section **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_sections` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_value` **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` default=null **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_section` **(** :ref:`String` section **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_section_key` **(** :ref:`String` section, :ref:`String` key **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`load` **(** :ref:`String` path **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`save` **(** :ref:`String` path **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_value` **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` value **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`erase_section` **(** :ref:`String` section **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_section_keys` **(** :ref:`String` section **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_sections` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_value` **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` default=null **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_section` **(** :ref:`String` section **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_section_key` **(** :ref:`String` section, :ref:`String` key **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`load` **(** :ref:`String` path **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`save` **(** :ref:`String` path **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_value` **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` value **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -73,55 +73,55 @@ Member Function Description .. _class_ConfigFile_erase_section: -- void **erase_section** **(** :ref:`String` section **)** +- void **erase_section** **(** :ref:`String` section **)** Deletes the specified section along with all the key-value pairs inside. .. _class_ConfigFile_get_section_keys: -- :ref:`PoolStringArray` **get_section_keys** **(** :ref:`String` section **)** const +- :ref:`PoolStringArray` **get_section_keys** **(** :ref:`String` section **)** const Returns an array of all defined key identifiers in the specified section. .. _class_ConfigFile_get_sections: -- :ref:`PoolStringArray` **get_sections** **(** **)** const +- :ref:`PoolStringArray` **get_sections** **(** **)** const Returns an array of all defined section identifiers. .. _class_ConfigFile_get_value: -- :ref:`Variant` **get_value** **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` default=null **)** const +- :ref:`Variant` **get_value** **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` default=null **)** const Returns the current value for the specified section and key. If the section and/or the key do not exist, the method returns the value of the optional ``default`` argument, or ``null`` if it is omitted. .. _class_ConfigFile_has_section: -- :ref:`bool` **has_section** **(** :ref:`String` section **)** const +- :ref:`bool` **has_section** **(** :ref:`String` section **)** const Returns ``true`` if the specified section exists. .. _class_ConfigFile_has_section_key: -- :ref:`bool` **has_section_key** **(** :ref:`String` section, :ref:`String` key **)** const +- :ref:`bool` **has_section_key** **(** :ref:`String` section, :ref:`String` key **)** const Returns ``true`` if the specified section-key pair exists. .. _class_ConfigFile_load: -- :ref:`int` **load** **(** :ref:`String` path **)** +- :ref:`int` **load** **(** :ref:`String` path **)** Loads the config file specified as a parameter. The file's contents are parsed and loaded in the ConfigFile object which the method was called on. Returns one of the ``OK``, ``FAILED`` or ``ERR\_\*`` constants listed in :ref:`@Global Scope`. If the load was successful, the return value is ``OK``. .. _class_ConfigFile_save: -- :ref:`int` **save** **(** :ref:`String` path **)** +- :ref:`int` **save** **(** :ref:`String` path **)** Saves the contents of the ConfigFile object to the file specified as a parameter. The output file uses an INI-style structure. Returns one of the ``OK``, ``FAILED`` or ``ERR\_\*`` constants listed in :ref:`@Global Scope`. If the load was successful, the return value is ``OK``. .. _class_ConfigFile_set_value: -- void **set_value** **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` value **)** +- void **set_value** **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` value **)** Assigns a value to the specified key of the the specified section. If the section and/or the key do not exist, they are created. Passing a ``null`` value deletes the specified key if it exists, and deletes the section if it ends up empty once the key has been removed. diff --git a/classes/class_confirmationdialog.rst b/classes/class_confirmationdialog.rst index 16e0f2a08..02ceda894 100644 --- a/classes/class_confirmationdialog.rst +++ b/classes/class_confirmationdialog.rst @@ -21,9 +21,9 @@ Dialog for confirmation of actions. Member Functions ---------------- -+------------------------------+---------------------------------------------------------------------+ -| :ref:`Button` | :ref:`get_cancel` **(** **)** | -+------------------------------+---------------------------------------------------------------------+ ++------------------------------+--------------------------------------------------------------------+ +| :ref:`Button` | :ref:`get_cancel` **(** **)** | ++------------------------------+--------------------------------------------------------------------+ Description ----------- @@ -35,7 +35,7 @@ Member Function Description .. _class_ConfirmationDialog_get_cancel: -- :ref:`Button` **get_cancel** **(** **)** +- :ref:`Button` **get_cancel** **(** **)** Return the cancel button. diff --git a/classes/class_container.rst b/classes/class_container.rst index f4b336b9b..2756bfefe 100644 --- a/classes/class_container.rst +++ b/classes/class_container.rst @@ -21,18 +21,18 @@ Base node for containers. Member Functions ---------------- -+-------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`fit_child_in_rect` **(** :ref:`Control` child, :ref:`Rect2` rect **)** | -+-------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`queue_sort` **(** **)** | -+-------+-----------------------------------------------------------------------------------------------------------------------------------------------+ ++-------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`fit_child_in_rect` **(** :ref:`Control` child, :ref:`Rect2` rect **)** | ++-------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`queue_sort` **(** **)** | ++-------+---------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_Container_sort_children: -- **sort_children** **(** **)** +- **sort_children** **(** **)** Emitted when sorting the children is needed. @@ -54,13 +54,13 @@ Member Function Description .. _class_Container_fit_child_in_rect: -- void **fit_child_in_rect** **(** :ref:`Control` child, :ref:`Rect2` rect **)** +- void **fit_child_in_rect** **(** :ref:`Control` child, :ref:`Rect2` rect **)** Fit a child control in a given rect. This is mainly a helper for creating custom container classes. .. _class_Container_queue_sort: -- void **queue_sort** **(** **)** +- void **queue_sort** **(** **)** Queue resort of the contained children. This is called automatically anyway, but can be called upon request. diff --git a/classes/class_control.rst b/classes/class_control.rst index 2eeaf20b3..2ace34951 100644 --- a/classes/class_control.rst +++ b/classes/class_control.rst @@ -21,258 +21,258 @@ All User Interface nodes inherit from Control. Features anchors and margins to a Member Functions ---------------- -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`_get_minimum_size` **(** **)** virtual | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_gui_input` **(** :ref:`InputEvent` event **)** virtual | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`accept_event` **(** **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_color_override` **(** :ref:`String` name, :ref:`Color` color **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_constant_override` **(** :ref:`String` name, :ref:`int` constant **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_font_override` **(** :ref:`String` name, :ref:`Font` font **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_icon_override` **(** :ref:`String` name, :ref:`Texture` texture **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_shader_override` **(** :ref:`String` name, :ref:`Shader` shader **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_style_override` **(** :ref:`String` name, :ref:`StyleBox` stylebox **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_drop_data` **(** :ref:`Vector2` position, :ref:`Variant` data **)** virtual | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`drop_data` **(** :ref:`Vector2` position, :ref:`Variant` data **)** virtual | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`force_drag` **(** :ref:`Variant` data, :ref:`Control` preview **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_anchor` **(** :ref:`int` margin **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_begin` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_color` **(** :ref:`String` name, :ref:`String` type="" **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_combined_minimum_size` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_constant` **(** :ref:`String` name, :ref:`String` type="" **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_cursor_shape` **(** :ref:`Vector2` position=Vector2( 0, 0 ) **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_custom_minimum_size` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_default_cursor_shape` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_drag_data` **(** :ref:`Vector2` position **)** virtual | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_end` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_focus_mode` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_focus_neighbour` **(** :ref:`int` margin **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Control` | :ref:`get_focus_owner` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Font` | :ref:`get_font` **(** :ref:`String` name, :ref:`String` type="" **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_global_position` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_global_rect` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_h_grow_direction` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_h_size_flags` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_icon` **(** :ref:`String` name, :ref:`String` type="" **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_margin` **(** :ref:`int` margin **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_minimum_size` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_mouse_filter` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_parent_area_size` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Control` | :ref:`get_parent_control` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_pivot_offset` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_position` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_rect` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_rotation` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_rotation_deg` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_scale` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_size` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_stretch_ratio` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`get_stylebox` **(** :ref:`String` name, :ref:`String` type="" **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Theme` | :ref:`get_theme` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_tooltip` **(** :ref:`Vector2` at_position=Vector2( 0, 0 ) **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_v_grow_direction` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_v_size_flags` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`grab_click_focus` **(** **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`grab_focus` **(** **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_color` **(** :ref:`String` name, :ref:`String` type="" **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_color_override` **(** :ref:`String` name **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_constant` **(** :ref:`String` name, :ref:`String` type="" **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_constant_override` **(** :ref:`String` name **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_focus` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_font` **(** :ref:`String` name, :ref:`String` type="" **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_font_override` **(** :ref:`String` name **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_icon` **(** :ref:`String` name, :ref:`String` type="" **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_icon_override` **(** :ref:`String` name **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_point` **(** :ref:`Vector2` point **)** virtual | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_stylebox` **(** :ref:`String` name, :ref:`String` type="" **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_stylebox_override` **(** :ref:`String` name **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_clipping_contents` **(** **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`minimum_size_changed` **(** **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`release_focus` **(** **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_anchor` **(** :ref:`int` margin, :ref:`float` anchor, :ref:`bool` keep_margin=false, :ref:`bool` push_opposite_anchor=true **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_anchor_and_margin` **(** :ref:`int` margin, :ref:`float` anchor, :ref:`float` offset, :ref:`bool` push_opposite_anchor=false **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_anchors_and_margins_preset` **(** :ref:`int` preset, :ref:`int` resize_mode=0, :ref:`int` margin=0 **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_anchors_preset` **(** :ref:`int` preset, :ref:`bool` keep_margin=false **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_begin` **(** :ref:`Vector2` position **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_clip_contents` **(** :ref:`bool` enable **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_minimum_size` **(** :ref:`Vector2` size **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_default_cursor_shape` **(** :ref:`int` shape **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_drag_forwarding` **(** :ref:`Control` target **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_drag_preview` **(** :ref:`Control` control **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_end` **(** :ref:`Vector2` position **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_focus_mode` **(** :ref:`int` mode **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_focus_neighbour` **(** :ref:`int` margin, :ref:`NodePath` neighbour **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_global_position` **(** :ref:`Vector2` position **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_h_grow_direction` **(** :ref:`int` direction **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_h_size_flags` **(** :ref:`int` flags **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_margin` **(** :ref:`int` margin, :ref:`float` offset **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_margins_preset` **(** :ref:`int` preset, :ref:`int` resize_mode=0, :ref:`int` margin=0 **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mouse_filter` **(** :ref:`int` filter **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pivot_offset` **(** :ref:`Vector2` pivot_offset **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_position` **(** :ref:`Vector2` position **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rotation` **(** :ref:`float` radians **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rotation_deg` **(** :ref:`float` degrees **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_scale` **(** :ref:`Vector2` scale **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_size` **(** :ref:`Vector2` size **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_stretch_ratio` **(** :ref:`float` ratio **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_theme` **(** :ref:`Theme` theme **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tooltip` **(** :ref:`String` tooltip **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_v_grow_direction` **(** :ref:`int` direction **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_v_size_flags` **(** :ref:`int` flags **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`show_modal` **(** :ref:`bool` exclusive=false **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`warp_mouse` **(** :ref:`Vector2` to_position **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`_get_minimum_size` **(** **)** virtual | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_gui_input` **(** :ref:`InputEvent` event **)** virtual | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`accept_event` **(** **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_color_override` **(** :ref:`String` name, :ref:`Color` color **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_constant_override` **(** :ref:`String` name, :ref:`int` constant **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_font_override` **(** :ref:`String` name, :ref:`Font` font **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_icon_override` **(** :ref:`String` name, :ref:`Texture` texture **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_shader_override` **(** :ref:`String` name, :ref:`Shader` shader **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_style_override` **(** :ref:`String` name, :ref:`StyleBox` stylebox **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_drop_data` **(** :ref:`Vector2` position, :ref:`Variant` data **)** virtual | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`drop_data` **(** :ref:`Vector2` position, :ref:`Variant` data **)** virtual | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`force_drag` **(** :ref:`Variant` data, :ref:`Control` preview **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_anchor` **(** :ref:`int` margin **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_begin` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_color` **(** :ref:`String` name, :ref:`String` type="" **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_combined_minimum_size` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_constant` **(** :ref:`String` name, :ref:`String` type="" **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_cursor_shape` **(** :ref:`Vector2` position=Vector2( 0, 0 ) **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_custom_minimum_size` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_default_cursor_shape` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_drag_data` **(** :ref:`Vector2` position **)** virtual | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_end` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_focus_mode` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_focus_neighbour` **(** :ref:`int` margin **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Control` | :ref:`get_focus_owner` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Font` | :ref:`get_font` **(** :ref:`String` name, :ref:`String` type="" **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_global_position` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_global_rect` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_h_grow_direction` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_h_size_flags` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_icon` **(** :ref:`String` name, :ref:`String` type="" **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_margin` **(** :ref:`int` margin **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_minimum_size` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_mouse_filter` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_parent_area_size` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Control` | :ref:`get_parent_control` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_pivot_offset` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_position` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_rect` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_rotation` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_rotation_deg` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_scale` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_size` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_stretch_ratio` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`StyleBox` | :ref:`get_stylebox` **(** :ref:`String` name, :ref:`String` type="" **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Theme` | :ref:`get_theme` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_tooltip` **(** :ref:`Vector2` at_position=Vector2( 0, 0 ) **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_v_grow_direction` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_v_size_flags` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`grab_click_focus` **(** **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`grab_focus` **(** **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_color` **(** :ref:`String` name, :ref:`String` type="" **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_color_override` **(** :ref:`String` name **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_constant` **(** :ref:`String` name, :ref:`String` type="" **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_constant_override` **(** :ref:`String` name **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_focus` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_font` **(** :ref:`String` name, :ref:`String` type="" **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_font_override` **(** :ref:`String` name **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_icon` **(** :ref:`String` name, :ref:`String` type="" **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_icon_override` **(** :ref:`String` name **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_point` **(** :ref:`Vector2` point **)** virtual | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_stylebox` **(** :ref:`String` name, :ref:`String` type="" **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_stylebox_override` **(** :ref:`String` name **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_clipping_contents` **(** **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`minimum_size_changed` **(** **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`release_focus` **(** **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_anchor` **(** :ref:`int` margin, :ref:`float` anchor, :ref:`bool` keep_margin=false, :ref:`bool` push_opposite_anchor=true **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_anchor_and_margin` **(** :ref:`int` margin, :ref:`float` anchor, :ref:`float` offset, :ref:`bool` push_opposite_anchor=false **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_anchors_and_margins_preset` **(** :ref:`int` preset, :ref:`int` resize_mode=0, :ref:`int` margin=0 **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_anchors_preset` **(** :ref:`int` preset, :ref:`bool` keep_margin=false **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_begin` **(** :ref:`Vector2` position **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_clip_contents` **(** :ref:`bool` enable **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_minimum_size` **(** :ref:`Vector2` size **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_default_cursor_shape` **(** :ref:`int` shape **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_drag_forwarding` **(** :ref:`Control` target **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_drag_preview` **(** :ref:`Control` control **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_end` **(** :ref:`Vector2` position **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_focus_mode` **(** :ref:`int` mode **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_focus_neighbour` **(** :ref:`int` margin, :ref:`NodePath` neighbour **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_global_position` **(** :ref:`Vector2` position **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_h_grow_direction` **(** :ref:`int` direction **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_h_size_flags` **(** :ref:`int` flags **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_margin` **(** :ref:`int` margin, :ref:`float` offset **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_margins_preset` **(** :ref:`int` preset, :ref:`int` resize_mode=0, :ref:`int` margin=0 **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_mouse_filter` **(** :ref:`int` filter **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pivot_offset` **(** :ref:`Vector2` pivot_offset **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_position` **(** :ref:`Vector2` position **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rotation` **(** :ref:`float` radians **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rotation_deg` **(** :ref:`float` degrees **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_scale` **(** :ref:`Vector2` scale **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_size` **(** :ref:`Vector2` size **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_stretch_ratio` **(** :ref:`float` ratio **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_theme` **(** :ref:`Theme` theme **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tooltip` **(** :ref:`String` tooltip **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_v_grow_direction` **(** :ref:`int` direction **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_v_size_flags` **(** :ref:`int` flags **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`show_modal` **(** :ref:`bool` exclusive=false **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`warp_mouse` **(** :ref:`Vector2` to_position **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_Control_focus_entered: -- **focus_entered** **(** **)** +- **focus_entered** **(** **)** Emitted when the node gains keyboard focus. .. _class_Control_focus_exited: -- **focus_exited** **(** **)** +- **focus_exited** **(** **)** Emitted when the node loses keyboard focus. .. _class_Control_gui_input: -- **gui_input** **(** :ref:`Object` ev **)** +- **gui_input** **(** :ref:`Object` ev **)** Emitted when the node receives an :ref:`InputEvent`. .. _class_Control_minimum_size_changed: -- **minimum_size_changed** **(** **)** +- **minimum_size_changed** **(** **)** Emitted when the node's minimum size changes. .. _class_Control_modal_closed: -- **modal_closed** **(** **)** +- **modal_closed** **(** **)** Emitted when a modal ``Control`` is closed. See :ref:`show_modal`. .. _class_Control_mouse_entered: -- **mouse_entered** **(** **)** +- **mouse_entered** **(** **)** Emitted when the mouse enters the control's ``Rect`` area. .. _class_Control_mouse_exited: -- **mouse_exited** **(** **)** +- **mouse_exited** **(** **)** Emitted when the mouse leaves the control's ``Rect`` area. .. _class_Control_resized: -- **resized** **(** **)** +- **resized** **(** **)** Emitted when the control changes size. .. _class_Control_size_flags_changed: -- **size_flags_changed** **(** **)** +- **size_flags_changed** **(** **)** Emitted when one of the size flags changes. See :ref:`size_flags_horizontal` and :ref:`size_flags_vertical`. @@ -478,13 +478,13 @@ Member Function Description .. _class_Control__get_minimum_size: -- :ref:`Vector2` **_get_minimum_size** **(** **)** virtual +- :ref:`Vector2` **_get_minimum_size** **(** **)** virtual Returns the minimum size this Control can shrink to. The node can never be smaller than this minimum size. .. _class_Control__gui_input: -- void **_gui_input** **(** :ref:`InputEvent` event **)** virtual +- void **_gui_input** **(** :ref:`InputEvent` event **)** virtual The node's parent forwards input events to this method. Use it to process and accept inputs on UI elements. See :ref:`accept_event`. @@ -492,486 +492,486 @@ Replaces Godot 2's ``_input_event``. .. _class_Control_accept_event: -- void **accept_event** **(** **)** +- void **accept_event** **(** **)** Marks an input event as handled. Once you accept an input event, it stops propagating, even to nodes listening to :ref:`Node._unhandled_input` or :ref:`Node._unhandled_key_input`. .. _class_Control_add_color_override: -- void **add_color_override** **(** :ref:`String` name, :ref:`Color` color **)** +- void **add_color_override** **(** :ref:`String` name, :ref:`Color` color **)** Overrides the color in the theme resource the node uses. .. _class_Control_add_constant_override: -- void **add_constant_override** **(** :ref:`String` name, :ref:`int` constant **)** +- void **add_constant_override** **(** :ref:`String` name, :ref:`int` constant **)** Overrides an integer constant in the theme resource the node uses. If the ``constant[code] is invalid, Godot clears the override. See [member Theme.INVALID_CONSTANT] for more information. .. _class_Control_add_font_override: -- void **add_font_override** **(** :ref:`String` name, :ref:`Font` font **)** +- void **add_font_override** **(** :ref:`String` name, :ref:`Font` font **)** Overrides the ``name`` font in the theme resource the node uses. If ``font`` is empty, Godot clears the override. .. _class_Control_add_icon_override: -- void **add_icon_override** **(** :ref:`String` name, :ref:`Texture` texture **)** +- void **add_icon_override** **(** :ref:`String` name, :ref:`Texture` texture **)** Overrides the ``name`` icon in the theme resource the node uses. If ``icon`` is empty, Godot clears the override. .. _class_Control_add_shader_override: -- void **add_shader_override** **(** :ref:`String` name, :ref:`Shader` shader **)** +- void **add_shader_override** **(** :ref:`String` name, :ref:`Shader` shader **)** Overrides the ``name`` shader in the theme resource the node uses. If ``shader`` is empty, Godot clears the override. .. _class_Control_add_style_override: -- void **add_style_override** **(** :ref:`String` name, :ref:`StyleBox` stylebox **)** +- void **add_style_override** **(** :ref:`String` name, :ref:`StyleBox` stylebox **)** Overrides the ``name`` Stylebox in the theme resource the node uses. If ``stylebox`` is empty, Godot clears the override. .. _class_Control_can_drop_data: -- :ref:`bool` **can_drop_data** **(** :ref:`Vector2` position, :ref:`Variant` data **)** virtual +- :ref:`bool` **can_drop_data** **(** :ref:`Vector2` position, :ref:`Variant` data **)** virtual .. _class_Control_drop_data: -- void **drop_data** **(** :ref:`Vector2` position, :ref:`Variant` data **)** virtual +- void **drop_data** **(** :ref:`Vector2` position, :ref:`Variant` data **)** virtual .. _class_Control_force_drag: -- void **force_drag** **(** :ref:`Variant` data, :ref:`Control` preview **)** +- void **force_drag** **(** :ref:`Variant` data, :ref:`Control` preview **)** .. _class_Control_get_anchor: -- :ref:`float` **get_anchor** **(** :ref:`int` margin **)** const +- :ref:`float` **get_anchor** **(** :ref:`int` margin **)** const Return the anchor type (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) for a given margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). .. _class_Control_get_begin: -- :ref:`Vector2` **get_begin** **(** **)** const +- :ref:`Vector2` **get_begin** **(** **)** const .. _class_Control_get_color: -- :ref:`Color` **get_color** **(** :ref:`String` name, :ref:`String` type="" **)** const +- :ref:`Color` **get_color** **(** :ref:`String` name, :ref:`String` type="" **)** const .. _class_Control_get_combined_minimum_size: -- :ref:`Vector2` **get_combined_minimum_size** **(** **)** const +- :ref:`Vector2` **get_combined_minimum_size** **(** **)** const .. _class_Control_get_constant: -- :ref:`int` **get_constant** **(** :ref:`String` name, :ref:`String` type="" **)** const +- :ref:`int` **get_constant** **(** :ref:`String` name, :ref:`String` type="" **)** const .. _class_Control_get_cursor_shape: -- :ref:`int` **get_cursor_shape** **(** :ref:`Vector2` position=Vector2( 0, 0 ) **)** const +- :ref:`int` **get_cursor_shape** **(** :ref:`Vector2` position=Vector2( 0, 0 ) **)** const Returns the mouse cursor shape the control displays on mouse hover, one of the ``CURSOR\_\*`` constants. .. _class_Control_get_custom_minimum_size: -- :ref:`Vector2` **get_custom_minimum_size** **(** **)** const +- :ref:`Vector2` **get_custom_minimum_size** **(** **)** const .. _class_Control_get_default_cursor_shape: -- :ref:`int` **get_default_cursor_shape** **(** **)** const +- :ref:`int` **get_default_cursor_shape** **(** **)** const Returns the default cursor shape for this control. See enum ``CURSOR\_\*`` for the list of shapes. .. _class_Control_get_drag_data: -- :ref:`Object` **get_drag_data** **(** :ref:`Vector2` position **)** virtual +- :ref:`Object` **get_drag_data** **(** :ref:`Vector2` position **)** virtual .. _class_Control_get_end: -- :ref:`Vector2` **get_end** **(** **)** const +- :ref:`Vector2` **get_end** **(** **)** const Returns MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see :ref:`set_margin`). .. _class_Control_get_focus_mode: -- :ref:`int` **get_focus_mode** **(** **)** const +- :ref:`int` **get_focus_mode** **(** **)** const Returns the focus access mode for the control (FOCUS_NONE, FOCUS_CLICK, FOCUS_ALL) (see :ref:`set_focus_mode`). .. _class_Control_get_focus_neighbour: -- :ref:`NodePath` **get_focus_neighbour** **(** :ref:`int` margin **)** const +- :ref:`NodePath` **get_focus_neighbour** **(** :ref:`int` margin **)** const Return the forced neighbour for moving the input focus to. When pressing TAB or directional/joypad directions focus is moved to the next control in that direction. However, the neighbour to move to can be forced with this function. .. _class_Control_get_focus_owner: -- :ref:`Control` **get_focus_owner** **(** **)** const +- :ref:`Control` **get_focus_owner** **(** **)** const Return which control is owning the keyboard focus, or null if no one. .. _class_Control_get_font: -- :ref:`Font` **get_font** **(** :ref:`String` name, :ref:`String` type="" **)** const +- :ref:`Font` **get_font** **(** :ref:`String` name, :ref:`String` type="" **)** const .. _class_Control_get_global_position: -- :ref:`Vector2` **get_global_position** **(** **)** const +- :ref:`Vector2` **get_global_position** **(** **)** const Returns the Control position, relative to the top-left corner of the parent Control and independent of the anchor mode. .. _class_Control_get_global_rect: -- :ref:`Rect2` **get_global_rect** **(** **)** const +- :ref:`Rect2` **get_global_rect** **(** **)** const Return position and size of the Control, relative to the top-left corner of the *window* Control. This is a helper (see :ref:`get_global_position`, :ref:`get_size`). .. _class_Control_get_h_grow_direction: -- :ref:`int` **get_h_grow_direction** **(** **)** const +- :ref:`int` **get_h_grow_direction** **(** **)** const .. _class_Control_get_h_size_flags: -- :ref:`int` **get_h_size_flags** **(** **)** const +- :ref:`int` **get_h_size_flags** **(** **)** const Hint for containers, return horizontal positioning flags. .. _class_Control_get_icon: -- :ref:`Texture` **get_icon** **(** :ref:`String` name, :ref:`String` type="" **)** const +- :ref:`Texture` **get_icon** **(** :ref:`String` name, :ref:`String` type="" **)** const .. _class_Control_get_margin: -- :ref:`float` **get_margin** **(** :ref:`int` margin **)** const +- :ref:`float` **get_margin** **(** :ref:`int` margin **)** const Return a margin offset. Margin can be one of (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). Offset value being returned depends on the anchor mode. .. _class_Control_get_minimum_size: -- :ref:`Vector2` **get_minimum_size** **(** **)** const +- :ref:`Vector2` **get_minimum_size** **(** **)** const Return the minimum size this Control can shrink to. A control will never be displayed or resized smaller than its minimum size. .. _class_Control_get_mouse_filter: -- :ref:`int` **get_mouse_filter** **(** **)** const +- :ref:`int` **get_mouse_filter** **(** **)** const Return when the control is ignoring mouse events (even touchpad events send mouse events). .. _class_Control_get_parent_area_size: -- :ref:`Vector2` **get_parent_area_size** **(** **)** const +- :ref:`Vector2` **get_parent_area_size** **(** **)** const .. _class_Control_get_parent_control: -- :ref:`Control` **get_parent_control** **(** **)** const +- :ref:`Control` **get_parent_control** **(** **)** const .. _class_Control_get_pivot_offset: -- :ref:`Vector2` **get_pivot_offset** **(** **)** const +- :ref:`Vector2` **get_pivot_offset** **(** **)** const .. _class_Control_get_position: -- :ref:`Vector2` **get_position** **(** **)** const +- :ref:`Vector2` **get_position** **(** **)** const Returns the Control position, relative to the top-left corner of the parent Control and independent of the anchor mode. .. _class_Control_get_rect: -- :ref:`Rect2` **get_rect** **(** **)** const +- :ref:`Rect2` **get_rect** **(** **)** const Return position and size of the Control, relative to the top-left corner of the parent Control. This is a helper (see :ref:`get_position`, :ref:`get_size`). .. _class_Control_get_rotation: -- :ref:`float` **get_rotation** **(** **)** const +- :ref:`float` **get_rotation** **(** **)** const Return the rotation (in radians) .. _class_Control_get_rotation_deg: -- :ref:`float` **get_rotation_deg** **(** **)** const +- :ref:`float` **get_rotation_deg** **(** **)** const Return the rotation (in degrees) .. _class_Control_get_scale: -- :ref:`Vector2` **get_scale** **(** **)** const +- :ref:`Vector2` **get_scale** **(** **)** const .. _class_Control_get_size: -- :ref:`Vector2` **get_size** **(** **)** const +- :ref:`Vector2` **get_size** **(** **)** const Returns the size of the Control, computed from all margins, however the size returned will **never be smaller than the minimum size reported by** :ref:`get_minimum_size`. This means that even if end position of the Control rectangle is smaller than the begin position, the Control will still display and interact correctly. (see description, :ref:`get_minimum_size`, :ref:`set_margin`, :ref:`set_anchor`). .. _class_Control_get_stretch_ratio: -- :ref:`float` **get_stretch_ratio** **(** **)** const +- :ref:`float` **get_stretch_ratio** **(** **)** const Hint for containers, return the stretch ratio. This value is relative to other stretch ratio, so if this control has 2 and another has 1, this one will be twice as big. .. _class_Control_get_stylebox: -- :ref:`StyleBox` **get_stylebox** **(** :ref:`String` name, :ref:`String` type="" **)** const +- :ref:`StyleBox` **get_stylebox** **(** :ref:`String` name, :ref:`String` type="" **)** const .. _class_Control_get_theme: -- :ref:`Theme` **get_theme** **(** **)** const +- :ref:`Theme` **get_theme** **(** **)** const Return a :ref:`Theme` override, if one exists (see :ref:`set_theme`). .. _class_Control_get_tooltip: -- :ref:`String` **get_tooltip** **(** :ref:`Vector2` at_position=Vector2( 0, 0 ) **)** const +- :ref:`String` **get_tooltip** **(** :ref:`Vector2` at_position=Vector2( 0, 0 ) **)** const Return the tooltip, which will appear when the cursor is resting over this control. .. _class_Control_get_v_grow_direction: -- :ref:`int` **get_v_grow_direction** **(** **)** const +- :ref:`int` **get_v_grow_direction** **(** **)** const .. _class_Control_get_v_size_flags: -- :ref:`int` **get_v_size_flags** **(** **)** const +- :ref:`int` **get_v_size_flags** **(** **)** const Hint for containers, return vertical positioning flags. .. _class_Control_grab_click_focus: -- void **grab_click_focus** **(** **)** +- void **grab_click_focus** **(** **)** .. _class_Control_grab_focus: -- void **grab_focus** **(** **)** +- void **grab_focus** **(** **)** Steal the focus from another control and become the focused control (see :ref:`set_focus_mode`). .. _class_Control_has_color: -- :ref:`bool` **has_color** **(** :ref:`String` name, :ref:`String` type="" **)** const +- :ref:`bool` **has_color** **(** :ref:`String` name, :ref:`String` type="" **)** const .. _class_Control_has_color_override: -- :ref:`bool` **has_color_override** **(** :ref:`String` name **)** const +- :ref:`bool` **has_color_override** **(** :ref:`String` name **)** const .. _class_Control_has_constant: -- :ref:`bool` **has_constant** **(** :ref:`String` name, :ref:`String` type="" **)** const +- :ref:`bool` **has_constant** **(** :ref:`String` name, :ref:`String` type="" **)** const .. _class_Control_has_constant_override: -- :ref:`bool` **has_constant_override** **(** :ref:`String` name **)** const +- :ref:`bool` **has_constant_override** **(** :ref:`String` name **)** const .. _class_Control_has_focus: -- :ref:`bool` **has_focus** **(** **)** const +- :ref:`bool` **has_focus** **(** **)** const Return whether the Control is the current focused control (see :ref:`set_focus_mode`). .. _class_Control_has_font: -- :ref:`bool` **has_font** **(** :ref:`String` name, :ref:`String` type="" **)** const +- :ref:`bool` **has_font** **(** :ref:`String` name, :ref:`String` type="" **)** const .. _class_Control_has_font_override: -- :ref:`bool` **has_font_override** **(** :ref:`String` name **)** const +- :ref:`bool` **has_font_override** **(** :ref:`String` name **)** const .. _class_Control_has_icon: -- :ref:`bool` **has_icon** **(** :ref:`String` name, :ref:`String` type="" **)** const +- :ref:`bool` **has_icon** **(** :ref:`String` name, :ref:`String` type="" **)** const .. _class_Control_has_icon_override: -- :ref:`bool` **has_icon_override** **(** :ref:`String` name **)** const +- :ref:`bool` **has_icon_override** **(** :ref:`String` name **)** const .. _class_Control_has_point: -- :ref:`bool` **has_point** **(** :ref:`Vector2` point **)** virtual +- :ref:`bool` **has_point** **(** :ref:`Vector2` point **)** virtual .. _class_Control_has_stylebox: -- :ref:`bool` **has_stylebox** **(** :ref:`String` name, :ref:`String` type="" **)** const +- :ref:`bool` **has_stylebox** **(** :ref:`String` name, :ref:`String` type="" **)** const .. _class_Control_has_stylebox_override: -- :ref:`bool` **has_stylebox_override** **(** :ref:`String` name **)** const +- :ref:`bool` **has_stylebox_override** **(** :ref:`String` name **)** const .. _class_Control_is_clipping_contents: -- :ref:`bool` **is_clipping_contents** **(** **)** +- :ref:`bool` **is_clipping_contents** **(** **)** .. _class_Control_minimum_size_changed: -- void **minimum_size_changed** **(** **)** +- void **minimum_size_changed** **(** **)** .. _class_Control_release_focus: -- void **release_focus** **(** **)** +- void **release_focus** **(** **)** Give up the focus, no other control will be able to receive keyboard input. .. _class_Control_set_anchor: -- void **set_anchor** **(** :ref:`int` margin, :ref:`float` anchor, :ref:`bool` keep_margin=false, :ref:`bool` push_opposite_anchor=true **)** +- void **set_anchor** **(** :ref:`int` margin, :ref:`float` anchor, :ref:`bool` keep_margin=false, :ref:`bool` push_opposite_anchor=true **)** .. _class_Control_set_anchor_and_margin: -- void **set_anchor_and_margin** **(** :ref:`int` margin, :ref:`float` anchor, :ref:`float` offset, :ref:`bool` push_opposite_anchor=false **)** +- void **set_anchor_and_margin** **(** :ref:`int` margin, :ref:`float` anchor, :ref:`float` offset, :ref:`bool` push_opposite_anchor=false **)** .. _class_Control_set_anchors_and_margins_preset: -- void **set_anchors_and_margins_preset** **(** :ref:`int` preset, :ref:`int` resize_mode=0, :ref:`int` margin=0 **)** +- void **set_anchors_and_margins_preset** **(** :ref:`int` preset, :ref:`int` resize_mode=0, :ref:`int` margin=0 **)** .. _class_Control_set_anchors_preset: -- void **set_anchors_preset** **(** :ref:`int` preset, :ref:`bool` keep_margin=false **)** +- void **set_anchors_preset** **(** :ref:`int` preset, :ref:`bool` keep_margin=false **)** .. _class_Control_set_begin: -- void **set_begin** **(** :ref:`Vector2` position **)** +- void **set_begin** **(** :ref:`Vector2` position **)** Sets MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see :ref:`set_margin`). .. _class_Control_set_clip_contents: -- void **set_clip_contents** **(** :ref:`bool` enable **)** +- void **set_clip_contents** **(** :ref:`bool` enable **)** .. _class_Control_set_custom_minimum_size: -- void **set_custom_minimum_size** **(** :ref:`Vector2` size **)** +- void **set_custom_minimum_size** **(** :ref:`Vector2` size **)** .. _class_Control_set_default_cursor_shape: -- void **set_default_cursor_shape** **(** :ref:`int` shape **)** +- void **set_default_cursor_shape** **(** :ref:`int` shape **)** Sets the default cursor shape for this control. See ``CURSOR\_\*`` for the list of available cursor shapes. Useful for Godot plugins and applications or games that use the system's mouse cursors. .. _class_Control_set_drag_forwarding: -- void **set_drag_forwarding** **(** :ref:`Control` target **)** +- void **set_drag_forwarding** **(** :ref:`Control` target **)** .. _class_Control_set_drag_preview: -- void **set_drag_preview** **(** :ref:`Control` control **)** +- void **set_drag_preview** **(** :ref:`Control` control **)** .. _class_Control_set_end: -- void **set_end** **(** :ref:`Vector2` position **)** +- void **set_end** **(** :ref:`Vector2` position **)** Sets MARGIN_RIGHT and MARGIN_BOTTOM at the same time. This is a helper (see :ref:`set_margin`). .. _class_Control_set_focus_mode: -- void **set_focus_mode** **(** :ref:`int` mode **)** +- void **set_focus_mode** **(** :ref:`int` mode **)** Set the focus access mode for the control (FOCUS_NONE, FOCUS_CLICK, FOCUS_ALL). Only one Control can be focused at the same time, and it will receive keyboard signals. .. _class_Control_set_focus_neighbour: -- void **set_focus_neighbour** **(** :ref:`int` margin, :ref:`NodePath` neighbour **)** +- void **set_focus_neighbour** **(** :ref:`int` margin, :ref:`NodePath` neighbour **)** Force a neighbour for moving the input focus to. When pressing TAB or directional/joypad directions focus is moved to the next control in that direction. However, the neighbour to move to can be forced with this function. .. _class_Control_set_global_position: -- void **set_global_position** **(** :ref:`Vector2` position **)** +- void **set_global_position** **(** :ref:`Vector2` position **)** Move the Control to a new position, relative to the top-left corner of the *window* Control, and without changing current anchor mode. (see :ref:`set_margin`). .. _class_Control_set_h_grow_direction: -- void **set_h_grow_direction** **(** :ref:`int` direction **)** +- void **set_h_grow_direction** **(** :ref:`int` direction **)** .. _class_Control_set_h_size_flags: -- void **set_h_size_flags** **(** :ref:`int` flags **)** +- void **set_h_size_flags** **(** :ref:`int` flags **)** Hint for containers, set horizontal positioning flags. .. _class_Control_set_margin: -- void **set_margin** **(** :ref:`int` margin, :ref:`float` offset **)** +- void **set_margin** **(** :ref:`int` margin, :ref:`float` offset **)** Set a margin offset. Margin can be one of (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). Offset value being set depends on the anchor mode. .. _class_Control_set_margins_preset: -- void **set_margins_preset** **(** :ref:`int` preset, :ref:`int` resize_mode=0, :ref:`int` margin=0 **)** +- void **set_margins_preset** **(** :ref:`int` preset, :ref:`int` resize_mode=0, :ref:`int` margin=0 **)** .. _class_Control_set_mouse_filter: -- void **set_mouse_filter** **(** :ref:`int` filter **)** +- void **set_mouse_filter** **(** :ref:`int` filter **)** Set when the control is ignoring mouse events (even touchpad events send mouse events). (see the MOUSE_FILTER\_\* constants) .. _class_Control_set_pivot_offset: -- void **set_pivot_offset** **(** :ref:`Vector2` pivot_offset **)** +- void **set_pivot_offset** **(** :ref:`Vector2` pivot_offset **)** .. _class_Control_set_position: -- void **set_position** **(** :ref:`Vector2` position **)** +- void **set_position** **(** :ref:`Vector2` position **)** Move the Control to a new position, relative to the top-left corner of the parent Control, changing all margins if needed and without changing current anchor mode. This is a helper (see :ref:`set_margin`). .. _class_Control_set_rotation: -- void **set_rotation** **(** :ref:`float` radians **)** +- void **set_rotation** **(** :ref:`float` radians **)** Set the rotation (in radians). .. _class_Control_set_rotation_deg: -- void **set_rotation_deg** **(** :ref:`float` degrees **)** +- void **set_rotation_deg** **(** :ref:`float` degrees **)** Set the rotation (in degrees). .. _class_Control_set_scale: -- void **set_scale** **(** :ref:`Vector2` scale **)** +- void **set_scale** **(** :ref:`Vector2` scale **)** .. _class_Control_set_size: -- void **set_size** **(** :ref:`Vector2` size **)** +- void **set_size** **(** :ref:`Vector2` size **)** Changes MARGIN_RIGHT and MARGIN_BOTTOM to fit a given size. This is a helper (see :ref:`set_margin`). .. _class_Control_set_stretch_ratio: -- void **set_stretch_ratio** **(** :ref:`float` ratio **)** +- void **set_stretch_ratio** **(** :ref:`float` ratio **)** Hint for containers, set the stretch ratio. This value is relative to other stretch ratio, so if this control has 2 and another has 1, this one will be twice as big. .. _class_Control_set_theme: -- void **set_theme** **(** :ref:`Theme` theme **)** +- void **set_theme** **(** :ref:`Theme` theme **)** Overrides the whole :ref:`Theme` for this node and all its ``Control`` children. .. _class_Control_set_tooltip: -- void **set_tooltip** **(** :ref:`String` tooltip **)** +- void **set_tooltip** **(** :ref:`String` tooltip **)** Changes the tooltip text. The tooltip appears when the user's mouse cursor stays idle over this control for a few moments. .. _class_Control_set_v_grow_direction: -- void **set_v_grow_direction** **(** :ref:`int` direction **)** +- void **set_v_grow_direction** **(** :ref:`int` direction **)** .. _class_Control_set_v_size_flags: -- void **set_v_size_flags** **(** :ref:`int` flags **)** +- void **set_v_size_flags** **(** :ref:`int` flags **)** Hint for containers, set vertical positioning flags. .. _class_Control_show_modal: -- void **show_modal** **(** :ref:`bool` exclusive=false **)** +- void **show_modal** **(** :ref:`bool` exclusive=false **)** Display a Control as modal. Control must be a subwindow. Modal controls capture the input signals until closed or the area outside them is accessed. When a modal control loses focus, or the ESC key is pressed, they automatically hide. Modal controls are used extensively for popup dialogs and menus. .. _class_Control_warp_mouse: -- void **warp_mouse** **(** :ref:`Vector2` to_position **)** +- void **warp_mouse** **(** :ref:`Vector2` to_position **)** diff --git a/classes/class_convexpolygonshape.rst b/classes/class_convexpolygonshape.rst index 083d4cb22..bad2f533e 100644 --- a/classes/class_convexpolygonshape.rst +++ b/classes/class_convexpolygonshape.rst @@ -19,11 +19,11 @@ Convex polygon shape for 3D physics. Member Functions ---------------- -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`get_points` **(** **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_points` **(** :ref:`PoolVector3Array` points **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`get_points` **(** **)** const | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_points` **(** :ref:`PoolVector3Array` points **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -43,10 +43,10 @@ Member Function Description .. _class_ConvexPolygonShape_get_points: -- :ref:`PoolVector3Array` **get_points** **(** **)** const +- :ref:`PoolVector3Array` **get_points** **(** **)** const .. _class_ConvexPolygonShape_set_points: -- void **set_points** **(** :ref:`PoolVector3Array` points **)** +- void **set_points** **(** :ref:`PoolVector3Array` points **)** diff --git a/classes/class_convexpolygonshape2d.rst b/classes/class_convexpolygonshape2d.rst index 3e3fed155..ad532278c 100644 --- a/classes/class_convexpolygonshape2d.rst +++ b/classes/class_convexpolygonshape2d.rst @@ -19,13 +19,13 @@ Convex Polygon Shape for 2D physics. Member Functions ---------------- -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_points` **(** **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_cloud` **(** :ref:`PoolVector2Array` point_cloud **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_points` **(** :ref:`PoolVector2Array` points **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`get_points` **(** **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_cloud` **(** :ref:`PoolVector2Array` point_cloud **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_points` **(** :ref:`PoolVector2Array` points **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -47,19 +47,19 @@ Member Function Description .. _class_ConvexPolygonShape2D_get_points: -- :ref:`PoolVector2Array` **get_points** **(** **)** const +- :ref:`PoolVector2Array` **get_points** **(** **)** const Returns a list of points in either clockwise or counter clockwise order, forming a convex polygon. .. _class_ConvexPolygonShape2D_set_point_cloud: -- void **set_point_cloud** **(** :ref:`PoolVector2Array` point_cloud **)** +- void **set_point_cloud** **(** :ref:`PoolVector2Array` point_cloud **)** Currently, this method does nothing. .. _class_ConvexPolygonShape2D_set_points: -- void **set_points** **(** :ref:`PoolVector2Array` points **)** +- void **set_points** **(** :ref:`PoolVector2Array` points **)** Sets a list of points in either clockwise or counter clockwise order, forming a convex polygon. diff --git a/classes/class_csharpscript.rst b/classes/class_csharpscript.rst index 076c841fb..95eac5576 100644 --- a/classes/class_csharpscript.rst +++ b/classes/class_csharpscript.rst @@ -19,15 +19,15 @@ Brief Description Member Functions ---------------- -+------------------------------+--------------------------------------------------------+ -| :ref:`Object` | :ref:`new` **(** **)** vararg | -+------------------------------+--------------------------------------------------------+ ++------------------------------+-------------------------------------------------------+ +| :ref:`Object` | :ref:`new` **(** **)** vararg | ++------------------------------+-------------------------------------------------------+ Member Function Description --------------------------- .. _class_CSharpScript_new: -- :ref:`Object` **new** **(** **)** vararg +- :ref:`Object` **new** **(** **)** vararg diff --git a/classes/class_cubemap.rst b/classes/class_cubemap.rst index e5a0d13ac..649a9ebcd 100644 --- a/classes/class_cubemap.rst +++ b/classes/class_cubemap.rst @@ -19,27 +19,27 @@ Brief Description Member Functions ---------------- -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_flags` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_height` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_lossy_storage_quality` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`get_side` **(** :ref:`int` side **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_storage` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_width` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_flags` **(** :ref:`int` flags **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_lossy_storage_quality` **(** :ref:`float` quality **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_side` **(** :ref:`int` side, :ref:`Image` image **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_storage` **(** :ref:`int` mode **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ ++----------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_flags` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_height` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_lossy_storage_quality` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Image` | :ref:`get_side` **(** :ref:`int` side **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_storage` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_width` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_flags` **(** :ref:`int` flags **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_lossy_storage_quality` **(** :ref:`float` quality **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_side` **(** :ref:`int` side, :ref:`Image` image **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_storage` **(** :ref:`int` mode **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -63,42 +63,42 @@ Member Function Description .. _class_CubeMap_get_flags: -- :ref:`int` **get_flags** **(** **)** const +- :ref:`int` **get_flags** **(** **)** const .. _class_CubeMap_get_height: -- :ref:`int` **get_height** **(** **)** const +- :ref:`int` **get_height** **(** **)** const .. _class_CubeMap_get_lossy_storage_quality: -- :ref:`float` **get_lossy_storage_quality** **(** **)** const +- :ref:`float` **get_lossy_storage_quality** **(** **)** const .. _class_CubeMap_get_side: -- :ref:`Image` **get_side** **(** :ref:`int` side **)** const +- :ref:`Image` **get_side** **(** :ref:`int` side **)** const .. _class_CubeMap_get_storage: -- :ref:`int` **get_storage** **(** **)** const +- :ref:`int` **get_storage** **(** **)** const .. _class_CubeMap_get_width: -- :ref:`int` **get_width** **(** **)** const +- :ref:`int` **get_width** **(** **)** const .. _class_CubeMap_set_flags: -- void **set_flags** **(** :ref:`int` flags **)** +- void **set_flags** **(** :ref:`int` flags **)** .. _class_CubeMap_set_lossy_storage_quality: -- void **set_lossy_storage_quality** **(** :ref:`float` quality **)** +- void **set_lossy_storage_quality** **(** :ref:`float` quality **)** .. _class_CubeMap_set_side: -- void **set_side** **(** :ref:`int` side, :ref:`Image` image **)** +- void **set_side** **(** :ref:`int` side, :ref:`Image` image **)** .. _class_CubeMap_set_storage: -- void **set_storage** **(** :ref:`int` mode **)** +- void **set_storage** **(** :ref:`int` mode **)** diff --git a/classes/class_cubemesh.rst b/classes/class_cubemesh.rst index 07461d2ff..95f7cddc7 100644 --- a/classes/class_cubemesh.rst +++ b/classes/class_cubemesh.rst @@ -19,23 +19,23 @@ Generate an axis-aligned cuboid :ref:`PrimitiveMesh`. Member Functions ---------------- -+--------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_size` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_subdivide_depth` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_subdivide_height` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_subdivide_width` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_size` **(** :ref:`Vector3` size **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_subdivide_depth` **(** :ref:`int` divisions **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_subdivide_height` **(** :ref:`int` divisions **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_subdivide_width` **(** :ref:`int` subdivide **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------+ ++--------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_size` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_subdivide_depth` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_subdivide_height` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_subdivide_width` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_size` **(** :ref:`Vector3` size **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_subdivide_depth` **(** :ref:`int` divisions **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_subdivide_height` **(** :ref:`int` divisions **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_subdivide_width` **(** :ref:`int` subdivide **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -67,34 +67,34 @@ Member Function Description .. _class_CubeMesh_get_size: -- :ref:`Vector3` **get_size** **(** **)** const +- :ref:`Vector3` **get_size** **(** **)** const .. _class_CubeMesh_get_subdivide_depth: -- :ref:`int` **get_subdivide_depth** **(** **)** const +- :ref:`int` **get_subdivide_depth** **(** **)** const .. _class_CubeMesh_get_subdivide_height: -- :ref:`int` **get_subdivide_height** **(** **)** const +- :ref:`int` **get_subdivide_height** **(** **)** const .. _class_CubeMesh_get_subdivide_width: -- :ref:`int` **get_subdivide_width** **(** **)** const +- :ref:`int` **get_subdivide_width** **(** **)** const .. _class_CubeMesh_set_size: -- void **set_size** **(** :ref:`Vector3` size **)** +- void **set_size** **(** :ref:`Vector3` size **)** .. _class_CubeMesh_set_subdivide_depth: -- void **set_subdivide_depth** **(** :ref:`int` divisions **)** +- void **set_subdivide_depth** **(** :ref:`int` divisions **)** .. _class_CubeMesh_set_subdivide_height: -- void **set_subdivide_height** **(** :ref:`int` divisions **)** +- void **set_subdivide_height** **(** :ref:`int` divisions **)** .. _class_CubeMesh_set_subdivide_width: -- void **set_subdivide_width** **(** :ref:`int` subdivide **)** +- void **set_subdivide_width** **(** :ref:`int` subdivide **)** diff --git a/classes/class_curve.rst b/classes/class_curve.rst index 15a33b51f..e3f3641c1 100644 --- a/classes/class_curve.rst +++ b/classes/class_curve.rst @@ -19,62 +19,62 @@ Brief Description Member Functions ---------------- -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`add_point` **(** :ref:`Vector2` position, :ref:`float` left_tangent=0, :ref:`float` right_tangent=0, :ref:`int` left_mode=0, :ref:`int` right_mode=0 **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`bake` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clean_dupes` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_points` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_bake_resolution` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_max_value` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_min_value` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_point_left_mode` **(** :ref:`int` index **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_point_left_tangent` **(** :ref:`int` index **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_point_position` **(** :ref:`int` index **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_point_right_mode` **(** :ref:`int` index **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_point_right_tangent` **(** :ref:`int` index **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`interpolate` **(** :ref:`float` offset **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`interpolate_baked` **(** :ref:`float` offset **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_point` **(** :ref:`int` index **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bake_resolution` **(** :ref:`int` resolution **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_max_value` **(** :ref:`float` max **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_min_value` **(** :ref:`float` min **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_left_mode` **(** :ref:`int` index, :ref:`int` mode **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_left_tangent` **(** :ref:`int` index, :ref:`float` tangent **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`set_point_offset` **(** :ref:`int` index, :ref:`float` offset **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_right_mode` **(** :ref:`int` index, :ref:`int` mode **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_right_tangent` **(** :ref:`int` index, :ref:`float` tangent **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_value` **(** :ref:`int` index, :ref:`float` y **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`add_point` **(** :ref:`Vector2` position, :ref:`float` left_tangent=0, :ref:`float` right_tangent=0, :ref:`int` left_mode=0, :ref:`int` right_mode=0 **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`bake` **(** **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clean_dupes` **(** **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_points` **(** **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_bake_resolution` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_max_value` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_min_value` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_point_left_mode` **(** :ref:`int` index **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_point_left_tangent` **(** :ref:`int` index **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_point_position` **(** :ref:`int` index **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_point_right_mode` **(** :ref:`int` index **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_point_right_tangent` **(** :ref:`int` index **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`interpolate` **(** :ref:`float` offset **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`interpolate_baked` **(** :ref:`float` offset **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_point` **(** :ref:`int` index **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bake_resolution` **(** :ref:`int` resolution **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_max_value` **(** :ref:`float` max **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_min_value` **(** :ref:`float` min **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_left_mode` **(** :ref:`int` index, :ref:`int` mode **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_left_tangent` **(** :ref:`int` index, :ref:`float` tangent **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`set_point_offset` **(** :ref:`int` index, :ref:`float` offset **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_right_mode` **(** :ref:`int` index, :ref:`int` mode **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_right_tangent` **(** :ref:`int` index, :ref:`float` tangent **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_value` **(** :ref:`int` index, :ref:`float` y **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_Curve_range_changed: -- **range_changed** **(** **)** +- **range_changed** **(** **)** Member Variables @@ -109,98 +109,98 @@ Member Function Description .. _class_Curve_add_point: -- :ref:`int` **add_point** **(** :ref:`Vector2` position, :ref:`float` left_tangent=0, :ref:`float` right_tangent=0, :ref:`int` left_mode=0, :ref:`int` right_mode=0 **)** +- :ref:`int` **add_point** **(** :ref:`Vector2` position, :ref:`float` left_tangent=0, :ref:`float` right_tangent=0, :ref:`int` left_mode=0, :ref:`int` right_mode=0 **)** .. _class_Curve_bake: -- void **bake** **(** **)** +- void **bake** **(** **)** .. _class_Curve_clean_dupes: -- void **clean_dupes** **(** **)** +- void **clean_dupes** **(** **)** .. _class_Curve_clear_points: -- void **clear_points** **(** **)** +- void **clear_points** **(** **)** .. _class_Curve_get_bake_resolution: -- :ref:`int` **get_bake_resolution** **(** **)** const +- :ref:`int` **get_bake_resolution** **(** **)** const .. _class_Curve_get_max_value: -- :ref:`float` **get_max_value** **(** **)** const +- :ref:`float` **get_max_value** **(** **)** const .. _class_Curve_get_min_value: -- :ref:`float` **get_min_value** **(** **)** const +- :ref:`float` **get_min_value** **(** **)** const .. _class_Curve_get_point_left_mode: -- :ref:`int` **get_point_left_mode** **(** :ref:`int` index **)** const +- :ref:`int` **get_point_left_mode** **(** :ref:`int` index **)** const .. _class_Curve_get_point_left_tangent: -- :ref:`float` **get_point_left_tangent** **(** :ref:`int` index **)** const +- :ref:`float` **get_point_left_tangent** **(** :ref:`int` index **)** const .. _class_Curve_get_point_position: -- :ref:`Vector2` **get_point_position** **(** :ref:`int` index **)** const +- :ref:`Vector2` **get_point_position** **(** :ref:`int` index **)** const .. _class_Curve_get_point_right_mode: -- :ref:`int` **get_point_right_mode** **(** :ref:`int` index **)** const +- :ref:`int` **get_point_right_mode** **(** :ref:`int` index **)** const .. _class_Curve_get_point_right_tangent: -- :ref:`float` **get_point_right_tangent** **(** :ref:`int` index **)** const +- :ref:`float` **get_point_right_tangent** **(** :ref:`int` index **)** const .. _class_Curve_interpolate: -- :ref:`float` **interpolate** **(** :ref:`float` offset **)** const +- :ref:`float` **interpolate** **(** :ref:`float` offset **)** const .. _class_Curve_interpolate_baked: -- :ref:`float` **interpolate_baked** **(** :ref:`float` offset **)** +- :ref:`float` **interpolate_baked** **(** :ref:`float` offset **)** .. _class_Curve_remove_point: -- void **remove_point** **(** :ref:`int` index **)** +- void **remove_point** **(** :ref:`int` index **)** .. _class_Curve_set_bake_resolution: -- void **set_bake_resolution** **(** :ref:`int` resolution **)** +- void **set_bake_resolution** **(** :ref:`int` resolution **)** .. _class_Curve_set_max_value: -- void **set_max_value** **(** :ref:`float` max **)** +- void **set_max_value** **(** :ref:`float` max **)** .. _class_Curve_set_min_value: -- void **set_min_value** **(** :ref:`float` min **)** +- void **set_min_value** **(** :ref:`float` min **)** .. _class_Curve_set_point_left_mode: -- void **set_point_left_mode** **(** :ref:`int` index, :ref:`int` mode **)** +- void **set_point_left_mode** **(** :ref:`int` index, :ref:`int` mode **)** .. _class_Curve_set_point_left_tangent: -- void **set_point_left_tangent** **(** :ref:`int` index, :ref:`float` tangent **)** +- void **set_point_left_tangent** **(** :ref:`int` index, :ref:`float` tangent **)** .. _class_Curve_set_point_offset: -- :ref:`int` **set_point_offset** **(** :ref:`int` index, :ref:`float` offset **)** +- :ref:`int` **set_point_offset** **(** :ref:`int` index, :ref:`float` offset **)** .. _class_Curve_set_point_right_mode: -- void **set_point_right_mode** **(** :ref:`int` index, :ref:`int` mode **)** +- void **set_point_right_mode** **(** :ref:`int` index, :ref:`int` mode **)** .. _class_Curve_set_point_right_tangent: -- void **set_point_right_tangent** **(** :ref:`int` index, :ref:`float` tangent **)** +- void **set_point_right_tangent** **(** :ref:`int` index, :ref:`float` tangent **)** .. _class_Curve_set_point_value: -- void **set_point_value** **(** :ref:`int` index, :ref:`float` y **)** +- void **set_point_value** **(** :ref:`int` index, :ref:`float` y **)** diff --git a/classes/class_curve2d.rst b/classes/class_curve2d.rst index a91d728c9..d0cabd0d2 100644 --- a/classes/class_curve2d.rst +++ b/classes/class_curve2d.rst @@ -19,43 +19,43 @@ Describes a Bezier curve in 2D space. Member Functions ---------------- -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_point` **(** :ref:`Vector2` position, :ref:`Vector2` in=Vector2( 0, 0 ), :ref:`Vector2` out=Vector2( 0, 0 ), :ref:`int` at_position=-1 **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_points` **(** **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_bake_interval` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_baked_length` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_baked_points` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_point_count` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_point_in` **(** :ref:`int` idx **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_point_out` **(** :ref:`int` idx **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_point_position` **(** :ref:`int` idx **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`interpolate` **(** :ref:`int` idx, :ref:`float` t **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`interpolate_baked` **(** :ref:`float` offset, :ref:`bool` cubic=false **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`interpolatef` **(** :ref:`float` fofs **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_point` **(** :ref:`int` idx **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bake_interval` **(** :ref:`float` distance **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_in` **(** :ref:`int` idx, :ref:`Vector2` position **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_out` **(** :ref:`int` idx, :ref:`Vector2` position **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_position` **(** :ref:`int` idx, :ref:`Vector2` position **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`tessellate` **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_point` **(** :ref:`Vector2` position, :ref:`Vector2` in=Vector2( 0, 0 ), :ref:`Vector2` out=Vector2( 0, 0 ), :ref:`int` at_position=-1 **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_points` **(** **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_bake_interval` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_baked_length` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`get_baked_points` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_point_count` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_point_in` **(** :ref:`int` idx **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_point_out` **(** :ref:`int` idx **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_point_position` **(** :ref:`int` idx **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`interpolate` **(** :ref:`int` idx, :ref:`float` t **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`interpolate_baked` **(** :ref:`float` offset, :ref:`bool` cubic=false **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`interpolatef` **(** :ref:`float` fofs **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_point` **(** :ref:`int` idx **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bake_interval` **(** :ref:`float` distance **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_in` **(** :ref:`int` idx, :ref:`Vector2` position **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_out` **(** :ref:`int` idx, :ref:`Vector2` position **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_position` **(** :ref:`int` idx, :ref:`Vector2` position **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`tessellate` **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -81,7 +81,7 @@ Member Function Description .. _class_Curve2D_add_point: -- void **add_point** **(** :ref:`Vector2` position, :ref:`Vector2` in=Vector2( 0, 0 ), :ref:`Vector2` out=Vector2( 0, 0 ), :ref:`int` at_position=-1 **)** +- void **add_point** **(** :ref:`Vector2` position, :ref:`Vector2` in=Vector2( 0, 0 ), :ref:`Vector2` out=Vector2( 0, 0 ), :ref:`int` at_position=-1 **)** Adds a point to a curve, at "position", with control points "in" and "out". @@ -89,53 +89,53 @@ If "at_position" is given, the point is inserted before the point number "at_pos .. _class_Curve2D_clear_points: -- void **clear_points** **(** **)** +- void **clear_points** **(** **)** .. _class_Curve2D_get_bake_interval: -- :ref:`float` **get_bake_interval** **(** **)** const +- :ref:`float` **get_bake_interval** **(** **)** const Returns the distance between two adjacent cached points. .. _class_Curve2D_get_baked_length: -- :ref:`float` **get_baked_length** **(** **)** const +- :ref:`float` **get_baked_length** **(** **)** const Returns the total length of the curve, based on the cached points. Given enough density (see :ref:`set_bake_interval`), it should be approximate enough. .. _class_Curve2D_get_baked_points: -- :ref:`PoolVector2Array` **get_baked_points** **(** **)** const +- :ref:`PoolVector2Array` **get_baked_points** **(** **)** const Returns the cache of points as a :ref:`PoolVector2Array`. .. _class_Curve2D_get_point_count: -- :ref:`int` **get_point_count** **(** **)** const +- :ref:`int` **get_point_count** **(** **)** const Returns the number of points describing the curve. .. _class_Curve2D_get_point_in: -- :ref:`Vector2` **get_point_in** **(** :ref:`int` idx **)** const +- :ref:`Vector2` **get_point_in** **(** :ref:`int` idx **)** const Returns the position of the control point leading to the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0). .. _class_Curve2D_get_point_out: -- :ref:`Vector2` **get_point_out** **(** :ref:`int` idx **)** const +- :ref:`Vector2` **get_point_out** **(** :ref:`int` idx **)** const Returns the position of the control point leading out of the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0). .. _class_Curve2D_get_point_position: -- :ref:`Vector2` **get_point_position** **(** :ref:`int` idx **)** const +- :ref:`Vector2` **get_point_position** **(** :ref:`int` idx **)** const Returns the position of the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0). .. _class_Curve2D_interpolate: -- :ref:`Vector2` **interpolate** **(** :ref:`int` idx, :ref:`float` t **)** const +- :ref:`Vector2` **interpolate** **(** :ref:`int` idx, :ref:`float` t **)** const Returns the position between the vertex "idx" and the vertex "idx"+1, where "t" controls if the point is the first vertex (t = 0.0), the last vertex (t = 1.0), or in between. Values of "t" outside the range (0.0 >= t <=1) give strange, but predictable results. @@ -143,7 +143,7 @@ If "idx" is out of bounds it is truncated to the first or last vertex, and "t" i .. _class_Curve2D_interpolate_baked: -- :ref:`Vector2` **interpolate_baked** **(** :ref:`float` offset, :ref:`bool` cubic=false **)** const +- :ref:`Vector2` **interpolate_baked** **(** :ref:`float` offset, :ref:`bool` cubic=false **)** const Returns a point within the curve at position "offset", where "offset" is measured as a pixel distance along the curve. @@ -153,43 +153,43 @@ Cubic interpolation tends to follow the curves better, but linear is faster (and .. _class_Curve2D_interpolatef: -- :ref:`Vector2` **interpolatef** **(** :ref:`float` fofs **)** const +- :ref:`Vector2` **interpolatef** **(** :ref:`float` fofs **)** const Returns the position at the vertex "fofs". It calls :ref:`interpolate` using the integer part of fofs as "idx", and its fractional part as "t". .. _class_Curve2D_remove_point: -- void **remove_point** **(** :ref:`int` idx **)** +- void **remove_point** **(** :ref:`int` idx **)** Deletes the point "idx" from the curve. Sends an error to the console if "idx" is out of bounds. .. _class_Curve2D_set_bake_interval: -- void **set_bake_interval** **(** :ref:`float` distance **)** +- void **set_bake_interval** **(** :ref:`float` distance **)** Sets the distance in pixels between two adjacent cached points. Changing it forces the cache to be recomputed the next time a xxx_baked_xxx function is called. The less distance, the more points the cache will have, and the more memory it will consume, so use with care. .. _class_Curve2D_set_point_in: -- void **set_point_in** **(** :ref:`int` idx, :ref:`Vector2` position **)** +- void **set_point_in** **(** :ref:`int` idx, :ref:`Vector2` position **)** Sets the position of the control point leading to the vertex "idx". If the index is out of bounds, the function sends an error to the console. .. _class_Curve2D_set_point_out: -- void **set_point_out** **(** :ref:`int` idx, :ref:`Vector2` position **)** +- void **set_point_out** **(** :ref:`int` idx, :ref:`Vector2` position **)** Sets the position of the control point leading out of the vertex "idx". If the index is out of bounds, the function sends an error to the console. .. _class_Curve2D_set_point_position: -- void **set_point_position** **(** :ref:`int` idx, :ref:`Vector2` position **)** +- void **set_point_position** **(** :ref:`int` idx, :ref:`Vector2` position **)** Sets the position for the vertex "idx". If the index is out of bounds, the function sends an error to the console. .. _class_Curve2D_tessellate: -- :ref:`PoolVector2Array` **tessellate** **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const +- :ref:`PoolVector2Array` **tessellate** **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const Returns a list of points along the curve, with a curvature controlled point density. That is, the curvier parts will have more points than the straighter parts. diff --git a/classes/class_curve3d.rst b/classes/class_curve3d.rst index 59954acf5..f27906982 100644 --- a/classes/class_curve3d.rst +++ b/classes/class_curve3d.rst @@ -19,49 +19,49 @@ Describes a Bezier curve in 3D space. Member Functions ---------------- -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_point` **(** :ref:`Vector3` position, :ref:`Vector3` in=Vector3( 0, 0, 0 ), :ref:`Vector3` out=Vector3( 0, 0, 0 ), :ref:`int` at_position=-1 **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_points` **(** **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_bake_interval` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_baked_length` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`get_baked_points` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolRealArray` | :ref:`get_baked_tilts` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_point_count` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_point_in` **(** :ref:`int` idx **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_point_out` **(** :ref:`int` idx **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_point_position` **(** :ref:`int` idx **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_point_tilt` **(** :ref:`int` idx **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`interpolate` **(** :ref:`int` idx, :ref:`float` t **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`interpolate_baked` **(** :ref:`float` offset, :ref:`bool` cubic=false **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`interpolatef` **(** :ref:`float` fofs **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_point` **(** :ref:`int` idx **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bake_interval` **(** :ref:`float` distance **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_in` **(** :ref:`int` idx, :ref:`Vector3` position **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_out` **(** :ref:`int` idx, :ref:`Vector3` position **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_position` **(** :ref:`int` idx, :ref:`Vector3` position **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_tilt` **(** :ref:`int` idx, :ref:`float` tilt **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`tessellate` **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_point` **(** :ref:`Vector3` position, :ref:`Vector3` in=Vector3( 0, 0, 0 ), :ref:`Vector3` out=Vector3( 0, 0, 0 ), :ref:`int` at_position=-1 **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_points` **(** **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_bake_interval` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_baked_length` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`get_baked_points` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolRealArray` | :ref:`get_baked_tilts` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_point_count` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_point_in` **(** :ref:`int` idx **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_point_out` **(** :ref:`int` idx **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_point_position` **(** :ref:`int` idx **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_point_tilt` **(** :ref:`int` idx **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`interpolate` **(** :ref:`int` idx, :ref:`float` t **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`interpolate_baked` **(** :ref:`float` offset, :ref:`bool` cubic=false **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`interpolatef` **(** :ref:`float` fofs **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_point` **(** :ref:`int` idx **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bake_interval` **(** :ref:`float` distance **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_in` **(** :ref:`int` idx, :ref:`Vector3` position **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_out` **(** :ref:`int` idx, :ref:`Vector3` position **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_position` **(** :ref:`int` idx, :ref:`Vector3` position **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_tilt` **(** :ref:`int` idx, :ref:`float` tilt **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`tessellate` **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -87,7 +87,7 @@ Member Function Description .. _class_Curve3D_add_point: -- void **add_point** **(** :ref:`Vector3` position, :ref:`Vector3` in=Vector3( 0, 0, 0 ), :ref:`Vector3` out=Vector3( 0, 0, 0 ), :ref:`int` at_position=-1 **)** +- void **add_point** **(** :ref:`Vector3` position, :ref:`Vector3` in=Vector3( 0, 0, 0 ), :ref:`Vector3` out=Vector3( 0, 0, 0 ), :ref:`int` at_position=-1 **)** Adds a point to a curve, at "position", with control points "in" and "out". @@ -95,65 +95,65 @@ If "at_position" is given, the point is inserted before the point number "at_pos .. _class_Curve3D_clear_points: -- void **clear_points** **(** **)** +- void **clear_points** **(** **)** .. _class_Curve3D_get_bake_interval: -- :ref:`float` **get_bake_interval** **(** **)** const +- :ref:`float` **get_bake_interval** **(** **)** const Returns the distance between two adjacent cached points. .. _class_Curve3D_get_baked_length: -- :ref:`float` **get_baked_length** **(** **)** const +- :ref:`float` **get_baked_length** **(** **)** const Returns the total length of the curve, based on the cached points. Given enough density (see :ref:`set_bake_interval`), it should be approximate enough. .. _class_Curve3D_get_baked_points: -- :ref:`PoolVector3Array` **get_baked_points** **(** **)** const +- :ref:`PoolVector3Array` **get_baked_points** **(** **)** const Returns the cache of points as a :ref:`PoolVector3Array`. .. _class_Curve3D_get_baked_tilts: -- :ref:`PoolRealArray` **get_baked_tilts** **(** **)** const +- :ref:`PoolRealArray` **get_baked_tilts** **(** **)** const Returns the cache of tilts as a RealArray. .. _class_Curve3D_get_point_count: -- :ref:`int` **get_point_count** **(** **)** const +- :ref:`int` **get_point_count** **(** **)** const Returns the number of points describing the curve. .. _class_Curve3D_get_point_in: -- :ref:`Vector3` **get_point_in** **(** :ref:`int` idx **)** const +- :ref:`Vector3` **get_point_in** **(** :ref:`int` idx **)** const Returns the position of the control point leading to the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0, 0). .. _class_Curve3D_get_point_out: -- :ref:`Vector3` **get_point_out** **(** :ref:`int` idx **)** const +- :ref:`Vector3` **get_point_out** **(** :ref:`int` idx **)** const Returns the position of the control point leading out of the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0, 0). .. _class_Curve3D_get_point_position: -- :ref:`Vector3` **get_point_position** **(** :ref:`int` idx **)** const +- :ref:`Vector3` **get_point_position** **(** :ref:`int` idx **)** const Returns the position of the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0, 0). .. _class_Curve3D_get_point_tilt: -- :ref:`float` **get_point_tilt** **(** :ref:`int` idx **)** const +- :ref:`float` **get_point_tilt** **(** :ref:`int` idx **)** const Returns the tilt angle in radians for the point "idx". If the index is out of bounds, the function sends an error to the console, and returns 0. .. _class_Curve3D_interpolate: -- :ref:`Vector3` **interpolate** **(** :ref:`int` idx, :ref:`float` t **)** const +- :ref:`Vector3` **interpolate** **(** :ref:`int` idx, :ref:`float` t **)** const Returns the position between the vertex "idx" and the vertex "idx"+1, where "t" controls if the point is the first vertex (t = 0.0), the last vertex (t = 1.0), or in between. Values of "t" outside the range (0.0 >= t <=1) give strange, but predictable results. @@ -161,7 +161,7 @@ If "idx" is out of bounds it is truncated to the first or last vertex, and "t" i .. _class_Curve3D_interpolate_baked: -- :ref:`Vector3` **interpolate_baked** **(** :ref:`float` offset, :ref:`bool` cubic=false **)** const +- :ref:`Vector3` **interpolate_baked** **(** :ref:`float` offset, :ref:`bool` cubic=false **)** const Returns a point within the curve at position "offset", where "offset" is measured as a distance in 3D units along the curve. @@ -171,43 +171,43 @@ Cubic interpolation tends to follow the curves better, but linear is faster (and .. _class_Curve3D_interpolatef: -- :ref:`Vector3` **interpolatef** **(** :ref:`float` fofs **)** const +- :ref:`Vector3` **interpolatef** **(** :ref:`float` fofs **)** const Returns the position at the vertex "fofs". It calls :ref:`interpolate` using the integer part of fofs as "idx", and its fractional part as "t". .. _class_Curve3D_remove_point: -- void **remove_point** **(** :ref:`int` idx **)** +- void **remove_point** **(** :ref:`int` idx **)** Deletes the point "idx" from the curve. Sends an error to the console if "idx" is out of bounds. .. _class_Curve3D_set_bake_interval: -- void **set_bake_interval** **(** :ref:`float` distance **)** +- void **set_bake_interval** **(** :ref:`float` distance **)** Sets the distance in 3D units between two adjacent cached points. Changing it forces the cache to be recomputed the next time a xxx_baked_xxx function is called. The less distance, the more points the cache will have, and the more memory it will consume, so use with care. .. _class_Curve3D_set_point_in: -- void **set_point_in** **(** :ref:`int` idx, :ref:`Vector3` position **)** +- void **set_point_in** **(** :ref:`int` idx, :ref:`Vector3` position **)** Sets the position of the control point leading to the vertex "idx". If the index is out of bounds, the function sends an error to the console. .. _class_Curve3D_set_point_out: -- void **set_point_out** **(** :ref:`int` idx, :ref:`Vector3` position **)** +- void **set_point_out** **(** :ref:`int` idx, :ref:`Vector3` position **)** Sets the position of the control point leading out of the vertex "idx". If the index is out of bounds, the function sends an error to the console. .. _class_Curve3D_set_point_position: -- void **set_point_position** **(** :ref:`int` idx, :ref:`Vector3` position **)** +- void **set_point_position** **(** :ref:`int` idx, :ref:`Vector3` position **)** Sets the position for the vertex "idx". If the index is out of bounds, the function sends an error to the console. .. _class_Curve3D_set_point_tilt: -- void **set_point_tilt** **(** :ref:`int` idx, :ref:`float` tilt **)** +- void **set_point_tilt** **(** :ref:`int` idx, :ref:`float` tilt **)** Sets the tilt angle in radians for the point "idx". If the index is out of bounds, the function sends an error to the console. @@ -215,7 +215,7 @@ The tilt controls the rotation along the look-at axis an object traveling the pa .. _class_Curve3D_tessellate: -- :ref:`PoolVector3Array` **tessellate** **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const +- :ref:`PoolVector3Array` **tessellate** **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const Returns a list of points along the curve, with a curvature controlled point density. That is, the curvier parts will have more points than the straighter parts. diff --git a/classes/class_curvetexture.rst b/classes/class_curvetexture.rst index e2c901d4a..6b76d3632 100644 --- a/classes/class_curvetexture.rst +++ b/classes/class_curvetexture.rst @@ -19,13 +19,13 @@ Brief Description Member Functions ---------------- -+----------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`Curve` | :ref:`get_curve` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------+ -| void | :ref:`set_curve` **(** :ref:`Curve` curve **)** | -+----------------------------+----------------------------------------------------------------------------------------------+ -| void | :ref:`set_width` **(** :ref:`int` width **)** | -+----------------------------+----------------------------------------------------------------------------------------------+ ++----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`Curve` | :ref:`get_curve` **(** **)** const | ++----------------------------+--------------------------------------------------------------------------------------------+ +| void | :ref:`set_curve` **(** :ref:`Curve` curve **)** | ++----------------------------+--------------------------------------------------------------------------------------------+ +| void | :ref:`set_width` **(** :ref:`int` width **)** | ++----------------------------+--------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -44,14 +44,14 @@ Member Function Description .. _class_CurveTexture_get_curve: -- :ref:`Curve` **get_curve** **(** **)** const +- :ref:`Curve` **get_curve** **(** **)** const .. _class_CurveTexture_set_curve: -- void **set_curve** **(** :ref:`Curve` curve **)** +- void **set_curve** **(** :ref:`Curve` curve **)** .. _class_CurveTexture_set_width: -- void **set_width** **(** :ref:`int` width **)** +- void **set_width** **(** :ref:`int` width **)** diff --git a/classes/class_cylindermesh.rst b/classes/class_cylindermesh.rst index 58143634c..0389d0276 100644 --- a/classes/class_cylindermesh.rst +++ b/classes/class_cylindermesh.rst @@ -19,27 +19,27 @@ Class representing a cylindrical :ref:`PrimitiveMesh`. Member Functions ---------------- -+----------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_bottom_radius` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_height` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_radial_segments` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_rings` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_top_radius` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bottom_radius` **(** :ref:`float` radius **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_height` **(** :ref:`float` height **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_radial_segments` **(** :ref:`int` segments **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rings` **(** :ref:`int` rings **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_top_radius` **(** :ref:`float` radius **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------+ ++----------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_bottom_radius` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_height` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_radial_segments` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_rings` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_top_radius` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bottom_radius` **(** :ref:`float` radius **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_height` **(** :ref:`float` height **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_radial_segments` **(** :ref:`int` segments **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rings` **(** :ref:`int` rings **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_top_radius` **(** :ref:`float` radius **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -75,42 +75,42 @@ Member Function Description .. _class_CylinderMesh_get_bottom_radius: -- :ref:`float` **get_bottom_radius** **(** **)** const +- :ref:`float` **get_bottom_radius** **(** **)** const .. _class_CylinderMesh_get_height: -- :ref:`float` **get_height** **(** **)** const +- :ref:`float` **get_height** **(** **)** const .. _class_CylinderMesh_get_radial_segments: -- :ref:`int` **get_radial_segments** **(** **)** const +- :ref:`int` **get_radial_segments** **(** **)** const .. _class_CylinderMesh_get_rings: -- :ref:`int` **get_rings** **(** **)** const +- :ref:`int` **get_rings** **(** **)** const .. _class_CylinderMesh_get_top_radius: -- :ref:`float` **get_top_radius** **(** **)** const +- :ref:`float` **get_top_radius** **(** **)** const .. _class_CylinderMesh_set_bottom_radius: -- void **set_bottom_radius** **(** :ref:`float` radius **)** +- void **set_bottom_radius** **(** :ref:`float` radius **)** .. _class_CylinderMesh_set_height: -- void **set_height** **(** :ref:`float` height **)** +- void **set_height** **(** :ref:`float` height **)** .. _class_CylinderMesh_set_radial_segments: -- void **set_radial_segments** **(** :ref:`int` segments **)** +- void **set_radial_segments** **(** :ref:`int` segments **)** .. _class_CylinderMesh_set_rings: -- void **set_rings** **(** :ref:`int` rings **)** +- void **set_rings** **(** :ref:`int` rings **)** .. _class_CylinderMesh_set_top_radius: -- void **set_top_radius** **(** :ref:`float` radius **)** +- void **set_top_radius** **(** :ref:`float` radius **)** diff --git a/classes/class_dampedspringjoint2d.rst b/classes/class_dampedspringjoint2d.rst index bf5ea0c85..724fc3738 100644 --- a/classes/class_dampedspringjoint2d.rst +++ b/classes/class_dampedspringjoint2d.rst @@ -19,23 +19,23 @@ Damped spring constraint for 2D physics. Member Functions ---------------- -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_damping` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_length` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_rest_length` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_stiffness` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_damping` **(** :ref:`float` damping **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_length` **(** :ref:`float` length **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rest_length` **(** :ref:`float` rest_length **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_stiffness` **(** :ref:`float` stiffness **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ ++----------------------------+---------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_damping` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_length` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_rest_length` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_stiffness` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_damping` **(** :ref:`float` damping **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_length` **(** :ref:`float` length **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rest_length` **(** :ref:`float` rest_length **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_stiffness` **(** :ref:`float` stiffness **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -67,49 +67,49 @@ Member Function Description .. _class_DampedSpringJoint2D_get_damping: -- :ref:`float` **get_damping** **(** **)** const +- :ref:`float` **get_damping** **(** **)** const Return the damping ratio of the spring joint. A value of 0 indicates an undamped spring, while 1 causes the system to reach equilibrium as fast as possible (critical damping). .. _class_DampedSpringJoint2D_get_length: -- :ref:`float` **get_length** **(** **)** const +- :ref:`float` **get_length** **(** **)** const Return the maximum length of the spring joint. .. _class_DampedSpringJoint2D_get_rest_length: -- :ref:`float` **get_rest_length** **(** **)** const +- :ref:`float` **get_rest_length** **(** **)** const Return the resting length of the spring joint. The joint will always try to go to back this length when pulled apart. .. _class_DampedSpringJoint2D_get_stiffness: -- :ref:`float` **get_stiffness** **(** **)** const +- :ref:`float` **get_stiffness** **(** **)** const Return the stiffness of the spring joint. The joint applies a force equal to the stiffness times the distance from its resting length. .. _class_DampedSpringJoint2D_set_damping: -- void **set_damping** **(** :ref:`float` damping **)** +- void **set_damping** **(** :ref:`float` damping **)** Set the damping ratio of the spring joint. A value of 0 indicates an undamped spring, while 1 causes the system to reach equilibrium as fast as possible (critical damping). .. _class_DampedSpringJoint2D_set_length: -- void **set_length** **(** :ref:`float` length **)** +- void **set_length** **(** :ref:`float` length **)** Set the maximum length of the spring joint. .. _class_DampedSpringJoint2D_set_rest_length: -- void **set_rest_length** **(** :ref:`float` rest_length **)** +- void **set_rest_length** **(** :ref:`float` rest_length **)** Set the resting length of the spring joint. The joint will always try to go to back this length when pulled apart. .. _class_DampedSpringJoint2D_set_stiffness: -- void **set_stiffness** **(** :ref:`float` stiffness **)** +- void **set_stiffness** **(** :ref:`float` stiffness **)** Set the stiffness of the spring joint. The joint applies a force equal to the stiffness times the distance from its resting length. diff --git a/classes/class_dictionary.rst b/classes/class_dictionary.rst index d983019ce..c306c9e47 100644 --- a/classes/class_dictionary.rst +++ b/classes/class_dictionary.rst @@ -17,25 +17,25 @@ Dictionary type. Member Functions ---------------- -+----------------------------+---------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+----------------------------+---------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`empty` **(** **)** | -+----------------------------+---------------------------------------------------------------------------------------+ -| void | :ref:`erase` **(** var key **)** | -+----------------------------+---------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has` **(** var key **)** | -+----------------------------+---------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_all` **(** :ref:`Array` keys **)** | -+----------------------------+---------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`hash` **(** **)** | -+----------------------------+---------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`keys` **(** **)** | -+----------------------------+---------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` **(** **)** | -+----------------------------+---------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`values` **(** **)** | -+----------------------------+---------------------------------------------------------------------------------------+ ++----------------------------+-------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++----------------------------+-------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`empty` **(** **)** | ++----------------------------+-------------------------------------------------------------------------------------+ +| void | :ref:`erase` **(** var key **)** | ++----------------------------+-------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has` **(** var key **)** | ++----------------------------+-------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_all` **(** :ref:`Array` keys **)** | ++----------------------------+-------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`hash` **(** **)** | ++----------------------------+-------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`keys` **(** **)** | ++----------------------------+-------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` **(** **)** | ++----------------------------+-------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`values` **(** **)** | ++----------------------------+-------------------------------------------------------------------------------------+ Description ----------- @@ -47,55 +47,55 @@ Member Function Description .. _class_Dictionary_clear: -- void **clear** **(** **)** +- void **clear** **(** **)** Clear the dictionary, removing all key/value pairs. .. _class_Dictionary_empty: -- :ref:`bool` **empty** **(** **)** +- :ref:`bool` **empty** **(** **)** Return true if the dictionary is empty. .. _class_Dictionary_erase: -- void **erase** **(** var key **)** +- void **erase** **(** var key **)** Erase a dictionary key/value pair by key. .. _class_Dictionary_has: -- :ref:`bool` **has** **(** var key **)** +- :ref:`bool` **has** **(** var key **)** Return true if the dictionary has a given key. .. _class_Dictionary_has_all: -- :ref:`bool` **has_all** **(** :ref:`Array` keys **)** +- :ref:`bool` **has_all** **(** :ref:`Array` keys **)** Return true if the dictionary has all of the keys in the given array. .. _class_Dictionary_hash: -- :ref:`int` **hash** **(** **)** +- :ref:`int` **hash** **(** **)** Return a hashed integer value representing the dictionary contents. .. _class_Dictionary_keys: -- :ref:`Array` **keys** **(** **)** +- :ref:`Array` **keys** **(** **)** Return the list of keys in the :ref:`Dictionary`. .. _class_Dictionary_size: -- :ref:`int` **size** **(** **)** +- :ref:`int` **size** **(** **)** Return the size of the dictionary (in pairs). .. _class_Dictionary_values: -- :ref:`Array` **values** **(** **)** +- :ref:`Array` **values** **(** **)** Return the list of values in the :ref:`Dictionary`. diff --git a/classes/class_directionallight.rst b/classes/class_directionallight.rst index 5851deee8..3d00567e6 100644 --- a/classes/class_directionallight.rst +++ b/classes/class_directionallight.rst @@ -19,19 +19,19 @@ Directional Light, such as the Sun or the Moon. Member Functions ---------------- -+--------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_shadow_depth_range` **(** **)** const | -+--------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_shadow_mode` **(** **)** const | -+--------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_blend_splits_enabled` **(** **)** const | -+--------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_blend_splits` **(** :ref:`bool` enabled **)** | -+--------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shadow_depth_range` **(** :ref:`int` mode **)** | -+--------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shadow_mode` **(** :ref:`int` mode **)** | -+--------------------------+-----------------------------------------------------------------------------------------------------------------------+ ++--------------------------+---------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_shadow_depth_range` **(** **)** const | ++--------------------------+---------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_shadow_mode` **(** **)** const | ++--------------------------+---------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_blend_splits_enabled` **(** **)** const | ++--------------------------+---------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_blend_splits` **(** :ref:`bool` enabled **)** | ++--------------------------+---------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shadow_depth_range` **(** :ref:`int` mode **)** | ++--------------------------+---------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shadow_mode` **(** :ref:`int` mode **)** | ++--------------------------+---------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -92,26 +92,26 @@ Member Function Description .. _class_DirectionalLight_get_shadow_depth_range: -- :ref:`int` **get_shadow_depth_range** **(** **)** const +- :ref:`int` **get_shadow_depth_range** **(** **)** const .. _class_DirectionalLight_get_shadow_mode: -- :ref:`int` **get_shadow_mode** **(** **)** const +- :ref:`int` **get_shadow_mode** **(** **)** const .. _class_DirectionalLight_is_blend_splits_enabled: -- :ref:`bool` **is_blend_splits_enabled** **(** **)** const +- :ref:`bool` **is_blend_splits_enabled** **(** **)** const .. _class_DirectionalLight_set_blend_splits: -- void **set_blend_splits** **(** :ref:`bool` enabled **)** +- void **set_blend_splits** **(** :ref:`bool` enabled **)** .. _class_DirectionalLight_set_shadow_depth_range: -- void **set_shadow_depth_range** **(** :ref:`int` mode **)** +- void **set_shadow_depth_range** **(** :ref:`int` mode **)** .. _class_DirectionalLight_set_shadow_mode: -- void **set_shadow_mode** **(** :ref:`int` mode **)** +- void **set_shadow_mode** **(** :ref:`int` mode **)** diff --git a/classes/class_directory.rst b/classes/class_directory.rst index bc3a916b0..943b49ea9 100644 --- a/classes/class_directory.rst +++ b/classes/class_directory.rst @@ -19,43 +19,43 @@ Type used to handle the filesystem. Member Functions ---------------- -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`change_dir` **(** :ref:`String` todir **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`copy` **(** :ref:`String` from, :ref:`String` to **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`current_is_dir` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`dir_exists` **(** :ref:`String` path **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`file_exists` **(** :ref:`String` path **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_current_dir` **(** **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_current_drive` **(** **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_drive` **(** :ref:`int` idx **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_drive_count` **(** **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_next` **(** **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_space_left` **(** **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`list_dir_begin` **(** :ref:`bool` skip_navigational=false, :ref:`bool` skip_hidden=false **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`list_dir_end` **(** **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`make_dir` **(** :ref:`String` path **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`make_dir_recursive` **(** :ref:`String` path **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`open` **(** :ref:`String` path **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`remove` **(** :ref:`String` path **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rename` **(** :ref:`String` from, :ref:`String` to **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`change_dir` **(** :ref:`String` todir **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`copy` **(** :ref:`String` from, :ref:`String` to **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`current_is_dir` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`dir_exists` **(** :ref:`String` path **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`file_exists` **(** :ref:`String` path **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_current_dir` **(** **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_current_drive` **(** **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_drive` **(** :ref:`int` idx **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_drive_count` **(** **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_next` **(** **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_space_left` **(** **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`list_dir_begin` **(** :ref:`bool` skip_navigational=false, :ref:`bool` skip_hidden=false **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`list_dir_end` **(** **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`make_dir` **(** :ref:`String` path **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`make_dir_recursive` **(** :ref:`String` path **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`open` **(** :ref:`String` path **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`remove` **(** :ref:`String` path **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rename` **(** :ref:`String` from, :ref:`String` to **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -85,7 +85,7 @@ Member Function Description .. _class_Directory_change_dir: -- :ref:`int` **change_dir** **(** :ref:`String` todir **)** +- :ref:`int` **change_dir** **(** :ref:`String` todir **)** Change the currently opened directory to the one passed as an argument. The argument can be relative to the current directory (e.g. ``newdir`` or ``../newdir``), or an absolute path (e.g. ``/tmp/newdir`` or ``res://somedir/newdir``). @@ -93,7 +93,7 @@ The method returns one of the error code constants defined in :ref:`@Global Scop .. _class_Directory_copy: -- :ref:`int` **copy** **(** :ref:`String` from, :ref:`String` to **)** +- :ref:`int` **copy** **(** :ref:`String` from, :ref:`String` to **)** Copy the *from* file to the *to* destination. Both arguments should be paths to files, either relative or absolute. If the destination file exists and is not access-protected, it will be overwritten. @@ -101,49 +101,49 @@ Returns one of the error code constants defined in :ref:`@Global Scope` **current_is_dir** **(** **)** const +- :ref:`bool` **current_is_dir** **(** **)** const Return whether the current item processed with the last :ref:`get_next` call is a directory (``.`` and ``..`` are considered directories). .. _class_Directory_dir_exists: -- :ref:`bool` **dir_exists** **(** :ref:`String` path **)** +- :ref:`bool` **dir_exists** **(** :ref:`String` path **)** Return whether the target directory exists. The argument can be relative to the current directory, or an absolute path. .. _class_Directory_file_exists: -- :ref:`bool` **file_exists** **(** :ref:`String` path **)** +- :ref:`bool` **file_exists** **(** :ref:`String` path **)** Return whether the target file exists. The argument can be relative to the current directory, or an absolute path. .. _class_Directory_get_current_dir: -- :ref:`String` **get_current_dir** **(** **)** +- :ref:`String` **get_current_dir** **(** **)** Return the absolute path to the currently opened directory (e.g. ``res://folder`` or ``C:\tmp\folder``). .. _class_Directory_get_current_drive: -- :ref:`int` **get_current_drive** **(** **)** +- :ref:`int` **get_current_drive** **(** **)** Returns the currently opened directory's drive index. See :ref:`get_drive` to convert returned index to the name of the drive. .. _class_Directory_get_drive: -- :ref:`String` **get_drive** **(** :ref:`int` idx **)** +- :ref:`String` **get_drive** **(** :ref:`int` idx **)** On Windows, return the name of the drive (partition) passed as an argument (e.g. ``C:``). On other platforms, or if the requested drive does not existed, the method returns an empty String. .. _class_Directory_get_drive_count: -- :ref:`int` **get_drive_count** **(** **)** +- :ref:`int` **get_drive_count** **(** **)** On Windows, return the number of drives (partitions) mounted on the current filesystem. On other platforms, the method returns 0. .. _class_Directory_get_next: -- :ref:`String` **get_next** **(** **)** +- :ref:`String` **get_next** **(** **)** Return the next element (file or directory) in the current directory (including ``.`` and ``..``, unless ``skip_navigational`` was given to :ref:`list_dir_begin`). @@ -151,13 +151,13 @@ The name of the file or directory is returned (and not its full path). Once the .. _class_Directory_get_space_left: -- :ref:`int` **get_space_left** **(** **)** +- :ref:`int` **get_space_left** **(** **)** On Unix desktop systems, return the available space on the current directory's disk. On other platforms, this information is not available and the method returns 0 or -1. .. _class_Directory_list_dir_begin: -- :ref:`int` **list_dir_begin** **(** :ref:`bool` skip_navigational=false, :ref:`bool` skip_hidden=false **)** +- :ref:`int` **list_dir_begin** **(** :ref:`bool` skip_navigational=false, :ref:`bool` skip_hidden=false **)** Initialise the stream used to list all files and directories using the :ref:`get_next` function, closing the current opened stream if needed. Once the stream has been processed, it should typically be closed with :ref:`list_dir_end`. @@ -167,13 +167,13 @@ If you pass ``skip_hidden``, then hidden files would be filtered out. .. _class_Directory_list_dir_end: -- void **list_dir_end** **(** **)** +- void **list_dir_end** **(** **)** Close the current stream opened with :ref:`list_dir_begin` (whether it has been fully processed with :ref:`get_next` or not does not matter). .. _class_Directory_make_dir: -- :ref:`int` **make_dir** **(** :ref:`String` path **)** +- :ref:`int` **make_dir** **(** :ref:`String` path **)** Create a directory. The argument can be relative to the current directory, or an absolute path. The target directory should be placed in an already existing directory (to create the full path recursively, see :ref:`make_dir_recursive`). @@ -181,7 +181,7 @@ The method returns one of the error code constants defined in :ref:`@Global Scop .. _class_Directory_make_dir_recursive: -- :ref:`int` **make_dir_recursive** **(** :ref:`String` path **)** +- :ref:`int` **make_dir_recursive** **(** :ref:`String` path **)** Create a target directory and all necessary intermediate directories in its path, by calling :ref:`make_dir` recursively. The argument can be relative to the current directory, or an absolute path. @@ -189,7 +189,7 @@ Return one of the error code constants defined in :ref:`@Global Scope` **open** **(** :ref:`String` path **)** +- :ref:`int` **open** **(** :ref:`String` path **)** Open an existing directory of the filesystem. The *path* argument can be within the project tree (``res://folder``), the user directory (``user://folder``) or an absolute path of the user filesystem (e.g. ``/tmp/folder`` or ``C:\tmp\folder``). @@ -197,7 +197,7 @@ The method returns one of the error code constants defined in :ref:`@Global Scop .. _class_Directory_remove: -- :ref:`int` **remove** **(** :ref:`String` path **)** +- :ref:`int` **remove** **(** :ref:`String` path **)** Delete the target file or an empty directory. The argument can be relative to the current directory, or an absolute path. If the target directory is not empty, the operation will fail. @@ -205,7 +205,7 @@ Return one of the error code constants defined in :ref:`@Global Scope` **rename** **(** :ref:`String` from, :ref:`String` to **)** +- :ref:`int` **rename** **(** :ref:`String` from, :ref:`String` to **)** Rename (move) the *from* file to the *to* destination. Both arguments should be paths to files, either relative or absolute. If the destination file exists and is not access-protected, it will be overwritten. diff --git a/classes/class_dynamicfont.rst b/classes/class_dynamicfont.rst index 37a74cdc0..ec35dbab3 100644 --- a/classes/class_dynamicfont.rst +++ b/classes/class_dynamicfont.rst @@ -19,37 +19,37 @@ DynamicFont renders vector font files at runtime. Member Functions ---------------- -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_fallback` **(** :ref:`DynamicFontData` data **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`DynamicFontData` | :ref:`get_fallback` **(** :ref:`int` idx **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_fallback_count` **(** **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`DynamicFontData` | :ref:`get_font_data` **(** **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_size` **(** **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_spacing` **(** :ref:`int` type **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_use_filter` **(** **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_use_mipmaps` **(** **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_fallback` **(** :ref:`int` idx **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fallback` **(** :ref:`int` idx, :ref:`DynamicFontData` data **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_font_data` **(** :ref:`DynamicFontData` data **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_size` **(** :ref:`int` data **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_spacing` **(** :ref:`int` type, :ref:`int` value **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_filter` **(** :ref:`bool` enable **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_mipmaps` **(** :ref:`bool` enable **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_fallback` **(** :ref:`DynamicFontData` data **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`DynamicFontData` | :ref:`get_fallback` **(** :ref:`int` idx **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_fallback_count` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`DynamicFontData` | :ref:`get_font_data` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_size` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_spacing` **(** :ref:`int` type **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_use_filter` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_use_mipmaps` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_fallback` **(** :ref:`int` idx **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fallback` **(** :ref:`int` idx, :ref:`DynamicFontData` data **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_font_data` **(** :ref:`DynamicFontData` data **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_size` **(** :ref:`int` data **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_spacing` **(** :ref:`int` type, :ref:`int` value **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_filter` **(** :ref:`bool` enable **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_mipmaps` **(** :ref:`bool` enable **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -105,89 +105,89 @@ Member Function Description .. _class_DynamicFont_add_fallback: -- void **add_fallback** **(** :ref:`DynamicFontData` data **)** +- void **add_fallback** **(** :ref:`DynamicFontData` data **)** Adds a fallback font. .. _class_DynamicFont_get_fallback: -- :ref:`DynamicFontData` **get_fallback** **(** :ref:`int` idx **)** const +- :ref:`DynamicFontData` **get_fallback** **(** :ref:`int` idx **)** const Returns the fallback font at index ``idx``. .. _class_DynamicFont_get_fallback_count: -- :ref:`int` **get_fallback_count** **(** **)** const +- :ref:`int` **get_fallback_count** **(** **)** const Returns the number of fallback fonts. .. _class_DynamicFont_get_font_data: -- :ref:`DynamicFontData` **get_font_data** **(** **)** const +- :ref:`DynamicFontData` **get_font_data** **(** **)** const .. _class_DynamicFont_get_size: -- :ref:`int` **get_size** **(** **)** const +- :ref:`int` **get_size** **(** **)** const Returns the font size in pixels. .. _class_DynamicFont_get_spacing: -- :ref:`int` **get_spacing** **(** :ref:`int` type **)** const +- :ref:`int` **get_spacing** **(** :ref:`int` type **)** const Returns the given type of spacing in pixels. See ``SPACING\_\*`` constants. .. _class_DynamicFont_get_use_filter: -- :ref:`bool` **get_use_filter** **(** **)** const +- :ref:`bool` **get_use_filter** **(** **)** const Returns ``true`` if filtering is used. .. _class_DynamicFont_get_use_mipmaps: -- :ref:`bool` **get_use_mipmaps** **(** **)** const +- :ref:`bool` **get_use_mipmaps** **(** **)** const Returns ``true`` if mipmapping is used. .. _class_DynamicFont_remove_fallback: -- void **remove_fallback** **(** :ref:`int` idx **)** +- void **remove_fallback** **(** :ref:`int` idx **)** Removes the fallback font at index ``idx``. .. _class_DynamicFont_set_fallback: -- void **set_fallback** **(** :ref:`int` idx, :ref:`DynamicFontData` data **)** +- void **set_fallback** **(** :ref:`int` idx, :ref:`DynamicFontData` data **)** Sets the fallback font at index ``idx``. .. _class_DynamicFont_set_font_data: -- void **set_font_data** **(** :ref:`DynamicFontData` data **)** +- void **set_font_data** **(** :ref:`DynamicFontData` data **)** Sets the :ref:`DynamicFontData`. .. _class_DynamicFont_set_size: -- void **set_size** **(** :ref:`int` data **)** +- void **set_size** **(** :ref:`int` data **)** Sets the font size. .. _class_DynamicFont_set_spacing: -- void **set_spacing** **(** :ref:`int` type, :ref:`int` value **)** +- void **set_spacing** **(** :ref:`int` type, :ref:`int` value **)** Sets the spacing of the given type. See ``SPACING\_\*`` constants. .. _class_DynamicFont_set_use_filter: -- void **set_use_filter** **(** :ref:`bool` enable **)** +- void **set_use_filter** **(** :ref:`bool` enable **)** Set to ``true`` to use filtering. .. _class_DynamicFont_set_use_mipmaps: -- void **set_use_mipmaps** **(** :ref:`bool` enable **)** +- void **set_use_mipmaps** **(** :ref:`bool` enable **)** Set to ``true`` to use mipmapping. diff --git a/classes/class_dynamicfontdata.rst b/classes/class_dynamicfontdata.rst index eab0a5518..b586c76fa 100644 --- a/classes/class_dynamicfontdata.rst +++ b/classes/class_dynamicfontdata.rst @@ -19,11 +19,11 @@ Used with :ref:`DynamicFont` to describe the location of a fo Member Functions ---------------- -+------------------------------+----------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_font_path` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_font_path` **(** :ref:`String` path **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------+ ++------------------------------+--------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_font_path` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_font_path` **(** :ref:`String` path **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -43,13 +43,13 @@ Member Function Description .. _class_DynamicFontData_get_font_path: -- :ref:`String` **get_font_path** **(** **)** const +- :ref:`String` **get_font_path** **(** **)** const Returns the font path. .. _class_DynamicFontData_set_font_path: -- void **set_font_path** **(** :ref:`String` path **)** +- void **set_font_path** **(** :ref:`String` path **)** Sets the font path. diff --git a/classes/class_editorexportplugin.rst b/classes/class_editorexportplugin.rst index bb930910f..55d462fc8 100644 --- a/classes/class_editorexportplugin.rst +++ b/classes/class_editorexportplugin.rst @@ -19,39 +19,39 @@ Brief Description Member Functions ---------------- -+-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_export_begin` **(** :ref:`PoolStringArray` features **)** virtual | -+-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_export_file` **(** :ref:`String` path, :ref:`String` type, :ref:`PoolStringArray` features **)** virtual | -+-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_file` **(** :ref:`String` path, :ref:`PoolByteArray` file, :ref:`bool` remap **)** | -+-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_shared_object` **(** :ref:`String` path **)** | -+-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`skip` **(** **)** | -+-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_export_begin` **(** :ref:`PoolStringArray` features **)** virtual | ++-------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_export_file` **(** :ref:`String` path, :ref:`String` type, :ref:`PoolStringArray` features **)** virtual | ++-------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_file` **(** :ref:`String` path, :ref:`PoolByteArray` file, :ref:`bool` remap **)** | ++-------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_shared_object` **(** :ref:`String` path **)** | ++-------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`skip` **(** **)** | ++-------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Function Description --------------------------- .. _class_EditorExportPlugin__export_begin: -- void **_export_begin** **(** :ref:`PoolStringArray` features **)** virtual +- void **_export_begin** **(** :ref:`PoolStringArray` features **)** virtual .. _class_EditorExportPlugin__export_file: -- void **_export_file** **(** :ref:`String` path, :ref:`String` type, :ref:`PoolStringArray` features **)** virtual +- void **_export_file** **(** :ref:`String` path, :ref:`String` type, :ref:`PoolStringArray` features **)** virtual .. _class_EditorExportPlugin_add_file: -- void **add_file** **(** :ref:`String` path, :ref:`PoolByteArray` file, :ref:`bool` remap **)** +- void **add_file** **(** :ref:`String` path, :ref:`PoolByteArray` file, :ref:`bool` remap **)** .. _class_EditorExportPlugin_add_shared_object: -- void **add_shared_object** **(** :ref:`String` path **)** +- void **add_shared_object** **(** :ref:`String` path **)** .. _class_EditorExportPlugin_skip: -- void **skip** **(** **)** +- void **skip** **(** **)** diff --git a/classes/class_editorfiledialog.rst b/classes/class_editorfiledialog.rst index f0fcc818c..200fae3a9 100644 --- a/classes/class_editorfiledialog.rst +++ b/classes/class_editorfiledialog.rst @@ -19,62 +19,62 @@ Brief Description Member Functions ---------------- -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_filter` **(** :ref:`String` filter **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_filters` **(** **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_access` **(** **)** const | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_current_dir` **(** **)** const | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_current_file` **(** **)** const | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_current_path` **(** **)** const | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_display_mode` **(** **)** const | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_mode` **(** **)** const | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`VBoxContainer` | :ref:`get_vbox` **(** **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`invalidate` **(** **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_overwrite_warning_disabled` **(** **)** const | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_showing_hidden_files` **(** **)** const | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_access` **(** :ref:`int` access **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_current_dir` **(** :ref:`String` dir **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_current_file` **(** :ref:`String` file **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_current_path` **(** :ref:`String` path **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_disable_overwrite_warning` **(** :ref:`bool` disable **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_display_mode` **(** :ref:`int` mode **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mode` **(** :ref:`int` mode **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_show_hidden_files` **(** :ref:`bool` show **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_filter` **(** :ref:`String` filter **)** | ++--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_filters` **(** **)** | ++--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_access` **(** **)** const | ++--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_current_dir` **(** **)** const | ++--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_current_file` **(** **)** const | ++--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_current_path` **(** **)** const | ++--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_display_mode` **(** **)** const | ++--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_mode` **(** **)** const | ++--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`VBoxContainer` | :ref:`get_vbox` **(** **)** | ++--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`invalidate` **(** **)** | ++--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_overwrite_warning_disabled` **(** **)** const | ++--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_showing_hidden_files` **(** **)** const | ++--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_access` **(** :ref:`int` access **)** | ++--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_current_dir` **(** :ref:`String` dir **)** | ++--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_current_file` **(** :ref:`String` file **)** | ++--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_current_path` **(** :ref:`String` path **)** | ++--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_disable_overwrite_warning` **(** :ref:`bool` disable **)** | ++--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_display_mode` **(** :ref:`int` mode **)** | ++--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_mode` **(** :ref:`int` mode **)** | ++--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_show_hidden_files` **(** :ref:`bool` show **)** | ++--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_EditorFileDialog_dir_selected: -- **dir_selected** **(** :ref:`String` dir **)** +- **dir_selected** **(** :ref:`String` dir **)** .. _class_EditorFileDialog_file_selected: -- **file_selected** **(** :ref:`String` path **)** +- **file_selected** **(** :ref:`String` path **)** .. _class_EditorFileDialog_files_selected: -- **files_selected** **(** :ref:`PoolStringArray` paths **)** +- **files_selected** **(** :ref:`PoolStringArray` paths **)** Numeric Constants @@ -96,82 +96,82 @@ Member Function Description .. _class_EditorFileDialog_add_filter: -- void **add_filter** **(** :ref:`String` filter **)** +- void **add_filter** **(** :ref:`String` filter **)** .. _class_EditorFileDialog_clear_filters: -- void **clear_filters** **(** **)** +- void **clear_filters** **(** **)** .. _class_EditorFileDialog_get_access: -- :ref:`int` **get_access** **(** **)** const +- :ref:`int` **get_access** **(** **)** const .. _class_EditorFileDialog_get_current_dir: -- :ref:`String` **get_current_dir** **(** **)** const +- :ref:`String` **get_current_dir** **(** **)** const .. _class_EditorFileDialog_get_current_file: -- :ref:`String` **get_current_file** **(** **)** const +- :ref:`String` **get_current_file** **(** **)** const .. _class_EditorFileDialog_get_current_path: -- :ref:`String` **get_current_path** **(** **)** const +- :ref:`String` **get_current_path** **(** **)** const .. _class_EditorFileDialog_get_display_mode: -- :ref:`int` **get_display_mode** **(** **)** const +- :ref:`int` **get_display_mode** **(** **)** const .. _class_EditorFileDialog_get_mode: -- :ref:`int` **get_mode** **(** **)** const +- :ref:`int` **get_mode** **(** **)** const .. _class_EditorFileDialog_get_vbox: -- :ref:`VBoxContainer` **get_vbox** **(** **)** +- :ref:`VBoxContainer` **get_vbox** **(** **)** .. _class_EditorFileDialog_invalidate: -- void **invalidate** **(** **)** +- void **invalidate** **(** **)** .. _class_EditorFileDialog_is_overwrite_warning_disabled: -- :ref:`bool` **is_overwrite_warning_disabled** **(** **)** const +- :ref:`bool` **is_overwrite_warning_disabled** **(** **)** const .. _class_EditorFileDialog_is_showing_hidden_files: -- :ref:`bool` **is_showing_hidden_files** **(** **)** const +- :ref:`bool` **is_showing_hidden_files** **(** **)** const .. _class_EditorFileDialog_set_access: -- void **set_access** **(** :ref:`int` access **)** +- void **set_access** **(** :ref:`int` access **)** .. _class_EditorFileDialog_set_current_dir: -- void **set_current_dir** **(** :ref:`String` dir **)** +- void **set_current_dir** **(** :ref:`String` dir **)** .. _class_EditorFileDialog_set_current_file: -- void **set_current_file** **(** :ref:`String` file **)** +- void **set_current_file** **(** :ref:`String` file **)** .. _class_EditorFileDialog_set_current_path: -- void **set_current_path** **(** :ref:`String` path **)** +- void **set_current_path** **(** :ref:`String` path **)** .. _class_EditorFileDialog_set_disable_overwrite_warning: -- void **set_disable_overwrite_warning** **(** :ref:`bool` disable **)** +- void **set_disable_overwrite_warning** **(** :ref:`bool` disable **)** .. _class_EditorFileDialog_set_display_mode: -- void **set_display_mode** **(** :ref:`int` mode **)** +- void **set_display_mode** **(** :ref:`int` mode **)** .. _class_EditorFileDialog_set_mode: -- void **set_mode** **(** :ref:`int` mode **)** +- void **set_mode** **(** :ref:`int` mode **)** .. _class_EditorFileDialog_set_show_hidden_files: -- void **set_show_hidden_files** **(** :ref:`bool` show **)** +- void **set_show_hidden_files** **(** :ref:`bool` show **)** diff --git a/classes/class_editorfilesystem.rst b/classes/class_editorfilesystem.rst index d0a794cb2..e0a61febc 100644 --- a/classes/class_editorfilesystem.rst +++ b/classes/class_editorfilesystem.rst @@ -19,40 +19,40 @@ Resource filesystem, as the editor sees it. Member Functions ---------------- -+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_file_type` **(** :ref:`String` path **)** const | -+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`EditorFileSystemDirectory` | :ref:`get_filesystem` **(** **)** | -+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`EditorFileSystemDirectory` | :ref:`get_filesystem_path` **(** :ref:`String` path **)** | -+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_scanning_progress` **(** **)** const | -+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_scanning` **(** **)** const | -+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`scan` **(** **)** | -+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`scan_sources` **(** **)** | -+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`update_file` **(** :ref:`String` path **)** | -+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_file_type` **(** :ref:`String` path **)** const | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ +| :ref:`EditorFileSystemDirectory` | :ref:`get_filesystem` **(** **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ +| :ref:`EditorFileSystemDirectory` | :ref:`get_filesystem_path` **(** :ref:`String` path **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_scanning_progress` **(** **)** const | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_scanning` **(** **)** const | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`scan` **(** **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`scan_sources` **(** **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`update_file` **(** :ref:`String` path **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_EditorFileSystem_filesystem_changed: -- **filesystem_changed** **(** **)** +- **filesystem_changed** **(** **)** Emitted if the filesystem changed. .. _class_EditorFileSystem_resources_reimported: -- **resources_reimported** **(** :ref:`PoolStringArray` resources **)** +- **resources_reimported** **(** :ref:`PoolStringArray` resources **)** .. _class_EditorFileSystem_sources_changed: -- **sources_changed** **(** :ref:`bool` exist **)** +- **sources_changed** **(** :ref:`bool` exist **)** Emitted if the source of any imported file changed. @@ -67,47 +67,47 @@ Member Function Description .. _class_EditorFileSystem_get_file_type: -- :ref:`String` **get_file_type** **(** :ref:`String` path **)** const +- :ref:`String` **get_file_type** **(** :ref:`String` path **)** const Get the type of the file, given the full path. .. _class_EditorFileSystem_get_filesystem: -- :ref:`EditorFileSystemDirectory` **get_filesystem** **(** **)** +- :ref:`EditorFileSystemDirectory` **get_filesystem** **(** **)** Get the root directory object. .. _class_EditorFileSystem_get_filesystem_path: -- :ref:`EditorFileSystemDirectory` **get_filesystem_path** **(** :ref:`String` path **)** +- :ref:`EditorFileSystemDirectory` **get_filesystem_path** **(** :ref:`String` path **)** .. _class_EditorFileSystem_get_scanning_progress: -- :ref:`float` **get_scanning_progress** **(** **)** const +- :ref:`float` **get_scanning_progress** **(** **)** const Return the scan progress for 0 to 1 if the FS is being scanned. .. _class_EditorFileSystem_is_scanning: -- :ref:`bool` **is_scanning** **(** **)** const +- :ref:`bool` **is_scanning** **(** **)** const Return true of the filesystem is being scanned. .. _class_EditorFileSystem_scan: -- void **scan** **(** **)** +- void **scan** **(** **)** Scan the filesystem for changes. .. _class_EditorFileSystem_scan_sources: -- void **scan_sources** **(** **)** +- void **scan_sources** **(** **)** Check if the source of any imported resource changed. .. _class_EditorFileSystem_update_file: -- void **update_file** **(** :ref:`String` path **)** +- void **update_file** **(** :ref:`String` path **)** Update a file information. Call this if an external program (not Godot) modified the file. diff --git a/classes/class_editorfilesystemdirectory.rst b/classes/class_editorfilesystemdirectory.rst index 68d191144..c9c514167 100644 --- a/classes/class_editorfilesystemdirectory.rst +++ b/classes/class_editorfilesystemdirectory.rst @@ -19,81 +19,81 @@ A diretory for the resource filesystem. Member Functions ---------------- -+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_dir_index` **(** :ref:`String` name **)** const | -+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_file_index` **(** :ref:`String` name **)** const | -+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_file` **(** :ref:`int` idx **)** const | -+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_file_count` **(** **)** const | -+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_file_import_is_valid` **(** :ref:`int` idx **)** const | -+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_file_path` **(** :ref:`int` idx **)** const | -+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_file_type` **(** :ref:`int` idx **)** const | -+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_name` **(** **)** | -+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`EditorFileSystemDirectory` | :ref:`get_parent` **(** **)** | -+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_path` **(** **)** const | -+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`EditorFileSystemDirectory` | :ref:`get_subdir` **(** :ref:`int` idx **)** | -+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_subdir_count` **(** **)** const | -+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find_dir_index` **(** :ref:`String` name **)** const | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find_file_index` **(** :ref:`String` name **)** const | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_file` **(** :ref:`int` idx **)** const | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_file_count` **(** **)** const | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_file_import_is_valid` **(** :ref:`int` idx **)** const | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_file_path` **(** :ref:`int` idx **)** const | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_file_type` **(** :ref:`int` idx **)** const | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_name` **(** **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`EditorFileSystemDirectory` | :ref:`get_parent` **(** **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_path` **(** **)** const | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`EditorFileSystemDirectory` | :ref:`get_subdir` **(** :ref:`int` idx **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_subdir_count` **(** **)** const | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ Member Function Description --------------------------- .. _class_EditorFileSystemDirectory_find_dir_index: -- :ref:`int` **find_dir_index** **(** :ref:`String` name **)** const +- :ref:`int` **find_dir_index** **(** :ref:`String` name **)** const .. _class_EditorFileSystemDirectory_find_file_index: -- :ref:`int` **find_file_index** **(** :ref:`String` name **)** const +- :ref:`int` **find_file_index** **(** :ref:`String` name **)** const .. _class_EditorFileSystemDirectory_get_file: -- :ref:`String` **get_file** **(** :ref:`int` idx **)** const +- :ref:`String` **get_file** **(** :ref:`int` idx **)** const .. _class_EditorFileSystemDirectory_get_file_count: -- :ref:`int` **get_file_count** **(** **)** const +- :ref:`int` **get_file_count** **(** **)** const .. _class_EditorFileSystemDirectory_get_file_import_is_valid: -- :ref:`bool` **get_file_import_is_valid** **(** :ref:`int` idx **)** const +- :ref:`bool` **get_file_import_is_valid** **(** :ref:`int` idx **)** const .. _class_EditorFileSystemDirectory_get_file_path: -- :ref:`String` **get_file_path** **(** :ref:`int` idx **)** const +- :ref:`String` **get_file_path** **(** :ref:`int` idx **)** const .. _class_EditorFileSystemDirectory_get_file_type: -- :ref:`String` **get_file_type** **(** :ref:`int` idx **)** const +- :ref:`String` **get_file_type** **(** :ref:`int` idx **)** const .. _class_EditorFileSystemDirectory_get_name: -- :ref:`String` **get_name** **(** **)** +- :ref:`String` **get_name** **(** **)** .. _class_EditorFileSystemDirectory_get_parent: -- :ref:`EditorFileSystemDirectory` **get_parent** **(** **)** +- :ref:`EditorFileSystemDirectory` **get_parent** **(** **)** .. _class_EditorFileSystemDirectory_get_path: -- :ref:`String` **get_path** **(** **)** const +- :ref:`String` **get_path** **(** **)** const .. _class_EditorFileSystemDirectory_get_subdir: -- :ref:`EditorFileSystemDirectory` **get_subdir** **(** :ref:`int` idx **)** +- :ref:`EditorFileSystemDirectory` **get_subdir** **(** :ref:`int` idx **)** .. _class_EditorFileSystemDirectory_get_subdir_count: -- :ref:`int` **get_subdir_count** **(** **)** const +- :ref:`int` **get_subdir_count** **(** **)** const diff --git a/classes/class_editorimportplugin.rst b/classes/class_editorimportplugin.rst index 320ec65f0..68a56362a 100644 --- a/classes/class_editorimportplugin.rst +++ b/classes/class_editorimportplugin.rst @@ -19,27 +19,27 @@ Registers a custom resource importer in the editor. Use the class to parse any f Member Functions ---------------- -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_import_options` **(** :ref:`int` preset **)** virtual | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_importer_name` **(** **)** virtual | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_option_visibility` **(** :ref:`String` option, :ref:`Dictionary` options **)** virtual | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_preset_count` **(** **)** virtual | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_preset_name` **(** :ref:`int` preset **)** virtual | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_recognized_extensions` **(** **)** virtual | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_resource_type` **(** **)** virtual | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_save_extension` **(** **)** virtual | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_visible_name` **(** **)** virtual | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`import` **(** :ref:`String` source_file, :ref:`String` save_path, :ref:`Dictionary` options, :ref:`Array` r_platform_variants, :ref:`Array` r_gen_files **)** virtual | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_import_options` **(** :ref:`int` preset **)** virtual | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_importer_name` **(** **)** virtual | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_option_visibility` **(** :ref:`String` option, :ref:`Dictionary` options **)** virtual | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_preset_count` **(** **)** virtual | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_preset_name` **(** :ref:`int` preset **)** virtual | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_recognized_extensions` **(** **)** virtual | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_resource_type` **(** **)** virtual | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_save_extension` **(** **)** virtual | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_visible_name` **(** **)** virtual | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`import` **(** :ref:`String` source_file, :ref:`String` save_path, :ref:`Dictionary` options, :ref:`Array` r_platform_variants, :ref:`Array` r_gen_files **)** virtual | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -101,58 +101,58 @@ Member Function Description .. _class_EditorImportPlugin_get_import_options: -- :ref:`Array` **get_import_options** **(** :ref:`int` preset **)** virtual +- :ref:`Array` **get_import_options** **(** :ref:`int` preset **)** virtual Get the options and default values for the preset at this index. Returns an Array of Dictionaries with the following keys: "name", "default_value", "property_hint" (optional), "hint_string" (optional), "usage" (optional). .. _class_EditorImportPlugin_get_importer_name: -- :ref:`String` **get_importer_name** **(** **)** virtual +- :ref:`String` **get_importer_name** **(** **)** virtual Get the unique name of the importer. .. _class_EditorImportPlugin_get_option_visibility: -- :ref:`bool` **get_option_visibility** **(** :ref:`String` option, :ref:`Dictionary` options **)** virtual +- :ref:`bool` **get_option_visibility** **(** :ref:`String` option, :ref:`Dictionary` options **)** virtual .. _class_EditorImportPlugin_get_preset_count: -- :ref:`int` **get_preset_count** **(** **)** virtual +- :ref:`int` **get_preset_count** **(** **)** virtual Get the number of initial presets defined by the plugin. Use :ref:`get_import_options` to get the default options for the preset and :ref:`get_preset_name` to get the name of the preset. .. _class_EditorImportPlugin_get_preset_name: -- :ref:`String` **get_preset_name** **(** :ref:`int` preset **)** virtual +- :ref:`String` **get_preset_name** **(** :ref:`int` preset **)** virtual Get the name of the options preset at this index. .. _class_EditorImportPlugin_get_recognized_extensions: -- :ref:`Array` **get_recognized_extensions** **(** **)** virtual +- :ref:`Array` **get_recognized_extensions** **(** **)** virtual Get the list of file extensions to associate with this loader (case insensitive). e.g. "obj". .. _class_EditorImportPlugin_get_resource_type: -- :ref:`String` **get_resource_type** **(** **)** virtual +- :ref:`String` **get_resource_type** **(** **)** virtual Get the godot resource type associated with this loader. e.g. "Mesh" or "Animation". .. _class_EditorImportPlugin_get_save_extension: -- :ref:`String` **get_save_extension** **(** **)** virtual +- :ref:`String` **get_save_extension** **(** **)** virtual Get the extension used to save this resource in the ``.import`` directory. .. _class_EditorImportPlugin_get_visible_name: -- :ref:`String` **get_visible_name** **(** **)** virtual +- :ref:`String` **get_visible_name** **(** **)** virtual Get the name to display in the import window. .. _class_EditorImportPlugin_import: -- :ref:`int` **import** **(** :ref:`String` source_file, :ref:`String` save_path, :ref:`Dictionary` options, :ref:`Array` r_platform_variants, :ref:`Array` r_gen_files **)** virtual +- :ref:`int` **import** **(** :ref:`String` source_file, :ref:`String` save_path, :ref:`Dictionary` options, :ref:`Array` r_platform_variants, :ref:`Array` r_gen_files **)** virtual diff --git a/classes/class_editorinterface.rst b/classes/class_editorinterface.rst index ff4188c23..99a7ae9e1 100644 --- a/classes/class_editorinterface.rst +++ b/classes/class_editorinterface.rst @@ -19,39 +19,39 @@ Editor interface and main components. Member Functions ---------------- -+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`edit_resource` **(** :ref:`Resource` resource **)** | -+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Control` | :ref:`get_base_control` **(** **)** | -+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_edited_scene_root` **(** **)** | -+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`EditorSettings` | :ref:`get_editor_settings` **(** **)** | -+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Control` | :ref:`get_editor_viewport` **(** **)** | -+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_open_scenes` **(** **)** const | -+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`EditorFileSystem` | :ref:`get_resource_filesystem` **(** **)** | -+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`EditorResourcePreview` | :ref:`get_resource_previewer` **(** **)** | -+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ScriptEditor` | :ref:`get_script_editor` **(** **)** | -+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`EditorSelection` | :ref:`get_selection` **(** **)** | -+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`inspect_object` **(** :ref:`Object` object, :ref:`String` for_property="" **)** | -+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`make_mesh_previews` **(** :ref:`Array` meshes, :ref:`int` preview_size **)** | -+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`open_scene_from_path` **(** :ref:`String` scene_filepath **)** | -+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reload_scene_from_path` **(** :ref:`String` scene_filepath **)** | -+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`save_scene` **(** **)** | -+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`save_scene_as` **(** :ref:`String` path, :ref:`bool` with_preview=true **)** | -+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`edit_resource` **(** :ref:`Resource` resource **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Control` | :ref:`get_base_control` **(** **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`get_edited_scene_root` **(** **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`EditorSettings` | :ref:`get_editor_settings` **(** **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Control` | :ref:`get_editor_viewport` **(** **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_open_scenes` **(** **)** const | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`EditorFileSystem` | :ref:`get_resource_filesystem` **(** **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`EditorResourcePreview` | :ref:`get_resource_previewer` **(** **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ScriptEditor` | :ref:`get_script_editor` **(** **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`EditorSelection` | :ref:`get_selection` **(** **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`inspect_object` **(** :ref:`Object` object, :ref:`String` for_property="" **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`make_mesh_previews` **(** :ref:`Array` meshes, :ref:`int` preview_size **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`open_scene_from_path` **(** :ref:`String` scene_filepath **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reload_scene_from_path` **(** :ref:`String` scene_filepath **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`save_scene` **(** **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`save_scene_as` **(** :ref:`String` path, :ref:`bool` with_preview=true **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -63,97 +63,97 @@ Member Function Description .. _class_EditorInterface_edit_resource: -- void **edit_resource** **(** :ref:`Resource` resource **)** +- void **edit_resource** **(** :ref:`Resource` resource **)** Edits the given :ref:`Resource`. .. _class_EditorInterface_get_base_control: -- :ref:`Control` **get_base_control** **(** **)** +- :ref:`Control` **get_base_control** **(** **)** Returns the base :ref:`Control`. .. _class_EditorInterface_get_edited_scene_root: -- :ref:`Node` **get_edited_scene_root** **(** **)** +- :ref:`Node` **get_edited_scene_root** **(** **)** Returns the edited scene's root :ref:`Node`. .. _class_EditorInterface_get_editor_settings: -- :ref:`EditorSettings` **get_editor_settings** **(** **)** +- :ref:`EditorSettings` **get_editor_settings** **(** **)** Returns the :ref:`EditorSettings`. .. _class_EditorInterface_get_editor_viewport: -- :ref:`Control` **get_editor_viewport** **(** **)** +- :ref:`Control` **get_editor_viewport** **(** **)** Returns the editor :ref:`Viewport`. .. _class_EditorInterface_get_open_scenes: -- :ref:`Array` **get_open_scenes** **(** **)** const +- :ref:`Array` **get_open_scenes** **(** **)** const Returns an :ref:`Array` of the currently opened scenes. .. _class_EditorInterface_get_resource_filesystem: -- :ref:`EditorFileSystem` **get_resource_filesystem** **(** **)** +- :ref:`EditorFileSystem` **get_resource_filesystem** **(** **)** Returns the :ref:`EditorFileSystem`. .. _class_EditorInterface_get_resource_previewer: -- :ref:`EditorResourcePreview` **get_resource_previewer** **(** **)** +- :ref:`EditorResourcePreview` **get_resource_previewer** **(** **)** Returns the :ref:`EditorResourcePreview`\ er. .. _class_EditorInterface_get_script_editor: -- :ref:`ScriptEditor` **get_script_editor** **(** **)** +- :ref:`ScriptEditor` **get_script_editor** **(** **)** Returns the :ref:`ScriptEditor`. .. _class_EditorInterface_get_selection: -- :ref:`EditorSelection` **get_selection** **(** **)** +- :ref:`EditorSelection` **get_selection** **(** **)** Returns the :ref:`EditorSelection`. .. _class_EditorInterface_inspect_object: -- void **inspect_object** **(** :ref:`Object` object, :ref:`String` for_property="" **)** +- void **inspect_object** **(** :ref:`Object` object, :ref:`String` for_property="" **)** Shows the given property on the given ``object`` in the Editor's Inspector dock. .. _class_EditorInterface_make_mesh_previews: -- :ref:`Array` **make_mesh_previews** **(** :ref:`Array` meshes, :ref:`int` preview_size **)** +- :ref:`Array` **make_mesh_previews** **(** :ref:`Array` meshes, :ref:`int` preview_size **)** Returns mesh previews rendered at the given size as an :ref:`Array` of :ref:`Texture`\ s. .. _class_EditorInterface_open_scene_from_path: -- void **open_scene_from_path** **(** :ref:`String` scene_filepath **)** +- void **open_scene_from_path** **(** :ref:`String` scene_filepath **)** Opens the scene at the given path. .. _class_EditorInterface_reload_scene_from_path: -- void **reload_scene_from_path** **(** :ref:`String` scene_filepath **)** +- void **reload_scene_from_path** **(** :ref:`String` scene_filepath **)** Reloads the scene at the given path. .. _class_EditorInterface_save_scene: -- :ref:`int` **save_scene** **(** **)** +- :ref:`int` **save_scene** **(** **)** Saves the scene. Returns either OK or ERR_CANT_CREATE. See :ref:`@Global Scope` constants. .. _class_EditorInterface_save_scene_as: -- void **save_scene_as** **(** :ref:`String` path, :ref:`bool` with_preview=true **)** +- void **save_scene_as** **(** :ref:`String` path, :ref:`bool` with_preview=true **)** Saves the scene as a file at ``path``. diff --git a/classes/class_editorplugin.rst b/classes/class_editorplugin.rst index c34b08ee3..ce26ed602 100644 --- a/classes/class_editorplugin.rst +++ b/classes/class_editorplugin.rst @@ -19,98 +19,98 @@ Used by the editor to extend its functionality. Member Functions ---------------- -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ToolButton` | :ref:`add_control_to_bottom_panel` **(** :ref:`Control` control, :ref:`String` title **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_control_to_container` **(** :ref:`int` container, :ref:`Control` control **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_control_to_dock` **(** :ref:`int` slot, :ref:`Control` control **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_custom_type` **(** :ref:`String` type, :ref:`String` base, :ref:`Script` script, :ref:`Texture` icon **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_export_plugin` **(** :ref:`EditorExportPlugin` exporter **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_import_plugin` **(** :ref:`EditorImportPlugin` importer **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_tool_submenu_item` **(** :ref:`String` name, :ref:`Object` submenu **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`apply_changes` **(** **)** virtual | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** virtual | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`EditorSpatialGizmo` | :ref:`create_spatial_gizmo` **(** :ref:`Spatial` for_spatial **)** virtual | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`edit` **(** :ref:`Object` object **)** virtual | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`forward_canvas_gui_input` **(** :ref:`Transform2D` canvas_xform, :ref:`InputEvent` event **)** virtual | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`forward_draw_over_canvas` **(** :ref:`Transform2D` canvas_xform, :ref:`Control` canvas **)** virtual | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`forward_spatial_gui_input` **(** :ref:`Camera` camera, :ref:`InputEvent` event **)** virtual | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_breakpoints` **(** **)** virtual | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`EditorInterface` | :ref:`get_editor_interface` **(** **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_plugin_name` **(** **)** virtual | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_state` **(** **)** virtual | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`UndoRedo` | :ref:`get_undo_redo` **(** **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`get_window_layout` **(** :ref:`ConfigFile` layout **)** virtual | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`handles` **(** :ref:`Object` object **)** virtual | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_main_screen` **(** **)** virtual | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`hide_bottom_panel` **(** **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`make_bottom_panel_item_visible` **(** :ref:`Control` item **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`make_visible` **(** :ref:`bool` visible **)** virtual | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`queue_save_layout` **(** **)** const | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_control_from_bottom_panel` **(** :ref:`Control` control **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_control_from_docks` **(** :ref:`Control` control **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_custom_type` **(** :ref:`String` type **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_export_plugin` **(** :ref:`EditorExportPlugin` exporter **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_import_plugin` **(** :ref:`EditorImportPlugin` importer **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`save_external_data` **(** **)** virtual | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_input_event_forwarding_always_enabled` **(** **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_state` **(** :ref:`Dictionary` state **)** virtual | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_window_layout` **(** :ref:`ConfigFile` layout **)** virtual | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`update_canvas` **(** **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ToolButton` | :ref:`add_control_to_bottom_panel` **(** :ref:`Control` control, :ref:`String` title **)** | ++------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_control_to_container` **(** :ref:`int` container, :ref:`Control` control **)** | ++------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_control_to_dock` **(** :ref:`int` slot, :ref:`Control` control **)** | ++------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_custom_type` **(** :ref:`String` type, :ref:`String` base, :ref:`Script` script, :ref:`Texture` icon **)** | ++------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_export_plugin` **(** :ref:`EditorExportPlugin` exporter **)** | ++------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_import_plugin` **(** :ref:`EditorImportPlugin` importer **)** | ++------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_tool_submenu_item` **(** :ref:`String` name, :ref:`Object` submenu **)** | ++------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`apply_changes` **(** **)** virtual | ++------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** virtual | ++------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`EditorSpatialGizmo` | :ref:`create_spatial_gizmo` **(** :ref:`Spatial` for_spatial **)** virtual | ++------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`edit` **(** :ref:`Object` object **)** virtual | ++------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`forward_canvas_gui_input` **(** :ref:`Transform2D` canvas_xform, :ref:`InputEvent` event **)** virtual | ++------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`forward_draw_over_canvas` **(** :ref:`Transform2D` canvas_xform, :ref:`Control` canvas **)** virtual | ++------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`forward_spatial_gui_input` **(** :ref:`Camera` camera, :ref:`InputEvent` event **)** virtual | ++------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_breakpoints` **(** **)** virtual | ++------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`EditorInterface` | :ref:`get_editor_interface` **(** **)** | ++------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_plugin_name` **(** **)** virtual | ++------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_state` **(** **)** virtual | ++------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`UndoRedo` | :ref:`get_undo_redo` **(** **)** | ++------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`get_window_layout` **(** :ref:`ConfigFile` layout **)** virtual | ++------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`handles` **(** :ref:`Object` object **)** virtual | ++------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_main_screen` **(** **)** virtual | ++------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`hide_bottom_panel` **(** **)** | ++------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`make_bottom_panel_item_visible` **(** :ref:`Control` item **)** | ++------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`make_visible` **(** :ref:`bool` visible **)** virtual | ++------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`queue_save_layout` **(** **)** const | ++------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_control_from_bottom_panel` **(** :ref:`Control` control **)** | ++------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_control_from_docks` **(** :ref:`Control` control **)** | ++------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_custom_type` **(** :ref:`String` type **)** | ++------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_export_plugin` **(** :ref:`EditorExportPlugin` exporter **)** | ++------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_import_plugin` **(** :ref:`EditorImportPlugin` importer **)** | ++------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`save_external_data` **(** **)** virtual | ++------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_input_event_forwarding_always_enabled` **(** **)** | ++------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_state` **(** :ref:`Dictionary` state **)** virtual | ++------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_window_layout` **(** :ref:`ConfigFile` layout **)** virtual | ++------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`update_canvas` **(** **)** | ++------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_EditorPlugin_main_screen_changed: -- **main_screen_changed** **(** :ref:`String` screen_name **)** +- **main_screen_changed** **(** :ref:`String` screen_name **)** Emitted when user change main screen view (2D, 3D, Script, AssetLib). Works also with screens which are defined by plugins. .. _class_EditorPlugin_scene_changed: -- **scene_changed** **(** :ref:`Object` scene_root **)** +- **scene_changed** **(** :ref:`Object` scene_root **)** Emitted when user change scene. The argument is a root node of freshly opened scene. .. _class_EditorPlugin_scene_closed: -- **scene_closed** **(** :ref:`String` filepath **)** +- **scene_closed** **(** :ref:`String` filepath **)** Emitted when user close scene. The argument is file path to a closed scene. @@ -145,13 +145,13 @@ Member Function Description .. _class_EditorPlugin_add_control_to_bottom_panel: -- :ref:`ToolButton` **add_control_to_bottom_panel** **(** :ref:`Control` control, :ref:`String` title **)** +- :ref:`ToolButton` **add_control_to_bottom_panel** **(** :ref:`Control` control, :ref:`String` title **)** Add a control to the bottom panel (together with Output, Debug, Animation, etc). Returns a reference to the button added. It's up to you to hide/show the button when needed. If your plugin is being removed, also make sure to remove your control by calling :ref:`remove_control_from_bottom_panel`. .. _class_EditorPlugin_add_control_to_container: -- void **add_control_to_container** **(** :ref:`int` container, :ref:`Control` control **)** +- void **add_control_to_container** **(** :ref:`int` container, :ref:`Control` control **)** Add a custom control to a container (see CONTAINER\_\* enum). There are many locations where custom controls can be added in the editor UI. @@ -161,7 +161,7 @@ If your plugin is being removed, also make sure to remove your custom controls t .. _class_EditorPlugin_add_control_to_dock: -- void **add_control_to_dock** **(** :ref:`int` slot, :ref:`Control` control **)** +- void **add_control_to_dock** **(** :ref:`int` slot, :ref:`Control` control **)** Add the control to a specific dock slot (see DOCK\_\* enum for options). @@ -171,7 +171,7 @@ If your plugin is being removed, also make sure to remove your control by callin .. _class_EditorPlugin_add_custom_type: -- void **add_custom_type** **(** :ref:`String` type, :ref:`String` base, :ref:`Script` script, :ref:`Texture` icon **)** +- void **add_custom_type** **(** :ref:`String` type, :ref:`String` base, :ref:`Script` script, :ref:`Texture` icon **)** Add a custom type, which will appear in the list of nodes or resources. An icon can be optionally passed. @@ -183,19 +183,19 @@ During run-time, this will be a simple object with a script so this function doe .. _class_EditorPlugin_add_export_plugin: -- void **add_export_plugin** **(** :ref:`EditorExportPlugin` exporter **)** +- void **add_export_plugin** **(** :ref:`EditorExportPlugin` exporter **)** .. _class_EditorPlugin_add_import_plugin: -- void **add_import_plugin** **(** :ref:`EditorImportPlugin` importer **)** +- void **add_import_plugin** **(** :ref:`EditorImportPlugin` importer **)** .. _class_EditorPlugin_add_tool_submenu_item: -- void **add_tool_submenu_item** **(** :ref:`String` name, :ref:`Object` submenu **)** +- void **add_tool_submenu_item** **(** :ref:`String` name, :ref:`Object` submenu **)** .. _class_EditorPlugin_apply_changes: -- void **apply_changes** **(** **)** virtual +- void **apply_changes** **(** **)** virtual This method is called when the editor is about to save the project, switch to another tab, etc. It asks the plugin to apply any pending state changes to ensure consistency. @@ -203,35 +203,35 @@ This is used, for example, in shader editors to let the plugin know that it must .. _class_EditorPlugin_clear: -- void **clear** **(** **)** virtual +- void **clear** **(** **)** virtual Clear all the state and reset the object being edited to zero. This ensures your plugin does not keep editing a currently existing node, or a node from the wrong scene. .. _class_EditorPlugin_create_spatial_gizmo: -- :ref:`EditorSpatialGizmo` **create_spatial_gizmo** **(** :ref:`Spatial` for_spatial **)** virtual +- :ref:`EditorSpatialGizmo` **create_spatial_gizmo** **(** :ref:`Spatial` for_spatial **)** virtual This is used for plugins that create gizmos used by the spatial editor. Just check that the node passed in the "for_spatial" argument matches your plugin. .. _class_EditorPlugin_edit: -- void **edit** **(** :ref:`Object` object **)** virtual +- void **edit** **(** :ref:`Object` object **)** virtual This function is used for plugins that edit specific object types (nodes or resources). It requests the editor to edit the given object. .. _class_EditorPlugin_forward_canvas_gui_input: -- :ref:`bool` **forward_canvas_gui_input** **(** :ref:`Transform2D` canvas_xform, :ref:`InputEvent` event **)** virtual +- :ref:`bool` **forward_canvas_gui_input** **(** :ref:`Transform2D` canvas_xform, :ref:`InputEvent` event **)** virtual .. _class_EditorPlugin_forward_draw_over_canvas: -- void **forward_draw_over_canvas** **(** :ref:`Transform2D` canvas_xform, :ref:`Control` canvas **)** virtual +- void **forward_draw_over_canvas** **(** :ref:`Transform2D` canvas_xform, :ref:`Control` canvas **)** virtual This function is called every time the 2D canvas editor draws (which overlays over the edited scene). Drawing over the supplied control will draw over the edited scene. To convert from control coordinates to edited scene coordinates (including zoom and offset), a transform is also provided. If you require this control to be redraw, call :ref:`update_canvas`. .. _class_EditorPlugin_forward_spatial_gui_input: -- :ref:`bool` **forward_spatial_gui_input** **(** :ref:`Camera` camera, :ref:`InputEvent` event **)** virtual +- :ref:`bool` **forward_spatial_gui_input** **(** :ref:`Camera` camera, :ref:`InputEvent` event **)** virtual Implement this function if you are interested in 3D view screen input events. It will be called only if currently selected node is handled by your plugin. @@ -239,59 +239,59 @@ If you would like to always gets those input events then additionally use :ref:` .. _class_EditorPlugin_get_breakpoints: -- :ref:`PoolStringArray` **get_breakpoints** **(** **)** virtual +- :ref:`PoolStringArray` **get_breakpoints** **(** **)** virtual This is for editors that edit script based objects. You can return a list of breakpoints in the format (script:line), for example: res://path_to_script.gd:25 .. _class_EditorPlugin_get_editor_interface: -- :ref:`EditorInterface` **get_editor_interface** **(** **)** +- :ref:`EditorInterface` **get_editor_interface** **(** **)** .. _class_EditorPlugin_get_plugin_name: -- :ref:`String` **get_plugin_name** **(** **)** virtual +- :ref:`String` **get_plugin_name** **(** **)** virtual .. _class_EditorPlugin_get_state: -- :ref:`Dictionary` **get_state** **(** **)** virtual +- :ref:`Dictionary` **get_state** **(** **)** virtual Get the state of your plugin editor. This is used when saving the scene (so state is kept when opening it again) and for switching tabs (so state can be restored when the tab returns). .. _class_EditorPlugin_get_undo_redo: -- :ref:`UndoRedo` **get_undo_redo** **(** **)** +- :ref:`UndoRedo` **get_undo_redo** **(** **)** Get the undo/redo object. Most actions in the editor can be undoable, so use this object to make sure this happens when it's worth it. .. _class_EditorPlugin_get_window_layout: -- void **get_window_layout** **(** :ref:`ConfigFile` layout **)** virtual +- void **get_window_layout** **(** :ref:`ConfigFile` layout **)** virtual Get the GUI layout of the plugin. This is used to save the project's editor layout when the :ref:`EditorPlugin.queue_save_layout` is called or the editor layout was changed(For example changing the position of a dock). .. _class_EditorPlugin_handles: -- :ref:`bool` **handles** **(** :ref:`Object` object **)** virtual +- :ref:`bool` **handles** **(** :ref:`Object` object **)** virtual Implement this function if your plugin edits a specific type of object (Resource or Node). If you return true, then you will get the functions :ref:`EditorPlugin.edit` and :ref:`EditorPlugin.make_visible` called when the editor requests them. .. _class_EditorPlugin_has_main_screen: -- :ref:`bool` **has_main_screen** **(** **)** virtual +- :ref:`bool` **has_main_screen** **(** **)** virtual Return true if this is a main screen editor plugin (it goes in the main screen selector together with 2D, 3D, Script). .. _class_EditorPlugin_hide_bottom_panel: -- void **hide_bottom_panel** **(** **)** +- void **hide_bottom_panel** **(** **)** .. _class_EditorPlugin_make_bottom_panel_item_visible: -- void **make_bottom_panel_item_visible** **(** :ref:`Control` item **)** +- void **make_bottom_panel_item_visible** **(** :ref:`Control` item **)** .. _class_EditorPlugin_make_visible: -- void **make_visible** **(** :ref:`bool` visible **)** virtual +- void **make_visible** **(** :ref:`bool` visible **)** virtual This function will be called when the editor is requested to become visible. It is used for plugins that edit a specific object type. @@ -299,63 +299,63 @@ Remember that you have to manage the visibility of all your editor controls manu .. _class_EditorPlugin_queue_save_layout: -- void **queue_save_layout** **(** **)** const +- void **queue_save_layout** **(** **)** const Queue save the project's editor layout. .. _class_EditorPlugin_remove_control_from_bottom_panel: -- void **remove_control_from_bottom_panel** **(** :ref:`Control` control **)** +- void **remove_control_from_bottom_panel** **(** :ref:`Control` control **)** Remove the control from the bottom panel. Don't forget to call this if you added one, so the editor can remove it cleanly. .. _class_EditorPlugin_remove_control_from_docks: -- void **remove_control_from_docks** **(** :ref:`Control` control **)** +- void **remove_control_from_docks** **(** :ref:`Control` control **)** Remove the control from the dock. Don't forget to call this if you added one, so the editor can save the layout and remove it cleanly. .. _class_EditorPlugin_remove_custom_type: -- void **remove_custom_type** **(** :ref:`String` type **)** +- void **remove_custom_type** **(** :ref:`String` type **)** Remove a custom type added by :ref:`EditorPlugin.add_custom_type` .. _class_EditorPlugin_remove_export_plugin: -- void **remove_export_plugin** **(** :ref:`EditorExportPlugin` exporter **)** +- void **remove_export_plugin** **(** :ref:`EditorExportPlugin` exporter **)** .. _class_EditorPlugin_remove_import_plugin: -- void **remove_import_plugin** **(** :ref:`EditorImportPlugin` importer **)** +- void **remove_import_plugin** **(** :ref:`EditorImportPlugin` importer **)** .. _class_EditorPlugin_save_external_data: -- void **save_external_data** **(** **)** virtual +- void **save_external_data** **(** **)** virtual This method is called after the editor saves the project or when it's closed. It asks the plugin to save edited external scenes/resources. .. _class_EditorPlugin_set_input_event_forwarding_always_enabled: -- void **set_input_event_forwarding_always_enabled** **(** **)** +- void **set_input_event_forwarding_always_enabled** **(** **)** Use this method if you always want to receive inputs from 3D view screen inside :ref:`forward_spatial_gui_input`. It might be especially usable if your plugin will want to use raycast in the scene. .. _class_EditorPlugin_set_state: -- void **set_state** **(** :ref:`Dictionary` state **)** virtual +- void **set_state** **(** :ref:`Dictionary` state **)** virtual Restore the state saved by :ref:`EditorPlugin.get_state`. .. _class_EditorPlugin_set_window_layout: -- void **set_window_layout** **(** :ref:`ConfigFile` layout **)** virtual +- void **set_window_layout** **(** :ref:`ConfigFile` layout **)** virtual Restore the plugin GUI layout saved by :ref:`EditorPlugin.get_window_layout`. .. _class_EditorPlugin_update_canvas: -- void **update_canvas** **(** **)** +- void **update_canvas** **(** **)** Updates the control used to draw the edited scene over the 2D canvas. This is used together with :ref:`forward_canvas_input_event`. diff --git a/classes/class_editorresourceconversionplugin.rst b/classes/class_editorresourceconversionplugin.rst index 9414a6661..6c2d94dd8 100644 --- a/classes/class_editorresourceconversionplugin.rst +++ b/classes/class_editorresourceconversionplugin.rst @@ -19,21 +19,21 @@ Brief Description Member Functions ---------------- -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Resource` | :ref:`_convert` **(** :ref:`Resource` resource **)** virtual | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`_converts_to` **(** **)** virtual | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Resource` | :ref:`_convert` **(** :ref:`Resource` resource **)** virtual | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`_converts_to` **(** **)** virtual | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ Member Function Description --------------------------- .. _class_EditorResourceConversionPlugin__convert: -- :ref:`Resource` **_convert** **(** :ref:`Resource` resource **)** virtual +- :ref:`Resource` **_convert** **(** :ref:`Resource` resource **)** virtual .. _class_EditorResourceConversionPlugin__converts_to: -- :ref:`bool` **_converts_to** **(** **)** virtual +- :ref:`bool` **_converts_to** **(** **)** virtual diff --git a/classes/class_editorresourcepreview.rst b/classes/class_editorresourcepreview.rst index abb3d5ac4..51a206757 100644 --- a/classes/class_editorresourcepreview.rst +++ b/classes/class_editorresourcepreview.rst @@ -19,24 +19,24 @@ Helper to generate previews of resources or files. Member Functions ---------------- -+-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_preview_generator` **(** :ref:`EditorResourcePreviewGenerator` generator **)** | -+-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`check_for_invalidation` **(** :ref:`String` path **)** | -+-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`queue_edited_resource_preview` **(** :ref:`Resource` resource, :ref:`Object` receiver, :ref:`String` receiver_func, :ref:`Variant` userdata **)** | -+-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`queue_resource_preview` **(** :ref:`String` path, :ref:`Object` receiver, :ref:`String` receiver_func, :ref:`Variant` userdata **)** | -+-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_preview_generator` **(** :ref:`EditorResourcePreviewGenerator` generator **)** | -+-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_preview_generator` **(** :ref:`EditorResourcePreviewGenerator` generator **)** | ++-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`check_for_invalidation` **(** :ref:`String` path **)** | ++-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`queue_edited_resource_preview` **(** :ref:`Resource` resource, :ref:`Object` receiver, :ref:`String` receiver_func, :ref:`Variant` userdata **)** | ++-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`queue_resource_preview` **(** :ref:`String` path, :ref:`Object` receiver, :ref:`String` receiver_func, :ref:`Variant` userdata **)** | ++-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_preview_generator` **(** :ref:`EditorResourcePreviewGenerator` generator **)** | ++-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_EditorResourcePreview_preview_invalidated: -- **preview_invalidated** **(** :ref:`String` path **)** +- **preview_invalidated** **(** :ref:`String` path **)** If a preview was invalidated (changed) this signal will emit (using the path of the preview) @@ -51,31 +51,31 @@ Member Function Description .. _class_EditorResourcePreview_add_preview_generator: -- void **add_preview_generator** **(** :ref:`EditorResourcePreviewGenerator` generator **)** +- void **add_preview_generator** **(** :ref:`EditorResourcePreviewGenerator` generator **)** Create an own, custom preview generator. .. _class_EditorResourcePreview_check_for_invalidation: -- void **check_for_invalidation** **(** :ref:`String` path **)** +- void **check_for_invalidation** **(** :ref:`String` path **)** Check if the resource changed, if so it will be invalidated and the corresponding signal emitted. .. _class_EditorResourcePreview_queue_edited_resource_preview: -- void **queue_edited_resource_preview** **(** :ref:`Resource` resource, :ref:`Object` receiver, :ref:`String` receiver_func, :ref:`Variant` userdata **)** +- void **queue_edited_resource_preview** **(** :ref:`Resource` resource, :ref:`Object` receiver, :ref:`String` receiver_func, :ref:`Variant` userdata **)** Queue a resource being edited for preview (using an instance). Once the preview is ready, your receiver.receiver_func will be called either containing the preview texture or an empty texture (if no preview was possible). Callback must have the format: (path,texture,userdata). Userdata can be anything. .. _class_EditorResourcePreview_queue_resource_preview: -- void **queue_resource_preview** **(** :ref:`String` path, :ref:`Object` receiver, :ref:`String` receiver_func, :ref:`Variant` userdata **)** +- void **queue_resource_preview** **(** :ref:`String` path, :ref:`Object` receiver, :ref:`String` receiver_func, :ref:`Variant` userdata **)** Queue a resource file for preview (using a path). Once the preview is ready, your receiver.receiver_func will be called either containing the preview texture or an empty texture (if no preview was possible). Callback must have the format: (path,texture,userdata). Userdata can be anything. .. _class_EditorResourcePreview_remove_preview_generator: -- void **remove_preview_generator** **(** :ref:`EditorResourcePreviewGenerator` generator **)** +- void **remove_preview_generator** **(** :ref:`EditorResourcePreviewGenerator` generator **)** Remove a custom preview generator. diff --git a/classes/class_editorresourcepreviewgenerator.rst b/classes/class_editorresourcepreviewgenerator.rst index 2fa774a5a..40d52d8e9 100644 --- a/classes/class_editorresourcepreviewgenerator.rst +++ b/classes/class_editorresourcepreviewgenerator.rst @@ -19,13 +19,13 @@ Custom generator of previews. Member Functions ---------------- -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`generate` **(** :ref:`Resource` from **)** virtual | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`generate_from_path` **(** :ref:`String` path **)** virtual | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`handles` **(** :ref:`String` type **)** virtual | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`generate` **(** :ref:`Resource` from **)** virtual | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`generate_from_path` **(** :ref:`String` path **)** virtual | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`handles` **(** :ref:`String` type **)** virtual | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -37,7 +37,7 @@ Member Function Description .. _class_EditorResourcePreviewGenerator_generate: -- :ref:`Texture` **generate** **(** :ref:`Resource` from **)** virtual +- :ref:`Texture` **generate** **(** :ref:`Resource` from **)** virtual Generate a preview from a given resource. This must be always implemented. @@ -47,7 +47,7 @@ Care must be taken because this function is always called from a thread (not the .. _class_EditorResourcePreviewGenerator_generate_from_path: -- :ref:`Texture` **generate_from_path** **(** :ref:`String` path **)** virtual +- :ref:`Texture` **generate_from_path** **(** :ref:`String` path **)** virtual Generate a preview directly from a path, implementing this is optional, as default code will load and call generate() @@ -57,7 +57,7 @@ Care must be taken because this function is always called from a thread (not the .. _class_EditorResourcePreviewGenerator_handles: -- :ref:`bool` **handles** **(** :ref:`String` type **)** virtual +- :ref:`bool` **handles** **(** :ref:`String` type **)** virtual Return if your generator supports this resource type. diff --git a/classes/class_editorscript.rst b/classes/class_editorscript.rst index 42f65e363..18c37f870 100644 --- a/classes/class_editorscript.rst +++ b/classes/class_editorscript.rst @@ -19,15 +19,15 @@ Base script that can be used to add extension functions to the editor. Member Functions ---------------- -+------------------------------------------------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`_run` **(** **)** virtual | -+------------------------------------------------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`add_root_node` **(** :ref:`Node` node **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------+ -| :ref:`EditorInterface` | :ref:`get_editor_interface` **(** **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_scene` **(** **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------+ ++------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| void | :ref:`_run` **(** **)** virtual | ++------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| void | :ref:`add_root_node` **(** :ref:`Node` node **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`EditorInterface` | :ref:`get_editor_interface` **(** **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`get_scene` **(** **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------+ Description ----------- @@ -51,23 +51,23 @@ Member Function Description .. _class_EditorScript__run: -- void **_run** **(** **)** virtual +- void **_run** **(** **)** virtual This method is executed by the Editor when ``File -> Run`` is used. .. _class_EditorScript_add_root_node: -- void **add_root_node** **(** :ref:`Node` node **)** +- void **add_root_node** **(** :ref:`Node` node **)** .. _class_EditorScript_get_editor_interface: -- :ref:`EditorInterface` **get_editor_interface** **(** **)** +- :ref:`EditorInterface` **get_editor_interface** **(** **)** Returns the :ref:`EditorInterface` singleton instance. .. _class_EditorScript_get_scene: -- :ref:`Node` **get_scene** **(** **)** +- :ref:`Node` **get_scene** **(** **)** Returns the Editor's currently active scene. diff --git a/classes/class_editorselection.rst b/classes/class_editorselection.rst index d05f483d0..4c8292fcf 100644 --- a/classes/class_editorselection.rst +++ b/classes/class_editorselection.rst @@ -19,24 +19,24 @@ Manages the SceneTree selection in the editor. Member Functions ---------------- -+----------------------------+--------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_node` **(** :ref:`Node` node **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_selected_nodes` **(** **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_transformable_selected_nodes` **(** **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_node` **(** :ref:`Node` node **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------+ ++----------------------------+-------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_node` **(** :ref:`Node` node **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_selected_nodes` **(** **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_transformable_selected_nodes` **(** **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_node` **(** :ref:`Node` node **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_EditorSelection_selection_changed: -- **selection_changed** **(** **)** +- **selection_changed** **(** **)** Emitted when the selection changes. @@ -51,31 +51,31 @@ Member Function Description .. _class_EditorSelection_add_node: -- void **add_node** **(** :ref:`Node` node **)** +- void **add_node** **(** :ref:`Node` node **)** Add a node to the selection. .. _class_EditorSelection_clear: -- void **clear** **(** **)** +- void **clear** **(** **)** Clear the selection. .. _class_EditorSelection_get_selected_nodes: -- :ref:`Array` **get_selected_nodes** **(** **)** +- :ref:`Array` **get_selected_nodes** **(** **)** Get the list of selected nodes. .. _class_EditorSelection_get_transformable_selected_nodes: -- :ref:`Array` **get_transformable_selected_nodes** **(** **)** +- :ref:`Array` **get_transformable_selected_nodes** **(** **)** Get the list of selected nodes, optimized for transform operations (ie, moving them, rotating, etc). This list avoids situations where a node is selected and also chid/grandchild. .. _class_EditorSelection_remove_node: -- void **remove_node** **(** :ref:`Node` node **)** +- void **remove_node** **(** :ref:`Node` node **)** Remove a node from the selection. diff --git a/classes/class_editorsettings.rst b/classes/class_editorsettings.rst index 66d2e0501..e84409007 100644 --- a/classes/class_editorsettings.rst +++ b/classes/class_editorsettings.rst @@ -19,42 +19,42 @@ Object that holds the project-independent editor settings. Member Functions ---------------- -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_property_info` **(** :ref:`Dictionary` info **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase` **(** :ref:`String` property **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_favorite_dirs` **(** **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_project_settings_path` **(** **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_recent_dirs` **(** **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_setting` **(** :ref:`String` name **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_settings_path` **(** **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_setting` **(** :ref:`String` name **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`property_can_revert` **(** :ref:`String` name **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`property_get_revert` **(** :ref:`String` name **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_favorite_dirs` **(** :ref:`PoolStringArray` dirs **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_initial_value` **(** :ref:`String` name, :ref:`Variant` value **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_recent_dirs` **(** :ref:`PoolStringArray` dirs **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_setting` **(** :ref:`String` name, :ref:`Variant` value **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_property_info` **(** :ref:`Dictionary` info **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`erase` **(** :ref:`String` property **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_favorite_dirs` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_project_settings_path` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_recent_dirs` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_setting` **(** :ref:`String` name **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_settings_path` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_setting` **(** :ref:`String` name **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`property_can_revert` **(** :ref:`String` name **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`property_get_revert` **(** :ref:`String` name **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_favorite_dirs` **(** :ref:`PoolStringArray` dirs **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_initial_value` **(** :ref:`String` name, :ref:`Variant` value **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_recent_dirs` **(** :ref:`PoolStringArray` dirs **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_setting` **(** :ref:`String` name, :ref:`Variant` value **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_EditorSettings_settings_changed: -- **settings_changed** **(** **)** +- **settings_changed** **(** **)** Description @@ -75,7 +75,7 @@ Member Function Description .. _class_EditorSettings_add_property_info: -- void **add_property_info** **(** :ref:`Dictionary` info **)** +- void **add_property_info** **(** :ref:`Dictionary` info **)** Add a custom property info to a property. The dictionary must contain: name::ref:`String`(the name of the property) and type::ref:`int`(see TYPE\_\* in :ref:`@Global Scope`), and optionally hint::ref:`int`(see PROPERTY_HINT\_\* in :ref:`@Global Scope`), hint_string::ref:`String`. @@ -96,35 +96,35 @@ Example: .. _class_EditorSettings_erase: -- void **erase** **(** :ref:`String` property **)** +- void **erase** **(** :ref:`String` property **)** Erase a given setting (pass full property path). .. _class_EditorSettings_get_favorite_dirs: -- :ref:`PoolStringArray` **get_favorite_dirs** **(** **)** const +- :ref:`PoolStringArray` **get_favorite_dirs** **(** **)** const Get the list of favorite directories for this project. .. _class_EditorSettings_get_project_settings_path: -- :ref:`String` **get_project_settings_path** **(** **)** const +- :ref:`String` **get_project_settings_path** **(** **)** const Get the specific project settings path. Projects all have a unique sub-directory inside the settings path where project specific settings are saved. .. _class_EditorSettings_get_recent_dirs: -- :ref:`PoolStringArray` **get_recent_dirs** **(** **)** const +- :ref:`PoolStringArray` **get_recent_dirs** **(** **)** const Get the list of recently visited folders in the file dialog for this project. .. _class_EditorSettings_get_setting: -- :ref:`Variant` **get_setting** **(** :ref:`String` name **)** const +- :ref:`Variant` **get_setting** **(** :ref:`String` name **)** const .. _class_EditorSettings_get_settings_path: -- :ref:`String` **get_settings_path** **(** **)** const +- :ref:`String` **get_settings_path** **(** **)** const Get the global settings path for the engine. Inside this path you can find some standard paths such as: @@ -134,34 +134,34 @@ settings/templates - where export templates are located .. _class_EditorSettings_has_setting: -- :ref:`bool` **has_setting** **(** :ref:`String` name **)** const +- :ref:`bool` **has_setting** **(** :ref:`String` name **)** const .. _class_EditorSettings_property_can_revert: -- :ref:`bool` **property_can_revert** **(** :ref:`String` name **)** +- :ref:`bool` **property_can_revert** **(** :ref:`String` name **)** .. _class_EditorSettings_property_get_revert: -- :ref:`Variant` **property_get_revert** **(** :ref:`String` name **)** +- :ref:`Variant` **property_get_revert** **(** :ref:`String` name **)** .. _class_EditorSettings_set_favorite_dirs: -- void **set_favorite_dirs** **(** :ref:`PoolStringArray` dirs **)** +- void **set_favorite_dirs** **(** :ref:`PoolStringArray` dirs **)** Set the list of favorite directories for this project. .. _class_EditorSettings_set_initial_value: -- void **set_initial_value** **(** :ref:`String` name, :ref:`Variant` value **)** +- void **set_initial_value** **(** :ref:`String` name, :ref:`Variant` value **)** .. _class_EditorSettings_set_recent_dirs: -- void **set_recent_dirs** **(** :ref:`PoolStringArray` dirs **)** +- void **set_recent_dirs** **(** :ref:`PoolStringArray` dirs **)** Set the list of recently visited folders in the file dialog for this project. .. _class_EditorSettings_set_setting: -- void **set_setting** **(** :ref:`String` name, :ref:`Variant` value **)** +- void **set_setting** **(** :ref:`String` name, :ref:`Variant` value **)** diff --git a/classes/class_editorspatialgizmo.rst b/classes/class_editorspatialgizmo.rst index cd4cb74f4..f1111b0ae 100644 --- a/classes/class_editorspatialgizmo.rst +++ b/classes/class_editorspatialgizmo.rst @@ -19,33 +19,33 @@ Custom gizmo for editing Spatial objects. Member Functions ---------------- -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_collision_segments` **(** :ref:`PoolVector3Array` segments **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_collision_triangles` **(** :ref:`TriangleMesh` triangles, :ref:`Rect3` bounds **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_handles` **(** :ref:`PoolVector3Array` handles, :ref:`bool` billboard=false, :ref:`bool` secondary=false **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_lines` **(** :ref:`PoolVector3Array` lines, :ref:`Material` material, :ref:`bool` billboard=false **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_mesh` **(** :ref:`ArrayMesh` mesh, :ref:`bool` billboard=false, :ref:`RID` skeleton **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_unscaled_billboard` **(** :ref:`Material` material, :ref:`float` default_scale=1 **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`commit_handle` **(** :ref:`int` index, :ref:`Variant` restore, :ref:`bool` cancel=false **)** virtual | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_handle_name` **(** :ref:`int` index **)** virtual | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_handle_value` **(** :ref:`int` index **)** virtual | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`redraw` **(** **)** virtual | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_handle` **(** :ref:`int` index, :ref:`Camera` camera, :ref:`Vector2` point **)** virtual | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_spatial_node` **(** :ref:`Node` node **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_collision_segments` **(** :ref:`PoolVector3Array` segments **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_collision_triangles` **(** :ref:`TriangleMesh` triangles, :ref:`Rect3` bounds **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_handles` **(** :ref:`PoolVector3Array` handles, :ref:`bool` billboard=false, :ref:`bool` secondary=false **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_lines` **(** :ref:`PoolVector3Array` lines, :ref:`Material` material, :ref:`bool` billboard=false **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_mesh` **(** :ref:`ArrayMesh` mesh, :ref:`bool` billboard=false, :ref:`RID` skeleton **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_unscaled_billboard` **(** :ref:`Material` material, :ref:`float` default_scale=1 **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`commit_handle` **(** :ref:`int` index, :ref:`Variant` restore, :ref:`bool` cancel=false **)** virtual | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_handle_name` **(** :ref:`int` index **)** virtual | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_handle_value` **(** :ref:`int` index **)** virtual | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`redraw` **(** **)** virtual | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_handle` **(** :ref:`int` index, :ref:`Camera` camera, :ref:`Vector2` point **)** virtual | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_spatial_node` **(** :ref:`Node` node **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -57,17 +57,17 @@ Member Function Description .. _class_EditorSpatialGizmo_add_collision_segments: -- void **add_collision_segments** **(** :ref:`PoolVector3Array` segments **)** +- void **add_collision_segments** **(** :ref:`PoolVector3Array` segments **)** .. _class_EditorSpatialGizmo_add_collision_triangles: -- void **add_collision_triangles** **(** :ref:`TriangleMesh` triangles, :ref:`Rect3` bounds **)** +- void **add_collision_triangles** **(** :ref:`TriangleMesh` triangles, :ref:`Rect3` bounds **)** Add collision triangles to the gizmo for picking. A :ref:`TriangleMesh` can be generated from a regular :ref:`Mesh` too. Call this function during :ref:`redraw`. .. _class_EditorSpatialGizmo_add_handles: -- void **add_handles** **(** :ref:`PoolVector3Array` handles, :ref:`bool` billboard=false, :ref:`bool` secondary=false **)** +- void **add_handles** **(** :ref:`PoolVector3Array` handles, :ref:`bool` billboard=false, :ref:`bool` secondary=false **)** Add a list of handles (points) which can be used to deform the object being edited. @@ -75,27 +75,27 @@ There are virtual functions which will be called upon editing of these handles. .. _class_EditorSpatialGizmo_add_lines: -- void **add_lines** **(** :ref:`PoolVector3Array` lines, :ref:`Material` material, :ref:`bool` billboard=false **)** +- void **add_lines** **(** :ref:`PoolVector3Array` lines, :ref:`Material` material, :ref:`bool` billboard=false **)** Add lines to the gizmo (as sets of 2 points), with a given material. The lines are used for visualizing the gizmo. Call this function during :ref:`redraw`. .. _class_EditorSpatialGizmo_add_mesh: -- void **add_mesh** **(** :ref:`ArrayMesh` mesh, :ref:`bool` billboard=false, :ref:`RID` skeleton **)** +- void **add_mesh** **(** :ref:`ArrayMesh` mesh, :ref:`bool` billboard=false, :ref:`RID` skeleton **)** .. _class_EditorSpatialGizmo_add_unscaled_billboard: -- void **add_unscaled_billboard** **(** :ref:`Material` material, :ref:`float` default_scale=1 **)** +- void **add_unscaled_billboard** **(** :ref:`Material` material, :ref:`float` default_scale=1 **)** Add an unscaled billboard for visualization. Call this function during :ref:`redraw`. .. _class_EditorSpatialGizmo_clear: -- void **clear** **(** **)** +- void **clear** **(** **)** .. _class_EditorSpatialGizmo_commit_handle: -- void **commit_handle** **(** :ref:`int` index, :ref:`Variant` restore, :ref:`bool` cancel=false **)** virtual +- void **commit_handle** **(** :ref:`int` index, :ref:`Variant` restore, :ref:`bool` cancel=false **)** virtual Commit a handle being edited (handles must have been previously added by :ref:`add_handles`). @@ -103,7 +103,7 @@ If the cancel parameter is true, an option to restore the edited value to the or .. _class_EditorSpatialGizmo_get_handle_name: -- :ref:`String` **get_handle_name** **(** :ref:`int` index **)** virtual +- :ref:`String` **get_handle_name** **(** :ref:`int` index **)** virtual Get the name of an edited handle (handles must have been previously added by :ref:`add_handles`). @@ -111,19 +111,19 @@ Handles can be named for reference to the user when editing. .. _class_EditorSpatialGizmo_get_handle_value: -- :ref:`Variant` **get_handle_value** **(** :ref:`int` index **)** virtual +- :ref:`Variant` **get_handle_value** **(** :ref:`int` index **)** virtual Get actual value of a handle. This value can be anything and used for eventually undoing the motion when calling :ref:`commit_handle` .. _class_EditorSpatialGizmo_redraw: -- void **redraw** **(** **)** virtual +- void **redraw** **(** **)** virtual This function is called when the Spatial this gizmo refers to changes (the :ref:`Spatial.update_gizmo` is called). .. _class_EditorSpatialGizmo_set_handle: -- void **set_handle** **(** :ref:`int` index, :ref:`Camera` camera, :ref:`Vector2` point **)** virtual +- void **set_handle** **(** :ref:`int` index, :ref:`Camera` camera, :ref:`Vector2` point **)** virtual This function is used when the user drags a gizmo handle (previously added with :ref:`add_handles`) in screen coordinates. @@ -131,6 +131,6 @@ The :ref:`Camera` is also provided so screen coordinates can be co .. _class_EditorSpatialGizmo_set_spatial_node: -- void **set_spatial_node** **(** :ref:`Node` node **)** +- void **set_spatial_node** **(** :ref:`Node` node **)** diff --git a/classes/class_encodedobjectasid.rst b/classes/class_encodedobjectasid.rst index af61162bd..ee319bdcb 100644 --- a/classes/class_encodedobjectasid.rst +++ b/classes/class_encodedobjectasid.rst @@ -19,21 +19,21 @@ Brief Description Member Functions ---------------- -+------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_object_id` **(** **)** const | -+------------------------+----------------------------------------------------------------------------------------------------+ -| void | :ref:`set_object_id` **(** :ref:`int` id **)** | -+------------------------+----------------------------------------------------------------------------------------------------+ ++------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_object_id` **(** **)** const | ++------------------------+--------------------------------------------------------------------------------------------------+ +| void | :ref:`set_object_id` **(** :ref:`int` id **)** | ++------------------------+--------------------------------------------------------------------------------------------------+ Member Function Description --------------------------- .. _class_EncodedObjectAsID_get_object_id: -- :ref:`int` **get_object_id** **(** **)** const +- :ref:`int` **get_object_id** **(** **)** const .. _class_EncodedObjectAsID_set_object_id: -- void **set_object_id** **(** :ref:`int` id **)** +- void **set_object_id** **(** :ref:`int` id **)** diff --git a/classes/class_engine.rst b/classes/class_engine.rst index e152d1637..014cb9863 100644 --- a/classes/class_engine.rst +++ b/classes/class_engine.rst @@ -19,33 +19,33 @@ Access to basic engine properties. Member Functions ---------------- -+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_frames_drawn` **(** **)** | -+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_frames_per_second` **(** **)** const | -+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_iterations_per_second` **(** **)** const | -+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`MainLoop` | :ref:`get_main_loop` **(** **)** const | -+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_target_fps` **(** **)** const | -+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_time_scale` **(** **)** | -+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_version_info` **(** **)** const | -+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_editor_hint` **(** **)** const | -+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_in_physics_frame` **(** **)** const | -+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_editor_hint` **(** :ref:`bool` enabled **)** | -+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_iterations_per_second` **(** :ref:`int` iterations_per_second **)** | -+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_target_fps` **(** :ref:`int` target_fps **)** | -+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_time_scale` **(** :ref:`float` time_scale **)** | -+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_frames_drawn` **(** **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_frames_per_second` **(** **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_iterations_per_second` **(** **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`MainLoop` | :ref:`get_main_loop` **(** **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_target_fps` **(** **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_time_scale` **(** **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_version_info` **(** **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_editor_hint` **(** **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_in_physics_frame` **(** **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_editor_hint` **(** :ref:`bool` enabled **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_iterations_per_second` **(** :ref:`int` iterations_per_second **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_target_fps` **(** :ref:`int` target_fps **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_time_scale` **(** :ref:`float` time_scale **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -57,43 +57,43 @@ Member Function Description .. _class_Engine_get_frames_drawn: -- :ref:`int` **get_frames_drawn** **(** **)** +- :ref:`int` **get_frames_drawn** **(** **)** Returns the total number of frames drawn. .. _class_Engine_get_frames_per_second: -- :ref:`float` **get_frames_per_second** **(** **)** const +- :ref:`float` **get_frames_per_second** **(** **)** const Returns the frames per second of the running game. .. _class_Engine_get_iterations_per_second: -- :ref:`int` **get_iterations_per_second** **(** **)** const +- :ref:`int` **get_iterations_per_second** **(** **)** const Returns the number of fixed iterations per second (for fixed process and physics). .. _class_Engine_get_main_loop: -- :ref:`MainLoop` **get_main_loop** **(** **)** const +- :ref:`MainLoop` **get_main_loop** **(** **)** const Returns the main loop object (see :ref:`MainLoop` and :ref:`SceneTree`). .. _class_Engine_get_target_fps: -- :ref:`float` **get_target_fps** **(** **)** const +- :ref:`float` **get_target_fps** **(** **)** const Returns the desired frames per second. If the hardware cannot keep up, this setting may not be respected. It defaults to 0, which indicates no limit. .. _class_Engine_get_time_scale: -- :ref:`float` **get_time_scale** **(** **)** +- :ref:`float` **get_time_scale** **(** **)** Returns how fast or slow the in-game clock ticks versus the real life one. It defaults to 1.0. A value of 2.0 means the game moves twice as fast as real life, whilst a value of 0.5 means the game moves at half the regular speed. .. _class_Engine_get_version_info: -- :ref:`Dictionary` **get_version_info** **(** **)** const +- :ref:`Dictionary` **get_version_info** **(** **)** const Returns the current engine version information in a Dictionary. @@ -113,37 +113,37 @@ Returns the current engine version information in a Dictionary. .. _class_Engine_is_editor_hint: -- :ref:`bool` **is_editor_hint** **(** **)** const +- :ref:`bool` **is_editor_hint** **(** **)** const Returns ``true`` if the editor is running. .. _class_Engine_is_in_physics_frame: -- :ref:`bool` **is_in_physics_frame** **(** **)** const +- :ref:`bool` **is_in_physics_frame** **(** **)** const Returns ``true`` if the game is inside the fixed process and physics phase of the game loop. .. _class_Engine_set_editor_hint: -- void **set_editor_hint** **(** :ref:`bool` enabled **)** +- void **set_editor_hint** **(** :ref:`bool` enabled **)** Sets the running inside the editor hint if ``enabled`` is ``true``. .. _class_Engine_set_iterations_per_second: -- void **set_iterations_per_second** **(** :ref:`int` iterations_per_second **)** +- void **set_iterations_per_second** **(** :ref:`int` iterations_per_second **)** Sets the number of fixed iterations per second (for fixed process and physics). .. _class_Engine_set_target_fps: -- void **set_target_fps** **(** :ref:`int` target_fps **)** +- void **set_target_fps** **(** :ref:`int` target_fps **)** Sets the target frames per second. .. _class_Engine_set_time_scale: -- void **set_time_scale** **(** :ref:`float` time_scale **)** +- void **set_time_scale** **(** :ref:`float` time_scale **)** Sets the time scale. diff --git a/classes/class_environment.rst b/classes/class_environment.rst index 92a944fe3..579fafa40 100644 --- a/classes/class_environment.rst +++ b/classes/class_environment.rst @@ -19,283 +19,283 @@ Resource for environment nodes (like :ref:`WorldEnvironment` | :ref:`get_adjustment_brightness` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_adjustment_color_correction` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_adjustment_contrast` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_adjustment_saturation` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_ambient_light_color` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ambient_light_energy` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ambient_light_sky_contribution` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_background` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_bg_color` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_bg_energy` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_canvas_max_layer` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_dof_blur_far_amount` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_dof_blur_far_distance` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_dof_blur_far_quality` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_dof_blur_far_transition` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_dof_blur_near_amount` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_dof_blur_near_distance` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_dof_blur_near_quality` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_dof_blur_near_transition` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_fog_color` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_fog_depth_begin` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_fog_depth_curve` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_fog_height_curve` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_fog_height_max` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_fog_height_min` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_fog_sun_amount` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_fog_sun_color` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_fog_transmit_curve` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_glow_blend_mode` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_glow_bloom` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_glow_hdr_bleed_scale` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_glow_hdr_bleed_threshold` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_glow_intensity` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_glow_strength` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Sky` | :ref:`get_sky` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_sky_custom_fov` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ssao_bias` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_ssao_color` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ssao_direct_light_affect` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ssao_intensity` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ssao_intensity2` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ssao_radius` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ssao_radius2` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ssr_depth_tolerance` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ssr_fade_in` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ssr_fade_out` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_ssr_max_steps` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_tonemap_auto_exposure` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_tonemap_auto_exposure_grey` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_tonemap_auto_exposure_max` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_tonemap_auto_exposure_min` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_tonemap_auto_exposure_speed` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_tonemap_exposure` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_tonemap_white` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_tonemapper` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_adjustment_enabled` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_dof_blur_far_enabled` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_dof_blur_near_enabled` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_fog_depth_enabled` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_fog_enabled` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_fog_height_enabled` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_fog_transmit_enabled` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_glow_bicubic_upscale_enabled` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_glow_enabled` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_glow_level_enabled` **(** :ref:`int` idx **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_ssao_blur_enabled` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_ssao_enabled` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_ssr_enabled` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_ssr_rough` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_adjustment_brightness` **(** :ref:`float` brightness **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_adjustment_color_correction` **(** :ref:`Texture` color_correction **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_adjustment_contrast` **(** :ref:`float` contrast **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_adjustment_enable` **(** :ref:`bool` enabled **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_adjustment_saturation` **(** :ref:`float` saturation **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ambient_light_color` **(** :ref:`Color` color **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ambient_light_energy` **(** :ref:`float` energy **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ambient_light_sky_contribution` **(** :ref:`float` energy **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_background` **(** :ref:`int` mode **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bg_color` **(** :ref:`Color` color **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bg_energy` **(** :ref:`float` energy **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_canvas_max_layer` **(** :ref:`int` layer **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_dof_blur_far_amount` **(** :ref:`float` intensity **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_dof_blur_far_distance` **(** :ref:`float` intensity **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_dof_blur_far_enabled` **(** :ref:`bool` enabled **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_dof_blur_far_quality` **(** :ref:`int` intensity **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_dof_blur_far_transition` **(** :ref:`float` intensity **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_dof_blur_near_amount` **(** :ref:`float` intensity **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_dof_blur_near_distance` **(** :ref:`float` intensity **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_dof_blur_near_enabled` **(** :ref:`bool` enabled **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_dof_blur_near_quality` **(** :ref:`int` level **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_dof_blur_near_transition` **(** :ref:`float` intensity **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fog_color` **(** :ref:`Color` color **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fog_depth_begin` **(** :ref:`float` distance **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fog_depth_curve` **(** :ref:`float` curve **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fog_depth_enabled` **(** :ref:`bool` enabled **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fog_enabled` **(** :ref:`bool` enabled **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fog_height_curve` **(** :ref:`float` curve **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fog_height_enabled` **(** :ref:`bool` enabled **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fog_height_max` **(** :ref:`float` height **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fog_height_min` **(** :ref:`float` height **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fog_sun_amount` **(** :ref:`float` amount **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fog_sun_color` **(** :ref:`Color` color **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fog_transmit_curve` **(** :ref:`float` curve **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fog_transmit_enabled` **(** :ref:`bool` enabled **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_glow_bicubic_upscale` **(** :ref:`bool` enabled **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_glow_blend_mode` **(** :ref:`int` mode **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_glow_bloom` **(** :ref:`float` amount **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_glow_enabled` **(** :ref:`bool` enabled **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_glow_hdr_bleed_scale` **(** :ref:`float` scale **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_glow_hdr_bleed_threshold` **(** :ref:`float` threshold **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_glow_intensity` **(** :ref:`float` intensity **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_glow_level` **(** :ref:`int` idx, :ref:`bool` enabled **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_glow_strength` **(** :ref:`float` strength **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sky` **(** :ref:`Sky` sky **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sky_custom_fov` **(** :ref:`float` scale **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ssao_bias` **(** :ref:`float` bias **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ssao_blur` **(** :ref:`bool` enabled **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ssao_color` **(** :ref:`Color` color **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ssao_direct_light_affect` **(** :ref:`float` amount **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ssao_enabled` **(** :ref:`bool` enabled **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ssao_intensity` **(** :ref:`float` intensity **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ssao_intensity2` **(** :ref:`float` intensity **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ssao_radius` **(** :ref:`float` radius **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ssao_radius2` **(** :ref:`float` radius **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ssr_depth_tolerance` **(** :ref:`float` depth_tolerance **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ssr_enabled` **(** :ref:`bool` enabled **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ssr_fade_in` **(** :ref:`float` fade_in **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ssr_fade_out` **(** :ref:`float` fade_out **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ssr_max_steps` **(** :ref:`int` max_steps **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ssr_rough` **(** :ref:`bool` rough **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tonemap_auto_exposure` **(** :ref:`bool` auto_exposure **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tonemap_auto_exposure_grey` **(** :ref:`float` exposure_grey **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tonemap_auto_exposure_max` **(** :ref:`float` exposure_max **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tonemap_auto_exposure_min` **(** :ref:`float` exposure_min **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tonemap_auto_exposure_speed` **(** :ref:`float` exposure_speed **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tonemap_exposure` **(** :ref:`float` exposure **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tonemap_white` **(** :ref:`float` white **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tonemapper` **(** :ref:`int` mode **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_adjustment_brightness` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_adjustment_color_correction` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_adjustment_contrast` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_adjustment_saturation` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_ambient_light_color` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_ambient_light_energy` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_ambient_light_sky_contribution` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_background` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_bg_color` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_bg_energy` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_canvas_max_layer` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_dof_blur_far_amount` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_dof_blur_far_distance` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_dof_blur_far_quality` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_dof_blur_far_transition` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_dof_blur_near_amount` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_dof_blur_near_distance` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_dof_blur_near_quality` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_dof_blur_near_transition` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_fog_color` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_fog_depth_begin` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_fog_depth_curve` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_fog_height_curve` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_fog_height_max` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_fog_height_min` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_fog_sun_amount` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_fog_sun_color` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_fog_transmit_curve` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_glow_blend_mode` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_glow_bloom` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_glow_hdr_bleed_scale` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_glow_hdr_bleed_threshold` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_glow_intensity` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_glow_strength` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Sky` | :ref:`get_sky` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_sky_custom_fov` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_ssao_bias` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_ssao_color` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_ssao_direct_light_affect` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_ssao_intensity` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_ssao_intensity2` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_ssao_radius` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_ssao_radius2` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_ssr_depth_tolerance` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_ssr_fade_in` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_ssr_fade_out` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_ssr_max_steps` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_tonemap_auto_exposure` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_tonemap_auto_exposure_grey` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_tonemap_auto_exposure_max` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_tonemap_auto_exposure_min` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_tonemap_auto_exposure_speed` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_tonemap_exposure` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_tonemap_white` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_tonemapper` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_adjustment_enabled` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_dof_blur_far_enabled` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_dof_blur_near_enabled` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_fog_depth_enabled` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_fog_enabled` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_fog_height_enabled` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_fog_transmit_enabled` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_glow_bicubic_upscale_enabled` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_glow_enabled` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_glow_level_enabled` **(** :ref:`int` idx **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_ssao_blur_enabled` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_ssao_enabled` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_ssr_enabled` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_ssr_rough` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_adjustment_brightness` **(** :ref:`float` brightness **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_adjustment_color_correction` **(** :ref:`Texture` color_correction **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_adjustment_contrast` **(** :ref:`float` contrast **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_adjustment_enable` **(** :ref:`bool` enabled **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_adjustment_saturation` **(** :ref:`float` saturation **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ambient_light_color` **(** :ref:`Color` color **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ambient_light_energy` **(** :ref:`float` energy **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ambient_light_sky_contribution` **(** :ref:`float` energy **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_background` **(** :ref:`int` mode **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bg_color` **(** :ref:`Color` color **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bg_energy` **(** :ref:`float` energy **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_canvas_max_layer` **(** :ref:`int` layer **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_dof_blur_far_amount` **(** :ref:`float` intensity **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_dof_blur_far_distance` **(** :ref:`float` intensity **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_dof_blur_far_enabled` **(** :ref:`bool` enabled **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_dof_blur_far_quality` **(** :ref:`int` intensity **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_dof_blur_far_transition` **(** :ref:`float` intensity **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_dof_blur_near_amount` **(** :ref:`float` intensity **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_dof_blur_near_distance` **(** :ref:`float` intensity **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_dof_blur_near_enabled` **(** :ref:`bool` enabled **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_dof_blur_near_quality` **(** :ref:`int` level **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_dof_blur_near_transition` **(** :ref:`float` intensity **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fog_color` **(** :ref:`Color` color **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fog_depth_begin` **(** :ref:`float` distance **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fog_depth_curve` **(** :ref:`float` curve **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fog_depth_enabled` **(** :ref:`bool` enabled **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fog_enabled` **(** :ref:`bool` enabled **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fog_height_curve` **(** :ref:`float` curve **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fog_height_enabled` **(** :ref:`bool` enabled **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fog_height_max` **(** :ref:`float` height **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fog_height_min` **(** :ref:`float` height **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fog_sun_amount` **(** :ref:`float` amount **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fog_sun_color` **(** :ref:`Color` color **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fog_transmit_curve` **(** :ref:`float` curve **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fog_transmit_enabled` **(** :ref:`bool` enabled **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_glow_bicubic_upscale` **(** :ref:`bool` enabled **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_glow_blend_mode` **(** :ref:`int` mode **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_glow_bloom` **(** :ref:`float` amount **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_glow_enabled` **(** :ref:`bool` enabled **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_glow_hdr_bleed_scale` **(** :ref:`float` scale **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_glow_hdr_bleed_threshold` **(** :ref:`float` threshold **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_glow_intensity` **(** :ref:`float` intensity **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_glow_level` **(** :ref:`int` idx, :ref:`bool` enabled **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_glow_strength` **(** :ref:`float` strength **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_sky` **(** :ref:`Sky` sky **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_sky_custom_fov` **(** :ref:`float` scale **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ssao_bias` **(** :ref:`float` bias **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ssao_blur` **(** :ref:`bool` enabled **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ssao_color` **(** :ref:`Color` color **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ssao_direct_light_affect` **(** :ref:`float` amount **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ssao_enabled` **(** :ref:`bool` enabled **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ssao_intensity` **(** :ref:`float` intensity **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ssao_intensity2` **(** :ref:`float` intensity **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ssao_radius` **(** :ref:`float` radius **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ssao_radius2` **(** :ref:`float` radius **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ssr_depth_tolerance` **(** :ref:`float` depth_tolerance **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ssr_enabled` **(** :ref:`bool` enabled **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ssr_fade_in` **(** :ref:`float` fade_in **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ssr_fade_out` **(** :ref:`float` fade_out **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ssr_max_steps` **(** :ref:`int` max_steps **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ssr_rough` **(** :ref:`bool` rough **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tonemap_auto_exposure` **(** :ref:`bool` auto_exposure **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tonemap_auto_exposure_grey` **(** :ref:`float` exposure_grey **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tonemap_auto_exposure_max` **(** :ref:`float` exposure_max **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tonemap_auto_exposure_min` **(** :ref:`float` exposure_min **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tonemap_auto_exposure_speed` **(** :ref:`float` exposure_speed **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tonemap_exposure` **(** :ref:`float` exposure **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tonemap_white` **(** :ref:`float` white **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tonemapper` **(** :ref:`int` mode **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -643,554 +643,554 @@ Member Function Description .. _class_Environment_get_adjustment_brightness: -- :ref:`float` **get_adjustment_brightness** **(** **)** const +- :ref:`float` **get_adjustment_brightness** **(** **)** const .. _class_Environment_get_adjustment_color_correction: -- :ref:`Texture` **get_adjustment_color_correction** **(** **)** const +- :ref:`Texture` **get_adjustment_color_correction** **(** **)** const .. _class_Environment_get_adjustment_contrast: -- :ref:`float` **get_adjustment_contrast** **(** **)** const +- :ref:`float` **get_adjustment_contrast** **(** **)** const .. _class_Environment_get_adjustment_saturation: -- :ref:`float` **get_adjustment_saturation** **(** **)** const +- :ref:`float` **get_adjustment_saturation** **(** **)** const .. _class_Environment_get_ambient_light_color: -- :ref:`Color` **get_ambient_light_color** **(** **)** const +- :ref:`Color` **get_ambient_light_color** **(** **)** const .. _class_Environment_get_ambient_light_energy: -- :ref:`float` **get_ambient_light_energy** **(** **)** const +- :ref:`float` **get_ambient_light_energy** **(** **)** const .. _class_Environment_get_ambient_light_sky_contribution: -- :ref:`float` **get_ambient_light_sky_contribution** **(** **)** const +- :ref:`float` **get_ambient_light_sky_contribution** **(** **)** const .. _class_Environment_get_background: -- :ref:`int` **get_background** **(** **)** const +- :ref:`int` **get_background** **(** **)** const .. _class_Environment_get_bg_color: -- :ref:`Color` **get_bg_color** **(** **)** const +- :ref:`Color` **get_bg_color** **(** **)** const .. _class_Environment_get_bg_energy: -- :ref:`float` **get_bg_energy** **(** **)** const +- :ref:`float` **get_bg_energy** **(** **)** const .. _class_Environment_get_canvas_max_layer: -- :ref:`int` **get_canvas_max_layer** **(** **)** const +- :ref:`int` **get_canvas_max_layer** **(** **)** const .. _class_Environment_get_dof_blur_far_amount: -- :ref:`float` **get_dof_blur_far_amount** **(** **)** const +- :ref:`float` **get_dof_blur_far_amount** **(** **)** const .. _class_Environment_get_dof_blur_far_distance: -- :ref:`float` **get_dof_blur_far_distance** **(** **)** const +- :ref:`float` **get_dof_blur_far_distance** **(** **)** const .. _class_Environment_get_dof_blur_far_quality: -- :ref:`int` **get_dof_blur_far_quality** **(** **)** const +- :ref:`int` **get_dof_blur_far_quality** **(** **)** const .. _class_Environment_get_dof_blur_far_transition: -- :ref:`float` **get_dof_blur_far_transition** **(** **)** const +- :ref:`float` **get_dof_blur_far_transition** **(** **)** const .. _class_Environment_get_dof_blur_near_amount: -- :ref:`float` **get_dof_blur_near_amount** **(** **)** const +- :ref:`float` **get_dof_blur_near_amount** **(** **)** const .. _class_Environment_get_dof_blur_near_distance: -- :ref:`float` **get_dof_blur_near_distance** **(** **)** const +- :ref:`float` **get_dof_blur_near_distance** **(** **)** const .. _class_Environment_get_dof_blur_near_quality: -- :ref:`int` **get_dof_blur_near_quality** **(** **)** const +- :ref:`int` **get_dof_blur_near_quality** **(** **)** const .. _class_Environment_get_dof_blur_near_transition: -- :ref:`float` **get_dof_blur_near_transition** **(** **)** const +- :ref:`float` **get_dof_blur_near_transition** **(** **)** const .. _class_Environment_get_fog_color: -- :ref:`Color` **get_fog_color** **(** **)** const +- :ref:`Color` **get_fog_color** **(** **)** const .. _class_Environment_get_fog_depth_begin: -- :ref:`float` **get_fog_depth_begin** **(** **)** const +- :ref:`float` **get_fog_depth_begin** **(** **)** const .. _class_Environment_get_fog_depth_curve: -- :ref:`float` **get_fog_depth_curve** **(** **)** const +- :ref:`float` **get_fog_depth_curve** **(** **)** const .. _class_Environment_get_fog_height_curve: -- :ref:`float` **get_fog_height_curve** **(** **)** const +- :ref:`float` **get_fog_height_curve** **(** **)** const .. _class_Environment_get_fog_height_max: -- :ref:`float` **get_fog_height_max** **(** **)** const +- :ref:`float` **get_fog_height_max** **(** **)** const .. _class_Environment_get_fog_height_min: -- :ref:`float` **get_fog_height_min** **(** **)** const +- :ref:`float` **get_fog_height_min** **(** **)** const .. _class_Environment_get_fog_sun_amount: -- :ref:`float` **get_fog_sun_amount** **(** **)** const +- :ref:`float` **get_fog_sun_amount** **(** **)** const .. _class_Environment_get_fog_sun_color: -- :ref:`Color` **get_fog_sun_color** **(** **)** const +- :ref:`Color` **get_fog_sun_color** **(** **)** const .. _class_Environment_get_fog_transmit_curve: -- :ref:`float` **get_fog_transmit_curve** **(** **)** const +- :ref:`float` **get_fog_transmit_curve** **(** **)** const .. _class_Environment_get_glow_blend_mode: -- :ref:`int` **get_glow_blend_mode** **(** **)** const +- :ref:`int` **get_glow_blend_mode** **(** **)** const .. _class_Environment_get_glow_bloom: -- :ref:`float` **get_glow_bloom** **(** **)** const +- :ref:`float` **get_glow_bloom** **(** **)** const .. _class_Environment_get_glow_hdr_bleed_scale: -- :ref:`float` **get_glow_hdr_bleed_scale** **(** **)** const +- :ref:`float` **get_glow_hdr_bleed_scale** **(** **)** const .. _class_Environment_get_glow_hdr_bleed_threshold: -- :ref:`float` **get_glow_hdr_bleed_threshold** **(** **)** const +- :ref:`float` **get_glow_hdr_bleed_threshold** **(** **)** const .. _class_Environment_get_glow_intensity: -- :ref:`float` **get_glow_intensity** **(** **)** const +- :ref:`float` **get_glow_intensity** **(** **)** const .. _class_Environment_get_glow_strength: -- :ref:`float` **get_glow_strength** **(** **)** const +- :ref:`float` **get_glow_strength** **(** **)** const .. _class_Environment_get_sky: -- :ref:`Sky` **get_sky** **(** **)** const +- :ref:`Sky` **get_sky** **(** **)** const .. _class_Environment_get_sky_custom_fov: -- :ref:`float` **get_sky_custom_fov** **(** **)** const +- :ref:`float` **get_sky_custom_fov** **(** **)** const .. _class_Environment_get_ssao_bias: -- :ref:`float` **get_ssao_bias** **(** **)** const +- :ref:`float` **get_ssao_bias** **(** **)** const .. _class_Environment_get_ssao_color: -- :ref:`Color` **get_ssao_color** **(** **)** const +- :ref:`Color` **get_ssao_color** **(** **)** const .. _class_Environment_get_ssao_direct_light_affect: -- :ref:`float` **get_ssao_direct_light_affect** **(** **)** const +- :ref:`float` **get_ssao_direct_light_affect** **(** **)** const .. _class_Environment_get_ssao_intensity: -- :ref:`float` **get_ssao_intensity** **(** **)** const +- :ref:`float` **get_ssao_intensity** **(** **)** const .. _class_Environment_get_ssao_intensity2: -- :ref:`float` **get_ssao_intensity2** **(** **)** const +- :ref:`float` **get_ssao_intensity2** **(** **)** const .. _class_Environment_get_ssao_radius: -- :ref:`float` **get_ssao_radius** **(** **)** const +- :ref:`float` **get_ssao_radius** **(** **)** const .. _class_Environment_get_ssao_radius2: -- :ref:`float` **get_ssao_radius2** **(** **)** const +- :ref:`float` **get_ssao_radius2** **(** **)** const .. _class_Environment_get_ssr_depth_tolerance: -- :ref:`float` **get_ssr_depth_tolerance** **(** **)** const +- :ref:`float` **get_ssr_depth_tolerance** **(** **)** const .. _class_Environment_get_ssr_fade_in: -- :ref:`float` **get_ssr_fade_in** **(** **)** const +- :ref:`float` **get_ssr_fade_in** **(** **)** const .. _class_Environment_get_ssr_fade_out: -- :ref:`float` **get_ssr_fade_out** **(** **)** const +- :ref:`float` **get_ssr_fade_out** **(** **)** const .. _class_Environment_get_ssr_max_steps: -- :ref:`int` **get_ssr_max_steps** **(** **)** const +- :ref:`int` **get_ssr_max_steps** **(** **)** const .. _class_Environment_get_tonemap_auto_exposure: -- :ref:`bool` **get_tonemap_auto_exposure** **(** **)** const +- :ref:`bool` **get_tonemap_auto_exposure** **(** **)** const .. _class_Environment_get_tonemap_auto_exposure_grey: -- :ref:`float` **get_tonemap_auto_exposure_grey** **(** **)** const +- :ref:`float` **get_tonemap_auto_exposure_grey** **(** **)** const .. _class_Environment_get_tonemap_auto_exposure_max: -- :ref:`float` **get_tonemap_auto_exposure_max** **(** **)** const +- :ref:`float` **get_tonemap_auto_exposure_max** **(** **)** const .. _class_Environment_get_tonemap_auto_exposure_min: -- :ref:`float` **get_tonemap_auto_exposure_min** **(** **)** const +- :ref:`float` **get_tonemap_auto_exposure_min** **(** **)** const .. _class_Environment_get_tonemap_auto_exposure_speed: -- :ref:`float` **get_tonemap_auto_exposure_speed** **(** **)** const +- :ref:`float` **get_tonemap_auto_exposure_speed** **(** **)** const .. _class_Environment_get_tonemap_exposure: -- :ref:`float` **get_tonemap_exposure** **(** **)** const +- :ref:`float` **get_tonemap_exposure** **(** **)** const .. _class_Environment_get_tonemap_white: -- :ref:`float` **get_tonemap_white** **(** **)** const +- :ref:`float` **get_tonemap_white** **(** **)** const .. _class_Environment_get_tonemapper: -- :ref:`int` **get_tonemapper** **(** **)** const +- :ref:`int` **get_tonemapper** **(** **)** const .. _class_Environment_is_adjustment_enabled: -- :ref:`bool` **is_adjustment_enabled** **(** **)** const +- :ref:`bool` **is_adjustment_enabled** **(** **)** const .. _class_Environment_is_dof_blur_far_enabled: -- :ref:`bool` **is_dof_blur_far_enabled** **(** **)** const +- :ref:`bool` **is_dof_blur_far_enabled** **(** **)** const .. _class_Environment_is_dof_blur_near_enabled: -- :ref:`bool` **is_dof_blur_near_enabled** **(** **)** const +- :ref:`bool` **is_dof_blur_near_enabled** **(** **)** const .. _class_Environment_is_fog_depth_enabled: -- :ref:`bool` **is_fog_depth_enabled** **(** **)** const +- :ref:`bool` **is_fog_depth_enabled** **(** **)** const .. _class_Environment_is_fog_enabled: -- :ref:`bool` **is_fog_enabled** **(** **)** const +- :ref:`bool` **is_fog_enabled** **(** **)** const .. _class_Environment_is_fog_height_enabled: -- :ref:`bool` **is_fog_height_enabled** **(** **)** const +- :ref:`bool` **is_fog_height_enabled** **(** **)** const .. _class_Environment_is_fog_transmit_enabled: -- :ref:`bool` **is_fog_transmit_enabled** **(** **)** const +- :ref:`bool` **is_fog_transmit_enabled** **(** **)** const .. _class_Environment_is_glow_bicubic_upscale_enabled: -- :ref:`bool` **is_glow_bicubic_upscale_enabled** **(** **)** const +- :ref:`bool` **is_glow_bicubic_upscale_enabled** **(** **)** const .. _class_Environment_is_glow_enabled: -- :ref:`bool` **is_glow_enabled** **(** **)** const +- :ref:`bool` **is_glow_enabled** **(** **)** const .. _class_Environment_is_glow_level_enabled: -- :ref:`bool` **is_glow_level_enabled** **(** :ref:`int` idx **)** const +- :ref:`bool` **is_glow_level_enabled** **(** :ref:`int` idx **)** const .. _class_Environment_is_ssao_blur_enabled: -- :ref:`bool` **is_ssao_blur_enabled** **(** **)** const +- :ref:`bool` **is_ssao_blur_enabled** **(** **)** const .. _class_Environment_is_ssao_enabled: -- :ref:`bool` **is_ssao_enabled** **(** **)** const +- :ref:`bool` **is_ssao_enabled** **(** **)** const .. _class_Environment_is_ssr_enabled: -- :ref:`bool` **is_ssr_enabled** **(** **)** const +- :ref:`bool` **is_ssr_enabled** **(** **)** const .. _class_Environment_is_ssr_rough: -- :ref:`bool` **is_ssr_rough** **(** **)** const +- :ref:`bool` **is_ssr_rough** **(** **)** const .. _class_Environment_set_adjustment_brightness: -- void **set_adjustment_brightness** **(** :ref:`float` brightness **)** +- void **set_adjustment_brightness** **(** :ref:`float` brightness **)** .. _class_Environment_set_adjustment_color_correction: -- void **set_adjustment_color_correction** **(** :ref:`Texture` color_correction **)** +- void **set_adjustment_color_correction** **(** :ref:`Texture` color_correction **)** .. _class_Environment_set_adjustment_contrast: -- void **set_adjustment_contrast** **(** :ref:`float` contrast **)** +- void **set_adjustment_contrast** **(** :ref:`float` contrast **)** .. _class_Environment_set_adjustment_enable: -- void **set_adjustment_enable** **(** :ref:`bool` enabled **)** +- void **set_adjustment_enable** **(** :ref:`bool` enabled **)** .. _class_Environment_set_adjustment_saturation: -- void **set_adjustment_saturation** **(** :ref:`float` saturation **)** +- void **set_adjustment_saturation** **(** :ref:`float` saturation **)** .. _class_Environment_set_ambient_light_color: -- void **set_ambient_light_color** **(** :ref:`Color` color **)** +- void **set_ambient_light_color** **(** :ref:`Color` color **)** .. _class_Environment_set_ambient_light_energy: -- void **set_ambient_light_energy** **(** :ref:`float` energy **)** +- void **set_ambient_light_energy** **(** :ref:`float` energy **)** .. _class_Environment_set_ambient_light_sky_contribution: -- void **set_ambient_light_sky_contribution** **(** :ref:`float` energy **)** +- void **set_ambient_light_sky_contribution** **(** :ref:`float` energy **)** .. _class_Environment_set_background: -- void **set_background** **(** :ref:`int` mode **)** +- void **set_background** **(** :ref:`int` mode **)** .. _class_Environment_set_bg_color: -- void **set_bg_color** **(** :ref:`Color` color **)** +- void **set_bg_color** **(** :ref:`Color` color **)** .. _class_Environment_set_bg_energy: -- void **set_bg_energy** **(** :ref:`float` energy **)** +- void **set_bg_energy** **(** :ref:`float` energy **)** .. _class_Environment_set_canvas_max_layer: -- void **set_canvas_max_layer** **(** :ref:`int` layer **)** +- void **set_canvas_max_layer** **(** :ref:`int` layer **)** .. _class_Environment_set_dof_blur_far_amount: -- void **set_dof_blur_far_amount** **(** :ref:`float` intensity **)** +- void **set_dof_blur_far_amount** **(** :ref:`float` intensity **)** .. _class_Environment_set_dof_blur_far_distance: -- void **set_dof_blur_far_distance** **(** :ref:`float` intensity **)** +- void **set_dof_blur_far_distance** **(** :ref:`float` intensity **)** .. _class_Environment_set_dof_blur_far_enabled: -- void **set_dof_blur_far_enabled** **(** :ref:`bool` enabled **)** +- void **set_dof_blur_far_enabled** **(** :ref:`bool` enabled **)** .. _class_Environment_set_dof_blur_far_quality: -- void **set_dof_blur_far_quality** **(** :ref:`int` intensity **)** +- void **set_dof_blur_far_quality** **(** :ref:`int` intensity **)** .. _class_Environment_set_dof_blur_far_transition: -- void **set_dof_blur_far_transition** **(** :ref:`float` intensity **)** +- void **set_dof_blur_far_transition** **(** :ref:`float` intensity **)** .. _class_Environment_set_dof_blur_near_amount: -- void **set_dof_blur_near_amount** **(** :ref:`float` intensity **)** +- void **set_dof_blur_near_amount** **(** :ref:`float` intensity **)** .. _class_Environment_set_dof_blur_near_distance: -- void **set_dof_blur_near_distance** **(** :ref:`float` intensity **)** +- void **set_dof_blur_near_distance** **(** :ref:`float` intensity **)** .. _class_Environment_set_dof_blur_near_enabled: -- void **set_dof_blur_near_enabled** **(** :ref:`bool` enabled **)** +- void **set_dof_blur_near_enabled** **(** :ref:`bool` enabled **)** .. _class_Environment_set_dof_blur_near_quality: -- void **set_dof_blur_near_quality** **(** :ref:`int` level **)** +- void **set_dof_blur_near_quality** **(** :ref:`int` level **)** .. _class_Environment_set_dof_blur_near_transition: -- void **set_dof_blur_near_transition** **(** :ref:`float` intensity **)** +- void **set_dof_blur_near_transition** **(** :ref:`float` intensity **)** .. _class_Environment_set_fog_color: -- void **set_fog_color** **(** :ref:`Color` color **)** +- void **set_fog_color** **(** :ref:`Color` color **)** .. _class_Environment_set_fog_depth_begin: -- void **set_fog_depth_begin** **(** :ref:`float` distance **)** +- void **set_fog_depth_begin** **(** :ref:`float` distance **)** .. _class_Environment_set_fog_depth_curve: -- void **set_fog_depth_curve** **(** :ref:`float` curve **)** +- void **set_fog_depth_curve** **(** :ref:`float` curve **)** .. _class_Environment_set_fog_depth_enabled: -- void **set_fog_depth_enabled** **(** :ref:`bool` enabled **)** +- void **set_fog_depth_enabled** **(** :ref:`bool` enabled **)** .. _class_Environment_set_fog_enabled: -- void **set_fog_enabled** **(** :ref:`bool` enabled **)** +- void **set_fog_enabled** **(** :ref:`bool` enabled **)** .. _class_Environment_set_fog_height_curve: -- void **set_fog_height_curve** **(** :ref:`float` curve **)** +- void **set_fog_height_curve** **(** :ref:`float` curve **)** .. _class_Environment_set_fog_height_enabled: -- void **set_fog_height_enabled** **(** :ref:`bool` enabled **)** +- void **set_fog_height_enabled** **(** :ref:`bool` enabled **)** .. _class_Environment_set_fog_height_max: -- void **set_fog_height_max** **(** :ref:`float` height **)** +- void **set_fog_height_max** **(** :ref:`float` height **)** .. _class_Environment_set_fog_height_min: -- void **set_fog_height_min** **(** :ref:`float` height **)** +- void **set_fog_height_min** **(** :ref:`float` height **)** .. _class_Environment_set_fog_sun_amount: -- void **set_fog_sun_amount** **(** :ref:`float` amount **)** +- void **set_fog_sun_amount** **(** :ref:`float` amount **)** .. _class_Environment_set_fog_sun_color: -- void **set_fog_sun_color** **(** :ref:`Color` color **)** +- void **set_fog_sun_color** **(** :ref:`Color` color **)** .. _class_Environment_set_fog_transmit_curve: -- void **set_fog_transmit_curve** **(** :ref:`float` curve **)** +- void **set_fog_transmit_curve** **(** :ref:`float` curve **)** .. _class_Environment_set_fog_transmit_enabled: -- void **set_fog_transmit_enabled** **(** :ref:`bool` enabled **)** +- void **set_fog_transmit_enabled** **(** :ref:`bool` enabled **)** .. _class_Environment_set_glow_bicubic_upscale: -- void **set_glow_bicubic_upscale** **(** :ref:`bool` enabled **)** +- void **set_glow_bicubic_upscale** **(** :ref:`bool` enabled **)** .. _class_Environment_set_glow_blend_mode: -- void **set_glow_blend_mode** **(** :ref:`int` mode **)** +- void **set_glow_blend_mode** **(** :ref:`int` mode **)** .. _class_Environment_set_glow_bloom: -- void **set_glow_bloom** **(** :ref:`float` amount **)** +- void **set_glow_bloom** **(** :ref:`float` amount **)** .. _class_Environment_set_glow_enabled: -- void **set_glow_enabled** **(** :ref:`bool` enabled **)** +- void **set_glow_enabled** **(** :ref:`bool` enabled **)** .. _class_Environment_set_glow_hdr_bleed_scale: -- void **set_glow_hdr_bleed_scale** **(** :ref:`float` scale **)** +- void **set_glow_hdr_bleed_scale** **(** :ref:`float` scale **)** .. _class_Environment_set_glow_hdr_bleed_threshold: -- void **set_glow_hdr_bleed_threshold** **(** :ref:`float` threshold **)** +- void **set_glow_hdr_bleed_threshold** **(** :ref:`float` threshold **)** .. _class_Environment_set_glow_intensity: -- void **set_glow_intensity** **(** :ref:`float` intensity **)** +- void **set_glow_intensity** **(** :ref:`float` intensity **)** .. _class_Environment_set_glow_level: -- void **set_glow_level** **(** :ref:`int` idx, :ref:`bool` enabled **)** +- void **set_glow_level** **(** :ref:`int` idx, :ref:`bool` enabled **)** .. _class_Environment_set_glow_strength: -- void **set_glow_strength** **(** :ref:`float` strength **)** +- void **set_glow_strength** **(** :ref:`float` strength **)** .. _class_Environment_set_sky: -- void **set_sky** **(** :ref:`Sky` sky **)** +- void **set_sky** **(** :ref:`Sky` sky **)** .. _class_Environment_set_sky_custom_fov: -- void **set_sky_custom_fov** **(** :ref:`float` scale **)** +- void **set_sky_custom_fov** **(** :ref:`float` scale **)** .. _class_Environment_set_ssao_bias: -- void **set_ssao_bias** **(** :ref:`float` bias **)** +- void **set_ssao_bias** **(** :ref:`float` bias **)** .. _class_Environment_set_ssao_blur: -- void **set_ssao_blur** **(** :ref:`bool` enabled **)** +- void **set_ssao_blur** **(** :ref:`bool` enabled **)** .. _class_Environment_set_ssao_color: -- void **set_ssao_color** **(** :ref:`Color` color **)** +- void **set_ssao_color** **(** :ref:`Color` color **)** .. _class_Environment_set_ssao_direct_light_affect: -- void **set_ssao_direct_light_affect** **(** :ref:`float` amount **)** +- void **set_ssao_direct_light_affect** **(** :ref:`float` amount **)** .. _class_Environment_set_ssao_enabled: -- void **set_ssao_enabled** **(** :ref:`bool` enabled **)** +- void **set_ssao_enabled** **(** :ref:`bool` enabled **)** .. _class_Environment_set_ssao_intensity: -- void **set_ssao_intensity** **(** :ref:`float` intensity **)** +- void **set_ssao_intensity** **(** :ref:`float` intensity **)** .. _class_Environment_set_ssao_intensity2: -- void **set_ssao_intensity2** **(** :ref:`float` intensity **)** +- void **set_ssao_intensity2** **(** :ref:`float` intensity **)** .. _class_Environment_set_ssao_radius: -- void **set_ssao_radius** **(** :ref:`float` radius **)** +- void **set_ssao_radius** **(** :ref:`float` radius **)** .. _class_Environment_set_ssao_radius2: -- void **set_ssao_radius2** **(** :ref:`float` radius **)** +- void **set_ssao_radius2** **(** :ref:`float` radius **)** .. _class_Environment_set_ssr_depth_tolerance: -- void **set_ssr_depth_tolerance** **(** :ref:`float` depth_tolerance **)** +- void **set_ssr_depth_tolerance** **(** :ref:`float` depth_tolerance **)** .. _class_Environment_set_ssr_enabled: -- void **set_ssr_enabled** **(** :ref:`bool` enabled **)** +- void **set_ssr_enabled** **(** :ref:`bool` enabled **)** .. _class_Environment_set_ssr_fade_in: -- void **set_ssr_fade_in** **(** :ref:`float` fade_in **)** +- void **set_ssr_fade_in** **(** :ref:`float` fade_in **)** .. _class_Environment_set_ssr_fade_out: -- void **set_ssr_fade_out** **(** :ref:`float` fade_out **)** +- void **set_ssr_fade_out** **(** :ref:`float` fade_out **)** .. _class_Environment_set_ssr_max_steps: -- void **set_ssr_max_steps** **(** :ref:`int` max_steps **)** +- void **set_ssr_max_steps** **(** :ref:`int` max_steps **)** .. _class_Environment_set_ssr_rough: -- void **set_ssr_rough** **(** :ref:`bool` rough **)** +- void **set_ssr_rough** **(** :ref:`bool` rough **)** .. _class_Environment_set_tonemap_auto_exposure: -- void **set_tonemap_auto_exposure** **(** :ref:`bool` auto_exposure **)** +- void **set_tonemap_auto_exposure** **(** :ref:`bool` auto_exposure **)** .. _class_Environment_set_tonemap_auto_exposure_grey: -- void **set_tonemap_auto_exposure_grey** **(** :ref:`float` exposure_grey **)** +- void **set_tonemap_auto_exposure_grey** **(** :ref:`float` exposure_grey **)** .. _class_Environment_set_tonemap_auto_exposure_max: -- void **set_tonemap_auto_exposure_max** **(** :ref:`float` exposure_max **)** +- void **set_tonemap_auto_exposure_max** **(** :ref:`float` exposure_max **)** .. _class_Environment_set_tonemap_auto_exposure_min: -- void **set_tonemap_auto_exposure_min** **(** :ref:`float` exposure_min **)** +- void **set_tonemap_auto_exposure_min** **(** :ref:`float` exposure_min **)** .. _class_Environment_set_tonemap_auto_exposure_speed: -- void **set_tonemap_auto_exposure_speed** **(** :ref:`float` exposure_speed **)** +- void **set_tonemap_auto_exposure_speed** **(** :ref:`float` exposure_speed **)** .. _class_Environment_set_tonemap_exposure: -- void **set_tonemap_exposure** **(** :ref:`float` exposure **)** +- void **set_tonemap_exposure** **(** :ref:`float` exposure **)** .. _class_Environment_set_tonemap_white: -- void **set_tonemap_white** **(** :ref:`float` white **)** +- void **set_tonemap_white** **(** :ref:`float` white **)** .. _class_Environment_set_tonemapper: -- void **set_tonemapper** **(** :ref:`int` mode **)** +- void **set_tonemapper** **(** :ref:`int` mode **)** diff --git a/classes/class_file.rst b/classes/class_file.rst index 98fd8a070..824c66a88 100644 --- a/classes/class_file.rst +++ b/classes/class_file.rst @@ -19,93 +19,93 @@ Type to handle file reading and writing operations. Member Functions ---------------- -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`close` **(** **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`eof_reached` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`file_exists` **(** :ref:`String` path **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_16` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_32` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_64` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_8` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_as_text` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`get_buffer` **(** :ref:`int` len **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_csv_line` **(** :ref:`String` delim="," **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_double` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_endian_swap` **(** **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_error` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_float` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_len` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_line` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_md5` **(** :ref:`String` path **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_modified_time` **(** :ref:`String` file **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_pascal_string` **(** **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_position` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_real` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_sha256` **(** :ref:`String` path **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_var` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_open` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`open` **(** :ref:`String` path, :ref:`int` flags **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`open_compressed` **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`int` compression_mode=0 **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`open_encrypted` **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`PoolByteArray` key **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`open_encrypted_with_pass` **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`String` pass **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`seek` **(** :ref:`int` position **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`seek_end` **(** :ref:`int` position=0 **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_endian_swap` **(** :ref:`bool` enable **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_16` **(** :ref:`int` value **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_32` **(** :ref:`int` value **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_64` **(** :ref:`int` value **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_8` **(** :ref:`int` value **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_buffer` **(** :ref:`PoolByteArray` buffer **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_double` **(** :ref:`float` value **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_float` **(** :ref:`float` value **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_line` **(** :ref:`String` line **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_pascal_string` **(** :ref:`String` string **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_real` **(** :ref:`float` value **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_string` **(** :ref:`String` string **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_var` **(** :ref:`Variant` value **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`close` **(** **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`eof_reached` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`file_exists` **(** :ref:`String` path **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_16` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_32` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_64` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_8` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_as_text` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`get_buffer` **(** :ref:`int` len **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_csv_line` **(** :ref:`String` delim="," **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_double` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_endian_swap` **(** **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_error` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_float` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_len` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_line` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_md5` **(** :ref:`String` path **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_modified_time` **(** :ref:`String` file **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_pascal_string` **(** **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_position` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_real` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_sha256` **(** :ref:`String` path **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_var` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_open` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`open` **(** :ref:`String` path, :ref:`int` flags **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`open_compressed` **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`int` compression_mode=0 **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`open_encrypted` **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`PoolByteArray` key **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`open_encrypted_with_pass` **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`String` pass **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`seek` **(** :ref:`int` position **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`seek_end` **(** :ref:`int` position=0 **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_endian_swap` **(** :ref:`bool` enable **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_16` **(** :ref:`int` value **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_32` **(** :ref:`int` value **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_64` **(** :ref:`int` value **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_8` **(** :ref:`int` value **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_buffer` **(** :ref:`PoolByteArray` buffer **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_double` **(** :ref:`float` value **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_float` **(** :ref:`float` value **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_line` **(** :ref:`String` line **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_pascal_string` **(** :ref:`String` string **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_real` **(** :ref:`float` value **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_string` **(** :ref:`String` string **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_var` **(** :ref:`Variant` value **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -146,187 +146,187 @@ Member Function Description .. _class_File_close: -- void **close** **(** **)** +- void **close** **(** **)** Closes the currently opened file. .. _class_File_eof_reached: -- :ref:`bool` **eof_reached** **(** **)** const +- :ref:`bool` **eof_reached** **(** **)** const Returns ``true`` if the file cursor has reached the end of the file. .. _class_File_file_exists: -- :ref:`bool` **file_exists** **(** :ref:`String` path **)** const +- :ref:`bool` **file_exists** **(** :ref:`String` path **)** const Returns ``true`` if the file exists in the given path. .. _class_File_get_16: -- :ref:`int` **get_16** **(** **)** const +- :ref:`int` **get_16** **(** **)** const Returns the next 16 bits from the file as an integer. .. _class_File_get_32: -- :ref:`int` **get_32** **(** **)** const +- :ref:`int` **get_32** **(** **)** const Returns the next 32 bits from the file as an integer. .. _class_File_get_64: -- :ref:`int` **get_64** **(** **)** const +- :ref:`int` **get_64** **(** **)** const Returns the next 64 bits from the file as an integer. .. _class_File_get_8: -- :ref:`int` **get_8** **(** **)** const +- :ref:`int` **get_8** **(** **)** const Returns the next 8 bits from the file as an integer. .. _class_File_get_as_text: -- :ref:`String` **get_as_text** **(** **)** const +- :ref:`String` **get_as_text** **(** **)** const Returns the whole file as a :ref:`String`. .. _class_File_get_buffer: -- :ref:`PoolByteArray` **get_buffer** **(** :ref:`int` len **)** const +- :ref:`PoolByteArray` **get_buffer** **(** :ref:`int` len **)** const Returns next ``len`` bytes of the file as a :ref:`PoolByteArray`. .. _class_File_get_csv_line: -- :ref:`PoolStringArray` **get_csv_line** **(** :ref:`String` delim="," **)** const +- :ref:`PoolStringArray` **get_csv_line** **(** :ref:`String` delim="," **)** const Returns the next value of the file in CSV (Comma Separated Values) format. You can pass a different delimiter to use other than the default "," (comma). .. _class_File_get_double: -- :ref:`float` **get_double** **(** **)** const +- :ref:`float` **get_double** **(** **)** const Returns the next 64 bits from the file as a floating point number. .. _class_File_get_endian_swap: -- :ref:`bool` **get_endian_swap** **(** **)** +- :ref:`bool` **get_endian_swap** **(** **)** Returns ``true`` if endian swap is enabled for this file. .. _class_File_get_error: -- :ref:`int` **get_error** **(** **)** const +- :ref:`int` **get_error** **(** **)** const Returns the last error that happened when trying to perform operations. Compare with the ``ERR_FILE\_\*`` constants from :ref:`@Global Scope`. .. _class_File_get_float: -- :ref:`float` **get_float** **(** **)** const +- :ref:`float` **get_float** **(** **)** const Returns the next 32 bits from the file as a floating point number. .. _class_File_get_len: -- :ref:`int` **get_len** **(** **)** const +- :ref:`int` **get_len** **(** **)** const Returns the size of the file in bytes. .. _class_File_get_line: -- :ref:`String` **get_line** **(** **)** const +- :ref:`String` **get_line** **(** **)** const Returns the next line of the file as a :ref:`String`. .. _class_File_get_md5: -- :ref:`String` **get_md5** **(** :ref:`String` path **)** const +- :ref:`String` **get_md5** **(** :ref:`String` path **)** const Returns an MD5 String representing the file at the given path or an empty :ref:`String` on failure. .. _class_File_get_modified_time: -- :ref:`int` **get_modified_time** **(** :ref:`String` file **)** const +- :ref:`int` **get_modified_time** **(** :ref:`String` file **)** const Returns the last time the ``file`` was modified in unix timestamp format or returns a :ref:`String` "ERROR IN ``file``". This unix timestamp can be converted to datetime by using :ref:`OS.get_datetime_from_unix_time`. .. _class_File_get_pascal_string: -- :ref:`String` **get_pascal_string** **(** **)** +- :ref:`String` **get_pascal_string** **(** **)** Returns a :ref:`String` saved in Pascal format from the file. .. _class_File_get_position: -- :ref:`int` **get_position** **(** **)** const +- :ref:`int` **get_position** **(** **)** const Returns the file cursor's position. .. _class_File_get_real: -- :ref:`float` **get_real** **(** **)** const +- :ref:`float` **get_real** **(** **)** const Returns the next bits from the file as a floating point number. .. _class_File_get_sha256: -- :ref:`String` **get_sha256** **(** :ref:`String` path **)** const +- :ref:`String` **get_sha256** **(** :ref:`String` path **)** const Returns a SHA-256 :ref:`String` representing the file at the given path or an empty :ref:`String` on failure. .. _class_File_get_var: -- :ref:`Variant` **get_var** **(** **)** const +- :ref:`Variant` **get_var** **(** **)** const Returns the next :ref:`Variant` value from the file. .. _class_File_is_open: -- :ref:`bool` **is_open** **(** **)** const +- :ref:`bool` **is_open** **(** **)** const Returns ``true`` if the file is currently opened. .. _class_File_open: -- :ref:`int` **open** **(** :ref:`String` path, :ref:`int` flags **)** +- :ref:`int` **open** **(** :ref:`String` path, :ref:`int` flags **)** Opens the file for writing or reading, depending on the flags. .. _class_File_open_compressed: -- :ref:`int` **open_compressed** **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`int` compression_mode=0 **)** +- :ref:`int` **open_compressed** **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`int` compression_mode=0 **)** Opens a compressed file for reading or writing. Use COMPRESSION\_\* constants to set ``compression_mode``. .. _class_File_open_encrypted: -- :ref:`int` **open_encrypted** **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`PoolByteArray` key **)** +- :ref:`int` **open_encrypted** **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`PoolByteArray` key **)** Opens an encrypted file in write or read mode. You need to pass a binary key to encrypt/decrypt it. .. _class_File_open_encrypted_with_pass: -- :ref:`int` **open_encrypted_with_pass** **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`String` pass **)** +- :ref:`int` **open_encrypted_with_pass** **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`String` pass **)** Opens an encrypted file in write or read mode. You need to pass a password to encrypt/decrypt it. .. _class_File_seek: -- void **seek** **(** :ref:`int` position **)** +- void **seek** **(** :ref:`int` position **)** Change the file reading/writing cursor to the specified position (in bytes from the beginning of the file). .. _class_File_seek_end: -- void **seek_end** **(** :ref:`int` position=0 **)** +- void **seek_end** **(** :ref:`int` position=0 **)** Changes the file reading/writing cursor to the specified position (in bytes from the end of the file). Note that this is an offset, so you should use negative numbers or the cursor will be at the end of the file. .. _class_File_set_endian_swap: -- void **set_endian_swap** **(** :ref:`bool` enable **)** +- void **set_endian_swap** **(** :ref:`bool` enable **)** If ``true`` the file's endianness is swapped. Use this if you're dealing with files written in big endian machines. @@ -334,73 +334,73 @@ Note that this is about the file format, not CPU type. This is always reseted to .. _class_File_store_16: -- void **store_16** **(** :ref:`int` value **)** +- void **store_16** **(** :ref:`int` value **)** Stores an integer as 16 bits in the file. .. _class_File_store_32: -- void **store_32** **(** :ref:`int` value **)** +- void **store_32** **(** :ref:`int` value **)** Stores an integer as 32 bits in the file. .. _class_File_store_64: -- void **store_64** **(** :ref:`int` value **)** +- void **store_64** **(** :ref:`int` value **)** Stores an integer as 64 bits in the file. .. _class_File_store_8: -- void **store_8** **(** :ref:`int` value **)** +- void **store_8** **(** :ref:`int` value **)** Stores an integer as 8 bits in the file. .. _class_File_store_buffer: -- void **store_buffer** **(** :ref:`PoolByteArray` buffer **)** +- void **store_buffer** **(** :ref:`PoolByteArray` buffer **)** Stores the given array of bytes in the file. .. _class_File_store_double: -- void **store_double** **(** :ref:`float` value **)** +- void **store_double** **(** :ref:`float` value **)** Stores a floating point number as 64 bits in the file. .. _class_File_store_float: -- void **store_float** **(** :ref:`float` value **)** +- void **store_float** **(** :ref:`float` value **)** Stores a floating point number as 32 bits in the file. .. _class_File_store_line: -- void **store_line** **(** :ref:`String` line **)** +- void **store_line** **(** :ref:`String` line **)** Stores the given :ref:`String` as a line in the file. .. _class_File_store_pascal_string: -- void **store_pascal_string** **(** :ref:`String` string **)** +- void **store_pascal_string** **(** :ref:`String` string **)** Stores the given :ref:`String` as a line in the file in Pascal format (i.e. also store the length of the string). .. _class_File_store_real: -- void **store_real** **(** :ref:`float` value **)** +- void **store_real** **(** :ref:`float` value **)** Stores a floating point number in the file. .. _class_File_store_string: -- void **store_string** **(** :ref:`String` string **)** +- void **store_string** **(** :ref:`String` string **)** Stores the given :ref:`String` in the file. .. _class_File_store_var: -- void **store_var** **(** :ref:`Variant` value **)** +- void **store_var** **(** :ref:`Variant` value **)** Stores any Variant value in the file. diff --git a/classes/class_filedialog.rst b/classes/class_filedialog.rst index 3c913d962..f23c804cd 100644 --- a/classes/class_filedialog.rst +++ b/classes/class_filedialog.rst @@ -19,62 +19,62 @@ Dialog for selecting files or directories in the filesystem. Member Functions ---------------- -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_filter` **(** :ref:`String` filter **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_filters` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_access` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_current_dir` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_current_file` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_current_path` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_filters` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_mode` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`VBoxContainer` | :ref:`get_vbox` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`invalidate` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_showing_hidden_files` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_access` **(** :ref:`int` access **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_current_dir` **(** :ref:`String` dir **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_current_file` **(** :ref:`String` file **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_current_path` **(** :ref:`String` path **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_filters` **(** :ref:`PoolStringArray` filters **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mode` **(** :ref:`int` mode **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_show_hidden_files` **(** :ref:`bool` show **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_filter` **(** :ref:`String` filter **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_filters` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_access` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_current_dir` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_current_file` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_current_path` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_filters` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_mode` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`VBoxContainer` | :ref:`get_vbox` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`invalidate` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_showing_hidden_files` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_access` **(** :ref:`int` access **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_current_dir` **(** :ref:`String` dir **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_current_file` **(** :ref:`String` file **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_current_path` **(** :ref:`String` path **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_filters` **(** :ref:`PoolStringArray` filters **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_mode` **(** :ref:`int` mode **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_show_hidden_files` **(** :ref:`bool` show **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_FileDialog_dir_selected: -- **dir_selected** **(** :ref:`String` dir **)** +- **dir_selected** **(** :ref:`String` dir **)** Event emitted when the user selects a directory. .. _class_FileDialog_file_selected: -- **file_selected** **(** :ref:`String` path **)** +- **file_selected** **(** :ref:`String` path **)** Event emitted when the user selects a file (double clicks it or presses the OK button). .. _class_FileDialog_files_selected: -- **files_selected** **(** :ref:`PoolStringArray` paths **)** +- **files_selected** **(** :ref:`PoolStringArray` paths **)** Event emitted when the user selects multiple files. @@ -121,105 +121,105 @@ Member Function Description .. _class_FileDialog_add_filter: -- void **add_filter** **(** :ref:`String` filter **)** +- void **add_filter** **(** :ref:`String` filter **)** Add a custom filter. Filter format is: "mask ; description", example (C++): dialog->add_filter("\*.png ; PNG Images"); .. _class_FileDialog_clear_filters: -- void **clear_filters** **(** **)** +- void **clear_filters** **(** **)** Clear all the added filters in the dialog. .. _class_FileDialog_get_access: -- :ref:`int` **get_access** **(** **)** const +- :ref:`int` **get_access** **(** **)** const Return the file access permission of the dialog. .. _class_FileDialog_get_current_dir: -- :ref:`String` **get_current_dir** **(** **)** const +- :ref:`String` **get_current_dir** **(** **)** const Get the current working directory of the file dialog. .. _class_FileDialog_get_current_file: -- :ref:`String` **get_current_file** **(** **)** const +- :ref:`String` **get_current_file** **(** **)** const Get the current selected file of the file dialog (empty if none). .. _class_FileDialog_get_current_path: -- :ref:`String` **get_current_path** **(** **)** const +- :ref:`String` **get_current_path** **(** **)** const Get the current selected path (directory and file) of the file dialog (empty if none). .. _class_FileDialog_get_filters: -- :ref:`PoolStringArray` **get_filters** **(** **)** const +- :ref:`PoolStringArray` **get_filters** **(** **)** const .. _class_FileDialog_get_mode: -- :ref:`int` **get_mode** **(** **)** const +- :ref:`int` **get_mode** **(** **)** const Get the file dialog mode from the MODE\_\* enum. .. _class_FileDialog_get_vbox: -- :ref:`VBoxContainer` **get_vbox** **(** **)** +- :ref:`VBoxContainer` **get_vbox** **(** **)** Return the vertical box container of the dialog, custom controls can be added to it. .. _class_FileDialog_invalidate: -- void **invalidate** **(** **)** +- void **invalidate** **(** **)** Invalidate and update the current dialog content list. .. _class_FileDialog_is_showing_hidden_files: -- :ref:`bool` **is_showing_hidden_files** **(** **)** const +- :ref:`bool` **is_showing_hidden_files** **(** **)** const Return true if the dialog allows show hidden files. .. _class_FileDialog_set_access: -- void **set_access** **(** :ref:`int` access **)** +- void **set_access** **(** :ref:`int` access **)** Set the file access permission of the dialog(Must be one of ACCESS_RESOURCES, ACCESS_USERDATA or ACCESS_FILESYSTEM). .. _class_FileDialog_set_current_dir: -- void **set_current_dir** **(** :ref:`String` dir **)** +- void **set_current_dir** **(** :ref:`String` dir **)** Set the current working directory of the file dialog. .. _class_FileDialog_set_current_file: -- void **set_current_file** **(** :ref:`String` file **)** +- void **set_current_file** **(** :ref:`String` file **)** Set the current selected file name of the file dialog. .. _class_FileDialog_set_current_path: -- void **set_current_path** **(** :ref:`String` path **)** +- void **set_current_path** **(** :ref:`String` path **)** Set the current selected file path of the file dialog. .. _class_FileDialog_set_filters: -- void **set_filters** **(** :ref:`PoolStringArray` filters **)** +- void **set_filters** **(** :ref:`PoolStringArray` filters **)** .. _class_FileDialog_set_mode: -- void **set_mode** **(** :ref:`int` mode **)** +- void **set_mode** **(** :ref:`int` mode **)** Set the file dialog mode from the MODE\_\* enum. .. _class_FileDialog_set_show_hidden_files: -- void **set_show_hidden_files** **(** :ref:`bool` show **)** +- void **set_show_hidden_files** **(** :ref:`bool` show **)** Set the dialog should show hidden files. diff --git a/classes/class_float.rst b/classes/class_float.rst index a403d9be0..37e354bfa 100644 --- a/classes/class_float.rst +++ b/classes/class_float.rst @@ -17,13 +17,13 @@ Float built-in type Member Functions ---------------- -+----------------------------+--------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`float` **(** :ref:`bool` from **)** | -+----------------------------+--------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`float` **(** :ref:`int` from **)** | -+----------------------------+--------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`float` **(** :ref:`String` from **)** | -+----------------------------+--------------------------------------------------------------------------------+ ++----------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`float` **(** :ref:`bool` from **)** | ++----------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`float` **(** :ref:`int` from **)** | ++----------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`float` **(** :ref:`String` from **)** | ++----------------------------+------------------------------------------------------------------------------+ Description ----------- @@ -35,19 +35,19 @@ Member Function Description .. _class_float_float: -- :ref:`float` **float** **(** :ref:`bool` from **)** +- :ref:`float` **float** **(** :ref:`bool` from **)** Cast a :ref:`bool` value to a floating point value, ``float(true)`` will be equals to 1.0 and ``float(false)`` will be equals to 0.0. .. _class_float_float: -- :ref:`float` **float** **(** :ref:`int` from **)** +- :ref:`float` **float** **(** :ref:`int` from **)** Cast an :ref:`int` value to a floating point value, ``float(1)`` will be equals to 1.0. .. _class_float_float: -- :ref:`float` **float** **(** :ref:`String` from **)** +- :ref:`float` **float** **(** :ref:`String` from **)** Cast a :ref:`String` value to a floating point value. This method accepts float value strings like `` '1.23' `` and exponential notation strings for its parameter so calling `` float('1e3') `` will return 1000.0 and calling `` float('1e-3') `` will return -0.001. diff --git a/classes/class_font.rst b/classes/class_font.rst index 0d1e8571f..2eb65499f 100644 --- a/classes/class_font.rst +++ b/classes/class_font.rst @@ -21,23 +21,23 @@ Internationalized font and text drawing support. Member Functions ---------------- -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw` **(** :ref:`RID` canvas_item, :ref:`Vector2` position, :ref:`String` string, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`int` clip_w=-1 **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`draw_char` **(** :ref:`RID` canvas_item, :ref:`Vector2` position, :ref:`int` char, :ref:`int` next=-1, :ref:`Color` modulate=Color( 1, 1, 1, 1 ) **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ascent` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_descent` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_height` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_string_size` **(** :ref:`String` string **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_distance_field_hint` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`update_changes` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw` **(** :ref:`RID` canvas_item, :ref:`Vector2` position, :ref:`String` string, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`int` clip_w=-1 **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`draw_char` **(** :ref:`RID` canvas_item, :ref:`Vector2` position, :ref:`int` char, :ref:`int` next=-1, :ref:`Color` modulate=Color( 1, 1, 1, 1 ) **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_ascent` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_descent` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_height` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_string_size` **(** :ref:`String` string **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_distance_field_hint` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`update_changes` **(** **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -49,47 +49,47 @@ Member Function Description .. _class_Font_draw: -- void **draw** **(** :ref:`RID` canvas_item, :ref:`Vector2` position, :ref:`String` string, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`int` clip_w=-1 **)** const +- void **draw** **(** :ref:`RID` canvas_item, :ref:`Vector2` position, :ref:`String` string, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`int` clip_w=-1 **)** const Draw "string" into a canvas item using the font at a given position, with "modulate" color, and optionally clipping the width. "position" specifies the baseline, not the top. To draw from the top, *ascent* must be added to the Y axis. .. _class_Font_draw_char: -- :ref:`float` **draw_char** **(** :ref:`RID` canvas_item, :ref:`Vector2` position, :ref:`int` char, :ref:`int` next=-1, :ref:`Color` modulate=Color( 1, 1, 1, 1 ) **)** const +- :ref:`float` **draw_char** **(** :ref:`RID` canvas_item, :ref:`Vector2` position, :ref:`int` char, :ref:`int` next=-1, :ref:`Color` modulate=Color( 1, 1, 1, 1 ) **)** const Draw character "char" into a canvas item using the font at a given position, with "modulate" color, and optionally kerning if "next" is passed. clipping the width. "position" specifies the baseline, not the top. To draw from the top, *ascent* must be added to the Y axis. The width used by the character is returned, making this function useful for drawing strings character by character. .. _class_Font_get_ascent: -- :ref:`float` **get_ascent** **(** **)** const +- :ref:`float` **get_ascent** **(** **)** const Return the font ascent (number of pixels above the baseline). .. _class_Font_get_descent: -- :ref:`float` **get_descent** **(** **)** const +- :ref:`float` **get_descent** **(** **)** const Return the font descent (number of pixels below the baseline). .. _class_Font_get_height: -- :ref:`float` **get_height** **(** **)** const +- :ref:`float` **get_height** **(** **)** const Return the total font height (ascent plus descent) in pixels. .. _class_Font_get_string_size: -- :ref:`Vector2` **get_string_size** **(** :ref:`String` string **)** const +- :ref:`Vector2` **get_string_size** **(** :ref:`String` string **)** const Return the size of a string, taking kerning and advance into account. .. _class_Font_is_distance_field_hint: -- :ref:`bool` **is_distance_field_hint** **(** **)** const +- :ref:`bool` **is_distance_field_hint** **(** **)** const .. _class_Font_update_changes: -- void **update_changes** **(** **)** +- void **update_changes** **(** **)** After editing a font (changing size, ascent, char rects, etc.). Call this function to propagate changes to controls that might use it. diff --git a/classes/class_funcref.rst b/classes/class_funcref.rst index f36dae0f3..9bc12ebcf 100644 --- a/classes/class_funcref.rst +++ b/classes/class_funcref.rst @@ -19,13 +19,13 @@ Reference to a function in an object. Member Functions ---------------- -+--------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`call_func` **(** **)** vararg | -+--------------------------------+----------------------------------------------------------------------------------------------------+ -| void | :ref:`set_function` **(** :ref:`String` name **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------+ -| void | :ref:`set_instance` **(** :ref:`Object` instance **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------+ ++--------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`call_func` **(** **)** vararg | ++--------------------------------+--------------------------------------------------------------------------------------------------+ +| void | :ref:`set_function` **(** :ref:`String` name **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------+ +| void | :ref:`set_instance` **(** :ref:`Object` instance **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------+ Description ----------- @@ -39,19 +39,19 @@ Member Function Description .. _class_FuncRef_call_func: -- :ref:`Variant` **call_func** **(** **)** vararg +- :ref:`Variant` **call_func** **(** **)** vararg Calls the referenced function previously set by :ref:`set_function` or :ref:`@GDScript.funcref`. .. _class_FuncRef_set_function: -- void **set_function** **(** :ref:`String` name **)** +- void **set_function** **(** :ref:`String` name **)** The name of the referenced function to call on the object, without parentheses or any parameters. .. _class_FuncRef_set_instance: -- void **set_instance** **(** :ref:`Object` instance **)** +- void **set_instance** **(** :ref:`Object` instance **)** The object containing the referenced function. This object must be of a type actually inheriting from :ref:`Object`, not a built-in type such as :ref:`int`, :ref:`Vector2` or :ref:`Dictionary`. diff --git a/classes/class_gdfunctionstate.rst b/classes/class_gdfunctionstate.rst index f8b6e3a01..aeb6ba0e0 100644 --- a/classes/class_gdfunctionstate.rst +++ b/classes/class_gdfunctionstate.rst @@ -19,18 +19,18 @@ State of a function call after yielding. Member Functions ---------------- -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_valid` **(** :ref:`bool` extended_check=false **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`resume` **(** :ref:`Variant` arg=null **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_valid` **(** :ref:`bool` extended_check=false **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`resume` **(** :ref:`Variant` arg=null **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_GDFunctionState_completed: -- **completed** **(** :ref:`Nil` result **)** +- **completed** **(** :ref:`Nil` result **)** Description @@ -43,7 +43,7 @@ Member Function Description .. _class_GDFunctionState_is_valid: -- :ref:`bool` **is_valid** **(** :ref:`bool` extended_check=false **)** const +- :ref:`bool` **is_valid** **(** :ref:`bool` extended_check=false **)** const Check whether the function call may be resumed. This is not the case if the function state was already resumed. @@ -51,7 +51,7 @@ If ``extended_check`` is enabled, it also checks if the associated script and ob .. _class_GDFunctionState_resume: -- :ref:`Variant` **resume** **(** :ref:`Variant` arg=null **)** +- :ref:`Variant` **resume** **(** :ref:`Variant` arg=null **)** Resume execution of the yielded function call. diff --git a/classes/class_gdnative.rst b/classes/class_gdnative.rst index 17fa56b20..9e6ad539d 100644 --- a/classes/class_gdnative.rst +++ b/classes/class_gdnative.rst @@ -19,17 +19,17 @@ Brief Description Member Functions ---------------- -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`call_native` **(** :ref:`String` calling_type, :ref:`String` procedure_name, :ref:`Array` arguments **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`GDNativeLibrary` | :ref:`get_library` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`initialize` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_library` **(** :ref:`GDNativeLibrary` library **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`terminate` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`call_native` **(** :ref:`String` calling_type, :ref:`String` procedure_name, :ref:`Array` arguments **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`GDNativeLibrary` | :ref:`get_library` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`initialize` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_library` **(** :ref:`GDNativeLibrary` library **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`terminate` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -44,22 +44,22 @@ Member Function Description .. _class_GDNative_call_native: -- :ref:`Variant` **call_native** **(** :ref:`String` calling_type, :ref:`String` procedure_name, :ref:`Array` arguments **)** +- :ref:`Variant` **call_native** **(** :ref:`String` calling_type, :ref:`String` procedure_name, :ref:`Array` arguments **)** .. _class_GDNative_get_library: -- :ref:`GDNativeLibrary` **get_library** **(** **)** +- :ref:`GDNativeLibrary` **get_library** **(** **)** .. _class_GDNative_initialize: -- :ref:`bool` **initialize** **(** **)** +- :ref:`bool` **initialize** **(** **)** .. _class_GDNative_set_library: -- void **set_library** **(** :ref:`GDNativeLibrary` library **)** +- void **set_library** **(** :ref:`GDNativeLibrary` library **)** .. _class_GDNative_terminate: -- :ref:`bool` **terminate** **(** **)** +- :ref:`bool` **terminate** **(** **)** diff --git a/classes/class_gdnativeclass.rst b/classes/class_gdnativeclass.rst index f63de4071..d4f0d70c5 100644 --- a/classes/class_gdnativeclass.rst +++ b/classes/class_gdnativeclass.rst @@ -19,15 +19,15 @@ Brief Description Member Functions ---------------- -+--------------------------------+--------------------------------------------------+ -| :ref:`Variant` | :ref:`new` **(** **)** | -+--------------------------------+--------------------------------------------------+ ++--------------------------------+-------------------------------------------------+ +| :ref:`Variant` | :ref:`new` **(** **)** | ++--------------------------------+-------------------------------------------------+ Member Function Description --------------------------- .. _class_GDNativeClass_new: -- :ref:`Variant` **new** **(** **)** +- :ref:`Variant` **new** **(** **)** diff --git a/classes/class_gdnativelibrary.rst b/classes/class_gdnativelibrary.rst index 4517dc6a7..de816d896 100644 --- a/classes/class_gdnativelibrary.rst +++ b/classes/class_gdnativelibrary.rst @@ -19,17 +19,17 @@ Brief Description Member Functions ---------------- -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_active_library_path` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_library_path` **(** :ref:`String` platform **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_singleton_gdnative` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_library_path` **(** :ref:`String` platform, :ref:`String` path **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_singleton_gdnative` **(** :ref:`bool` singleton **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_active_library_path` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_library_path` **(** :ref:`String` platform **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_singleton_gdnative` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_library_path` **(** :ref:`String` platform, :ref:`String` path **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_singleton_gdnative` **(** :ref:`bool` singleton **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -44,22 +44,22 @@ Member Function Description .. _class_GDNativeLibrary_get_active_library_path: -- :ref:`String` **get_active_library_path** **(** **)** const +- :ref:`String` **get_active_library_path** **(** **)** const .. _class_GDNativeLibrary_get_library_path: -- :ref:`String` **get_library_path** **(** :ref:`String` platform **)** const +- :ref:`String` **get_library_path** **(** :ref:`String` platform **)** const .. _class_GDNativeLibrary_is_singleton_gdnative: -- :ref:`bool` **is_singleton_gdnative** **(** **)** const +- :ref:`bool` **is_singleton_gdnative** **(** **)** const .. _class_GDNativeLibrary_set_library_path: -- void **set_library_path** **(** :ref:`String` platform, :ref:`String` path **)** +- void **set_library_path** **(** :ref:`String` platform, :ref:`String` path **)** .. _class_GDNativeLibrary_set_singleton_gdnative: -- void **set_singleton_gdnative** **(** :ref:`bool` singleton **)** +- void **set_singleton_gdnative** **(** :ref:`bool` singleton **)** diff --git a/classes/class_gdscript.rst b/classes/class_gdscript.rst index 1e716a894..120737d39 100644 --- a/classes/class_gdscript.rst +++ b/classes/class_gdscript.rst @@ -19,11 +19,11 @@ A script implemented in the GDScript programming language. Member Functions ---------------- -+--------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`get_as_byte_code` **(** **)** const | -+--------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`new` **(** **)** vararg | -+--------------------------------------------+-----------------------------------------------------------------------------+ ++--------------------------------------------+----------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`get_as_byte_code` **(** **)** const | ++--------------------------------------------+----------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`new` **(** **)** vararg | ++--------------------------------------------+----------------------------------------------------------------------------+ Description ----------- @@ -37,13 +37,13 @@ Member Function Description .. _class_GDScript_get_as_byte_code: -- :ref:`PoolByteArray` **get_as_byte_code** **(** **)** const +- :ref:`PoolByteArray` **get_as_byte_code** **(** **)** const Returns byte code for the script source code. .. _class_GDScript_new: -- :ref:`Object` **new** **(** **)** vararg +- :ref:`Object` **new** **(** **)** vararg Returns a new instance of the script. diff --git a/classes/class_generic6dofjoint.rst b/classes/class_generic6dofjoint.rst index a5059dc93..09a7b4ffe 100644 --- a/classes/class_generic6dofjoint.rst +++ b/classes/class_generic6dofjoint.rst @@ -19,31 +19,31 @@ The generic 6 degrees of freedom joint can implement a variety of joint-types by Member Functions ---------------- -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_flag_x` **(** :ref:`int` flag **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_flag_y` **(** :ref:`int` flag **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_flag_z` **(** :ref:`int` flag **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_param_x` **(** :ref:`int` param **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_param_y` **(** :ref:`int` param **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_param_z` **(** :ref:`int` param **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_flag_x` **(** :ref:`int` flag, :ref:`bool` value **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_flag_y` **(** :ref:`int` flag, :ref:`bool` value **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_flag_z` **(** :ref:`int` flag, :ref:`bool` value **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_param_x` **(** :ref:`int` param, :ref:`float` value **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_param_y` **(** :ref:`int` param, :ref:`float` value **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_param_z` **(** :ref:`int` param, :ref:`float` value **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_flag_x` **(** :ref:`int` flag **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_flag_y` **(** :ref:`int` flag **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_flag_z` **(** :ref:`int` flag **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_param_x` **(** :ref:`int` param **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_param_y` **(** :ref:`int` param **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_param_z` **(** :ref:`int` param **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_flag_x` **(** :ref:`int` flag, :ref:`bool` value **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_flag_y` **(** :ref:`int` flag, :ref:`bool` value **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_flag_z` **(** :ref:`int` flag, :ref:`bool` value **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_param_x` **(** :ref:`int` param, :ref:`float` value **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_param_y` **(** :ref:`int` param, :ref:`float` value **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_param_z` **(** :ref:`int` param, :ref:`float` value **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -288,50 +288,50 @@ Member Function Description .. _class_Generic6DOFJoint_get_flag_x: -- :ref:`bool` **get_flag_x** **(** :ref:`int` flag **)** const +- :ref:`bool` **get_flag_x** **(** :ref:`int` flag **)** const .. _class_Generic6DOFJoint_get_flag_y: -- :ref:`bool` **get_flag_y** **(** :ref:`int` flag **)** const +- :ref:`bool` **get_flag_y** **(** :ref:`int` flag **)** const .. _class_Generic6DOFJoint_get_flag_z: -- :ref:`bool` **get_flag_z** **(** :ref:`int` flag **)** const +- :ref:`bool` **get_flag_z** **(** :ref:`int` flag **)** const .. _class_Generic6DOFJoint_get_param_x: -- :ref:`float` **get_param_x** **(** :ref:`int` param **)** const +- :ref:`float` **get_param_x** **(** :ref:`int` param **)** const .. _class_Generic6DOFJoint_get_param_y: -- :ref:`float` **get_param_y** **(** :ref:`int` param **)** const +- :ref:`float` **get_param_y** **(** :ref:`int` param **)** const .. _class_Generic6DOFJoint_get_param_z: -- :ref:`float` **get_param_z** **(** :ref:`int` param **)** const +- :ref:`float` **get_param_z** **(** :ref:`int` param **)** const .. _class_Generic6DOFJoint_set_flag_x: -- void **set_flag_x** **(** :ref:`int` flag, :ref:`bool` value **)** +- void **set_flag_x** **(** :ref:`int` flag, :ref:`bool` value **)** .. _class_Generic6DOFJoint_set_flag_y: -- void **set_flag_y** **(** :ref:`int` flag, :ref:`bool` value **)** +- void **set_flag_y** **(** :ref:`int` flag, :ref:`bool` value **)** .. _class_Generic6DOFJoint_set_flag_z: -- void **set_flag_z** **(** :ref:`int` flag, :ref:`bool` value **)** +- void **set_flag_z** **(** :ref:`int` flag, :ref:`bool` value **)** .. _class_Generic6DOFJoint_set_param_x: -- void **set_param_x** **(** :ref:`int` param, :ref:`float` value **)** +- void **set_param_x** **(** :ref:`int` param, :ref:`float` value **)** .. _class_Generic6DOFJoint_set_param_y: -- void **set_param_y** **(** :ref:`int` param, :ref:`float` value **)** +- void **set_param_y** **(** :ref:`int` param, :ref:`float` value **)** .. _class_Generic6DOFJoint_set_param_z: -- void **set_param_z** **(** :ref:`int` param, :ref:`float` value **)** +- void **set_param_z** **(** :ref:`int` param, :ref:`float` value **)** diff --git a/classes/class_geometry.rst b/classes/class_geometry.rst index 1bd138e22..bb2ecb1a9 100644 --- a/classes/class_geometry.rst +++ b/classes/class_geometry.rst @@ -19,129 +19,129 @@ Brief Description Member Functions ---------------- -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`build_box_planes` **(** :ref:`Vector3` extents **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`build_capsule_planes` **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`int` lats, :ref:`int` axis=2 **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`build_cylinder_planes` **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`int` axis=2 **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_closest_point_to_segment` **(** :ref:`Vector3` point, :ref:`Vector3` s1, :ref:`Vector3` s2 **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_closest_point_to_segment_2d` **(** :ref:`Vector2` point, :ref:`Vector2` s1, :ref:`Vector2` s2 **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_closest_point_to_segment_uncapped` **(** :ref:`Vector3` point, :ref:`Vector3` s1, :ref:`Vector3` s2 **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_closest_point_to_segment_uncapped_2d` **(** :ref:`Vector2` point, :ref:`Vector2` s1, :ref:`Vector2` s2 **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`get_closest_points_between_segments` **(** :ref:`Vector3` p1, :ref:`Vector3` p2, :ref:`Vector3` q1, :ref:`Vector3` q2 **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_closest_points_between_segments_2d` **(** :ref:`Vector2` p1, :ref:`Vector2` q1, :ref:`Vector2` p2, :ref:`Vector2` q2 **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_uv84_normal_bit` **(** :ref:`Vector3` normal **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`make_atlas` **(** :ref:`PoolVector2Array` sizes **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`point_is_inside_triangle` **(** :ref:`Vector2` point, :ref:`Vector2` a, :ref:`Vector2` b, :ref:`Vector2` c **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`ray_intersects_triangle` **(** :ref:`Vector3` from, :ref:`Vector3` dir, :ref:`Vector3` a, :ref:`Vector3` b, :ref:`Vector3` c **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`segment_intersects_circle` **(** :ref:`Vector2` segment_from, :ref:`Vector2` segment_to, :ref:`Vector2` circle_position, :ref:`float` circle_radius **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`segment_intersects_convex` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` planes **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`segment_intersects_cylinder` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`float` height, :ref:`float` radius **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`segment_intersects_segment_2d` **(** :ref:`Vector2` from_a, :ref:`Vector2` to_a, :ref:`Vector2` from_b, :ref:`Vector2` to_b **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`segment_intersects_sphere` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` sphere_position, :ref:`float` sphere_radius **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`segment_intersects_triangle` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` a, :ref:`Vector3` b, :ref:`Vector3` c **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`triangulate_polygon` **(** :ref:`PoolVector2Array` polygon **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`build_box_planes` **(** :ref:`Vector3` extents **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`build_capsule_planes` **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`int` lats, :ref:`int` axis=2 **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`build_cylinder_planes` **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`int` axis=2 **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_closest_point_to_segment` **(** :ref:`Vector3` point, :ref:`Vector3` s1, :ref:`Vector3` s2 **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_closest_point_to_segment_2d` **(** :ref:`Vector2` point, :ref:`Vector2` s1, :ref:`Vector2` s2 **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_closest_point_to_segment_uncapped` **(** :ref:`Vector3` point, :ref:`Vector3` s1, :ref:`Vector3` s2 **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_closest_point_to_segment_uncapped_2d` **(** :ref:`Vector2` point, :ref:`Vector2` s1, :ref:`Vector2` s2 **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`get_closest_points_between_segments` **(** :ref:`Vector3` p1, :ref:`Vector3` p2, :ref:`Vector3` q1, :ref:`Vector3` q2 **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`get_closest_points_between_segments_2d` **(** :ref:`Vector2` p1, :ref:`Vector2` q1, :ref:`Vector2` p2, :ref:`Vector2` q2 **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_uv84_normal_bit` **(** :ref:`Vector3` normal **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`make_atlas` **(** :ref:`PoolVector2Array` sizes **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`point_is_inside_triangle` **(** :ref:`Vector2` point, :ref:`Vector2` a, :ref:`Vector2` b, :ref:`Vector2` c **)** const | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`ray_intersects_triangle` **(** :ref:`Vector3` from, :ref:`Vector3` dir, :ref:`Vector3` a, :ref:`Vector3` b, :ref:`Vector3` c **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`segment_intersects_circle` **(** :ref:`Vector2` segment_from, :ref:`Vector2` segment_to, :ref:`Vector2` circle_position, :ref:`float` circle_radius **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`segment_intersects_convex` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` planes **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`segment_intersects_cylinder` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`float` height, :ref:`float` radius **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`segment_intersects_segment_2d` **(** :ref:`Vector2` from_a, :ref:`Vector2` to_a, :ref:`Vector2` from_b, :ref:`Vector2` to_b **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`segment_intersects_sphere` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` sphere_position, :ref:`float` sphere_radius **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`segment_intersects_triangle` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` a, :ref:`Vector3` b, :ref:`Vector3` c **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`triangulate_polygon` **(** :ref:`PoolVector2Array` polygon **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Function Description --------------------------- .. _class_Geometry_build_box_planes: -- :ref:`Array` **build_box_planes** **(** :ref:`Vector3` extents **)** +- :ref:`Array` **build_box_planes** **(** :ref:`Vector3` extents **)** .. _class_Geometry_build_capsule_planes: -- :ref:`Array` **build_capsule_planes** **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`int` lats, :ref:`int` axis=2 **)** +- :ref:`Array` **build_capsule_planes** **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`int` lats, :ref:`int` axis=2 **)** .. _class_Geometry_build_cylinder_planes: -- :ref:`Array` **build_cylinder_planes** **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`int` axis=2 **)** +- :ref:`Array` **build_cylinder_planes** **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`int` axis=2 **)** .. _class_Geometry_get_closest_point_to_segment: -- :ref:`Vector3` **get_closest_point_to_segment** **(** :ref:`Vector3` point, :ref:`Vector3` s1, :ref:`Vector3` s2 **)** +- :ref:`Vector3` **get_closest_point_to_segment** **(** :ref:`Vector3` point, :ref:`Vector3` s1, :ref:`Vector3` s2 **)** .. _class_Geometry_get_closest_point_to_segment_2d: -- :ref:`Vector2` **get_closest_point_to_segment_2d** **(** :ref:`Vector2` point, :ref:`Vector2` s1, :ref:`Vector2` s2 **)** +- :ref:`Vector2` **get_closest_point_to_segment_2d** **(** :ref:`Vector2` point, :ref:`Vector2` s1, :ref:`Vector2` s2 **)** .. _class_Geometry_get_closest_point_to_segment_uncapped: -- :ref:`Vector3` **get_closest_point_to_segment_uncapped** **(** :ref:`Vector3` point, :ref:`Vector3` s1, :ref:`Vector3` s2 **)** +- :ref:`Vector3` **get_closest_point_to_segment_uncapped** **(** :ref:`Vector3` point, :ref:`Vector3` s1, :ref:`Vector3` s2 **)** .. _class_Geometry_get_closest_point_to_segment_uncapped_2d: -- :ref:`Vector2` **get_closest_point_to_segment_uncapped_2d** **(** :ref:`Vector2` point, :ref:`Vector2` s1, :ref:`Vector2` s2 **)** +- :ref:`Vector2` **get_closest_point_to_segment_uncapped_2d** **(** :ref:`Vector2` point, :ref:`Vector2` s1, :ref:`Vector2` s2 **)** .. _class_Geometry_get_closest_points_between_segments: -- :ref:`PoolVector3Array` **get_closest_points_between_segments** **(** :ref:`Vector3` p1, :ref:`Vector3` p2, :ref:`Vector3` q1, :ref:`Vector3` q2 **)** +- :ref:`PoolVector3Array` **get_closest_points_between_segments** **(** :ref:`Vector3` p1, :ref:`Vector3` p2, :ref:`Vector3` q1, :ref:`Vector3` q2 **)** .. _class_Geometry_get_closest_points_between_segments_2d: -- :ref:`PoolVector2Array` **get_closest_points_between_segments_2d** **(** :ref:`Vector2` p1, :ref:`Vector2` q1, :ref:`Vector2` p2, :ref:`Vector2` q2 **)** +- :ref:`PoolVector2Array` **get_closest_points_between_segments_2d** **(** :ref:`Vector2` p1, :ref:`Vector2` q1, :ref:`Vector2` p2, :ref:`Vector2` q2 **)** .. _class_Geometry_get_uv84_normal_bit: -- :ref:`int` **get_uv84_normal_bit** **(** :ref:`Vector3` normal **)** +- :ref:`int` **get_uv84_normal_bit** **(** :ref:`Vector3` normal **)** .. _class_Geometry_make_atlas: -- :ref:`Dictionary` **make_atlas** **(** :ref:`PoolVector2Array` sizes **)** +- :ref:`Dictionary` **make_atlas** **(** :ref:`PoolVector2Array` sizes **)** .. _class_Geometry_point_is_inside_triangle: -- :ref:`bool` **point_is_inside_triangle** **(** :ref:`Vector2` point, :ref:`Vector2` a, :ref:`Vector2` b, :ref:`Vector2` c **)** const +- :ref:`bool` **point_is_inside_triangle** **(** :ref:`Vector2` point, :ref:`Vector2` a, :ref:`Vector2` b, :ref:`Vector2` c **)** const .. _class_Geometry_ray_intersects_triangle: -- :ref:`Variant` **ray_intersects_triangle** **(** :ref:`Vector3` from, :ref:`Vector3` dir, :ref:`Vector3` a, :ref:`Vector3` b, :ref:`Vector3` c **)** +- :ref:`Variant` **ray_intersects_triangle** **(** :ref:`Vector3` from, :ref:`Vector3` dir, :ref:`Vector3` a, :ref:`Vector3` b, :ref:`Vector3` c **)** .. _class_Geometry_segment_intersects_circle: -- :ref:`float` **segment_intersects_circle** **(** :ref:`Vector2` segment_from, :ref:`Vector2` segment_to, :ref:`Vector2` circle_position, :ref:`float` circle_radius **)** +- :ref:`float` **segment_intersects_circle** **(** :ref:`Vector2` segment_from, :ref:`Vector2` segment_to, :ref:`Vector2` circle_position, :ref:`float` circle_radius **)** .. _class_Geometry_segment_intersects_convex: -- :ref:`PoolVector3Array` **segment_intersects_convex** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` planes **)** +- :ref:`PoolVector3Array` **segment_intersects_convex** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` planes **)** .. _class_Geometry_segment_intersects_cylinder: -- :ref:`PoolVector3Array` **segment_intersects_cylinder** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`float` height, :ref:`float` radius **)** +- :ref:`PoolVector3Array` **segment_intersects_cylinder** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`float` height, :ref:`float` radius **)** .. _class_Geometry_segment_intersects_segment_2d: -- :ref:`Variant` **segment_intersects_segment_2d** **(** :ref:`Vector2` from_a, :ref:`Vector2` to_a, :ref:`Vector2` from_b, :ref:`Vector2` to_b **)** +- :ref:`Variant` **segment_intersects_segment_2d** **(** :ref:`Vector2` from_a, :ref:`Vector2` to_a, :ref:`Vector2` from_b, :ref:`Vector2` to_b **)** .. _class_Geometry_segment_intersects_sphere: -- :ref:`PoolVector3Array` **segment_intersects_sphere** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` sphere_position, :ref:`float` sphere_radius **)** +- :ref:`PoolVector3Array` **segment_intersects_sphere** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` sphere_position, :ref:`float` sphere_radius **)** .. _class_Geometry_segment_intersects_triangle: -- :ref:`Variant` **segment_intersects_triangle** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` a, :ref:`Vector3` b, :ref:`Vector3` c **)** +- :ref:`Variant` **segment_intersects_triangle** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` a, :ref:`Vector3` b, :ref:`Vector3` c **)** .. _class_Geometry_triangulate_polygon: -- :ref:`PoolIntArray` **triangulate_polygon** **(** :ref:`PoolVector2Array` polygon **)** +- :ref:`PoolIntArray` **triangulate_polygon** **(** :ref:`PoolVector2Array` polygon **)** diff --git a/classes/class_geometryinstance.rst b/classes/class_geometryinstance.rst index d74a19d5b..534ab34b2 100644 --- a/classes/class_geometryinstance.rst +++ b/classes/class_geometryinstance.rst @@ -21,39 +21,39 @@ Base node for geometry based visual instances. Member Functions ---------------- -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_cast_shadows_setting` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_extra_cull_margin` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_flag` **(** :ref:`int` flag **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_lod_max_distance` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_lod_max_hysteresis` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_lod_min_distance` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_lod_min_hysteresis` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Material` | :ref:`get_material_override` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cast_shadows_setting` **(** :ref:`int` shadow_casting_setting **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_extra_cull_margin` **(** :ref:`float` margin **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_flag` **(** :ref:`int` flag, :ref:`bool` value **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_lod_max_distance` **(** :ref:`float` mode **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_lod_max_hysteresis` **(** :ref:`float` mode **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_lod_min_distance` **(** :ref:`float` mode **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_lod_min_hysteresis` **(** :ref:`float` mode **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_material_override` **(** :ref:`Material` material **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_cast_shadows_setting` **(** **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_extra_cull_margin` **(** **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_flag` **(** :ref:`int` flag **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_lod_max_distance` **(** **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_lod_max_hysteresis` **(** **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_lod_min_distance` **(** **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_lod_min_hysteresis` **(** **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Material` | :ref:`get_material_override` **(** **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cast_shadows_setting` **(** :ref:`int` shadow_casting_setting **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_extra_cull_margin` **(** :ref:`float` margin **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_flag` **(** :ref:`int` flag, :ref:`bool` value **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_lod_max_distance` **(** :ref:`float` mode **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_lod_max_hysteresis` **(** :ref:`float` mode **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_lod_min_distance` **(** :ref:`float` mode **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_lod_min_hysteresis` **(** :ref:`float` mode **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_material_override` **(** :ref:`Material` material **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -111,69 +111,69 @@ Member Function Description .. _class_GeometryInstance_get_cast_shadows_setting: -- :ref:`int` **get_cast_shadows_setting** **(** **)** const +- :ref:`int` **get_cast_shadows_setting** **(** **)** const .. _class_GeometryInstance_get_extra_cull_margin: -- :ref:`float` **get_extra_cull_margin** **(** **)** const +- :ref:`float` **get_extra_cull_margin** **(** **)** const .. _class_GeometryInstance_get_flag: -- :ref:`bool` **get_flag** **(** :ref:`int` flag **)** const +- :ref:`bool` **get_flag** **(** :ref:`int` flag **)** const .. _class_GeometryInstance_get_lod_max_distance: -- :ref:`float` **get_lod_max_distance** **(** **)** const +- :ref:`float` **get_lod_max_distance** **(** **)** const .. _class_GeometryInstance_get_lod_max_hysteresis: -- :ref:`float` **get_lod_max_hysteresis** **(** **)** const +- :ref:`float` **get_lod_max_hysteresis** **(** **)** const .. _class_GeometryInstance_get_lod_min_distance: -- :ref:`float` **get_lod_min_distance** **(** **)** const +- :ref:`float` **get_lod_min_distance** **(** **)** const .. _class_GeometryInstance_get_lod_min_hysteresis: -- :ref:`float` **get_lod_min_hysteresis** **(** **)** const +- :ref:`float` **get_lod_min_hysteresis** **(** **)** const .. _class_GeometryInstance_get_material_override: -- :ref:`Material` **get_material_override** **(** **)** const +- :ref:`Material` **get_material_override** **(** **)** const Return the material override for the whole geometry. .. _class_GeometryInstance_set_cast_shadows_setting: -- void **set_cast_shadows_setting** **(** :ref:`int` shadow_casting_setting **)** +- void **set_cast_shadows_setting** **(** :ref:`int` shadow_casting_setting **)** .. _class_GeometryInstance_set_extra_cull_margin: -- void **set_extra_cull_margin** **(** :ref:`float` margin **)** +- void **set_extra_cull_margin** **(** :ref:`float` margin **)** .. _class_GeometryInstance_set_flag: -- void **set_flag** **(** :ref:`int` flag, :ref:`bool` value **)** +- void **set_flag** **(** :ref:`int` flag, :ref:`bool` value **)** .. _class_GeometryInstance_set_lod_max_distance: -- void **set_lod_max_distance** **(** :ref:`float` mode **)** +- void **set_lod_max_distance** **(** :ref:`float` mode **)** .. _class_GeometryInstance_set_lod_max_hysteresis: -- void **set_lod_max_hysteresis** **(** :ref:`float` mode **)** +- void **set_lod_max_hysteresis** **(** :ref:`float` mode **)** .. _class_GeometryInstance_set_lod_min_distance: -- void **set_lod_min_distance** **(** :ref:`float` mode **)** +- void **set_lod_min_distance** **(** :ref:`float` mode **)** .. _class_GeometryInstance_set_lod_min_hysteresis: -- void **set_lod_min_hysteresis** **(** :ref:`float` mode **)** +- void **set_lod_min_hysteresis** **(** :ref:`float` mode **)** .. _class_GeometryInstance_set_material_override: -- void **set_material_override** **(** :ref:`Material` material **)** +- void **set_material_override** **(** :ref:`Material` material **)** Set the material override for the whole geometry. diff --git a/classes/class_giprobe.rst b/classes/class_giprobe.rst index 8abe926aa..e857bc301 100644 --- a/classes/class_giprobe.rst +++ b/classes/class_giprobe.rst @@ -19,51 +19,51 @@ Brief Description Member Functions ---------------- -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`bake` **(** :ref:`Node` from_node=null, :ref:`bool` create_visual_debug=false **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`debug_bake` **(** **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_bias` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_dynamic_range` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_energy` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_extents` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_normal_bias` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`GIProbeData` | :ref:`get_probe_data` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_propagation` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_subdiv` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_compressed` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_interior` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bias` **(** :ref:`float` max **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_compress` **(** :ref:`bool` enable **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_dynamic_range` **(** :ref:`int` max **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_energy` **(** :ref:`float` max **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_extents` **(** :ref:`Vector3` extents **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_interior` **(** :ref:`bool` enable **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_normal_bias` **(** :ref:`float` max **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_probe_data` **(** :ref:`GIProbeData` data **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_propagation` **(** :ref:`float` max **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_subdiv` **(** :ref:`int` subdiv **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`bake` **(** :ref:`Node` from_node=null, :ref:`bool` create_visual_debug=false **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`debug_bake` **(** **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_bias` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_dynamic_range` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_energy` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_extents` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_normal_bias` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`GIProbeData` | :ref:`get_probe_data` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_propagation` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_subdiv` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_compressed` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_interior` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bias` **(** :ref:`float` max **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_compress` **(** :ref:`bool` enable **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_dynamic_range` **(** :ref:`int` max **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_energy` **(** :ref:`float` max **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_extents` **(** :ref:`Vector3` extents **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_interior` **(** :ref:`bool` enable **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_normal_bias` **(** :ref:`float` max **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_probe_data` **(** :ref:`GIProbeData` data **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_propagation` **(** :ref:`float` max **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_subdiv` **(** :ref:`int` subdiv **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -122,90 +122,90 @@ Member Function Description .. _class_GIProbe_bake: -- void **bake** **(** :ref:`Node` from_node=null, :ref:`bool` create_visual_debug=false **)** +- void **bake** **(** :ref:`Node` from_node=null, :ref:`bool` create_visual_debug=false **)** .. _class_GIProbe_debug_bake: -- void **debug_bake** **(** **)** +- void **debug_bake** **(** **)** .. _class_GIProbe_get_bias: -- :ref:`float` **get_bias** **(** **)** const +- :ref:`float` **get_bias** **(** **)** const .. _class_GIProbe_get_dynamic_range: -- :ref:`int` **get_dynamic_range** **(** **)** const +- :ref:`int` **get_dynamic_range** **(** **)** const .. _class_GIProbe_get_energy: -- :ref:`float` **get_energy** **(** **)** const +- :ref:`float` **get_energy** **(** **)** const .. _class_GIProbe_get_extents: -- :ref:`Vector3` **get_extents** **(** **)** const +- :ref:`Vector3` **get_extents** **(** **)** const .. _class_GIProbe_get_normal_bias: -- :ref:`float` **get_normal_bias** **(** **)** const +- :ref:`float` **get_normal_bias** **(** **)** const .. _class_GIProbe_get_probe_data: -- :ref:`GIProbeData` **get_probe_data** **(** **)** const +- :ref:`GIProbeData` **get_probe_data** **(** **)** const .. _class_GIProbe_get_propagation: -- :ref:`float` **get_propagation** **(** **)** const +- :ref:`float` **get_propagation** **(** **)** const .. _class_GIProbe_get_subdiv: -- :ref:`int` **get_subdiv** **(** **)** const +- :ref:`int` **get_subdiv** **(** **)** const .. _class_GIProbe_is_compressed: -- :ref:`bool` **is_compressed** **(** **)** const +- :ref:`bool` **is_compressed** **(** **)** const .. _class_GIProbe_is_interior: -- :ref:`bool` **is_interior** **(** **)** const +- :ref:`bool` **is_interior** **(** **)** const .. _class_GIProbe_set_bias: -- void **set_bias** **(** :ref:`float` max **)** +- void **set_bias** **(** :ref:`float` max **)** .. _class_GIProbe_set_compress: -- void **set_compress** **(** :ref:`bool` enable **)** +- void **set_compress** **(** :ref:`bool` enable **)** .. _class_GIProbe_set_dynamic_range: -- void **set_dynamic_range** **(** :ref:`int` max **)** +- void **set_dynamic_range** **(** :ref:`int` max **)** .. _class_GIProbe_set_energy: -- void **set_energy** **(** :ref:`float` max **)** +- void **set_energy** **(** :ref:`float` max **)** .. _class_GIProbe_set_extents: -- void **set_extents** **(** :ref:`Vector3` extents **)** +- void **set_extents** **(** :ref:`Vector3` extents **)** .. _class_GIProbe_set_interior: -- void **set_interior** **(** :ref:`bool` enable **)** +- void **set_interior** **(** :ref:`bool` enable **)** .. _class_GIProbe_set_normal_bias: -- void **set_normal_bias** **(** :ref:`float` max **)** +- void **set_normal_bias** **(** :ref:`float` max **)** .. _class_GIProbe_set_probe_data: -- void **set_probe_data** **(** :ref:`GIProbeData` data **)** +- void **set_probe_data** **(** :ref:`GIProbeData` data **)** .. _class_GIProbe_set_propagation: -- void **set_propagation** **(** :ref:`float` max **)** +- void **set_propagation** **(** :ref:`float` max **)** .. _class_GIProbe_set_subdiv: -- void **set_subdiv** **(** :ref:`int` subdiv **)** +- void **set_subdiv** **(** :ref:`int` subdiv **)** diff --git a/classes/class_giprobedata.rst b/classes/class_giprobedata.rst index 4759dba95..0623dadec 100644 --- a/classes/class_giprobedata.rst +++ b/classes/class_giprobedata.rst @@ -19,51 +19,51 @@ Brief Description Member Functions ---------------- -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_bias` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect3` | :ref:`get_bounds` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_cell_size` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_dynamic_data` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_dynamic_range` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_energy` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_normal_bias` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_propagation` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_to_cell_xform` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_compressed` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_interior` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bias` **(** :ref:`float` bias **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bounds` **(** :ref:`Rect3` bounds **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cell_size` **(** :ref:`float` cell_size **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_compress` **(** :ref:`bool` compress **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_dynamic_data` **(** :ref:`PoolIntArray` dynamic_data **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_dynamic_range` **(** :ref:`int` dynamic_range **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_energy` **(** :ref:`float` energy **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_interior` **(** :ref:`bool` interior **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_normal_bias` **(** :ref:`float` bias **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_propagation` **(** :ref:`float` propagation **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_to_cell_xform` **(** :ref:`Transform` to_cell_xform **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_bias` **(** **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect3` | :ref:`get_bounds` **(** **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_cell_size` **(** **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`get_dynamic_data` **(** **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_dynamic_range` **(** **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_energy` **(** **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_normal_bias` **(** **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_propagation` **(** **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`get_to_cell_xform` **(** **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_compressed` **(** **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_interior` **(** **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bias` **(** :ref:`float` bias **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bounds` **(** :ref:`Rect3` bounds **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cell_size` **(** :ref:`float` cell_size **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_compress` **(** :ref:`bool` compress **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_dynamic_data` **(** :ref:`PoolIntArray` dynamic_data **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_dynamic_range` **(** :ref:`int` dynamic_range **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_energy` **(** :ref:`float` energy **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_interior` **(** :ref:`bool` interior **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_normal_bias` **(** :ref:`float` bias **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_propagation` **(** :ref:`float` propagation **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_to_cell_xform` **(** :ref:`Transform` to_cell_xform **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -118,90 +118,90 @@ Member Function Description .. _class_GIProbeData_get_bias: -- :ref:`float` **get_bias** **(** **)** const +- :ref:`float` **get_bias** **(** **)** const .. _class_GIProbeData_get_bounds: -- :ref:`Rect3` **get_bounds** **(** **)** const +- :ref:`Rect3` **get_bounds** **(** **)** const .. _class_GIProbeData_get_cell_size: -- :ref:`float` **get_cell_size** **(** **)** const +- :ref:`float` **get_cell_size** **(** **)** const .. _class_GIProbeData_get_dynamic_data: -- :ref:`PoolIntArray` **get_dynamic_data** **(** **)** const +- :ref:`PoolIntArray` **get_dynamic_data** **(** **)** const .. _class_GIProbeData_get_dynamic_range: -- :ref:`int` **get_dynamic_range** **(** **)** const +- :ref:`int` **get_dynamic_range** **(** **)** const .. _class_GIProbeData_get_energy: -- :ref:`float` **get_energy** **(** **)** const +- :ref:`float` **get_energy** **(** **)** const .. _class_GIProbeData_get_normal_bias: -- :ref:`float` **get_normal_bias** **(** **)** const +- :ref:`float` **get_normal_bias** **(** **)** const .. _class_GIProbeData_get_propagation: -- :ref:`float` **get_propagation** **(** **)** const +- :ref:`float` **get_propagation** **(** **)** const .. _class_GIProbeData_get_to_cell_xform: -- :ref:`Transform` **get_to_cell_xform** **(** **)** const +- :ref:`Transform` **get_to_cell_xform** **(** **)** const .. _class_GIProbeData_is_compressed: -- :ref:`bool` **is_compressed** **(** **)** const +- :ref:`bool` **is_compressed** **(** **)** const .. _class_GIProbeData_is_interior: -- :ref:`bool` **is_interior** **(** **)** const +- :ref:`bool` **is_interior** **(** **)** const .. _class_GIProbeData_set_bias: -- void **set_bias** **(** :ref:`float` bias **)** +- void **set_bias** **(** :ref:`float` bias **)** .. _class_GIProbeData_set_bounds: -- void **set_bounds** **(** :ref:`Rect3` bounds **)** +- void **set_bounds** **(** :ref:`Rect3` bounds **)** .. _class_GIProbeData_set_cell_size: -- void **set_cell_size** **(** :ref:`float` cell_size **)** +- void **set_cell_size** **(** :ref:`float` cell_size **)** .. _class_GIProbeData_set_compress: -- void **set_compress** **(** :ref:`bool` compress **)** +- void **set_compress** **(** :ref:`bool` compress **)** .. _class_GIProbeData_set_dynamic_data: -- void **set_dynamic_data** **(** :ref:`PoolIntArray` dynamic_data **)** +- void **set_dynamic_data** **(** :ref:`PoolIntArray` dynamic_data **)** .. _class_GIProbeData_set_dynamic_range: -- void **set_dynamic_range** **(** :ref:`int` dynamic_range **)** +- void **set_dynamic_range** **(** :ref:`int` dynamic_range **)** .. _class_GIProbeData_set_energy: -- void **set_energy** **(** :ref:`float` energy **)** +- void **set_energy** **(** :ref:`float` energy **)** .. _class_GIProbeData_set_interior: -- void **set_interior** **(** :ref:`bool` interior **)** +- void **set_interior** **(** :ref:`bool` interior **)** .. _class_GIProbeData_set_normal_bias: -- void **set_normal_bias** **(** :ref:`float` bias **)** +- void **set_normal_bias** **(** :ref:`float` bias **)** .. _class_GIProbeData_set_propagation: -- void **set_propagation** **(** :ref:`float` propagation **)** +- void **set_propagation** **(** :ref:`float` propagation **)** .. _class_GIProbeData_set_to_cell_xform: -- void **set_to_cell_xform** **(** :ref:`Transform` to_cell_xform **)** +- void **set_to_cell_xform** **(** :ref:`Transform` to_cell_xform **)** diff --git a/classes/class_godotsharp.rst b/classes/class_godotsharp.rst index 617304179..a51759e73 100644 --- a/classes/class_godotsharp.rst +++ b/classes/class_godotsharp.rst @@ -19,40 +19,40 @@ Brief Description Member Functions ---------------- -+--------------------------+---------------------------------------------------------------------------------+ -| void | :ref:`attach_thread` **(** **)** | -+--------------------------+---------------------------------------------------------------------------------+ -| void | :ref:`detach_thread` **(** **)** | -+--------------------------+---------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_domain_loaded` **(** **)** | -+--------------------------+---------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_finalizing_domain` **(** **)** | -+--------------------------+---------------------------------------------------------------------------------+ ++--------------------------+--------------------------------------------------------------------------------+ +| void | :ref:`attach_thread` **(** **)** | ++--------------------------+--------------------------------------------------------------------------------+ +| void | :ref:`detach_thread` **(** **)** | ++--------------------------+--------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_domain_loaded` **(** **)** | ++--------------------------+--------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_finalizing_domain` **(** **)** | ++--------------------------+--------------------------------------------------------------------------------+ Member Function Description --------------------------- .. _class_GodotSharp_attach_thread: -- void **attach_thread** **(** **)** +- void **attach_thread** **(** **)** Attaches the current thread to the mono runtime. .. _class_GodotSharp_detach_thread: -- void **detach_thread** **(** **)** +- void **detach_thread** **(** **)** Detaches the current thread from the mono runtime. .. _class_GodotSharp_is_domain_loaded: -- :ref:`bool` **is_domain_loaded** **(** **)** +- :ref:`bool` **is_domain_loaded** **(** **)** Returns whether the scripts domain is loaded. .. _class_GodotSharp_is_finalizing_domain: -- :ref:`bool` **is_finalizing_domain** **(** **)** +- :ref:`bool` **is_finalizing_domain** **(** **)** Returns whether the scripts domain is being finalized. diff --git a/classes/class_gradient.rst b/classes/class_gradient.rst index 8a47f0efb..2a886f78d 100644 --- a/classes/class_gradient.rst +++ b/classes/class_gradient.rst @@ -19,31 +19,31 @@ Color interpolator node. Member Functions ---------------- -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_point` **(** :ref:`float` offset, :ref:`Color` color **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_color` **(** :ref:`int` point **)** const | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolColorArray` | :ref:`get_colors` **(** **)** const | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_offset` **(** :ref:`int` point **)** const | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolRealArray` | :ref:`get_offsets` **(** **)** const | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_point_count` **(** **)** const | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`interpolate` **(** :ref:`float` offset **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_point` **(** :ref:`int` offset **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_color` **(** :ref:`int` point, :ref:`Color` color **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_colors` **(** :ref:`PoolColorArray` colors **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_offset` **(** :ref:`int` point, :ref:`float` offset **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_offsets` **(** :ref:`PoolRealArray` offsets **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_point` **(** :ref:`float` offset, :ref:`Color` color **)** | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_color` **(** :ref:`int` point **)** const | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolColorArray` | :ref:`get_colors` **(** **)** const | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_offset` **(** :ref:`int` point **)** const | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolRealArray` | :ref:`get_offsets` **(** **)** const | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_point_count` **(** **)** const | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`interpolate` **(** :ref:`float` offset **)** | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_point` **(** :ref:`int` offset **)** | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_color` **(** :ref:`int` point, :ref:`Color` color **)** | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_colors` **(** :ref:`PoolColorArray` colors **)** | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_offset` **(** :ref:`int` point, :ref:`float` offset **)** | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_offsets` **(** :ref:`PoolRealArray` offsets **)** | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -67,73 +67,73 @@ Member Function Description .. _class_Gradient_add_point: -- void **add_point** **(** :ref:`float` offset, :ref:`Color` color **)** +- void **add_point** **(** :ref:`float` offset, :ref:`Color` color **)** Adds the specified color to the end of the ramp, with the specified offset .. _class_Gradient_get_color: -- :ref:`Color` **get_color** **(** :ref:`int` point **)** const +- :ref:`Color` **get_color** **(** :ref:`int` point **)** const Returns the color of the ramp color at index *point* .. _class_Gradient_get_colors: -- :ref:`PoolColorArray` **get_colors** **(** **)** const +- :ref:`PoolColorArray` **get_colors** **(** **)** const Returns the colors in the ramp .. _class_Gradient_get_offset: -- :ref:`float` **get_offset** **(** :ref:`int` point **)** const +- :ref:`float` **get_offset** **(** :ref:`int` point **)** const Returns the offset of the ramp color at index *point* .. _class_Gradient_get_offsets: -- :ref:`PoolRealArray` **get_offsets** **(** **)** const +- :ref:`PoolRealArray` **get_offsets** **(** **)** const Returns the offsets for the colors in this ramp .. _class_Gradient_get_point_count: -- :ref:`int` **get_point_count** **(** **)** const +- :ref:`int` **get_point_count** **(** **)** const Returns the number of colors in the ramp .. _class_Gradient_interpolate: -- :ref:`Color` **interpolate** **(** :ref:`float` offset **)** +- :ref:`Color` **interpolate** **(** :ref:`float` offset **)** Returns the interpolated color specified by *offset* .. _class_Gradient_remove_point: -- void **remove_point** **(** :ref:`int` offset **)** +- void **remove_point** **(** :ref:`int` offset **)** Removes the color at the index *offset* .. _class_Gradient_set_color: -- void **set_color** **(** :ref:`int` point, :ref:`Color` color **)** +- void **set_color** **(** :ref:`int` point, :ref:`Color` color **)** Sets the color of the ramp color at index *point* .. _class_Gradient_set_colors: -- void **set_colors** **(** :ref:`PoolColorArray` colors **)** +- void **set_colors** **(** :ref:`PoolColorArray` colors **)** Sets the colors for the specified amount of elements. Calling this function with a different number of elements than previously defined causes the ramp to resize its colors and offsets array to accommodate the new elements. .. _class_Gradient_set_offset: -- void **set_offset** **(** :ref:`int` point, :ref:`float` offset **)** +- void **set_offset** **(** :ref:`int` point, :ref:`float` offset **)** Sets the offset for the ramp color at index *point* .. _class_Gradient_set_offsets: -- void **set_offsets** **(** :ref:`PoolRealArray` offsets **)** +- void **set_offsets** **(** :ref:`PoolRealArray` offsets **)** Sets the offset for the specified amount of elements. Calling this function with a different number of elements than previously defined causes the ramp to resize its colors and offsets array to accommodate the new elements, all new colors will be black by default. diff --git a/classes/class_gradienttexture.rst b/classes/class_gradienttexture.rst index 76cf84095..b8c875b61 100644 --- a/classes/class_gradienttexture.rst +++ b/classes/class_gradienttexture.rst @@ -19,13 +19,13 @@ Gradient filled texture. Member Functions ---------------- -+----------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`Gradient` | :ref:`get_gradient` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_gradient` **(** :ref:`Gradient` gradient **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_width` **(** :ref:`int` width **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------+ ++----------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`Gradient` | :ref:`get_gradient` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_gradient` **(** :ref:`Gradient` gradient **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_width` **(** :ref:`int` width **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -49,14 +49,14 @@ Member Function Description .. _class_GradientTexture_get_gradient: -- :ref:`Gradient` **get_gradient** **(** **)** const +- :ref:`Gradient` **get_gradient** **(** **)** const .. _class_GradientTexture_set_gradient: -- void **set_gradient** **(** :ref:`Gradient` gradient **)** +- void **set_gradient** **(** :ref:`Gradient` gradient **)** .. _class_GradientTexture_set_width: -- void **set_width** **(** :ref:`int` width **)** +- void **set_width** **(** :ref:`int` width **)** diff --git a/classes/class_graphedit.rst b/classes/class_graphedit.rst index c4d4e91c8..614dd2b6e 100644 --- a/classes/class_graphedit.rst +++ b/classes/class_graphedit.rst @@ -19,94 +19,94 @@ GraphEdit is an area capable of showing various GraphNodes. It manages connectio Member Functions ---------------- -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`connect_node` **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`disconnect_node` **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_connection_list` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_scroll_ofs` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_snap` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_zoom` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_node_connected` **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_right_disconnects_enabled` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_using_snap` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_right_disconnects` **(** :ref:`bool` enable **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_scroll_ofs` **(** :ref:`Vector2` ofs **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_selected` **(** :ref:`Node` node **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_snap` **(** :ref:`int` pixels **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_snap` **(** :ref:`bool` enable **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_zoom` **(** :ref:`float` p_zoom **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`connect_node` **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`disconnect_node` **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_connection_list` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_scroll_ofs` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_snap` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_zoom` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_node_connected` **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_right_disconnects_enabled` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_using_snap` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_right_disconnects` **(** :ref:`bool` enable **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_scroll_ofs` **(** :ref:`Vector2` ofs **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_selected` **(** :ref:`Node` node **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_snap` **(** :ref:`int` pixels **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_snap` **(** :ref:`bool` enable **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_zoom` **(** :ref:`float` p_zoom **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_GraphEdit__begin_node_move: -- **_begin_node_move** **(** **)** +- **_begin_node_move** **(** **)** Signal sent at the beginning of a GraphNode movement. .. _class_GraphEdit__end_node_move: -- **_end_node_move** **(** **)** +- **_end_node_move** **(** **)** Signal sent at the end of a GraphNode movement. .. _class_GraphEdit_connection_request: -- **connection_request** **(** :ref:`String` from, :ref:`int` from_slot, :ref:`String` to, :ref:`int` to_slot **)** +- **connection_request** **(** :ref:`String` from, :ref:`int` from_slot, :ref:`String` to, :ref:`int` to_slot **)** Signal sent to the GraphEdit when the connection between 'from_slot' slot of 'from' GraphNode and 'to_slot' slot of 'to' GraphNode is attempted to be created. .. _class_GraphEdit_connection_to_empty: -- **connection_to_empty** **(** :ref:`String` from, :ref:`int` from_slot, :ref:`Vector2` release_position **)** +- **connection_to_empty** **(** :ref:`String` from, :ref:`int` from_slot, :ref:`Vector2` release_position **)** .. _class_GraphEdit_delete_nodes_request: -- **delete_nodes_request** **(** **)** +- **delete_nodes_request** **(** **)** Signal sent when a GraphNode is attempted to be removed from the GraphEdit. .. _class_GraphEdit_disconnection_request: -- **disconnection_request** **(** :ref:`String` from, :ref:`int` from_slot, :ref:`String` to, :ref:`int` to_slot **)** +- **disconnection_request** **(** :ref:`String` from, :ref:`int` from_slot, :ref:`String` to, :ref:`int` to_slot **)** Signal sent to the GraphEdit when the connection between 'from_slot' slot of 'from' GraphNode and 'to_slot' slot of 'to' GraphNode is attempted to be removed. .. _class_GraphEdit_duplicate_nodes_request: -- **duplicate_nodes_request** **(** **)** +- **duplicate_nodes_request** **(** **)** Signal sent when a GraphNode is attempted to be duplicated in the GraphEdit. .. _class_GraphEdit_node_selected: -- **node_selected** **(** :ref:`Object` node **)** +- **node_selected** **(** :ref:`Object` node **)** .. _class_GraphEdit_popup_request: -- **popup_request** **(** :ref:`Vector2` p_position **)** +- **popup_request** **(** :ref:`Vector2` p_position **)** Signal sent when a popup is requested. Happens on right-clicking in the GraphEdit. 'p_position' is the position of the mouse pointer when the signal is sent. .. _class_GraphEdit_scroll_offset_changed: -- **scroll_offset_changed** **(** :ref:`Vector2` ofs **)** +- **scroll_offset_changed** **(** :ref:`Vector2` ofs **)** Description @@ -121,79 +121,79 @@ Member Function Description .. _class_GraphEdit_connect_node: -- :ref:`int` **connect_node** **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** +- :ref:`int` **connect_node** **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** Create a connection between 'from_port' slot of 'from' GraphNode and 'to_port' slot of 'to' GraphNode. If the connection already exists, no connection is created. .. _class_GraphEdit_disconnect_node: -- void **disconnect_node** **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** +- void **disconnect_node** **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** Remove the connection between 'from_port' slot of 'from' GraphNode and 'to_port' slot of 'to' GraphNode, if connection exists. .. _class_GraphEdit_get_connection_list: -- :ref:`Array` **get_connection_list** **(** **)** const +- :ref:`Array` **get_connection_list** **(** **)** const Return an Array containing the list of connections. A connection consists in a structure of the form {from_slot: 0, from: "GraphNode name 0", to_slot: 1, to: "GraphNode name 1" } .. _class_GraphEdit_get_scroll_ofs: -- :ref:`Vector2` **get_scroll_ofs** **(** **)** const +- :ref:`Vector2` **get_scroll_ofs** **(** **)** const Return the scroll offset. .. _class_GraphEdit_get_snap: -- :ref:`int` **get_snap** **(** **)** const +- :ref:`int` **get_snap** **(** **)** const .. _class_GraphEdit_get_zoom: -- :ref:`float` **get_zoom** **(** **)** const +- :ref:`float` **get_zoom** **(** **)** const Return the current zoom value. .. _class_GraphEdit_is_node_connected: -- :ref:`bool` **is_node_connected** **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** +- :ref:`bool` **is_node_connected** **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** Return true if the 'from_port' slot of 'from' GraphNode is connected to the 'to_port' slot of 'to' GraphNode. .. _class_GraphEdit_is_right_disconnects_enabled: -- :ref:`bool` **is_right_disconnects_enabled** **(** **)** const +- :ref:`bool` **is_right_disconnects_enabled** **(** **)** const Return true is the disconnection of connections is enable in the visual GraphEdit. False otherwise. .. _class_GraphEdit_is_using_snap: -- :ref:`bool` **is_using_snap** **(** **)** const +- :ref:`bool` **is_using_snap** **(** **)** const .. _class_GraphEdit_set_right_disconnects: -- void **set_right_disconnects** **(** :ref:`bool` enable **)** +- void **set_right_disconnects** **(** :ref:`bool` enable **)** Enable the disconnection of existing connections in the visual GraphEdit by left-clicking a connection and releasing into the void. .. _class_GraphEdit_set_scroll_ofs: -- void **set_scroll_ofs** **(** :ref:`Vector2` ofs **)** +- void **set_scroll_ofs** **(** :ref:`Vector2` ofs **)** .. _class_GraphEdit_set_selected: -- void **set_selected** **(** :ref:`Node` node **)** +- void **set_selected** **(** :ref:`Node` node **)** .. _class_GraphEdit_set_snap: -- void **set_snap** **(** :ref:`int` pixels **)** +- void **set_snap** **(** :ref:`int` pixels **)** .. _class_GraphEdit_set_use_snap: -- void **set_use_snap** **(** :ref:`bool` enable **)** +- void **set_use_snap** **(** :ref:`bool` enable **)** .. _class_GraphEdit_set_zoom: -- void **set_zoom** **(** :ref:`float` p_zoom **)** +- void **set_zoom** **(** :ref:`float` p_zoom **)** Set the zoom value of the GraphEdit. Zoom value is between 0.01; 1.728. diff --git a/classes/class_graphnode.rst b/classes/class_graphnode.rst index a3036487b..7f48b31dd 100644 --- a/classes/class_graphnode.rst +++ b/classes/class_graphnode.rst @@ -19,100 +19,100 @@ A GraphNode is a container with several input and output slots allowing connecti Member Functions ---------------- -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_all_slots` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_slot` **(** :ref:`int` idx **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_connection_input_color` **(** :ref:`int` idx **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_connection_input_count` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_connection_input_position` **(** :ref:`int` idx **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_connection_input_type` **(** :ref:`int` idx **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_connection_output_color` **(** :ref:`int` idx **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_connection_output_count` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_connection_output_position` **(** :ref:`int` idx **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_connection_output_type` **(** :ref:`int` idx **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_offset` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_overlay` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_slot_color_left` **(** :ref:`int` idx **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_slot_color_right` **(** :ref:`int` idx **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_slot_type_left` **(** :ref:`int` idx **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_slot_type_right` **(** :ref:`int` idx **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_title` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_close_button_visible` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_comment` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_resizable` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_selected` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_slot_enabled_left` **(** :ref:`int` idx **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_slot_enabled_right` **(** :ref:`int` idx **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_comment` **(** :ref:`bool` comment **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_offset` **(** :ref:`Vector2` offset **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_overlay` **(** :ref:`int` overlay **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_resizable` **(** :ref:`bool` resizable **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_selected` **(** :ref:`bool` selected **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_show_close_button` **(** :ref:`bool` show **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_slot` **(** :ref:`int` idx, :ref:`bool` enable_left, :ref:`int` type_left, :ref:`Color` color_left, :ref:`bool` enable_right, :ref:`int` type_right, :ref:`Color` color_right, :ref:`Texture` custom_left=null, :ref:`Texture` custom_right=null **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_title` **(** :ref:`String` title **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_all_slots` **(** **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_slot` **(** :ref:`int` idx **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_connection_input_color` **(** :ref:`int` idx **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_connection_input_count` **(** **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_connection_input_position` **(** :ref:`int` idx **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_connection_input_type` **(** :ref:`int` idx **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_connection_output_color` **(** :ref:`int` idx **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_connection_output_count` **(** **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_connection_output_position` **(** :ref:`int` idx **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_connection_output_type` **(** :ref:`int` idx **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_offset` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_overlay` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_slot_color_left` **(** :ref:`int` idx **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_slot_color_right` **(** :ref:`int` idx **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_slot_type_left` **(** :ref:`int` idx **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_slot_type_right` **(** :ref:`int` idx **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_title` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_close_button_visible` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_comment` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_resizable` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_selected` **(** **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_slot_enabled_left` **(** :ref:`int` idx **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_slot_enabled_right` **(** :ref:`int` idx **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_comment` **(** :ref:`bool` comment **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_offset` **(** :ref:`Vector2` offset **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_overlay` **(** :ref:`int` overlay **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_resizable` **(** :ref:`bool` resizable **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_selected` **(** :ref:`bool` selected **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_show_close_button` **(** :ref:`bool` show **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_slot` **(** :ref:`int` idx, :ref:`bool` enable_left, :ref:`int` type_left, :ref:`Color` color_left, :ref:`bool` enable_right, :ref:`int` type_right, :ref:`Color` color_right, :ref:`Texture` custom_left=null, :ref:`Texture` custom_right=null **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_title` **(** :ref:`String` title **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_GraphNode_close_request: -- **close_request** **(** **)** +- **close_request** **(** **)** Signal sent on closing the GraphNode. .. _class_GraphNode_dragged: -- **dragged** **(** :ref:`Vector2` from, :ref:`Vector2` to **)** +- **dragged** **(** :ref:`Vector2` from, :ref:`Vector2` to **)** Signal sent when the GraphNode is dragged. .. _class_GraphNode_offset_changed: -- **offset_changed** **(** **)** +- **offset_changed** **(** **)** Signal sent when the GraphNode is moved. .. _class_GraphNode_raise_request: -- **raise_request** **(** **)** +- **raise_request** **(** **)** Signal sent when the GraphNode is requested to be displayed over other ones. Happens on focusing (clicking into) the GraphNode. .. _class_GraphNode_resize_request: -- **resize_request** **(** :ref:`Vector2` new_minsize **)** +- **resize_request** **(** :ref:`Vector2` new_minsize **)** Member Variables @@ -148,169 +148,169 @@ Member Function Description .. _class_GraphNode_clear_all_slots: -- void **clear_all_slots** **(** **)** +- void **clear_all_slots** **(** **)** Disable all input and output slots of the GraphNode. .. _class_GraphNode_clear_slot: -- void **clear_slot** **(** :ref:`int` idx **)** +- void **clear_slot** **(** :ref:`int` idx **)** Disable input and output slot whose index is 'idx'. .. _class_GraphNode_get_connection_input_color: -- :ref:`Color` **get_connection_input_color** **(** :ref:`int` idx **)** +- :ref:`Color` **get_connection_input_color** **(** :ref:`int` idx **)** Return the color of the input connection 'idx'. .. _class_GraphNode_get_connection_input_count: -- :ref:`int` **get_connection_input_count** **(** **)** +- :ref:`int` **get_connection_input_count** **(** **)** Return the number of enabled input slots (connections) to the GraphNode. .. _class_GraphNode_get_connection_input_position: -- :ref:`Vector2` **get_connection_input_position** **(** :ref:`int` idx **)** +- :ref:`Vector2` **get_connection_input_position** **(** :ref:`int` idx **)** Return the position of the input connection 'idx'. .. _class_GraphNode_get_connection_input_type: -- :ref:`int` **get_connection_input_type** **(** :ref:`int` idx **)** +- :ref:`int` **get_connection_input_type** **(** :ref:`int` idx **)** Return the type of the input connection 'idx'. .. _class_GraphNode_get_connection_output_color: -- :ref:`Color` **get_connection_output_color** **(** :ref:`int` idx **)** +- :ref:`Color` **get_connection_output_color** **(** :ref:`int` idx **)** Return the color of the output connection 'idx'. .. _class_GraphNode_get_connection_output_count: -- :ref:`int` **get_connection_output_count** **(** **)** +- :ref:`int` **get_connection_output_count** **(** **)** Return the number of enabled output slots (connections) of the GraphNode. .. _class_GraphNode_get_connection_output_position: -- :ref:`Vector2` **get_connection_output_position** **(** :ref:`int` idx **)** +- :ref:`Vector2` **get_connection_output_position** **(** :ref:`int` idx **)** Return the position of the output connection 'idx'. .. _class_GraphNode_get_connection_output_type: -- :ref:`int` **get_connection_output_type** **(** :ref:`int` idx **)** +- :ref:`int` **get_connection_output_type** **(** :ref:`int` idx **)** Return the type of the output connection 'idx'. .. _class_GraphNode_get_offset: -- :ref:`Vector2` **get_offset** **(** **)** const +- :ref:`Vector2` **get_offset** **(** **)** const Return the offset of the GraphNode. .. _class_GraphNode_get_overlay: -- :ref:`int` **get_overlay** **(** **)** const +- :ref:`int` **get_overlay** **(** **)** const .. _class_GraphNode_get_slot_color_left: -- :ref:`Color` **get_slot_color_left** **(** :ref:`int` idx **)** const +- :ref:`Color` **get_slot_color_left** **(** :ref:`int` idx **)** const Return the color set to 'idx' left (input) slot. .. _class_GraphNode_get_slot_color_right: -- :ref:`Color` **get_slot_color_right** **(** :ref:`int` idx **)** const +- :ref:`Color` **get_slot_color_right** **(** :ref:`int` idx **)** const Return the color set to 'idx' right (output) slot. .. _class_GraphNode_get_slot_type_left: -- :ref:`int` **get_slot_type_left** **(** :ref:`int` idx **)** const +- :ref:`int` **get_slot_type_left** **(** :ref:`int` idx **)** const Return the (integer) type of left (input) 'idx' slot. .. _class_GraphNode_get_slot_type_right: -- :ref:`int` **get_slot_type_right** **(** :ref:`int` idx **)** const +- :ref:`int` **get_slot_type_right** **(** :ref:`int` idx **)** const Return the (integer) type of right (output) 'idx' slot. .. _class_GraphNode_get_title: -- :ref:`String` **get_title** **(** **)** const +- :ref:`String` **get_title** **(** **)** const Return the title of the GraphNode. .. _class_GraphNode_is_close_button_visible: -- :ref:`bool` **is_close_button_visible** **(** **)** const +- :ref:`bool` **is_close_button_visible** **(** **)** const Returns true if the close button is shown. False otherwise. .. _class_GraphNode_is_comment: -- :ref:`bool` **is_comment** **(** **)** const +- :ref:`bool` **is_comment** **(** **)** const .. _class_GraphNode_is_resizable: -- :ref:`bool` **is_resizable** **(** **)** const +- :ref:`bool` **is_resizable** **(** **)** const .. _class_GraphNode_is_selected: -- :ref:`bool` **is_selected** **(** **)** +- :ref:`bool` **is_selected** **(** **)** .. _class_GraphNode_is_slot_enabled_left: -- :ref:`bool` **is_slot_enabled_left** **(** :ref:`int` idx **)** const +- :ref:`bool` **is_slot_enabled_left** **(** :ref:`int` idx **)** const Return true if left (input) slot 'idx' is enabled. False otherwise. .. _class_GraphNode_is_slot_enabled_right: -- :ref:`bool` **is_slot_enabled_right** **(** :ref:`int` idx **)** const +- :ref:`bool` **is_slot_enabled_right** **(** :ref:`int` idx **)** const Return true if right (output) slot 'idx' is enabled. False otherwise. .. _class_GraphNode_set_comment: -- void **set_comment** **(** :ref:`bool` comment **)** +- void **set_comment** **(** :ref:`bool` comment **)** .. _class_GraphNode_set_offset: -- void **set_offset** **(** :ref:`Vector2` offset **)** +- void **set_offset** **(** :ref:`Vector2` offset **)** Set the offset of the GraphNode. .. _class_GraphNode_set_overlay: -- void **set_overlay** **(** :ref:`int` overlay **)** +- void **set_overlay** **(** :ref:`int` overlay **)** .. _class_GraphNode_set_resizable: -- void **set_resizable** **(** :ref:`bool` resizable **)** +- void **set_resizable** **(** :ref:`bool` resizable **)** .. _class_GraphNode_set_selected: -- void **set_selected** **(** :ref:`bool` selected **)** +- void **set_selected** **(** :ref:`bool` selected **)** .. _class_GraphNode_set_show_close_button: -- void **set_show_close_button** **(** :ref:`bool` show **)** +- void **set_show_close_button** **(** :ref:`bool` show **)** Show the close button on the GraphNode if 'show' is true (disabled by default). If enabled, a connection on the signal close_request is needed for the close button to work. .. _class_GraphNode_set_slot: -- void **set_slot** **(** :ref:`int` idx, :ref:`bool` enable_left, :ref:`int` type_left, :ref:`Color` color_left, :ref:`bool` enable_right, :ref:`int` type_right, :ref:`Color` color_right, :ref:`Texture` custom_left=null, :ref:`Texture` custom_right=null **)** +- void **set_slot** **(** :ref:`int` idx, :ref:`bool` enable_left, :ref:`int` type_left, :ref:`Color` color_left, :ref:`bool` enable_right, :ref:`int` type_right, :ref:`Color` color_right, :ref:`Texture` custom_left=null, :ref:`Texture` custom_right=null **)** .. _class_GraphNode_set_title: -- void **set_title** **(** :ref:`String` title **)** +- void **set_title** **(** :ref:`String` title **)** Set the title of the GraphNode. diff --git a/classes/class_gridcontainer.rst b/classes/class_gridcontainer.rst index bb4333ac1..644e9285f 100644 --- a/classes/class_gridcontainer.rst +++ b/classes/class_gridcontainer.rst @@ -19,11 +19,11 @@ Grid container used to arrange elements in a grid like layout Member Functions ---------------- -+------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_columns` **(** **)** const | -+------------------------+-------------------------------------------------------------------------------------------------+ -| void | :ref:`set_columns` **(** :ref:`int` columns **)** | -+------------------------+-------------------------------------------------------------------------------------------------+ ++------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_columns` **(** **)** const | ++------------------------+-----------------------------------------------------------------------------------------------+ +| void | :ref:`set_columns` **(** :ref:`int` columns **)** | ++------------------------+-----------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -43,13 +43,13 @@ Member Function Description .. _class_GridContainer_get_columns: -- :ref:`int` **get_columns** **(** **)** const +- :ref:`int` **get_columns** **(** **)** const Returns the number of columns in this container .. _class_GridContainer_set_columns: -- void **set_columns** **(** :ref:`int` columns **)** +- void **set_columns** **(** :ref:`int` columns **)** Sets the numbers of columns in the container, then reorder its children to accommodate the new layout diff --git a/classes/class_gridmap.rst b/classes/class_gridmap.rst index 6f8afb6e3..20fec24cb 100644 --- a/classes/class_gridmap.rst +++ b/classes/class_gridmap.rst @@ -19,51 +19,51 @@ Node for 3D tile-based maps. Member Functions ---------------- -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_cell_item` **(** :ref:`int` x, :ref:`int` y, :ref:`int` z **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_cell_item_orientation` **(** :ref:`int` x, :ref:`int` y, :ref:`int` z **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_cell_size` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_center_x` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_center_y` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_center_z` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_meshes` **(** **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_octant_size` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`MeshLibrary` | :ref:`get_theme` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_used_cells` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`map_to_world` **(** :ref:`int` x, :ref:`int` y, :ref:`int` z **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resource_changed` **(** :ref:`Resource` resource **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cell_item` **(** :ref:`int` x, :ref:`int` y, :ref:`int` z, :ref:`int` item, :ref:`int` orientation=0 **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cell_size` **(** :ref:`Vector3` size **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_center_x` **(** :ref:`bool` enable **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_center_y` **(** :ref:`bool` enable **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_center_z` **(** :ref:`bool` enable **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_clip` **(** :ref:`bool` enabled, :ref:`bool` clipabove=true, :ref:`int` floor=0, :ref:`int` axis=0 **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_octant_size` **(** :ref:`int` size **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_theme` **(** :ref:`MeshLibrary` theme **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`world_to_map` **(** :ref:`Vector3` pos **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_cell_item` **(** :ref:`int` x, :ref:`int` y, :ref:`int` z **)** const | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_cell_item_orientation` **(** :ref:`int` x, :ref:`int` y, :ref:`int` z **)** const | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_cell_size` **(** **)** const | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_center_x` **(** **)** const | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_center_y` **(** **)** const | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_center_z` **(** **)** const | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_meshes` **(** **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_octant_size` **(** **)** const | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`MeshLibrary` | :ref:`get_theme` **(** **)** const | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_used_cells` **(** **)** const | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`map_to_world` **(** :ref:`int` x, :ref:`int` y, :ref:`int` z **)** const | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resource_changed` **(** :ref:`Resource` resource **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cell_item` **(** :ref:`int` x, :ref:`int` y, :ref:`int` z, :ref:`int` item, :ref:`int` orientation=0 **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cell_size` **(** :ref:`Vector3` size **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_center_x` **(** :ref:`bool` enable **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_center_y` **(** :ref:`bool` enable **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_center_z` **(** :ref:`bool` enable **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_clip` **(** :ref:`bool` enabled, :ref:`bool` clipabove=true, :ref:`int` floor=0, :ref:`int` axis=0 **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_octant_size` **(** :ref:`int` size **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_theme` **(** :ref:`MeshLibrary` theme **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`world_to_map` **(** :ref:`Vector3` pos **)** const | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -86,81 +86,81 @@ Member Function Description .. _class_GridMap_clear: -- void **clear** **(** **)** +- void **clear** **(** **)** Clear all cells. .. _class_GridMap_get_cell_item: -- :ref:`int` **get_cell_item** **(** :ref:`int` x, :ref:`int` y, :ref:`int` z **)** const +- :ref:`int` **get_cell_item** **(** :ref:`int` x, :ref:`int` y, :ref:`int` z **)** const The :ref:`MeshLibrary` item index located at the grid-based X, Y and Z coordinates. If the cell is empty, INVALID_CELL_ITEM will be returned. .. _class_GridMap_get_cell_item_orientation: -- :ref:`int` **get_cell_item_orientation** **(** :ref:`int` x, :ref:`int` y, :ref:`int` z **)** const +- :ref:`int` **get_cell_item_orientation** **(** :ref:`int` x, :ref:`int` y, :ref:`int` z **)** const The orientation of the cell at the grid-based X, Y and Z coordinates. -1 is retuned if the cell is empty. .. _class_GridMap_get_cell_size: -- :ref:`Vector3` **get_cell_size** **(** **)** const +- :ref:`Vector3` **get_cell_size** **(** **)** const The dimensions of the grid's cells. .. _class_GridMap_get_center_x: -- :ref:`bool` **get_center_x** **(** **)** const +- :ref:`bool` **get_center_x** **(** **)** const Returns whether or not grid items are centered on the X axis. .. _class_GridMap_get_center_y: -- :ref:`bool` **get_center_y** **(** **)** const +- :ref:`bool` **get_center_y** **(** **)** const Returns whether or not grid items are centered on the Y axis. .. _class_GridMap_get_center_z: -- :ref:`bool` **get_center_z** **(** **)** const +- :ref:`bool` **get_center_z** **(** **)** const Returns whether or not grid items are centered on the Z axis. .. _class_GridMap_get_meshes: -- :ref:`Array` **get_meshes** **(** **)** +- :ref:`Array` **get_meshes** **(** **)** Array of :ref:`Transform` and :ref:`Mesh` references corresponding to the non empty cells in the grid. The transforms are specified in world space. .. _class_GridMap_get_octant_size: -- :ref:`int` **get_octant_size** **(** **)** const +- :ref:`int` **get_octant_size** **(** **)** const The size of each octant measured in number of cells. This applies to all three axis. .. _class_GridMap_get_theme: -- :ref:`MeshLibrary` **get_theme** **(** **)** const +- :ref:`MeshLibrary` **get_theme** **(** **)** const The assigned :ref:`MeshLibrary`. .. _class_GridMap_get_used_cells: -- :ref:`Array` **get_used_cells** **(** **)** const +- :ref:`Array` **get_used_cells** **(** **)** const Array of :ref:`Vector3` with the non empty cell coordinates in the grid map. .. _class_GridMap_map_to_world: -- :ref:`Vector3` **map_to_world** **(** :ref:`int` x, :ref:`int` y, :ref:`int` z **)** const +- :ref:`Vector3` **map_to_world** **(** :ref:`int` x, :ref:`int` y, :ref:`int` z **)** const .. _class_GridMap_resource_changed: -- void **resource_changed** **(** :ref:`Resource` resource **)** +- void **resource_changed** **(** :ref:`Resource` resource **)** .. _class_GridMap_set_cell_item: -- void **set_cell_item** **(** :ref:`int` x, :ref:`int` y, :ref:`int` z, :ref:`int` item, :ref:`int` orientation=0 **)** +- void **set_cell_item** **(** :ref:`int` x, :ref:`int` y, :ref:`int` z, :ref:`int` item, :ref:`int` orientation=0 **)** Set the mesh index for the cell referenced by its grid-based X, Y and Z coordinates. @@ -170,46 +170,46 @@ Optionally, the item's orientation can be passed. .. _class_GridMap_set_cell_size: -- void **set_cell_size** **(** :ref:`Vector3` size **)** +- void **set_cell_size** **(** :ref:`Vector3` size **)** Sets the height, width and depth of the grid's cells. .. _class_GridMap_set_center_x: -- void **set_center_x** **(** :ref:`bool` enable **)** +- void **set_center_x** **(** :ref:`bool` enable **)** Set grid items to be centered on the X axis. By default it is enabled. .. _class_GridMap_set_center_y: -- void **set_center_y** **(** :ref:`bool` enable **)** +- void **set_center_y** **(** :ref:`bool` enable **)** Set grid items to be centered on the Y axis. By default it is enabled. .. _class_GridMap_set_center_z: -- void **set_center_z** **(** :ref:`bool` enable **)** +- void **set_center_z** **(** :ref:`bool` enable **)** Set grid items to be centered on the Z axis. By default it is enabled. .. _class_GridMap_set_clip: -- void **set_clip** **(** :ref:`bool` enabled, :ref:`bool` clipabove=true, :ref:`int` floor=0, :ref:`int` axis=0 **)** +- void **set_clip** **(** :ref:`bool` enabled, :ref:`bool` clipabove=true, :ref:`int` floor=0, :ref:`int` axis=0 **)** .. _class_GridMap_set_octant_size: -- void **set_octant_size** **(** :ref:`int` size **)** +- void **set_octant_size** **(** :ref:`int` size **)** Sets the size for each octant measured in number of cells. This applies to all three axis. .. _class_GridMap_set_theme: -- void **set_theme** **(** :ref:`MeshLibrary` theme **)** +- void **set_theme** **(** :ref:`MeshLibrary` theme **)** Sets the collection of meshes for the map. .. _class_GridMap_world_to_map: -- :ref:`Vector3` **world_to_map** **(** :ref:`Vector3` pos **)** const +- :ref:`Vector3` **world_to_map** **(** :ref:`Vector3` pos **)** const diff --git a/classes/class_groovejoint2d.rst b/classes/class_groovejoint2d.rst index 738a6dd90..55697cac7 100644 --- a/classes/class_groovejoint2d.rst +++ b/classes/class_groovejoint2d.rst @@ -19,15 +19,15 @@ Groove constraint for 2D physics. Member Functions ---------------- -+----------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_initial_offset` **(** **)** const | -+----------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_length` **(** **)** const | -+----------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_initial_offset` **(** :ref:`float` offset **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_length` **(** :ref:`float` length **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------------+ ++----------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_initial_offset` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_length` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_initial_offset` **(** :ref:`float` offset **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_length` **(** :ref:`float` length **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -51,25 +51,25 @@ Member Function Description .. _class_GrooveJoint2D_get_initial_offset: -- :ref:`float` **get_initial_offset** **(** **)** const +- :ref:`float` **get_initial_offset** **(** **)** const Set the final offset of the groove on body A. .. _class_GrooveJoint2D_get_length: -- :ref:`float` **get_length** **(** **)** const +- :ref:`float` **get_length** **(** **)** const Return the length of the groove. .. _class_GrooveJoint2D_set_initial_offset: -- void **set_initial_offset** **(** :ref:`float` offset **)** +- void **set_initial_offset** **(** :ref:`float` offset **)** Set the initial offset of the groove on body A. .. _class_GrooveJoint2D_set_length: -- void **set_length** **(** :ref:`float` length **)** +- void **set_length** **(** :ref:`float` length **)** Set the length of the groove. diff --git a/classes/class_hingejoint.rst b/classes/class_hingejoint.rst index 0eead23bb..279a29c26 100644 --- a/classes/class_hingejoint.rst +++ b/classes/class_hingejoint.rst @@ -19,15 +19,15 @@ A hinge between two 3D bodies. Member Functions ---------------- -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_flag` **(** :ref:`int` flag **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_param` **(** :ref:`int` param **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_flag` **(** :ref:`int` flag, :ref:`bool` enabled **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_param` **(** :ref:`int` param, :ref:`float` value **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ ++----------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_flag` **(** :ref:`int` flag **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_param` **(** :ref:`int` param **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_flag` **(** :ref:`int` flag, :ref:`bool` enabled **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_param` **(** :ref:`int` param, :ref:`float` value **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -99,18 +99,18 @@ Member Function Description .. _class_HingeJoint_get_flag: -- :ref:`bool` **get_flag** **(** :ref:`int` flag **)** const +- :ref:`bool` **get_flag** **(** :ref:`int` flag **)** const .. _class_HingeJoint_get_param: -- :ref:`float` **get_param** **(** :ref:`int` param **)** const +- :ref:`float` **get_param** **(** :ref:`int` param **)** const .. _class_HingeJoint_set_flag: -- void **set_flag** **(** :ref:`int` flag, :ref:`bool` enabled **)** +- void **set_flag** **(** :ref:`int` flag, :ref:`bool` enabled **)** .. _class_HingeJoint_set_param: -- void **set_param** **(** :ref:`int` param, :ref:`float` value **)** +- void **set_param** **(** :ref:`int` param, :ref:`float` value **)** diff --git a/classes/class_httpclient.rst b/classes/class_httpclient.rst index ddbc93dca..d02a0cfa5 100644 --- a/classes/class_httpclient.rst +++ b/classes/class_httpclient.rst @@ -19,49 +19,49 @@ Hyper-text transfer protocol client. Member Functions ---------------- -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`close` **(** **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`connect_to_host` **(** :ref:`String` host, :ref:`int` port, :ref:`bool` use_ssl=false, :ref:`bool` verify_host=true **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StreamPeer` | :ref:`get_connection` **(** **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_response_body_length` **(** **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_response_code` **(** **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_response_headers` **(** **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_response_headers_as_dictionary` **(** **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_status` **(** **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_response` **(** **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_blocking_mode_enabled` **(** **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_response_chunked` **(** **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`poll` **(** **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`query_string_from_dict` **(** :ref:`Dictionary` fields **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`read_response_body_chunk` **(** **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`request` **(** :ref:`int` method, :ref:`String` url, :ref:`PoolStringArray` headers, :ref:`String` body="" **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`request_raw` **(** :ref:`int` method, :ref:`String` url, :ref:`PoolStringArray` headers, :ref:`PoolByteArray` body **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`send_body_data` **(** :ref:`PoolByteArray` body **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`send_body_text` **(** :ref:`String` body **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_blocking_mode` **(** :ref:`bool` enabled **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_connection` **(** :ref:`StreamPeer` connection **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_read_chunk_size` **(** :ref:`int` bytes **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`close` **(** **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`connect_to_host` **(** :ref:`String` host, :ref:`int` port, :ref:`bool` use_ssl=false, :ref:`bool` verify_host=true **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`StreamPeer` | :ref:`get_connection` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_response_body_length` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_response_code` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_response_headers` **(** **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_response_headers_as_dictionary` **(** **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_status` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_response` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_blocking_mode_enabled` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_response_chunked` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`poll` **(** **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`query_string_from_dict` **(** :ref:`Dictionary` fields **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`read_response_body_chunk` **(** **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`request` **(** :ref:`int` method, :ref:`String` url, :ref:`PoolStringArray` headers, :ref:`String` body="" **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`request_raw` **(** :ref:`int` method, :ref:`String` url, :ref:`PoolStringArray` headers, :ref:`PoolByteArray` body **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`send_body_data` **(** :ref:`PoolByteArray` body **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`send_body_text` **(** :ref:`String` body **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_blocking_mode` **(** :ref:`bool` enabled **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_connection` **(** :ref:`StreamPeer` connection **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_read_chunk_size` **(** :ref:`int` bytes **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -147,13 +147,13 @@ Member Function Description .. _class_HTTPClient_close: -- void **close** **(** **)** +- void **close** **(** **)** Cloces the current connection, allows for reusal of :ref:`HTTPClient`. .. _class_HTTPClient_connect_to_host: -- :ref:`int` **connect_to_host** **(** :ref:`String` host, :ref:`int` port, :ref:`bool` use_ssl=false, :ref:`bool` verify_host=true **)** +- :ref:`int` **connect_to_host** **(** :ref:`String` host, :ref:`int` port, :ref:`bool` use_ssl=false, :ref:`bool` verify_host=true **)** Connect to a host. This needs to be done before any requests are sent. @@ -163,31 +163,31 @@ verify_host will check the SSL identity of the host if set to true. .. _class_HTTPClient_get_connection: -- :ref:`StreamPeer` **get_connection** **(** **)** const +- :ref:`StreamPeer` **get_connection** **(** **)** const Return current connection. .. _class_HTTPClient_get_response_body_length: -- :ref:`int` **get_response_body_length** **(** **)** const +- :ref:`int` **get_response_body_length** **(** **)** const Return the response's body length. .. _class_HTTPClient_get_response_code: -- :ref:`int` **get_response_code** **(** **)** const +- :ref:`int` **get_response_code** **(** **)** const Return the HTTP status code of the response. .. _class_HTTPClient_get_response_headers: -- :ref:`PoolStringArray` **get_response_headers** **(** **)** +- :ref:`PoolStringArray` **get_response_headers** **(** **)** Return the response headers. .. _class_HTTPClient_get_response_headers_as_dictionary: -- :ref:`Dictionary` **get_response_headers_as_dictionary** **(** **)** +- :ref:`Dictionary` **get_response_headers_as_dictionary** **(** **)** Returns all response headers as dictionary where the case-sensitivity of the keys and values is kept like the server delivers it. A value is a simple String, this string can have more than one value where "; " is used as separator. @@ -197,37 +197,37 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) .. _class_HTTPClient_get_status: -- :ref:`int` **get_status** **(** **)** const +- :ref:`int` **get_status** **(** **)** const Returns a STATUS\_\* enum constant. Need to call :ref:`poll` in order to get status updates. .. _class_HTTPClient_has_response: -- :ref:`bool` **has_response** **(** **)** const +- :ref:`bool` **has_response** **(** **)** const Return whether this :ref:`HTTPClient` has a response available. .. _class_HTTPClient_is_blocking_mode_enabled: -- :ref:`bool` **is_blocking_mode_enabled** **(** **)** const +- :ref:`bool` **is_blocking_mode_enabled** **(** **)** const Return whether blocking mode is enabled. .. _class_HTTPClient_is_response_chunked: -- :ref:`bool` **is_response_chunked** **(** **)** const +- :ref:`bool` **is_response_chunked** **(** **)** const Return whether this :ref:`HTTPClient` has a response that is chunked. .. _class_HTTPClient_poll: -- :ref:`int` **poll** **(** **)** +- :ref:`int` **poll** **(** **)** This needs to be called in order to have any request processed. Check results with :ref:`get_status` .. _class_HTTPClient_query_string_from_dict: -- :ref:`String` **query_string_from_dict** **(** :ref:`Dictionary` fields **)** +- :ref:`String` **query_string_from_dict** **(** :ref:`Dictionary` fields **)** Generates a GET/POST application/x-www-form-urlencoded style query string from a provided dictionary, e.g.: @@ -239,13 +239,13 @@ Generates a GET/POST application/x-www-form-urlencoded style query string from a .. _class_HTTPClient_read_response_body_chunk: -- :ref:`PoolByteArray` **read_response_body_chunk** **(** **)** +- :ref:`PoolByteArray` **read_response_body_chunk** **(** **)** Reads one chunk from the response. .. _class_HTTPClient_request: -- :ref:`int` **request** **(** :ref:`int` method, :ref:`String` url, :ref:`PoolStringArray` headers, :ref:`String` body="" **)** +- :ref:`int` **request** **(** :ref:`int` method, :ref:`String` url, :ref:`PoolStringArray` headers, :ref:`String` body="" **)** Sends a request to the connected host. The url is what is normally behind the hostname, i.e. in ``http://somehost.com/index.php``, url would be "index.php". @@ -262,7 +262,7 @@ To create a POST request with query strings to push to the server, do: .. _class_HTTPClient_request_raw: -- :ref:`int` **request_raw** **(** :ref:`int` method, :ref:`String` url, :ref:`PoolStringArray` headers, :ref:`PoolByteArray` body **)** +- :ref:`int` **request_raw** **(** :ref:`int` method, :ref:`String` url, :ref:`PoolStringArray` headers, :ref:`PoolByteArray` body **)** Sends a raw request to the connected host. The url is what is normally behind the hostname, i.e. in ``http://somehost.com/index.php``, url would be "index.php". @@ -272,31 +272,31 @@ Sends body raw, as a byte array, does not encode it in any way. .. _class_HTTPClient_send_body_data: -- :ref:`int` **send_body_data** **(** :ref:`PoolByteArray` body **)** +- :ref:`int` **send_body_data** **(** :ref:`PoolByteArray` body **)** Stub function .. _class_HTTPClient_send_body_text: -- :ref:`int` **send_body_text** **(** :ref:`String` body **)** +- :ref:`int` **send_body_text** **(** :ref:`String` body **)** Stub function .. _class_HTTPClient_set_blocking_mode: -- void **set_blocking_mode** **(** :ref:`bool` enabled **)** +- void **set_blocking_mode** **(** :ref:`bool` enabled **)** If set to true, execution will block until all data is read from the response. .. _class_HTTPClient_set_connection: -- void **set_connection** **(** :ref:`StreamPeer` connection **)** +- void **set_connection** **(** :ref:`StreamPeer` connection **)** Set connection to use, for this client. .. _class_HTTPClient_set_read_chunk_size: -- void **set_read_chunk_size** **(** :ref:`int` bytes **)** +- void **set_read_chunk_size** **(** :ref:`int` bytes **)** Sets the size of the buffer used and maximum bytes to read per iteration. see :ref:`read_response_body_chunk` diff --git a/classes/class_httprequest.rst b/classes/class_httprequest.rst index 3f17c55ba..d2ce5ca7e 100644 --- a/classes/class_httprequest.rst +++ b/classes/class_httprequest.rst @@ -19,40 +19,40 @@ A Node with the ability to send HTTP requests. Member Functions ---------------- -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cancel_request` **(** **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_body_size` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_body_size_limit` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_download_file` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_downloaded_bytes` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_http_client_status` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_max_redirects` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_using_threads` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`request` **(** :ref:`String` url, :ref:`PoolStringArray` custom_headers=PoolStringArray( ), :ref:`bool` ssl_validate_domain=true, :ref:`int` method=0, :ref:`String` request_data="" **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_body_size_limit` **(** :ref:`int` bytes **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_download_file` **(** :ref:`String` path **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_max_redirects` **(** :ref:`int` amount **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_threads` **(** :ref:`bool` enable **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`cancel_request` **(** **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_body_size` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_body_size_limit` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_download_file` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_downloaded_bytes` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_http_client_status` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_max_redirects` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_using_threads` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`request` **(** :ref:`String` url, :ref:`PoolStringArray` custom_headers=PoolStringArray( ), :ref:`bool` ssl_validate_domain=true, :ref:`int` method=0, :ref:`String` request_data="" **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_body_size_limit` **(** :ref:`int` bytes **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_download_file` **(** :ref:`String` path **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_max_redirects` **(** :ref:`int` amount **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_threads` **(** :ref:`bool` enable **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_HTTPRequest_request_completed: -- **request_completed** **(** :ref:`int` result, :ref:`int` response_code, :ref:`PoolStringArray` headers, :ref:`PoolByteArray` body **)** +- **request_completed** **(** :ref:`int` result, :ref:`int` response_code, :ref:`PoolStringArray` headers, :ref:`PoolByteArray` body **)** This signal is emitted upon request completion. @@ -101,77 +101,77 @@ Member Function Description .. _class_HTTPRequest_cancel_request: -- void **cancel_request** **(** **)** +- void **cancel_request** **(** **)** Cancel the current request. .. _class_HTTPRequest_get_body_size: -- :ref:`int` **get_body_size** **(** **)** const +- :ref:`int` **get_body_size** **(** **)** const Return the response body length. .. _class_HTTPRequest_get_body_size_limit: -- :ref:`int` **get_body_size_limit** **(** **)** const +- :ref:`int` **get_body_size_limit** **(** **)** const Return current body size limit. .. _class_HTTPRequest_get_download_file: -- :ref:`String` **get_download_file** **(** **)** const +- :ref:`String` **get_download_file** **(** **)** const Return the file this request will download into. .. _class_HTTPRequest_get_downloaded_bytes: -- :ref:`int` **get_downloaded_bytes** **(** **)** const +- :ref:`int` **get_downloaded_bytes** **(** **)** const Return the amount of bytes this HTTPRequest downloaded. .. _class_HTTPRequest_get_http_client_status: -- :ref:`int` **get_http_client_status** **(** **)** const +- :ref:`int` **get_http_client_status** **(** **)** const Return the current status of the underlying :ref:`HTTPClient`. .. _class_HTTPRequest_get_max_redirects: -- :ref:`int` **get_max_redirects** **(** **)** const +- :ref:`int` **get_max_redirects** **(** **)** const Return the maximum amount of redirects that will be followed. .. _class_HTTPRequest_is_using_threads: -- :ref:`bool` **is_using_threads** **(** **)** const +- :ref:`bool` **is_using_threads** **(** **)** const Whether this request is using threads. .. _class_HTTPRequest_request: -- :ref:`int` **request** **(** :ref:`String` url, :ref:`PoolStringArray` custom_headers=PoolStringArray( ), :ref:`bool` ssl_validate_domain=true, :ref:`int` method=0, :ref:`String` request_data="" **)** +- :ref:`int` **request** **(** :ref:`String` url, :ref:`PoolStringArray` custom_headers=PoolStringArray( ), :ref:`bool` ssl_validate_domain=true, :ref:`int` method=0, :ref:`String` request_data="" **)** .. _class_HTTPRequest_set_body_size_limit: -- void **set_body_size_limit** **(** :ref:`int` bytes **)** +- void **set_body_size_limit** **(** :ref:`int` bytes **)** Set the response body size limit. .. _class_HTTPRequest_set_download_file: -- void **set_download_file** **(** :ref:`String` path **)** +- void **set_download_file** **(** :ref:`String` path **)** Set the file to download into. Outputs the response body into the file. .. _class_HTTPRequest_set_max_redirects: -- void **set_max_redirects** **(** :ref:`int` amount **)** +- void **set_max_redirects** **(** :ref:`int` amount **)** Set the maximum amount of redirects the request will follow. .. _class_HTTPRequest_set_use_threads: -- void **set_use_threads** **(** :ref:`bool` enable **)** +- void **set_use_threads** **(** :ref:`bool` enable **)** Make this HTTPRequest use threads. diff --git a/classes/class_image.rst b/classes/class_image.rst index b6060acdd..8eb4781b3 100644 --- a/classes/class_image.rst +++ b/classes/class_image.rst @@ -19,93 +19,93 @@ Image datatype. Member Functions ---------------- -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`blend_rect` **(** :ref:`Image` src, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`blend_rect_mask` **(** :ref:`Image` src, :ref:`Image` mask, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`blit_rect` **(** :ref:`Image` src, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`blit_rect_mask` **(** :ref:`Image` src, :ref:`Image` mask, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_mipmaps` **(** **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`compress` **(** :ref:`int` mode, :ref:`int` source, :ref:`float` lossy_quality **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`convert` **(** :ref:`int` format **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`copy_from` **(** :ref:`Image` src **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create` **(** :ref:`int` width, :ref:`int` height, :ref:`bool` use_mipmaps, :ref:`int` format **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_from_data` **(** :ref:`int` width, :ref:`int` height, :ref:`bool` use_mipmaps, :ref:`int` format, :ref:`PoolByteArray` data **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`crop` **(** :ref:`int` width, :ref:`int` height **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`decompress` **(** **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`detect_alpha` **(** **)** const | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`expand_x2_hq2x` **(** **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`fill` **(** :ref:`Color` color **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`fix_alpha_edges` **(** **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`flip_x` **(** **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`flip_y` **(** **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`generate_mipmaps` **(** **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`get_data` **(** **)** const | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_format` **(** **)** const | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_height` **(** **)** const | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_mipmap_offset` **(** :ref:`int` mipmap **)** const | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_pixel` **(** :ref:`int` x, :ref:`int` y **)** const | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`get_rect` **(** :ref:`Rect2` rect **)** const | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_size` **(** **)** const | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_used_rect` **(** **)** const | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_width` **(** **)** const | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_mipmaps` **(** **)** const | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_compressed` **(** **)** const | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_empty` **(** **)** const | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_invisible` **(** **)** const | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`load` **(** :ref:`String` path **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`lock` **(** **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`normalmap_to_xy` **(** **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`premultiply_alpha` **(** **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resize` **(** :ref:`int` width, :ref:`int` height, :ref:`int` interpolation=1 **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resize_to_po2` **(** :ref:`bool` square=false **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`save_png` **(** :ref:`String` path **)** const | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pixel` **(** :ref:`int` x, :ref:`int` y, :ref:`Color` color **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shrink_x2` **(** **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`srgb_to_linear` **(** **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`unlock` **(** **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`blend_rect` **(** :ref:`Image` src, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`blend_rect_mask` **(** :ref:`Image` src, :ref:`Image` mask, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`blit_rect` **(** :ref:`Image` src, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`blit_rect_mask` **(** :ref:`Image` src, :ref:`Image` mask, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_mipmaps` **(** **)** | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`compress` **(** :ref:`int` mode, :ref:`int` source, :ref:`float` lossy_quality **)** | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`convert` **(** :ref:`int` format **)** | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`copy_from` **(** :ref:`Image` src **)** | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create` **(** :ref:`int` width, :ref:`int` height, :ref:`bool` use_mipmaps, :ref:`int` format **)** | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create_from_data` **(** :ref:`int` width, :ref:`int` height, :ref:`bool` use_mipmaps, :ref:`int` format, :ref:`PoolByteArray` data **)** | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`crop` **(** :ref:`int` width, :ref:`int` height **)** | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`decompress` **(** **)** | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`detect_alpha` **(** **)** const | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`expand_x2_hq2x` **(** **)** | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`fill` **(** :ref:`Color` color **)** | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`fix_alpha_edges` **(** **)** | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`flip_x` **(** **)** | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`flip_y` **(** **)** | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`generate_mipmaps` **(** **)** | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`get_data` **(** **)** const | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_format` **(** **)** const | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_height` **(** **)** const | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_mipmap_offset` **(** :ref:`int` mipmap **)** const | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_pixel` **(** :ref:`int` x, :ref:`int` y **)** const | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Image` | :ref:`get_rect` **(** :ref:`Rect2` rect **)** const | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_size` **(** **)** const | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_used_rect` **(** **)** const | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_width` **(** **)** const | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_mipmaps` **(** **)** const | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_compressed` **(** **)** const | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_empty` **(** **)** const | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_invisible` **(** **)** const | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`load` **(** :ref:`String` path **)** | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`lock` **(** **)** | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`normalmap_to_xy` **(** **)** | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`premultiply_alpha` **(** **)** | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resize` **(** :ref:`int` width, :ref:`int` height, :ref:`int` interpolation=1 **)** | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resize_to_po2` **(** :ref:`bool` square=false **)** | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`save_png` **(** :ref:`String` path **)** const | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pixel` **(** :ref:`int` x, :ref:`int` y, :ref:`Color` color **)** | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shrink_x2` **(** **)** | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`srgb_to_linear` **(** **)** | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`unlock` **(** **)** | ++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -181,202 +181,202 @@ Member Function Description .. _class_Image_blend_rect: -- void **blend_rect** **(** :ref:`Image` src, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** +- void **blend_rect** **(** :ref:`Image` src, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** Alpha-blends a "src_rect" :ref:`Rect2` from "src" :ref:`Image` to this :ref:`Image` on coordinates "dest". .. _class_Image_blend_rect_mask: -- void **blend_rect_mask** **(** :ref:`Image` src, :ref:`Image` mask, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** +- void **blend_rect_mask** **(** :ref:`Image` src, :ref:`Image` mask, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** Alpha-blends a "src_rect" :ref:`Rect2` from "src" :ref:`Image` to this :ref:`Image` using a "mask" :ref:`Image` on coordinates "dest". Alpha channels are required for both "src" and "mask", dest pixels and src pixels will blend if the corresponding mask pixel's alpha value is not 0. "src" :ref:`Image` and "mask" :ref:`Image` \*must\* have the same size (width and height) but they can have different formats .. _class_Image_blit_rect: -- void **blit_rect** **(** :ref:`Image` src, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** +- void **blit_rect** **(** :ref:`Image` src, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** Copy a "src_rect" :ref:`Rect2` from "src" :ref:`Image` to this :ref:`Image` on coordinates "dest". .. _class_Image_blit_rect_mask: -- void **blit_rect_mask** **(** :ref:`Image` src, :ref:`Image` mask, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** +- void **blit_rect_mask** **(** :ref:`Image` src, :ref:`Image` mask, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** Blits a "src_rect" :ref:`Rect2` from "src" :ref:`Image` to this :ref:`Image` using a "mask" :ref:`Image` on coordinates "dest". Alpha channel is required for "mask", will copy src pixel onto dest if the corresponding mask pixel's alpha value is not 0. "src" :ref:`Image` and "mask" :ref:`Image` \*must\* have the same size (width and height) but they can have different formats .. _class_Image_clear_mipmaps: -- void **clear_mipmaps** **(** **)** +- void **clear_mipmaps** **(** **)** .. _class_Image_compress: -- :ref:`int` **compress** **(** :ref:`int` mode, :ref:`int` source, :ref:`float` lossy_quality **)** +- :ref:`int` **compress** **(** :ref:`int` mode, :ref:`int` source, :ref:`float` lossy_quality **)** .. _class_Image_convert: -- void **convert** **(** :ref:`int` format **)** +- void **convert** **(** :ref:`int` format **)** .. _class_Image_copy_from: -- void **copy_from** **(** :ref:`Image` src **)** +- void **copy_from** **(** :ref:`Image` src **)** .. _class_Image_create: -- void **create** **(** :ref:`int` width, :ref:`int` height, :ref:`bool` use_mipmaps, :ref:`int` format **)** +- void **create** **(** :ref:`int` width, :ref:`int` height, :ref:`bool` use_mipmaps, :ref:`int` format **)** Create an empty image of a specific size and format. .. _class_Image_create_from_data: -- void **create_from_data** **(** :ref:`int` width, :ref:`int` height, :ref:`bool` use_mipmaps, :ref:`int` format, :ref:`PoolByteArray` data **)** +- void **create_from_data** **(** :ref:`int` width, :ref:`int` height, :ref:`bool` use_mipmaps, :ref:`int` format, :ref:`PoolByteArray` data **)** .. _class_Image_crop: -- void **crop** **(** :ref:`int` width, :ref:`int` height **)** +- void **crop** **(** :ref:`int` width, :ref:`int` height **)** .. _class_Image_decompress: -- :ref:`int` **decompress** **(** **)** +- :ref:`int` **decompress** **(** **)** .. _class_Image_detect_alpha: -- :ref:`int` **detect_alpha** **(** **)** const +- :ref:`int` **detect_alpha** **(** **)** const .. _class_Image_expand_x2_hq2x: -- void **expand_x2_hq2x** **(** **)** +- void **expand_x2_hq2x** **(** **)** .. _class_Image_fill: -- void **fill** **(** :ref:`Color` color **)** +- void **fill** **(** :ref:`Color` color **)** Fills an :ref:`Image` with a specified :ref:`Color` .. _class_Image_fix_alpha_edges: -- void **fix_alpha_edges** **(** **)** +- void **fix_alpha_edges** **(** **)** .. _class_Image_flip_x: -- void **flip_x** **(** **)** +- void **flip_x** **(** **)** .. _class_Image_flip_y: -- void **flip_y** **(** **)** +- void **flip_y** **(** **)** .. _class_Image_generate_mipmaps: -- :ref:`int` **generate_mipmaps** **(** **)** +- :ref:`int` **generate_mipmaps** **(** **)** .. _class_Image_get_data: -- :ref:`PoolByteArray` **get_data** **(** **)** const +- :ref:`PoolByteArray` **get_data** **(** **)** const Return the raw data of the :ref:`Image`. .. _class_Image_get_format: -- :ref:`int` **get_format** **(** **)** const +- :ref:`int` **get_format** **(** **)** const Return the format of the :ref:`Image`, one of :ref:`Image`.FORMAT\_\*. .. _class_Image_get_height: -- :ref:`int` **get_height** **(** **)** const +- :ref:`int` **get_height** **(** **)** const Return the height of the :ref:`Image`. .. _class_Image_get_mipmap_offset: -- :ref:`int` **get_mipmap_offset** **(** :ref:`int` mipmap **)** const +- :ref:`int` **get_mipmap_offset** **(** :ref:`int` mipmap **)** const .. _class_Image_get_pixel: -- :ref:`Color` **get_pixel** **(** :ref:`int` x, :ref:`int` y **)** const +- :ref:`Color` **get_pixel** **(** :ref:`int` x, :ref:`int` y **)** const .. _class_Image_get_rect: -- :ref:`Image` **get_rect** **(** :ref:`Rect2` rect **)** const +- :ref:`Image` **get_rect** **(** :ref:`Rect2` rect **)** const Return a new :ref:`Image` that is a copy of "area" in this :ref:`Image`. .. _class_Image_get_size: -- :ref:`Vector2` **get_size** **(** **)** const +- :ref:`Vector2` **get_size** **(** **)** const .. _class_Image_get_used_rect: -- :ref:`Rect2` **get_used_rect** **(** **)** const +- :ref:`Rect2` **get_used_rect** **(** **)** const Return the area of this :ref:`Image` that is used/visibly colored/opaque. .. _class_Image_get_width: -- :ref:`int` **get_width** **(** **)** const +- :ref:`int` **get_width** **(** **)** const Return the width of the :ref:`Image`. .. _class_Image_has_mipmaps: -- :ref:`bool` **has_mipmaps** **(** **)** const +- :ref:`bool` **has_mipmaps** **(** **)** const .. _class_Image_is_compressed: -- :ref:`bool` **is_compressed** **(** **)** const +- :ref:`bool` **is_compressed** **(** **)** const .. _class_Image_is_empty: -- :ref:`bool` **is_empty** **(** **)** const +- :ref:`bool` **is_empty** **(** **)** const .. _class_Image_is_invisible: -- :ref:`bool` **is_invisible** **(** **)** const +- :ref:`bool` **is_invisible** **(** **)** const .. _class_Image_load: -- :ref:`int` **load** **(** :ref:`String` path **)** +- :ref:`int` **load** **(** :ref:`String` path **)** Load an :ref:`Image`. .. _class_Image_lock: -- void **lock** **(** **)** +- void **lock** **(** **)** .. _class_Image_normalmap_to_xy: -- void **normalmap_to_xy** **(** **)** +- void **normalmap_to_xy** **(** **)** .. _class_Image_premultiply_alpha: -- void **premultiply_alpha** **(** **)** +- void **premultiply_alpha** **(** **)** .. _class_Image_resize: -- void **resize** **(** :ref:`int` width, :ref:`int` height, :ref:`int` interpolation=1 **)** +- void **resize** **(** :ref:`int` width, :ref:`int` height, :ref:`int` interpolation=1 **)** .. _class_Image_resize_to_po2: -- void **resize_to_po2** **(** :ref:`bool` square=false **)** +- void **resize_to_po2** **(** :ref:`bool` square=false **)** .. _class_Image_save_png: -- :ref:`int` **save_png** **(** :ref:`String` path **)** const +- :ref:`int` **save_png** **(** :ref:`String` path **)** const Save this :ref:`Image` as a png. .. _class_Image_set_pixel: -- void **set_pixel** **(** :ref:`int` x, :ref:`int` y, :ref:`Color` color **)** +- void **set_pixel** **(** :ref:`int` x, :ref:`int` y, :ref:`Color` color **)** .. _class_Image_shrink_x2: -- void **shrink_x2** **(** **)** +- void **shrink_x2** **(** **)** .. _class_Image_srgb_to_linear: -- void **srgb_to_linear** **(** **)** +- void **srgb_to_linear** **(** **)** .. _class_Image_unlock: -- void **unlock** **(** **)** +- void **unlock** **(** **)** diff --git a/classes/class_imagetexture.rst b/classes/class_imagetexture.rst index 58141e047..32fd84876 100644 --- a/classes/class_imagetexture.rst +++ b/classes/class_imagetexture.rst @@ -19,27 +19,27 @@ A :ref:`Texture` based on an :ref:`Image`. Member Functions ---------------- -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create` **(** :ref:`int` width, :ref:`int` height, :ref:`int` format, :ref:`int` flags=7 **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_from_image` **(** :ref:`Image` image, :ref:`int` flags=7 **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_format` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_lossy_storage_quality` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_storage` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`load` **(** :ref:`String` path **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_data` **(** :ref:`Image` image **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_lossy_storage_quality` **(** :ref:`float` quality **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_size_override` **(** :ref:`Vector2` size **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_storage` **(** :ref:`int` mode **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create` **(** :ref:`int` width, :ref:`int` height, :ref:`int` format, :ref:`int` flags=7 **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create_from_image` **(** :ref:`Image` image, :ref:`int` flags=7 **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_format` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_lossy_storage_quality` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_storage` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`load` **(** :ref:`String` path **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_data` **(** :ref:`Image` image **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_lossy_storage_quality` **(** :ref:`float` quality **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_size_override` **(** :ref:`Vector2` size **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_storage` **(** :ref:`int` mode **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -58,7 +58,7 @@ Member Function Description .. _class_ImageTexture_create: -- void **create** **(** :ref:`int` width, :ref:`int` height, :ref:`int` format, :ref:`int` flags=7 **)** +- void **create** **(** :ref:`int` width, :ref:`int` height, :ref:`int` format, :ref:`int` flags=7 **)** Create a new :ref:`ImageTexture` with "width" and "height". @@ -68,55 +68,55 @@ Create a new :ref:`ImageTexture` with "width" and "height". .. _class_ImageTexture_create_from_image: -- void **create_from_image** **(** :ref:`Image` image, :ref:`int` flags=7 **)** +- void **create_from_image** **(** :ref:`Image` image, :ref:`int` flags=7 **)** Create a new :ref:`ImageTexture` from an :ref:`Image` with "flags" from :ref:`Texture`.FLAG\_\*. .. _class_ImageTexture_get_format: -- :ref:`int` **get_format** **(** **)** const +- :ref:`int` **get_format** **(** **)** const Return the format of the :ref:`ImageTexture`, one of :ref:`Image`.FORMAT\_\*. .. _class_ImageTexture_get_lossy_storage_quality: -- :ref:`float` **get_lossy_storage_quality** **(** **)** const +- :ref:`float` **get_lossy_storage_quality** **(** **)** const Return the storage quality for :ref:`ImageTexture`.STORAGE_COMPRESS_LOSSY. .. _class_ImageTexture_get_storage: -- :ref:`int` **get_storage** **(** **)** const +- :ref:`int` **get_storage** **(** **)** const Return the storage type. One of :ref:`ImageTexture`.STORAGE\_\*. .. _class_ImageTexture_load: -- void **load** **(** :ref:`String` path **)** +- void **load** **(** :ref:`String` path **)** Load an :ref:`ImageTexture`. .. _class_ImageTexture_set_data: -- void **set_data** **(** :ref:`Image` image **)** +- void **set_data** **(** :ref:`Image` image **)** Set the :ref:`Image` of this :ref:`ImageTexture`. .. _class_ImageTexture_set_lossy_storage_quality: -- void **set_lossy_storage_quality** **(** :ref:`float` quality **)** +- void **set_lossy_storage_quality** **(** :ref:`float` quality **)** Set the storage quality in case of :ref:`ImageTexture`.STORAGE_COMPRESS_LOSSY. .. _class_ImageTexture_set_size_override: -- void **set_size_override** **(** :ref:`Vector2` size **)** +- void **set_size_override** **(** :ref:`Vector2` size **)** Resizes the ``ImageTexture`` to the specified dimensions. .. _class_ImageTexture_set_storage: -- void **set_storage** **(** :ref:`int` mode **)** +- void **set_storage** **(** :ref:`int` mode **)** Set the storage type. One of :ref:`ImageTexture`.STORAGE\_\*. diff --git a/classes/class_immediategeometry.rst b/classes/class_immediategeometry.rst index 8592b9581..bb5a1964d 100644 --- a/classes/class_immediategeometry.rst +++ b/classes/class_immediategeometry.rst @@ -19,27 +19,27 @@ Draws simple geometry from code. Member Functions ---------------- -+-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_sphere` **(** :ref:`int` lats, :ref:`int` lons, :ref:`float` radius, :ref:`bool` add_uv=true **)** | -+-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_vertex` **(** :ref:`Vector3` position **)** | -+-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`begin` **(** :ref:`int` primitive, :ref:`Texture` texture=null **)** | -+-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`end` **(** **)** | -+-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_color` **(** :ref:`Color` color **)** | -+-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_normal` **(** :ref:`Vector3` normal **)** | -+-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tangent` **(** :ref:`Plane` tangent **)** | -+-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_uv` **(** :ref:`Vector2` uv **)** | -+-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_uv2` **(** :ref:`Vector2` uv **)** | -+-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_sphere` **(** :ref:`int` lats, :ref:`int` lons, :ref:`float` radius, :ref:`bool` add_uv=true **)** | ++-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_vertex` **(** :ref:`Vector3` position **)** | ++-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`begin` **(** :ref:`int` primitive, :ref:`Texture` texture=null **)** | ++-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`end` **(** **)** | ++-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_color` **(** :ref:`Color` color **)** | ++-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_normal` **(** :ref:`Vector3` normal **)** | ++-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tangent` **(** :ref:`Plane` tangent **)** | ++-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_uv` **(** :ref:`Vector2` uv **)** | ++-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_uv2` **(** :ref:`Vector2` uv **)** | ++-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -51,19 +51,19 @@ Member Function Description .. _class_ImmediateGeometry_add_sphere: -- void **add_sphere** **(** :ref:`int` lats, :ref:`int` lons, :ref:`float` radius, :ref:`bool` add_uv=true **)** +- void **add_sphere** **(** :ref:`int` lats, :ref:`int` lons, :ref:`float` radius, :ref:`bool` add_uv=true **)** Simple helper to draw a uvsphere, with given latitudes, longitude and radius. .. _class_ImmediateGeometry_add_vertex: -- void **add_vertex** **(** :ref:`Vector3` position **)** +- void **add_vertex** **(** :ref:`Vector3` position **)** Adds a vertex with the currently set color/uv/etc. .. _class_ImmediateGeometry_begin: -- void **begin** **(** :ref:`int` primitive, :ref:`Texture` texture=null **)** +- void **begin** **(** :ref:`int` primitive, :ref:`Texture` texture=null **)** Begin drawing (And optionally pass a texture override). When done call end(). For more information on how this works, search for glBegin() glEnd() references. @@ -71,43 +71,43 @@ For the type of primitive, use the :ref:`Mesh`.PRIMITIVE\_\* enumera .. _class_ImmediateGeometry_clear: -- void **clear** **(** **)** +- void **clear** **(** **)** Clears everything that was drawn using begin/end. .. _class_ImmediateGeometry_end: -- void **end** **(** **)** +- void **end** **(** **)** Ends a drawing context and displays the results. .. _class_ImmediateGeometry_set_color: -- void **set_color** **(** :ref:`Color` color **)** +- void **set_color** **(** :ref:`Color` color **)** The current drawing color. .. _class_ImmediateGeometry_set_normal: -- void **set_normal** **(** :ref:`Vector3` normal **)** +- void **set_normal** **(** :ref:`Vector3` normal **)** The next vertex's normal. .. _class_ImmediateGeometry_set_tangent: -- void **set_tangent** **(** :ref:`Plane` tangent **)** +- void **set_tangent** **(** :ref:`Plane` tangent **)** The next vertex's tangent (and binormal facing). .. _class_ImmediateGeometry_set_uv: -- void **set_uv** **(** :ref:`Vector2` uv **)** +- void **set_uv** **(** :ref:`Vector2` uv **)** The next vertex's UV. .. _class_ImmediateGeometry_set_uv2: -- void **set_uv2** **(** :ref:`Vector2` uv **)** +- void **set_uv2** **(** :ref:`Vector2` uv **)** The next vertex's second layer UV. diff --git a/classes/class_input.rst b/classes/class_input.rst index dccb83c6d..2ead258ac 100644 --- a/classes/class_input.rst +++ b/classes/class_input.rst @@ -21,84 +21,84 @@ A Singleton that deals with inputs. Member Functions ---------------- -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`action_press` **(** :ref:`String` action **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`action_release` **(** :ref:`String` action **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_joy_mapping` **(** :ref:`String` mapping, :ref:`bool` update_existing=false **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_accelerometer` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_connected_joypads` **(** **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_gravity` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_gyroscope` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_joy_axis` **(** :ref:`int` device, :ref:`int` axis **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_joy_axis_index_from_string` **(** :ref:`String` axis **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_joy_axis_string` **(** :ref:`int` axis_index **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_joy_button_index_from_string` **(** :ref:`String` button **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_joy_button_string` **(** :ref:`int` button_index **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_joy_guid` **(** :ref:`int` device **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_joy_name` **(** :ref:`int` device **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_joy_vibration_duration` **(** :ref:`int` device **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_joy_vibration_strength` **(** :ref:`int` device **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_last_mouse_speed` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_magnetometer` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_mouse_button_mask` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_mouse_mode` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_just_pressed` **(** :ref:`String` action **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_just_released` **(** :ref:`String` action **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_pressed` **(** :ref:`String` action **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_joy_button_pressed` **(** :ref:`int` device, :ref:`int` button **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_joy_known` **(** :ref:`int` device **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_key_pressed` **(** :ref:`int` scancode **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_mouse_button_pressed` **(** :ref:`int` button **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`joy_connection_changed` **(** :ref:`int` device, :ref:`bool` connected, :ref:`String` name, :ref:`String` guid **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`parse_input_event` **(** :ref:`InputEvent` event **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_joy_mapping` **(** :ref:`String` guid **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_mouse_cursor` **(** :ref:`Resource` image, :ref:`Vector2` hotspot=Vector2( 0, 0 ) **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mouse_mode` **(** :ref:`int` mode **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`start_joy_vibration` **(** :ref:`int` device, :ref:`float` weak_magnitude, :ref:`float` strong_magnitude, :ref:`float` duration=0 **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop_joy_vibration` **(** :ref:`int` device **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`warp_mouse_position` **(** :ref:`Vector2` to **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`action_press` **(** :ref:`String` action **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`action_release` **(** :ref:`String` action **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_joy_mapping` **(** :ref:`String` mapping, :ref:`bool` update_existing=false **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_accelerometer` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_connected_joypads` **(** **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_gravity` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_gyroscope` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_joy_axis` **(** :ref:`int` device, :ref:`int` axis **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_joy_axis_index_from_string` **(** :ref:`String` axis **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_joy_axis_string` **(** :ref:`int` axis_index **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_joy_button_index_from_string` **(** :ref:`String` button **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_joy_button_string` **(** :ref:`int` button_index **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_joy_guid` **(** :ref:`int` device **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_joy_name` **(** :ref:`int` device **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_joy_vibration_duration` **(** :ref:`int` device **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_joy_vibration_strength` **(** :ref:`int` device **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_last_mouse_speed` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_magnetometer` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_mouse_button_mask` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_mouse_mode` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_action_just_pressed` **(** :ref:`String` action **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_action_just_released` **(** :ref:`String` action **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_action_pressed` **(** :ref:`String` action **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_joy_button_pressed` **(** :ref:`int` device, :ref:`int` button **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_joy_known` **(** :ref:`int` device **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_key_pressed` **(** :ref:`int` scancode **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_mouse_button_pressed` **(** :ref:`int` button **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`joy_connection_changed` **(** :ref:`int` device, :ref:`bool` connected, :ref:`String` name, :ref:`String` guid **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`parse_input_event` **(** :ref:`InputEvent` event **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_joy_mapping` **(** :ref:`String` guid **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_mouse_cursor` **(** :ref:`Resource` image, :ref:`Vector2` hotspot=Vector2( 0, 0 ) **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_mouse_mode` **(** :ref:`int` mode **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`start_joy_vibration` **(** :ref:`int` device, :ref:`float` weak_magnitude, :ref:`float` strong_magnitude, :ref:`float` duration=0 **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop_joy_vibration` **(** :ref:`int` device **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`warp_mouse_position` **(** :ref:`Vector2` to **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_Input_joy_connection_changed: -- **joy_connection_changed** **(** :ref:`int` index, :ref:`bool` connected **)** +- **joy_connection_changed** **(** :ref:`int` index, :ref:`bool` connected **)** Emitted when a joypad device has been connected or disconnected @@ -121,183 +121,183 @@ Member Function Description .. _class_Input_action_press: -- void **action_press** **(** :ref:`String` action **)** +- void **action_press** **(** :ref:`String` action **)** This will simulate pressing the specificed action. .. _class_Input_action_release: -- void **action_release** **(** :ref:`String` action **)** +- void **action_release** **(** :ref:`String` action **)** If the specified action is already pressed, this will release it. .. _class_Input_add_joy_mapping: -- void **add_joy_mapping** **(** :ref:`String` mapping, :ref:`bool` update_existing=false **)** +- void **add_joy_mapping** **(** :ref:`String` mapping, :ref:`bool` update_existing=false **)** Add a new mapping entry (in SDL2 format) to the mapping database. Optionally update already connected devices. .. _class_Input_get_accelerometer: -- :ref:`Vector3` **get_accelerometer** **(** **)** const +- :ref:`Vector3` **get_accelerometer** **(** **)** const If the device has an accelerometer, this will return the movement. .. _class_Input_get_connected_joypads: -- :ref:`Array` **get_connected_joypads** **(** **)** +- :ref:`Array` **get_connected_joypads** **(** **)** Returns an :ref:`Array` containing the device IDs of all currently connected joypads. .. _class_Input_get_gravity: -- :ref:`Vector3` **get_gravity** **(** **)** const +- :ref:`Vector3` **get_gravity** **(** **)** const .. _class_Input_get_gyroscope: -- :ref:`Vector3` **get_gyroscope** **(** **)** const +- :ref:`Vector3` **get_gyroscope** **(** **)** const If the device has a gyroscope, this will return the rate of rotation in rad/s around a device's x, y, and z axis. .. _class_Input_get_joy_axis: -- :ref:`float` **get_joy_axis** **(** :ref:`int` device, :ref:`int` axis **)** const +- :ref:`float` **get_joy_axis** **(** :ref:`int` device, :ref:`int` axis **)** const Returns the current value of the joypad axis at given index (see ``JOY\_\*`` constants in :ref:`@Global Scope`) .. _class_Input_get_joy_axis_index_from_string: -- :ref:`int` **get_joy_axis_index_from_string** **(** :ref:`String` axis **)** +- :ref:`int` **get_joy_axis_index_from_string** **(** :ref:`String` axis **)** .. _class_Input_get_joy_axis_string: -- :ref:`String` **get_joy_axis_string** **(** :ref:`int` axis_index **)** +- :ref:`String` **get_joy_axis_string** **(** :ref:`int` axis_index **)** .. _class_Input_get_joy_button_index_from_string: -- :ref:`int` **get_joy_button_index_from_string** **(** :ref:`String` button **)** +- :ref:`int` **get_joy_button_index_from_string** **(** :ref:`String` button **)** .. _class_Input_get_joy_button_string: -- :ref:`String` **get_joy_button_string** **(** :ref:`int` button_index **)** +- :ref:`String` **get_joy_button_string** **(** :ref:`int` button_index **)** .. _class_Input_get_joy_guid: -- :ref:`String` **get_joy_guid** **(** :ref:`int` device **)** const +- :ref:`String` **get_joy_guid** **(** :ref:`int` device **)** const Returns a SDL2 compatible device guid on platforms that use gamepad remapping. Returns "Default Gamepad" otherwise. .. _class_Input_get_joy_name: -- :ref:`String` **get_joy_name** **(** :ref:`int` device **)** +- :ref:`String` **get_joy_name** **(** :ref:`int` device **)** Returns the name of the joypad at the specified device index .. _class_Input_get_joy_vibration_duration: -- :ref:`float` **get_joy_vibration_duration** **(** :ref:`int` device **)** +- :ref:`float` **get_joy_vibration_duration** **(** :ref:`int` device **)** Returns the duration of the current vibration effect in seconds. .. _class_Input_get_joy_vibration_strength: -- :ref:`Vector2` **get_joy_vibration_strength** **(** :ref:`int` device **)** +- :ref:`Vector2` **get_joy_vibration_strength** **(** :ref:`int` device **)** Returns the strength of the joypad vibration: x is the strength of the weak motor, and y is the strength of the strong motor. .. _class_Input_get_last_mouse_speed: -- :ref:`Vector2` **get_last_mouse_speed** **(** **)** const +- :ref:`Vector2` **get_last_mouse_speed** **(** **)** const Returns the mouse speed for the last time the cursor was moved, and this until the next frame where the mouse moves. This means that even if the mouse is not moving, this function will still return the value of the last motion. .. _class_Input_get_magnetometer: -- :ref:`Vector3` **get_magnetometer** **(** **)** const +- :ref:`Vector3` **get_magnetometer** **(** **)** const If the device has a magnetometer, this will return the magnetic field strength in micro-Tesla for all axes. .. _class_Input_get_mouse_button_mask: -- :ref:`int` **get_mouse_button_mask** **(** **)** const +- :ref:`int` **get_mouse_button_mask** **(** **)** const Returns mouse buttons as a bitmask. If multiple mouse buttons are pressed at the same time the bits are added together. .. _class_Input_get_mouse_mode: -- :ref:`int` **get_mouse_mode** **(** **)** const +- :ref:`int` **get_mouse_mode** **(** **)** const Return the mouse mode. See the constants for more information. .. _class_Input_is_action_just_pressed: -- :ref:`bool` **is_action_just_pressed** **(** :ref:`String` action **)** const +- :ref:`bool` **is_action_just_pressed** **(** :ref:`String` action **)** const Returns ``true`` when you start pressing the action event. .. _class_Input_is_action_just_released: -- :ref:`bool` **is_action_just_released** **(** :ref:`String` action **)** const +- :ref:`bool` **is_action_just_released** **(** :ref:`String` action **)** const Returns ``true`` when you stop pressing the action event. .. _class_Input_is_action_pressed: -- :ref:`bool` **is_action_pressed** **(** :ref:`String` action **)** const +- :ref:`bool` **is_action_pressed** **(** :ref:`String` action **)** const Returns ``true`` if you are pressing the action event. .. _class_Input_is_joy_button_pressed: -- :ref:`bool` **is_joy_button_pressed** **(** :ref:`int` device, :ref:`int` button **)** const +- :ref:`bool` **is_joy_button_pressed** **(** :ref:`int` device, :ref:`int` button **)** const Returns ``true`` if you are pressing the joypad button. (see ``JOY\_\*`` constants in :ref:`@Global Scope`) .. _class_Input_is_joy_known: -- :ref:`bool` **is_joy_known** **(** :ref:`int` device **)** +- :ref:`bool` **is_joy_known** **(** :ref:`int` device **)** Returns ``true`` if the system knows the specified device. This means that it sets all button and axis indices exactly as defined in the ``JOY\_\*`` constants (see :ref:`@Global Scope`). Unknown joypads are not expected to match these constants, but you can still retrieve events from them. .. _class_Input_is_key_pressed: -- :ref:`bool` **is_key_pressed** **(** :ref:`int` scancode **)** const +- :ref:`bool` **is_key_pressed** **(** :ref:`int` scancode **)** const Returns ``true`` if you are pressing the key. You can pass ``KEY\_\*``, which are pre-defined constants listed in :ref:`@Global Scope`. .. _class_Input_is_mouse_button_pressed: -- :ref:`bool` **is_mouse_button_pressed** **(** :ref:`int` button **)** const +- :ref:`bool` **is_mouse_button_pressed** **(** :ref:`int` button **)** const Returns ``true`` if you are pressing the mouse button. You can pass ``BUTTON\_\*``, which are pre-defined constants listed in :ref:`@Global Scope`. .. _class_Input_joy_connection_changed: -- void **joy_connection_changed** **(** :ref:`int` device, :ref:`bool` connected, :ref:`String` name, :ref:`String` guid **)** +- void **joy_connection_changed** **(** :ref:`int` device, :ref:`bool` connected, :ref:`String` name, :ref:`String` guid **)** .. _class_Input_parse_input_event: -- void **parse_input_event** **(** :ref:`InputEvent` event **)** +- void **parse_input_event** **(** :ref:`InputEvent` event **)** .. _class_Input_remove_joy_mapping: -- void **remove_joy_mapping** **(** :ref:`String` guid **)** +- void **remove_joy_mapping** **(** :ref:`String` guid **)** Removes all mappings from the internal db that match the given uid. .. _class_Input_set_custom_mouse_cursor: -- void **set_custom_mouse_cursor** **(** :ref:`Resource` image, :ref:`Vector2` hotspot=Vector2( 0, 0 ) **)** +- void **set_custom_mouse_cursor** **(** :ref:`Resource` image, :ref:`Vector2` hotspot=Vector2( 0, 0 ) **)** .. _class_Input_set_mouse_mode: -- void **set_mouse_mode** **(** :ref:`int` mode **)** +- void **set_mouse_mode** **(** :ref:`int` mode **)** Set the mouse mode. See the constants for more information. .. _class_Input_start_joy_vibration: -- void **start_joy_vibration** **(** :ref:`int` device, :ref:`float` weak_magnitude, :ref:`float` strong_magnitude, :ref:`float` duration=0 **)** +- void **start_joy_vibration** **(** :ref:`int` device, :ref:`float` weak_magnitude, :ref:`float` strong_magnitude, :ref:`float` duration=0 **)** Starts to vibrate the joypad. Joypads usually come with two rumble motors, a strong and a weak one. weak_magnitude is the strength of the weak motor (between 0 and 1) and strong_magnitude is the strength of the strong motor (between 0 and 1). duration is the duration of the effect in seconds (a duration of 0 will try to play the vibration indefinitely). @@ -305,13 +305,13 @@ Note that not every hardware is compatible with long effect durations, it is rec .. _class_Input_stop_joy_vibration: -- void **stop_joy_vibration** **(** :ref:`int` device **)** +- void **stop_joy_vibration** **(** :ref:`int` device **)** Stops the vibration of the joypad. .. _class_Input_warp_mouse_position: -- void **warp_mouse_position** **(** :ref:`Vector2` to **)** +- void **warp_mouse_position** **(** :ref:`Vector2` to **)** Sets the mouse position to the specified vector. diff --git a/classes/class_inputevent.rst b/classes/class_inputevent.rst index cbb8dac76..5011d8359 100644 --- a/classes/class_inputevent.rst +++ b/classes/class_inputevent.rst @@ -21,35 +21,35 @@ Generic input event Member Functions ---------------- -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`action_match` **(** :ref:`InputEvent` event **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`as_text` **(** **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_device` **(** **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_id` **(** **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action` **(** :ref:`String` action **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_pressed` **(** :ref:`String` action **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_released` **(** :ref:`String` action **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_type` **(** **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_echo` **(** **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_pressed` **(** **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_device` **(** :ref:`int` device **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_id` **(** :ref:`int` id **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`shortcut_match` **(** :ref:`InputEvent` event **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`InputEvent` | :ref:`xformed_by` **(** :ref:`Transform2D` xform, :ref:`Vector2` local_ofs=Vector2( 0, 0 ) **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`action_match` **(** :ref:`InputEvent` event **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`as_text` **(** **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_device` **(** **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_id` **(** **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_action` **(** :ref:`String` action **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_action_pressed` **(** :ref:`String` action **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_action_released` **(** :ref:`String` action **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_action_type` **(** **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_echo` **(** **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_pressed` **(** **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_device` **(** :ref:`int` device **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_id` **(** :ref:`int` id **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`shortcut_match` **(** :ref:`InputEvent` event **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`InputEvent` | :ref:`xformed_by` **(** :ref:`Transform2D` xform, :ref:`Vector2` local_ofs=Vector2( 0, 0 ) **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -69,78 +69,78 @@ Member Function Description .. _class_InputEvent_action_match: -- :ref:`bool` **action_match** **(** :ref:`InputEvent` event **)** const +- :ref:`bool` **action_match** **(** :ref:`InputEvent` event **)** const Returns ``true`` if this event matches ``event[event]. .. _class_InputEvent_as_text: -- :ref:`String` **as_text** **(** **)** const +- :ref:`String` **as_text** **(** **)** const Returns a :ref:`String` representation of the event. .. _class_InputEvent_get_device: -- :ref:`int` **get_device** **(** **)** const +- :ref:`int` **get_device** **(** **)** const Returns the device's id that generated the event. .. _class_InputEvent_get_id: -- :ref:`int` **get_id** **(** **)** const +- :ref:`int` **get_id** **(** **)** const Returns the event's ID. .. _class_InputEvent_is_action: -- :ref:`bool` **is_action** **(** :ref:`String` action **)** const +- :ref:`bool` **is_action** **(** :ref:`String` action **)** const Returns ``true`` if this input event matches a pre-defined action of any type. .. _class_InputEvent_is_action_pressed: -- :ref:`bool` **is_action_pressed** **(** :ref:`String` action **)** const +- :ref:`bool` **is_action_pressed** **(** :ref:`String` action **)** const Returns ``true`` if the given action is being pressed (and is not an echo event for KEY events). Not relevant for the event types ``MOUSE_MOTION``, ``SCREEN_DRAG`` or ``NONE``. .. _class_InputEvent_is_action_released: -- :ref:`bool` **is_action_released** **(** :ref:`String` action **)** const +- :ref:`bool` **is_action_released** **(** :ref:`String` action **)** const Returns ``true`` if the given action is released (i.e. not pressed). Not relevant for the event types ``MOUSE_MOTION``, ``SCREEN_DRAG`` or ``NONE``. .. _class_InputEvent_is_action_type: -- :ref:`bool` **is_action_type** **(** **)** const +- :ref:`bool` **is_action_type** **(** **)** const Returns ``true`` if this input event's type is one of the ``InputEvent`` constants. .. _class_InputEvent_is_echo: -- :ref:`bool` **is_echo** **(** **)** const +- :ref:`bool` **is_echo** **(** **)** const Returns ``true`` if this input event is an echo event (only for events of type KEY). .. _class_InputEvent_is_pressed: -- :ref:`bool` **is_pressed** **(** **)** const +- :ref:`bool` **is_pressed** **(** **)** const Returns ``true`` if this input event is pressed. Not relevant for the event types ``MOUSE_MOTION``, ``SCREEN_DRAG`` or ``NONE``. .. _class_InputEvent_set_device: -- void **set_device** **(** :ref:`int` device **)** +- void **set_device** **(** :ref:`int` device **)** .. _class_InputEvent_set_id: -- void **set_id** **(** :ref:`int` id **)** +- void **set_id** **(** :ref:`int` id **)** .. _class_InputEvent_shortcut_match: -- :ref:`bool` **shortcut_match** **(** :ref:`InputEvent` event **)** const +- :ref:`bool` **shortcut_match** **(** :ref:`InputEvent` event **)** const .. _class_InputEvent_xformed_by: -- :ref:`InputEvent` **xformed_by** **(** :ref:`Transform2D` xform, :ref:`Vector2` local_ofs=Vector2( 0, 0 ) **)** const +- :ref:`InputEvent` **xformed_by** **(** :ref:`Transform2D` xform, :ref:`Vector2` local_ofs=Vector2( 0, 0 ) **)** const diff --git a/classes/class_inputeventaction.rst b/classes/class_inputeventaction.rst index 49064f3bb..6ec856d8e 100644 --- a/classes/class_inputeventaction.rst +++ b/classes/class_inputeventaction.rst @@ -19,13 +19,13 @@ Input event type for actions. Member Functions ---------------- -+------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_action` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_action` **(** :ref:`String` action **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pressed` **(** :ref:`bool` pressed **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------+ ++------------------------------+-----------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_action` **(** **)** const | ++------------------------------+-----------------------------------------------------------------------------------------------------+ +| void | :ref:`set_action` **(** :ref:`String` action **)** | ++------------------------------+-----------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pressed` **(** :ref:`bool` pressed **)** | ++------------------------------+-----------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -49,14 +49,14 @@ Member Function Description .. _class_InputEventAction_get_action: -- :ref:`String` **get_action** **(** **)** const +- :ref:`String` **get_action** **(** **)** const .. _class_InputEventAction_set_action: -- void **set_action** **(** :ref:`String` action **)** +- void **set_action** **(** :ref:`String` action **)** .. _class_InputEventAction_set_pressed: -- void **set_pressed** **(** :ref:`bool` pressed **)** +- void **set_pressed** **(** :ref:`bool` pressed **)** diff --git a/classes/class_inputeventjoypadbutton.rst b/classes/class_inputeventjoypadbutton.rst index 994a2ca7d..526366fb3 100644 --- a/classes/class_inputeventjoypadbutton.rst +++ b/classes/class_inputeventjoypadbutton.rst @@ -19,17 +19,17 @@ Input event for gamepad buttons. Member Functions ---------------- -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_button_index` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_pressure` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_button_index` **(** :ref:`int` button_index **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pressed` **(** :ref:`bool` pressed **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pressure` **(** :ref:`float` pressure **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ ++----------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_button_index` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_pressure` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_button_index` **(** :ref:`int` button_index **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pressed` **(** :ref:`bool` pressed **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pressure` **(** :ref:`float` pressure **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -57,22 +57,22 @@ Member Function Description .. _class_InputEventJoypadButton_get_button_index: -- :ref:`int` **get_button_index** **(** **)** const +- :ref:`int` **get_button_index** **(** **)** const .. _class_InputEventJoypadButton_get_pressure: -- :ref:`float` **get_pressure** **(** **)** const +- :ref:`float` **get_pressure** **(** **)** const .. _class_InputEventJoypadButton_set_button_index: -- void **set_button_index** **(** :ref:`int` button_index **)** +- void **set_button_index** **(** :ref:`int` button_index **)** .. _class_InputEventJoypadButton_set_pressed: -- void **set_pressed** **(** :ref:`bool` pressed **)** +- void **set_pressed** **(** :ref:`bool` pressed **)** .. _class_InputEventJoypadButton_set_pressure: -- void **set_pressure** **(** :ref:`float` pressure **)** +- void **set_pressure** **(** :ref:`float` pressure **)** diff --git a/classes/class_inputeventjoypadmotion.rst b/classes/class_inputeventjoypadmotion.rst index c6c1a5ca5..0f5defd9f 100644 --- a/classes/class_inputeventjoypadmotion.rst +++ b/classes/class_inputeventjoypadmotion.rst @@ -19,15 +19,15 @@ Input event type for gamepad joysticks and other motions. For buttons see :ref:` Member Functions ---------------- -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_axis` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_axis_value` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_axis` **(** :ref:`int` axis **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_axis_value` **(** :ref:`float` axis_value **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ ++----------------------------+---------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_axis` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_axis_value` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_axis` **(** :ref:`int` axis **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_axis_value` **(** :ref:`float` axis_value **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -51,18 +51,18 @@ Member Function Description .. _class_InputEventJoypadMotion_get_axis: -- :ref:`int` **get_axis** **(** **)** const +- :ref:`int` **get_axis** **(** **)** const .. _class_InputEventJoypadMotion_get_axis_value: -- :ref:`float` **get_axis_value** **(** **)** const +- :ref:`float` **get_axis_value** **(** **)** const .. _class_InputEventJoypadMotion_set_axis: -- void **set_axis** **(** :ref:`int` axis **)** +- void **set_axis** **(** :ref:`int` axis **)** .. _class_InputEventJoypadMotion_set_axis_value: -- void **set_axis_value** **(** :ref:`float` axis_value **)** +- void **set_axis_value** **(** :ref:`float` axis_value **)** diff --git a/classes/class_inputeventkey.rst b/classes/class_inputeventkey.rst index fdf29cab9..d520ff91f 100644 --- a/classes/class_inputeventkey.rst +++ b/classes/class_inputeventkey.rst @@ -19,21 +19,21 @@ Input event type for keyboard events. Member Functions ---------------- -+------------------------+--------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_scancode` **(** **)** const | -+------------------------+--------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_scancode_with_modifiers` **(** **)** const | -+------------------------+--------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_unicode` **(** **)** const | -+------------------------+--------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_echo` **(** :ref:`bool` echo **)** | -+------------------------+--------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pressed` **(** :ref:`bool` pressed **)** | -+------------------------+--------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_scancode` **(** :ref:`int` scancode **)** | -+------------------------+--------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_unicode` **(** :ref:`int` unicode **)** | -+------------------------+--------------------------------------------------------------------------------------------------------+ ++------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_scancode` **(** **)** const | ++------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_scancode_with_modifiers` **(** **)** const | ++------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_unicode` **(** **)** const | ++------------------------+-------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_echo` **(** :ref:`bool` echo **)** | ++------------------------+-------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pressed` **(** :ref:`bool` pressed **)** | ++------------------------+-------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_scancode` **(** :ref:`int` scancode **)** | ++------------------------+-------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_unicode` **(** :ref:`int` unicode **)** | ++------------------------+-------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -65,30 +65,30 @@ Member Function Description .. _class_InputEventKey_get_scancode: -- :ref:`int` **get_scancode** **(** **)** const +- :ref:`int` **get_scancode** **(** **)** const .. _class_InputEventKey_get_scancode_with_modifiers: -- :ref:`int` **get_scancode_with_modifiers** **(** **)** const +- :ref:`int` **get_scancode_with_modifiers** **(** **)** const .. _class_InputEventKey_get_unicode: -- :ref:`int` **get_unicode** **(** **)** const +- :ref:`int` **get_unicode** **(** **)** const .. _class_InputEventKey_set_echo: -- void **set_echo** **(** :ref:`bool` echo **)** +- void **set_echo** **(** :ref:`bool` echo **)** .. _class_InputEventKey_set_pressed: -- void **set_pressed** **(** :ref:`bool` pressed **)** +- void **set_pressed** **(** :ref:`bool` pressed **)** .. _class_InputEventKey_set_scancode: -- void **set_scancode** **(** :ref:`int` scancode **)** +- void **set_scancode** **(** :ref:`int` scancode **)** .. _class_InputEventKey_set_unicode: -- void **set_unicode** **(** :ref:`int` unicode **)** +- void **set_unicode** **(** :ref:`int` unicode **)** diff --git a/classes/class_inputeventmouse.rst b/classes/class_inputeventmouse.rst index 3d9a0e4a2..4994dd984 100644 --- a/classes/class_inputeventmouse.rst +++ b/classes/class_inputeventmouse.rst @@ -21,19 +21,19 @@ Base input event type for mouse events. Member Functions ---------------- -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_button_mask` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_global_position` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_position` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_button_mask` **(** :ref:`int` button_mask **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_global_position` **(** :ref:`Vector2` global_position **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_position` **(** :ref:`Vector2` position **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_button_mask` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_global_position` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_position` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_button_mask` **(** :ref:`int` button_mask **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_global_position` **(** :ref:`Vector2` global_position **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_position` **(** :ref:`Vector2` position **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -61,26 +61,26 @@ Member Function Description .. _class_InputEventMouse_get_button_mask: -- :ref:`int` **get_button_mask** **(** **)** const +- :ref:`int` **get_button_mask** **(** **)** const .. _class_InputEventMouse_get_global_position: -- :ref:`Vector2` **get_global_position** **(** **)** const +- :ref:`Vector2` **get_global_position** **(** **)** const .. _class_InputEventMouse_get_position: -- :ref:`Vector2` **get_position** **(** **)** const +- :ref:`Vector2` **get_position** **(** **)** const .. _class_InputEventMouse_set_button_mask: -- void **set_button_mask** **(** :ref:`int` button_mask **)** +- void **set_button_mask** **(** :ref:`int` button_mask **)** .. _class_InputEventMouse_set_global_position: -- void **set_global_position** **(** :ref:`Vector2` global_position **)** +- void **set_global_position** **(** :ref:`Vector2` global_position **)** .. _class_InputEventMouse_set_position: -- void **set_position** **(** :ref:`Vector2` position **)** +- void **set_position** **(** :ref:`Vector2` position **)** diff --git a/classes/class_inputeventmousebutton.rst b/classes/class_inputeventmousebutton.rst index e65e5a99a..4f3756f88 100644 --- a/classes/class_inputeventmousebutton.rst +++ b/classes/class_inputeventmousebutton.rst @@ -19,21 +19,21 @@ Input event type for mouse button events. Member Functions ---------------- -+----------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_button_index` **(** **)** const | -+----------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_factor` **(** **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_doubleclick` **(** **)** const | -+----------------------------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_button_index` **(** :ref:`int` button_index **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_doubleclick` **(** :ref:`bool` doubleclick **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_factor` **(** :ref:`float` factor **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pressed` **(** :ref:`bool` pressed **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------------------+ ++----------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_button_index` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_factor` **(** **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_doubleclick` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_button_index` **(** :ref:`int` button_index **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_doubleclick` **(** :ref:`bool` doubleclick **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_factor` **(** :ref:`float` factor **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pressed` **(** :ref:`bool` pressed **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -65,30 +65,30 @@ Member Function Description .. _class_InputEventMouseButton_get_button_index: -- :ref:`int` **get_button_index** **(** **)** const +- :ref:`int` **get_button_index** **(** **)** const .. _class_InputEventMouseButton_get_factor: -- :ref:`float` **get_factor** **(** **)** +- :ref:`float` **get_factor** **(** **)** .. _class_InputEventMouseButton_is_doubleclick: -- :ref:`bool` **is_doubleclick** **(** **)** const +- :ref:`bool` **is_doubleclick** **(** **)** const .. _class_InputEventMouseButton_set_button_index: -- void **set_button_index** **(** :ref:`int` button_index **)** +- void **set_button_index** **(** :ref:`int` button_index **)** .. _class_InputEventMouseButton_set_doubleclick: -- void **set_doubleclick** **(** :ref:`bool` doubleclick **)** +- void **set_doubleclick** **(** :ref:`bool` doubleclick **)** .. _class_InputEventMouseButton_set_factor: -- void **set_factor** **(** :ref:`float` factor **)** +- void **set_factor** **(** :ref:`float` factor **)** .. _class_InputEventMouseButton_set_pressed: -- void **set_pressed** **(** :ref:`bool` pressed **)** +- void **set_pressed** **(** :ref:`bool` pressed **)** diff --git a/classes/class_inputeventmousemotion.rst b/classes/class_inputeventmousemotion.rst index 2713b2abc..0d2efc4c6 100644 --- a/classes/class_inputeventmousemotion.rst +++ b/classes/class_inputeventmousemotion.rst @@ -19,15 +19,15 @@ Input event type for mouse motion events. Member Functions ---------------- -+--------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_relative` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_speed` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_relative` **(** :ref:`Vector2` relative **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_speed` **(** :ref:`Vector2` speed **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_relative` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_speed` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_relative` **(** :ref:`Vector2` relative **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_speed` **(** :ref:`Vector2` speed **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -51,18 +51,18 @@ Member Function Description .. _class_InputEventMouseMotion_get_relative: -- :ref:`Vector2` **get_relative** **(** **)** const +- :ref:`Vector2` **get_relative** **(** **)** const .. _class_InputEventMouseMotion_get_speed: -- :ref:`Vector2` **get_speed** **(** **)** const +- :ref:`Vector2` **get_speed** **(** **)** const .. _class_InputEventMouseMotion_set_relative: -- void **set_relative** **(** :ref:`Vector2` relative **)** +- void **set_relative** **(** :ref:`Vector2` relative **)** .. _class_InputEventMouseMotion_set_speed: -- void **set_speed** **(** :ref:`Vector2` speed **)** +- void **set_speed** **(** :ref:`Vector2` speed **)** diff --git a/classes/class_inputeventscreendrag.rst b/classes/class_inputeventscreendrag.rst index da50fd4d4..91021405f 100644 --- a/classes/class_inputeventscreendrag.rst +++ b/classes/class_inputeventscreendrag.rst @@ -21,23 +21,23 @@ Input event type for screen drag events. Member Functions ---------------- -+--------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_index` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_position` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_relative` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_speed` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_index` **(** :ref:`int` index **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_position` **(** :ref:`Vector2` position **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_relative` **(** :ref:`Vector2` relative **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_speed` **(** :ref:`Vector2` speed **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_index` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_position` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_relative` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_speed` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_index` **(** :ref:`int` index **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_position` **(** :ref:`Vector2` position **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_relative` **(** :ref:`Vector2` relative **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_speed` **(** :ref:`Vector2` speed **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -69,34 +69,34 @@ Member Function Description .. _class_InputEventScreenDrag_get_index: -- :ref:`int` **get_index** **(** **)** const +- :ref:`int` **get_index** **(** **)** const .. _class_InputEventScreenDrag_get_position: -- :ref:`Vector2` **get_position** **(** **)** const +- :ref:`Vector2` **get_position** **(** **)** const .. _class_InputEventScreenDrag_get_relative: -- :ref:`Vector2` **get_relative** **(** **)** const +- :ref:`Vector2` **get_relative** **(** **)** const .. _class_InputEventScreenDrag_get_speed: -- :ref:`Vector2` **get_speed** **(** **)** const +- :ref:`Vector2` **get_speed** **(** **)** const .. _class_InputEventScreenDrag_set_index: -- void **set_index** **(** :ref:`int` index **)** +- void **set_index** **(** :ref:`int` index **)** .. _class_InputEventScreenDrag_set_position: -- void **set_position** **(** :ref:`Vector2` position **)** +- void **set_position** **(** :ref:`Vector2` position **)** .. _class_InputEventScreenDrag_set_relative: -- void **set_relative** **(** :ref:`Vector2` relative **)** +- void **set_relative** **(** :ref:`Vector2` relative **)** .. _class_InputEventScreenDrag_set_speed: -- void **set_speed** **(** :ref:`Vector2` speed **)** +- void **set_speed** **(** :ref:`Vector2` speed **)** diff --git a/classes/class_inputeventscreentouch.rst b/classes/class_inputeventscreentouch.rst index d3a6c2e66..dd220dd8d 100644 --- a/classes/class_inputeventscreentouch.rst +++ b/classes/class_inputeventscreentouch.rst @@ -21,17 +21,17 @@ Input event type for screen touch events. Member Functions ---------------- -+--------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_index` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_position` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_index` **(** :ref:`int` index **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_position` **(** :ref:`Vector2` position **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pressed` **(** :ref:`bool` pressed **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_index` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_position` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_index` **(** :ref:`int` index **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_position` **(** :ref:`Vector2` position **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pressed` **(** :ref:`bool` pressed **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -59,22 +59,22 @@ Member Function Description .. _class_InputEventScreenTouch_get_index: -- :ref:`int` **get_index** **(** **)** const +- :ref:`int` **get_index** **(** **)** const .. _class_InputEventScreenTouch_get_position: -- :ref:`Vector2` **get_position** **(** **)** const +- :ref:`Vector2` **get_position** **(** **)** const .. _class_InputEventScreenTouch_set_index: -- void **set_index** **(** :ref:`int` index **)** +- void **set_index** **(** :ref:`int` index **)** .. _class_InputEventScreenTouch_set_position: -- void **set_position** **(** :ref:`Vector2` position **)** +- void **set_position** **(** :ref:`Vector2` position **)** .. _class_InputEventScreenTouch_set_pressed: -- void **set_pressed** **(** :ref:`bool` pressed **)** +- void **set_pressed** **(** :ref:`bool` pressed **)** diff --git a/classes/class_inputeventwithmodifiers.rst b/classes/class_inputeventwithmodifiers.rst index dc8fa8cef..542dc535d 100644 --- a/classes/class_inputeventwithmodifiers.rst +++ b/classes/class_inputeventwithmodifiers.rst @@ -21,27 +21,27 @@ Base class for keys events with modifiers. Member Functions ---------------- -+--------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_alt` **(** **)** const | -+--------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_command` **(** **)** const | -+--------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_control` **(** **)** const | -+--------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_metakey` **(** **)** const | -+--------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_shift` **(** **)** const | -+--------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_alt` **(** :ref:`bool` enable **)** | -+--------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_command` **(** :ref:`bool` enable **)** | -+--------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_control` **(** :ref:`bool` enable **)** | -+--------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_metakey` **(** :ref:`bool` enable **)** | -+--------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shift` **(** :ref:`bool` enable **)** | -+--------------------------+------------------------------------------------------------------------------------------------------------+ ++--------------------------+----------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_alt` **(** **)** const | ++--------------------------+----------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_command` **(** **)** const | ++--------------------------+----------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_control` **(** **)** const | ++--------------------------+----------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_metakey` **(** **)** const | ++--------------------------+----------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_shift` **(** **)** const | ++--------------------------+----------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_alt` **(** :ref:`bool` enable **)** | ++--------------------------+----------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_command` **(** :ref:`bool` enable **)** | ++--------------------------+----------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_control` **(** :ref:`bool` enable **)** | ++--------------------------+----------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_metakey` **(** :ref:`bool` enable **)** | ++--------------------------+----------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shift` **(** :ref:`bool` enable **)** | ++--------------------------+----------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -77,42 +77,42 @@ Member Function Description .. _class_InputEventWithModifiers_get_alt: -- :ref:`bool` **get_alt** **(** **)** const +- :ref:`bool` **get_alt** **(** **)** const .. _class_InputEventWithModifiers_get_command: -- :ref:`bool` **get_command** **(** **)** const +- :ref:`bool` **get_command** **(** **)** const .. _class_InputEventWithModifiers_get_control: -- :ref:`bool` **get_control** **(** **)** const +- :ref:`bool` **get_control** **(** **)** const .. _class_InputEventWithModifiers_get_metakey: -- :ref:`bool` **get_metakey** **(** **)** const +- :ref:`bool` **get_metakey** **(** **)** const .. _class_InputEventWithModifiers_get_shift: -- :ref:`bool` **get_shift** **(** **)** const +- :ref:`bool` **get_shift** **(** **)** const .. _class_InputEventWithModifiers_set_alt: -- void **set_alt** **(** :ref:`bool` enable **)** +- void **set_alt** **(** :ref:`bool` enable **)** .. _class_InputEventWithModifiers_set_command: -- void **set_command** **(** :ref:`bool` enable **)** +- void **set_command** **(** :ref:`bool` enable **)** .. _class_InputEventWithModifiers_set_control: -- void **set_control** **(** :ref:`bool` enable **)** +- void **set_control** **(** :ref:`bool` enable **)** .. _class_InputEventWithModifiers_set_metakey: -- void **set_metakey** **(** :ref:`bool` enable **)** +- void **set_metakey** **(** :ref:`bool` enable **)** .. _class_InputEventWithModifiers_set_shift: -- void **set_shift** **(** :ref:`bool` enable **)** +- void **set_shift** **(** :ref:`bool` enable **)** diff --git a/classes/class_inputmap.rst b/classes/class_inputmap.rst index 63ef838a3..8ef179702 100644 --- a/classes/class_inputmap.rst +++ b/classes/class_inputmap.rst @@ -19,27 +19,27 @@ Singleton that manages :ref:`InputEventAction`. Member Functions ---------------- -+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`action_add_event` **(** :ref:`String` action, :ref:`InputEvent` event **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`action_erase_event` **(** :ref:`String` action, :ref:`InputEvent` event **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`action_has_event` **(** :ref:`String` action, :ref:`InputEvent` event **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_action` **(** :ref:`String` action **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase_action` **(** :ref:`String` action **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`event_is_action` **(** :ref:`InputEvent` event, :ref:`String` action **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_action_list` **(** :ref:`String` action **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_actions` **(** **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_action` **(** :ref:`String` action **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`load_from_globals` **(** **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`action_add_event` **(** :ref:`String` action, :ref:`InputEvent` event **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`action_erase_event` **(** :ref:`String` action, :ref:`InputEvent` event **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`action_has_event` **(** :ref:`String` action, :ref:`InputEvent` event **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_action` **(** :ref:`String` action **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`erase_action` **(** :ref:`String` action **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`event_is_action` **(** :ref:`InputEvent` event, :ref:`String` action **)** const | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_action_list` **(** :ref:`String` action **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_actions` **(** **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_action` **(** :ref:`String` action **)** const | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`load_from_globals` **(** **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -51,61 +51,61 @@ Member Function Description .. _class_InputMap_action_add_event: -- void **action_add_event** **(** :ref:`String` action, :ref:`InputEvent` event **)** +- void **action_add_event** **(** :ref:`String` action, :ref:`InputEvent` event **)** Adds an :ref:`InputEvent` to an action. This :ref:`InputEvent` will trigger the action. .. _class_InputMap_action_erase_event: -- void **action_erase_event** **(** :ref:`String` action, :ref:`InputEvent` event **)** +- void **action_erase_event** **(** :ref:`String` action, :ref:`InputEvent` event **)** Removes an :ref:`InputEvent` from an action. .. _class_InputMap_action_has_event: -- :ref:`bool` **action_has_event** **(** :ref:`String` action, :ref:`InputEvent` event **)** +- :ref:`bool` **action_has_event** **(** :ref:`String` action, :ref:`InputEvent` event **)** Returns true if an action has an :ref:`InputEvent` associated with it. .. _class_InputMap_add_action: -- void **add_action** **(** :ref:`String` action **)** +- void **add_action** **(** :ref:`String` action **)** Adds an (empty) action to the :ref:`InputMap`. An :ref:`InputEvent` can then be added to this action with :ref:`action_add_event`. .. _class_InputMap_erase_action: -- void **erase_action** **(** :ref:`String` action **)** +- void **erase_action** **(** :ref:`String` action **)** Removes an action from the ``InputMap``. .. _class_InputMap_event_is_action: -- :ref:`bool` **event_is_action** **(** :ref:`InputEvent` event, :ref:`String` action **)** const +- :ref:`bool` **event_is_action** **(** :ref:`InputEvent` event, :ref:`String` action **)** const Returns true if the given event is part of an existing action. This method ignores keyboard modifiers if the given :ref:`InputEvent` is not pressed (for proper release detection). See :ref:`action_has_event` if you don't want this behavior. .. _class_InputMap_get_action_list: -- :ref:`Array` **get_action_list** **(** :ref:`String` action **)** +- :ref:`Array` **get_action_list** **(** :ref:`String` action **)** Returns an array of :ref:`InputEvent`\ s associated with a given action. .. _class_InputMap_get_actions: -- :ref:`Array` **get_actions** **(** **)** +- :ref:`Array` **get_actions** **(** **)** Returns an array of all actions in the ``InputMap``. .. _class_InputMap_has_action: -- :ref:`bool` **has_action** **(** :ref:`String` action **)** const +- :ref:`bool` **has_action** **(** :ref:`String` action **)** const Returns ``true`` if the ``InputMap`` has a registered action with the given name. .. _class_InputMap_load_from_globals: -- void **load_from_globals** **(** **)** +- void **load_from_globals** **(** **)** Clears all :ref:`InputEventAction` in the ``InputMap`` and load it anew from :ref:`ProjectSettings`. diff --git a/classes/class_instanceplaceholder.rst b/classes/class_instanceplaceholder.rst index d36f9c570..692f63366 100644 --- a/classes/class_instanceplaceholder.rst +++ b/classes/class_instanceplaceholder.rst @@ -19,13 +19,13 @@ Placeholder for the root :ref:`Node` of a :ref:`PackedScene` | :ref:`get_instance_path` **(** **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_stored_values` **(** :ref:`bool` with_order=false **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`replace_by_instance` **(** :ref:`PackedScene` custom_scene=null **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_instance_path` **(** **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_stored_values` **(** :ref:`bool` with_order=false **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`replace_by_instance` **(** :ref:`PackedScene` custom_scene=null **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -39,17 +39,17 @@ Member Function Description .. _class_InstancePlaceholder_get_instance_path: -- :ref:`String` **get_instance_path** **(** **)** const +- :ref:`String` **get_instance_path** **(** **)** const Retrieve the path to the :ref:`PackedScene` resource file that is loaded by default when calling :ref:`replace_by_instance`. .. _class_InstancePlaceholder_get_stored_values: -- :ref:`Dictionary` **get_stored_values** **(** :ref:`bool` with_order=false **)** +- :ref:`Dictionary` **get_stored_values** **(** :ref:`bool` with_order=false **)** .. _class_InstancePlaceholder_replace_by_instance: -- void **replace_by_instance** **(** :ref:`PackedScene` custom_scene=null **)** +- void **replace_by_instance** **(** :ref:`PackedScene` custom_scene=null **)** Replace this placeholder by the scene handed as an argument, or the original scene if no argument is given. As for all resources, the scene is loaded only if it's not loaded already. By manually loading the scene beforehand, delays caused by this function can be avoided. diff --git a/classes/class_int.rst b/classes/class_int.rst index 0d6b9607f..786ed1cb8 100644 --- a/classes/class_int.rst +++ b/classes/class_int.rst @@ -17,13 +17,13 @@ Integer built-in type. Member Functions ---------------- -+------------------------+--------------------------------------------------------------------------+ -| :ref:`int` | :ref:`int` **(** :ref:`bool` from **)** | -+------------------------+--------------------------------------------------------------------------+ -| :ref:`int` | :ref:`int` **(** :ref:`float` from **)** | -+------------------------+--------------------------------------------------------------------------+ -| :ref:`int` | :ref:`int` **(** :ref:`String` from **)** | -+------------------------+--------------------------------------------------------------------------+ ++------------------------+------------------------------------------------------------------------+ +| :ref:`int` | :ref:`int` **(** :ref:`bool` from **)** | ++------------------------+------------------------------------------------------------------------+ +| :ref:`int` | :ref:`int` **(** :ref:`float` from **)** | ++------------------------+------------------------------------------------------------------------+ +| :ref:`int` | :ref:`int` **(** :ref:`String` from **)** | ++------------------------+------------------------------------------------------------------------+ Description ----------- @@ -35,19 +35,19 @@ Member Function Description .. _class_int_int: -- :ref:`int` **int** **(** :ref:`bool` from **)** +- :ref:`int` **int** **(** :ref:`bool` from **)** Cast a :ref:`bool` value to an integer value, ``int(true)`` will be equals to 1 and ``int(false)`` will be equals to 0. .. _class_int_int: -- :ref:`int` **int** **(** :ref:`float` from **)** +- :ref:`int` **int** **(** :ref:`float` from **)** Cast a float value to an integer value, this method simply removes the number fractions, so for example ``int(2.7)`` will be equals to 2, ``int(.1)`` will be equals to 0 and ``int(-2.7)`` will be equals to -2. .. _class_int_int: -- :ref:`int` **int** **(** :ref:`String` from **)** +- :ref:`int` **int** **(** :ref:`String` from **)** Cast a :ref:`String` value to an integer value, this method is an integer parser from a string, so calling this method with an invalid integer string will return 0, a valid string will be something like ``'1.7'``. This method will ignore all non-number characters, so calling ``int('1e3')`` will return 13. diff --git a/classes/class_interpolatedcamera.rst b/classes/class_interpolatedcamera.rst index 79161d38e..fd9b74d2d 100644 --- a/classes/class_interpolatedcamera.rst +++ b/classes/class_interpolatedcamera.rst @@ -19,21 +19,21 @@ Brief Description Member Functions ---------------- -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_speed` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_target_path` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_interpolation_enabled` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_interpolation_enabled` **(** :ref:`bool` target_path **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_speed` **(** :ref:`float` speed **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_target` **(** :ref:`Object` target **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_target_path` **(** :ref:`NodePath` target_path **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_speed` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_target_path` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_interpolation_enabled` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_interpolation_enabled` **(** :ref:`bool` target_path **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_speed` **(** :ref:`float` speed **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_target` **(** :ref:`Object` target **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_target_path` **(** :ref:`NodePath` target_path **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -56,30 +56,30 @@ Member Function Description .. _class_InterpolatedCamera_get_speed: -- :ref:`float` **get_speed** **(** **)** const +- :ref:`float` **get_speed** **(** **)** const .. _class_InterpolatedCamera_get_target_path: -- :ref:`NodePath` **get_target_path** **(** **)** const +- :ref:`NodePath` **get_target_path** **(** **)** const .. _class_InterpolatedCamera_is_interpolation_enabled: -- :ref:`bool` **is_interpolation_enabled** **(** **)** const +- :ref:`bool` **is_interpolation_enabled** **(** **)** const .. _class_InterpolatedCamera_set_interpolation_enabled: -- void **set_interpolation_enabled** **(** :ref:`bool` target_path **)** +- void **set_interpolation_enabled** **(** :ref:`bool` target_path **)** .. _class_InterpolatedCamera_set_speed: -- void **set_speed** **(** :ref:`float` speed **)** +- void **set_speed** **(** :ref:`float` speed **)** .. _class_InterpolatedCamera_set_target: -- void **set_target** **(** :ref:`Object` target **)** +- void **set_target** **(** :ref:`Object` target **)** .. _class_InterpolatedCamera_set_target_path: -- void **set_target_path** **(** :ref:`NodePath` target_path **)** +- void **set_target_path** **(** :ref:`NodePath` target_path **)** diff --git a/classes/class_ip.rst b/classes/class_ip.rst index 2ce8669ea..ed3586c93 100644 --- a/classes/class_ip.rst +++ b/classes/class_ip.rst @@ -21,21 +21,21 @@ IP Protocol support functions. Member Functions ---------------- -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_cache` **(** :ref:`String` hostname="" **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase_resolve_item` **(** :ref:`int` id **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_local_addresses` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_resolve_item_address` **(** :ref:`int` id **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_resolve_item_status` **(** :ref:`int` id **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`resolve_hostname` **(** :ref:`String` host, :ref:`int` ip_type=3 **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`resolve_hostname_queue_item` **(** :ref:`String` host, :ref:`int` ip_type=3 **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_cache` **(** :ref:`String` hostname="" **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`erase_resolve_item` **(** :ref:`int` id **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_local_addresses` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_resolve_item_address` **(** :ref:`int` id **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_resolve_item_status` **(** :ref:`int` id **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`resolve_hostname` **(** :ref:`String` host, :ref:`int` ip_type=3 **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`resolve_hostname_queue_item` **(** :ref:`String` host, :ref:`int` ip_type=3 **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -61,43 +61,43 @@ Member Function Description .. _class_IP_clear_cache: -- void **clear_cache** **(** :ref:`String` hostname="" **)** +- void **clear_cache** **(** :ref:`String` hostname="" **)** Removes all of a "hostname"'s cached references. If no "hostname" is given then all cached IP addresses are removed. .. _class_IP_erase_resolve_item: -- void **erase_resolve_item** **(** :ref:`int` id **)** +- void **erase_resolve_item** **(** :ref:`int` id **)** Removes a given item "id" from the queue. This should be used to free a queue after it has completed to enable more queries to happen. .. _class_IP_get_local_addresses: -- :ref:`Array` **get_local_addresses** **(** **)** const +- :ref:`Array` **get_local_addresses** **(** **)** const Returns all of the user's current IPv4 and IPv6 addresses as an array. .. _class_IP_get_resolve_item_address: -- :ref:`String` **get_resolve_item_address** **(** :ref:`int` id **)** const +- :ref:`String` **get_resolve_item_address** **(** :ref:`int` id **)** const Returns a queued hostname's IP address, given its queue "id". Returns an empty string on error or if resolution hasn't happened yet (see :ref:`get_resolve_item_status`). .. _class_IP_get_resolve_item_status: -- :ref:`int` **get_resolve_item_status** **(** :ref:`int` id **)** const +- :ref:`int` **get_resolve_item_status** **(** :ref:`int` id **)** const Returns a queued hostname's status as a RESOLVER_STATUS\_\* constant, given its queue "id". .. _class_IP_resolve_hostname: -- :ref:`String` **resolve_hostname** **(** :ref:`String` host, :ref:`int` ip_type=3 **)** +- :ref:`String` **resolve_hostname** **(** :ref:`String` host, :ref:`int` ip_type=3 **)** Returns a given hostname's IPv4 or IPv6 address when resolved (blocking-type method). The address type returned depends on the TYPE\_\* constant given as "ip_type". .. _class_IP_resolve_hostname_queue_item: -- :ref:`int` **resolve_hostname_queue_item** **(** :ref:`String` host, :ref:`int` ip_type=3 **)** +- :ref:`int` **resolve_hostname_queue_item** **(** :ref:`String` host, :ref:`int` ip_type=3 **)** Creates a queue item to resolve a hostname to an IPv4 or IPv6 address depending on the TYPE\_\* constant given as "ip_type". Returns the queue ID if successful, or RESOLVER_INVALID_ID on error. diff --git a/classes/class_itemlist.rst b/classes/class_itemlist.rst index e60e78774..6f798e8b7 100644 --- a/classes/class_itemlist.rst +++ b/classes/class_itemlist.rst @@ -19,122 +19,122 @@ Control that provides a list of selectable items (and/or icons) in a single colu Member Functions ---------------- -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_icon_item` **(** :ref:`Texture` icon, :ref:`bool` selectable=true **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_item` **(** :ref:`String` text, :ref:`Texture` icon=null, :ref:`bool` selectable=true **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`ensure_current_is_visible` **(** **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_allow_rmb_select` **(** **)** const | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_fixed_column_width` **(** **)** const | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_fixed_icon_size` **(** **)** const | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_icon_mode` **(** **)** const | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_icon_scale` **(** **)** const | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_at_position` **(** :ref:`Vector2` position, :ref:`bool` exact=false **)** const | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_count` **(** **)** const | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_item_custom_bg_color` **(** :ref:`int` idx **)** const | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_item_icon` **(** :ref:`int` idx **)** const | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_item_icon_region` **(** :ref:`int` idx **)** const | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_item_metadata` **(** :ref:`int` idx **)** const | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_item_text` **(** :ref:`int` idx **)** const | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_item_tooltip` **(** :ref:`int` idx **)** const | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_max_columns` **(** **)** const | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_max_text_lines` **(** **)** const | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_select_mode` **(** **)** const | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_selected_items` **(** **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`VScrollBar` | :ref:`get_v_scroll` **(** **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_auto_height` **(** **)** const | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_item_disabled` **(** :ref:`int` idx **)** const | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_item_selectable` **(** :ref:`int` idx **)** const | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_item_tooltip_enabled` **(** :ref:`int` idx **)** const | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_same_column_width` **(** **)** const | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_selected` **(** :ref:`int` idx **)** const | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_item` **(** :ref:`int` idx **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`select` **(** :ref:`int` idx, :ref:`bool` single=true **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_allow_rmb_select` **(** :ref:`bool` allow **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_auto_height` **(** :ref:`bool` enable **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fixed_column_width` **(** :ref:`int` width **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fixed_icon_size` **(** :ref:`Vector2` size **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_icon_mode` **(** :ref:`int` mode **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_icon_scale` **(** :ref:`float` scale **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_custom_bg_color` **(** :ref:`int` idx, :ref:`Color` custom_bg_color **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_disabled` **(** :ref:`int` idx, :ref:`bool` disabled **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_icon` **(** :ref:`int` idx, :ref:`Texture` icon **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_icon_region` **(** :ref:`int` idx, :ref:`Rect2` rect **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_metadata` **(** :ref:`int` idx, :ref:`Variant` metadata **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_selectable` **(** :ref:`int` idx, :ref:`bool` selectable **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_text` **(** :ref:`int` idx, :ref:`String` text **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_tooltip` **(** :ref:`int` idx, :ref:`String` tooltip **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_tooltip_enabled` **(** :ref:`int` idx, :ref:`bool` enable **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_max_columns` **(** :ref:`int` amount **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_max_text_lines` **(** :ref:`int` lines **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_same_column_width` **(** :ref:`bool` enable **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_select_mode` **(** :ref:`int` mode **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sort_items_by_text` **(** **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`unselect` **(** :ref:`int` idx **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_icon_item` **(** :ref:`Texture` icon, :ref:`bool` selectable=true **)** | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_item` **(** :ref:`String` text, :ref:`Texture` icon=null, :ref:`bool` selectable=true **)** | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`ensure_current_is_visible` **(** **)** | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_allow_rmb_select` **(** **)** const | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_fixed_column_width` **(** **)** const | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_fixed_icon_size` **(** **)** const | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_icon_mode` **(** **)** const | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_icon_scale` **(** **)** const | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_item_at_position` **(** :ref:`Vector2` position, :ref:`bool` exact=false **)** const | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_item_count` **(** **)** const | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_item_custom_bg_color` **(** :ref:`int` idx **)** const | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_item_icon` **(** :ref:`int` idx **)** const | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_item_icon_region` **(** :ref:`int` idx **)** const | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_item_metadata` **(** :ref:`int` idx **)** const | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_item_text` **(** :ref:`int` idx **)** const | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_item_tooltip` **(** :ref:`int` idx **)** const | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_max_columns` **(** **)** const | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_max_text_lines` **(** **)** const | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_select_mode` **(** **)** const | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`get_selected_items` **(** **)** | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`VScrollBar` | :ref:`get_v_scroll` **(** **)** | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_auto_height` **(** **)** const | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_item_disabled` **(** :ref:`int` idx **)** const | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_item_selectable` **(** :ref:`int` idx **)** const | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_item_tooltip_enabled` **(** :ref:`int` idx **)** const | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_same_column_width` **(** **)** const | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_selected` **(** :ref:`int` idx **)** const | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_item` **(** :ref:`int` idx **)** | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`select` **(** :ref:`int` idx, :ref:`bool` single=true **)** | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_allow_rmb_select` **(** :ref:`bool` allow **)** | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_auto_height` **(** :ref:`bool` enable **)** | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fixed_column_width` **(** :ref:`int` width **)** | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fixed_icon_size` **(** :ref:`Vector2` size **)** | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_icon_mode` **(** :ref:`int` mode **)** | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_icon_scale` **(** :ref:`float` scale **)** | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_custom_bg_color` **(** :ref:`int` idx, :ref:`Color` custom_bg_color **)** | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_disabled` **(** :ref:`int` idx, :ref:`bool` disabled **)** | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_icon` **(** :ref:`int` idx, :ref:`Texture` icon **)** | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_icon_region` **(** :ref:`int` idx, :ref:`Rect2` rect **)** | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_metadata` **(** :ref:`int` idx, :ref:`Variant` metadata **)** | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_selectable` **(** :ref:`int` idx, :ref:`bool` selectable **)** | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_text` **(** :ref:`int` idx, :ref:`String` text **)** | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_tooltip` **(** :ref:`int` idx, :ref:`String` tooltip **)** | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_tooltip_enabled` **(** :ref:`int` idx, :ref:`bool` enable **)** | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_max_columns` **(** :ref:`int` amount **)** | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_max_text_lines` **(** :ref:`int` lines **)** | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_same_column_width` **(** :ref:`bool` enable **)** | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_select_mode` **(** :ref:`int` mode **)** | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`sort_items_by_text` **(** **)** | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`unselect` **(** :ref:`int` idx **)** | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_ItemList_item_activated: -- **item_activated** **(** :ref:`int` index **)** +- **item_activated** **(** :ref:`int` index **)** Fired when specified list item is activated via double click or Enter. .. _class_ItemList_item_rmb_selected: -- **item_rmb_selected** **(** :ref:`int` index, :ref:`Vector2` at_position **)** +- **item_rmb_selected** **(** :ref:`int` index, :ref:`Vector2` at_position **)** Fired when specified list item has been selected via right mouse clicking. @@ -144,13 +144,13 @@ at the correct location. .. _class_ItemList_item_selected: -- **item_selected** **(** :ref:`int` index **)** +- **item_selected** **(** :ref:`int` index **)** Fired when specified item has been selected. .. _class_ItemList_multi_selected: -- **multi_selected** **(** :ref:`int` index, :ref:`bool` selected **)** +- **multi_selected** **(** :ref:`int` index, :ref:`bool` selected **)** Fired when a multiple selection is altered on a list allowing multiple selection. @@ -223,13 +223,13 @@ Member Function Description .. _class_ItemList_add_icon_item: -- void **add_icon_item** **(** :ref:`Texture` icon, :ref:`bool` selectable=true **)** +- void **add_icon_item** **(** :ref:`Texture` icon, :ref:`bool` selectable=true **)** Adds an item to the item list with no text, only an icon. .. _class_ItemList_add_item: -- void **add_item** **(** :ref:`String` text, :ref:`Texture` icon=null, :ref:`bool` selectable=true **)** +- void **add_item** **(** :ref:`String` text, :ref:`Texture` icon=null, :ref:`bool` selectable=true **)** Adds an item to the item list with specified text. Specify an icon of null for a list item with no icon. @@ -237,151 +237,151 @@ If selectable is true the list item will be selectable. .. _class_ItemList_clear: -- void **clear** **(** **)** +- void **clear** **(** **)** Remove all items from the list. .. _class_ItemList_ensure_current_is_visible: -- void **ensure_current_is_visible** **(** **)** +- void **ensure_current_is_visible** **(** **)** Ensure selection is visible, adjusting the scroll position as necessary. .. _class_ItemList_get_allow_rmb_select: -- :ref:`bool` **get_allow_rmb_select** **(** **)** const +- :ref:`bool` **get_allow_rmb_select** **(** **)** const Return whether or not items may be selected via right mouse clicking. .. _class_ItemList_get_fixed_column_width: -- :ref:`int` **get_fixed_column_width** **(** **)** const +- :ref:`int` **get_fixed_column_width** **(** **)** const If column size has been fixed to a value, return that value. .. _class_ItemList_get_fixed_icon_size: -- :ref:`Vector2` **get_fixed_icon_size** **(** **)** const +- :ref:`Vector2` **get_fixed_icon_size** **(** **)** const .. _class_ItemList_get_icon_mode: -- :ref:`int` **get_icon_mode** **(** **)** const +- :ref:`int` **get_icon_mode** **(** **)** const .. _class_ItemList_get_icon_scale: -- :ref:`float` **get_icon_scale** **(** **)** const +- :ref:`float` **get_icon_scale** **(** **)** const .. _class_ItemList_get_item_at_position: -- :ref:`int` **get_item_at_position** **(** :ref:`Vector2` position, :ref:`bool` exact=false **)** const +- :ref:`int` **get_item_at_position** **(** :ref:`Vector2` position, :ref:`bool` exact=false **)** const Given a position within the control return the item (if any) at that point. .. _class_ItemList_get_item_count: -- :ref:`int` **get_item_count** **(** **)** const +- :ref:`int` **get_item_count** **(** **)** const Return count of items currently in the item list. .. _class_ItemList_get_item_custom_bg_color: -- :ref:`Color` **get_item_custom_bg_color** **(** :ref:`int` idx **)** const +- :ref:`Color` **get_item_custom_bg_color** **(** :ref:`int` idx **)** const .. _class_ItemList_get_item_icon: -- :ref:`Texture` **get_item_icon** **(** :ref:`int` idx **)** const +- :ref:`Texture` **get_item_icon** **(** :ref:`int` idx **)** const .. _class_ItemList_get_item_icon_region: -- :ref:`Rect2` **get_item_icon_region** **(** :ref:`int` idx **)** const +- :ref:`Rect2` **get_item_icon_region** **(** :ref:`int` idx **)** const .. _class_ItemList_get_item_metadata: -- :ref:`Variant` **get_item_metadata** **(** :ref:`int` idx **)** const +- :ref:`Variant` **get_item_metadata** **(** :ref:`int` idx **)** const .. _class_ItemList_get_item_text: -- :ref:`String` **get_item_text** **(** :ref:`int` idx **)** const +- :ref:`String` **get_item_text** **(** :ref:`int` idx **)** const Return the text for specified item index. .. _class_ItemList_get_item_tooltip: -- :ref:`String` **get_item_tooltip** **(** :ref:`int` idx **)** const +- :ref:`String` **get_item_tooltip** **(** :ref:`int` idx **)** const Return tooltip hint for specified item index. .. _class_ItemList_get_max_columns: -- :ref:`int` **get_max_columns** **(** **)** const +- :ref:`int` **get_max_columns** **(** **)** const Return total number of columns in use by the list. .. _class_ItemList_get_max_text_lines: -- :ref:`int` **get_max_text_lines** **(** **)** const +- :ref:`int` **get_max_text_lines** **(** **)** const Return total number of lines currently in use by the list. .. _class_ItemList_get_select_mode: -- :ref:`int` **get_select_mode** **(** **)** const +- :ref:`int` **get_select_mode** **(** **)** const .. _class_ItemList_get_selected_items: -- :ref:`PoolIntArray` **get_selected_items** **(** **)** +- :ref:`PoolIntArray` **get_selected_items** **(** **)** Returns the list of selected indexes. .. _class_ItemList_get_v_scroll: -- :ref:`VScrollBar` **get_v_scroll** **(** **)** +- :ref:`VScrollBar` **get_v_scroll** **(** **)** Returns the current vertical scroll bar for the List. .. _class_ItemList_has_auto_height: -- :ref:`bool` **has_auto_height** **(** **)** const +- :ref:`bool` **has_auto_height** **(** **)** const .. _class_ItemList_is_item_disabled: -- :ref:`bool` **is_item_disabled** **(** :ref:`int` idx **)** const +- :ref:`bool` **is_item_disabled** **(** :ref:`int` idx **)** const Returns whether or not the item at the specified index is disabled .. _class_ItemList_is_item_selectable: -- :ref:`bool` **is_item_selectable** **(** :ref:`int` idx **)** const +- :ref:`bool` **is_item_selectable** **(** :ref:`int` idx **)** const Returns whether or not the item at the specified index is selectable. .. _class_ItemList_is_item_tooltip_enabled: -- :ref:`bool` **is_item_tooltip_enabled** **(** :ref:`int` idx **)** const +- :ref:`bool` **is_item_tooltip_enabled** **(** :ref:`int` idx **)** const Returns whether the tooltip is enabled for specified item index. .. _class_ItemList_is_same_column_width: -- :ref:`bool` **is_same_column_width** **(** **)** const +- :ref:`bool` **is_same_column_width** **(** **)** const Returns whether or not all columns of the list are of the same size. .. _class_ItemList_is_selected: -- :ref:`bool` **is_selected** **(** :ref:`int` idx **)** const +- :ref:`bool` **is_selected** **(** :ref:`int` idx **)** const Returns whether or not item at the specified index is currently selected. .. _class_ItemList_remove_item: -- void **remove_item** **(** :ref:`int` idx **)** +- void **remove_item** **(** :ref:`int` idx **)** Remove item at specified index from the list. .. _class_ItemList_select: -- void **select** **(** :ref:`int` idx, :ref:`bool` single=true **)** +- void **select** **(** :ref:`int` idx, :ref:`bool` single=true **)** Select the item at the specified index. @@ -389,39 +389,39 @@ Note: This method does not trigger the item selection signal. .. _class_ItemList_set_allow_rmb_select: -- void **set_allow_rmb_select** **(** :ref:`bool` allow **)** +- void **set_allow_rmb_select** **(** :ref:`bool` allow **)** Allow (or disallow) selection of (selectable) items in the list using right mouse button. .. _class_ItemList_set_auto_height: -- void **set_auto_height** **(** :ref:`bool` enable **)** +- void **set_auto_height** **(** :ref:`bool` enable **)** .. _class_ItemList_set_fixed_column_width: -- void **set_fixed_column_width** **(** :ref:`int` width **)** +- void **set_fixed_column_width** **(** :ref:`int` width **)** Set the size (width) all columns in the list are to use. .. _class_ItemList_set_fixed_icon_size: -- void **set_fixed_icon_size** **(** :ref:`Vector2` size **)** +- void **set_fixed_icon_size** **(** :ref:`Vector2` size **)** .. _class_ItemList_set_icon_mode: -- void **set_icon_mode** **(** :ref:`int` mode **)** +- void **set_icon_mode** **(** :ref:`int` mode **)** .. _class_ItemList_set_icon_scale: -- void **set_icon_scale** **(** :ref:`float` scale **)** +- void **set_icon_scale** **(** :ref:`float` scale **)** .. _class_ItemList_set_item_custom_bg_color: -- void **set_item_custom_bg_color** **(** :ref:`int` idx, :ref:`Color` custom_bg_color **)** +- void **set_item_custom_bg_color** **(** :ref:`int` idx, :ref:`Color` custom_bg_color **)** .. _class_ItemList_set_item_disabled: -- void **set_item_disabled** **(** :ref:`int` idx, :ref:`bool` disabled **)** +- void **set_item_disabled** **(** :ref:`int` idx, :ref:`bool` disabled **)** Disable (or enable) item at specified index. @@ -429,75 +429,75 @@ Disabled items are not be selectable and do not fire activation (Enter or double .. _class_ItemList_set_item_icon: -- void **set_item_icon** **(** :ref:`int` idx, :ref:`Texture` icon **)** +- void **set_item_icon** **(** :ref:`int` idx, :ref:`Texture` icon **)** Set (or replace) icon of the item at the specified index. .. _class_ItemList_set_item_icon_region: -- void **set_item_icon_region** **(** :ref:`int` idx, :ref:`Rect2` rect **)** +- void **set_item_icon_region** **(** :ref:`int` idx, :ref:`Rect2` rect **)** .. _class_ItemList_set_item_metadata: -- void **set_item_metadata** **(** :ref:`int` idx, :ref:`Variant` metadata **)** +- void **set_item_metadata** **(** :ref:`int` idx, :ref:`Variant` metadata **)** Sets a value (of any type) to be stored with the item at the specified index. .. _class_ItemList_set_item_selectable: -- void **set_item_selectable** **(** :ref:`int` idx, :ref:`bool` selectable **)** +- void **set_item_selectable** **(** :ref:`int` idx, :ref:`bool` selectable **)** Allow or disallow selection of the item at the specified index. .. _class_ItemList_set_item_text: -- void **set_item_text** **(** :ref:`int` idx, :ref:`String` text **)** +- void **set_item_text** **(** :ref:`int` idx, :ref:`String` text **)** Sets text of item at specified index. .. _class_ItemList_set_item_tooltip: -- void **set_item_tooltip** **(** :ref:`int` idx, :ref:`String` tooltip **)** +- void **set_item_tooltip** **(** :ref:`int` idx, :ref:`String` tooltip **)** Sets tooltip hint for item at specified index. .. _class_ItemList_set_item_tooltip_enabled: -- void **set_item_tooltip_enabled** **(** :ref:`int` idx, :ref:`bool` enable **)** +- void **set_item_tooltip_enabled** **(** :ref:`int` idx, :ref:`bool` enable **)** Sets whether the tooltip is enabled for specified item index. .. _class_ItemList_set_max_columns: -- void **set_max_columns** **(** :ref:`int` amount **)** +- void **set_max_columns** **(** :ref:`int` amount **)** Set maximum number of columns to use for the list. .. _class_ItemList_set_max_text_lines: -- void **set_max_text_lines** **(** :ref:`int` lines **)** +- void **set_max_text_lines** **(** :ref:`int` lines **)** Set maximum number of lines to use for the list. .. _class_ItemList_set_same_column_width: -- void **set_same_column_width** **(** :ref:`bool` enable **)** +- void **set_same_column_width** **(** :ref:`bool` enable **)** Sets a fixed size (width) to use for all columns of the list. .. _class_ItemList_set_select_mode: -- void **set_select_mode** **(** :ref:`int` mode **)** +- void **set_select_mode** **(** :ref:`int` mode **)** .. _class_ItemList_sort_items_by_text: -- void **sort_items_by_text** **(** **)** +- void **sort_items_by_text** **(** **)** Sorts items in the list by their text. .. _class_ItemList_unselect: -- void **unselect** **(** :ref:`int` idx **)** +- void **unselect** **(** :ref:`int` idx **)** Ensure item at specified index is not selected. diff --git a/classes/class_joint.rst b/classes/class_joint.rst index de97e1050..170fa006e 100644 --- a/classes/class_joint.rst +++ b/classes/class_joint.rst @@ -21,23 +21,23 @@ Base class for all 3D joints Member Functions ---------------- -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_exclude_nodes_from_collision` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_node_a` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_node_b` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_solver_priority` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_exclude_nodes_from_collision` **(** :ref:`bool` enable **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_node_a` **(** :ref:`NodePath` node **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_node_b` **(** :ref:`NodePath` node **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_solver_priority` **(** :ref:`int` priority **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_exclude_nodes_from_collision` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_node_a` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_node_b` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_solver_priority` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_exclude_nodes_from_collision` **(** :ref:`bool` enable **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_node_a` **(** :ref:`NodePath` node **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_node_b` **(** :ref:`NodePath` node **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_solver_priority` **(** :ref:`int` priority **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -69,34 +69,34 @@ Member Function Description .. _class_Joint_get_exclude_nodes_from_collision: -- :ref:`bool` **get_exclude_nodes_from_collision** **(** **)** const +- :ref:`bool` **get_exclude_nodes_from_collision** **(** **)** const .. _class_Joint_get_node_a: -- :ref:`NodePath` **get_node_a** **(** **)** const +- :ref:`NodePath` **get_node_a** **(** **)** const .. _class_Joint_get_node_b: -- :ref:`NodePath` **get_node_b** **(** **)** const +- :ref:`NodePath` **get_node_b** **(** **)** const .. _class_Joint_get_solver_priority: -- :ref:`int` **get_solver_priority** **(** **)** const +- :ref:`int` **get_solver_priority** **(** **)** const .. _class_Joint_set_exclude_nodes_from_collision: -- void **set_exclude_nodes_from_collision** **(** :ref:`bool` enable **)** +- void **set_exclude_nodes_from_collision** **(** :ref:`bool` enable **)** .. _class_Joint_set_node_a: -- void **set_node_a** **(** :ref:`NodePath` node **)** +- void **set_node_a** **(** :ref:`NodePath` node **)** .. _class_Joint_set_node_b: -- void **set_node_b** **(** :ref:`NodePath` node **)** +- void **set_node_b** **(** :ref:`NodePath` node **)** .. _class_Joint_set_solver_priority: -- void **set_solver_priority** **(** :ref:`int` priority **)** +- void **set_solver_priority** **(** :ref:`int` priority **)** diff --git a/classes/class_joint2d.rst b/classes/class_joint2d.rst index a42ee374d..19d277dc9 100644 --- a/classes/class_joint2d.rst +++ b/classes/class_joint2d.rst @@ -21,23 +21,23 @@ Base node for all joint constraints in 2D physics. Member Functions ---------------- -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_bias` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_exclude_nodes_from_collision` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_node_a` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_node_b` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bias` **(** :ref:`float` bias **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_exclude_nodes_from_collision` **(** :ref:`bool` enable **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_node_a` **(** :ref:`NodePath` node **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_node_b` **(** :ref:`NodePath` node **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_bias` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_exclude_nodes_from_collision` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_node_a` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_node_b` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bias` **(** :ref:`float` bias **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_exclude_nodes_from_collision` **(** :ref:`bool` enable **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_node_a` **(** :ref:`NodePath` node **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_node_b` **(** :ref:`NodePath` node **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -69,41 +69,41 @@ Member Function Description .. _class_Joint2D_get_bias: -- :ref:`float` **get_bias** **(** **)** const +- :ref:`float` **get_bias** **(** **)** const .. _class_Joint2D_get_exclude_nodes_from_collision: -- :ref:`bool` **get_exclude_nodes_from_collision** **(** **)** const +- :ref:`bool` **get_exclude_nodes_from_collision** **(** **)** const .. _class_Joint2D_get_node_a: -- :ref:`NodePath` **get_node_a** **(** **)** const +- :ref:`NodePath` **get_node_a** **(** **)** const Return the path to the A node for the joint. .. _class_Joint2D_get_node_b: -- :ref:`NodePath` **get_node_b** **(** **)** const +- :ref:`NodePath` **get_node_b** **(** **)** const Return the path to the B node for the joint. .. _class_Joint2D_set_bias: -- void **set_bias** **(** :ref:`float` bias **)** +- void **set_bias** **(** :ref:`float` bias **)** .. _class_Joint2D_set_exclude_nodes_from_collision: -- void **set_exclude_nodes_from_collision** **(** :ref:`bool` enable **)** +- void **set_exclude_nodes_from_collision** **(** :ref:`bool` enable **)** .. _class_Joint2D_set_node_a: -- void **set_node_a** **(** :ref:`NodePath` node **)** +- void **set_node_a** **(** :ref:`NodePath` node **)** Set the path to the A node for the joint. Must be of type :ref:`PhysicsBody2D`. .. _class_Joint2D_set_node_b: -- void **set_node_b** **(** :ref:`NodePath` node **)** +- void **set_node_b** **(** :ref:`NodePath` node **)** Set the path to the B node for the joint. Must be of type :ref:`PhysicsBody2D`. diff --git a/classes/class_json.rst b/classes/class_json.rst index b87b5a5a6..89e678737 100644 --- a/classes/class_json.rst +++ b/classes/class_json.rst @@ -19,11 +19,11 @@ Helper class for parsing JSON data. Member Functions ---------------- -+------------------------------------------------+----------------------------------------------------------------------------------+ -| :ref:`JSONParseResult` | :ref:`parse` **(** :ref:`String` json **)** | -+------------------------------------------------+----------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`print` **(** :ref:`Variant` value **)** | -+------------------------------------------------+----------------------------------------------------------------------------------+ ++------------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`JSONParseResult` | :ref:`parse` **(** :ref:`String` json **)** | ++------------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`print` **(** :ref:`Variant` value **)** | ++------------------------------------------------+--------------------------------------------------------------------------------+ Description ----------- @@ -35,13 +35,13 @@ Member Function Description .. _class_JSON_parse: -- :ref:`JSONParseResult` **parse** **(** :ref:`String` json **)** +- :ref:`JSONParseResult` **parse** **(** :ref:`String` json **)** Parses a JSON encoded string and returns a :ref:`JSONParseResult` containing the result. .. _class_JSON_print: -- :ref:`String` **print** **(** :ref:`Variant` value **)** +- :ref:`String` **print** **(** :ref:`Variant` value **)** Converts a Variant var to JSON text and returns the result. Useful for serializing data to store or send over the network. diff --git a/classes/class_jsonparseresult.rst b/classes/class_jsonparseresult.rst index 8528e82a9..285f5213d 100644 --- a/classes/class_jsonparseresult.rst +++ b/classes/class_jsonparseresult.rst @@ -19,23 +19,23 @@ Data class wrapper for decoded JSON. Member Functions ---------------- -+--------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_error` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_error_line` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_error_string` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_result` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_error` **(** :ref:`int` error **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_error_line` **(** :ref:`int` error_line **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_error_string` **(** :ref:`String` error_string **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_result` **(** :ref:`Variant` result **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_error` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_error_line` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_error_string` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_result` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_error` **(** :ref:`int` error **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_error_line` **(** :ref:`int` error_line **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_error_string` **(** :ref:`String` error_string **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_result` **(** :ref:`Variant` result **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -77,34 +77,34 @@ Member Function Description .. _class_JSONParseResult_get_error: -- :ref:`int` **get_error** **(** **)** const +- :ref:`int` **get_error** **(** **)** const .. _class_JSONParseResult_get_error_line: -- :ref:`int` **get_error_line** **(** **)** const +- :ref:`int` **get_error_line** **(** **)** const .. _class_JSONParseResult_get_error_string: -- :ref:`String` **get_error_string** **(** **)** const +- :ref:`String` **get_error_string** **(** **)** const .. _class_JSONParseResult_get_result: -- :ref:`Variant` **get_result** **(** **)** const +- :ref:`Variant` **get_result** **(** **)** const .. _class_JSONParseResult_set_error: -- void **set_error** **(** :ref:`int` error **)** +- void **set_error** **(** :ref:`int` error **)** .. _class_JSONParseResult_set_error_line: -- void **set_error_line** **(** :ref:`int` error_line **)** +- void **set_error_line** **(** :ref:`int` error_line **)** .. _class_JSONParseResult_set_error_string: -- void **set_error_string** **(** :ref:`String` error_string **)** +- void **set_error_string** **(** :ref:`String` error_string **)** .. _class_JSONParseResult_set_result: -- void **set_result** **(** :ref:`Variant` result **)** +- void **set_result** **(** :ref:`Variant` result **)** diff --git a/classes/class_kinematicbody.rst b/classes/class_kinematicbody.rst index 667bd92b9..f83420758 100644 --- a/classes/class_kinematicbody.rst +++ b/classes/class_kinematicbody.rst @@ -19,29 +19,29 @@ Kinematic body 3D node. Member Functions ---------------- -+------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_floor_velocity` **(** **)** const | -+------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_safe_margin` **(** **)** const | -+------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`KinematicCollision` | :ref:`get_slide_collision` **(** :ref:`int` slide_idx **)** | -+------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_slide_count` **(** **)** const | -+------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_on_ceiling` **(** **)** const | -+------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_on_floor` **(** **)** const | -+------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_on_wall` **(** **)** const | -+------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`KinematicCollision` | :ref:`move_and_collide` **(** :ref:`Vector3` rel_vec **)** | -+------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`move_and_slide` **(** :ref:`Vector3` linear_velocity, :ref:`Vector3` floor_normal=Vector3( 0, 0, 0 ), :ref:`float` slope_stop_min_velocity=0.05, :ref:`int` max_slides=4, :ref:`float` floor_max_angle=0.785398 **)** | -+------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_safe_margin` **(** :ref:`float` pixels **)** | -+------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`test_move` **(** :ref:`Transform` from, :ref:`Vector3` rel_vec **)** | -+------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_floor_velocity` **(** **)** const | ++------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_safe_margin` **(** **)** const | ++------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`KinematicCollision` | :ref:`get_slide_collision` **(** :ref:`int` slide_idx **)** | ++------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_slide_count` **(** **)** const | ++------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_on_ceiling` **(** **)** const | ++------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_on_floor` **(** **)** const | ++------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_on_wall` **(** **)** const | ++------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`KinematicCollision` | :ref:`move_and_collide` **(** :ref:`Vector3` rel_vec **)** | ++------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`move_and_slide` **(** :ref:`Vector3` linear_velocity, :ref:`Vector3` floor_normal=Vector3( 0, 0, 0 ), :ref:`float` slope_stop_min_velocity=0.05, :ref:`int` max_slides=4, :ref:`float` floor_max_angle=0.785398 **)** | ++------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_safe_margin` **(** :ref:`float` pixels **)** | ++------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`test_move` **(** :ref:`Transform` from, :ref:`Vector3` rel_vec **)** | ++------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -65,53 +65,53 @@ Member Function Description .. _class_KinematicBody_get_floor_velocity: -- :ref:`Vector3` **get_floor_velocity** **(** **)** const +- :ref:`Vector3` **get_floor_velocity** **(** **)** const Returns the velocity of the floor. Only updates when calling :ref:`move_and_slide`. .. _class_KinematicBody_get_safe_margin: -- :ref:`float` **get_safe_margin** **(** **)** const +- :ref:`float` **get_safe_margin** **(** **)** const .. _class_KinematicBody_get_slide_collision: -- :ref:`KinematicCollision` **get_slide_collision** **(** :ref:`int` slide_idx **)** +- :ref:`KinematicCollision` **get_slide_collision** **(** :ref:`int` slide_idx **)** Returns a :ref:`KinematicCollision`, which contains information about a collision that occured during the last :ref:`move_and_slide` call. Since the body can collide several times in a single call to :ref:`move_and_slide`, you must specify the index of the collision in the range 0 to (:ref:`get_slide_count`()-1). .. _class_KinematicBody_get_slide_count: -- :ref:`int` **get_slide_count** **(** **)** const +- :ref:`int` **get_slide_count** **(** **)** const Returns the number of times the body collided and changed direction during the last call to :ref:`move_and_slide`. .. _class_KinematicBody_is_on_ceiling: -- :ref:`bool` **is_on_ceiling** **(** **)** const +- :ref:`bool` **is_on_ceiling** **(** **)** const Returns ``true`` if the body is on the ceiling. Only updates when calling :ref:`move_and_slide`. .. _class_KinematicBody_is_on_floor: -- :ref:`bool` **is_on_floor** **(** **)** const +- :ref:`bool` **is_on_floor** **(** **)** const Returns ``true`` if the body is on the floor. Only updates when calling :ref:`move_and_slide`. .. _class_KinematicBody_is_on_wall: -- :ref:`bool` **is_on_wall** **(** **)** const +- :ref:`bool` **is_on_wall** **(** **)** const Returns ``true`` if the body is on a wall. Only updates when calling :ref:`move_and_slide`. .. _class_KinematicBody_move_and_collide: -- :ref:`KinematicCollision` **move_and_collide** **(** :ref:`Vector3` rel_vec **)** +- :ref:`KinematicCollision` **move_and_collide** **(** :ref:`Vector3` rel_vec **)** Moves the body along the vector ``rel_vec``. The body will stop if it collides. Returns a :ref:`KinematicCollision`, which contains information about the collision. .. _class_KinematicBody_move_and_slide: -- :ref:`Vector3` **move_and_slide** **(** :ref:`Vector3` linear_velocity, :ref:`Vector3` floor_normal=Vector3( 0, 0, 0 ), :ref:`float` slope_stop_min_velocity=0.05, :ref:`int` max_slides=4, :ref:`float` floor_max_angle=0.785398 **)** +- :ref:`Vector3` **move_and_slide** **(** :ref:`Vector3` linear_velocity, :ref:`Vector3` floor_normal=Vector3( 0, 0, 0 ), :ref:`float` slope_stop_min_velocity=0.05, :ref:`int` max_slides=4, :ref:`float` floor_max_angle=0.785398 **)** Moves the body along a vector. If the body collides with another, it will slide along the other body rather than stop immediately. If the other body is a :ref:`KinematicBody` or :ref:`RigidBody`, it will also be affected by the motion of the other body. You can use this to make moving or rotating platforms, or to make nodes push other nodes. @@ -129,11 +129,11 @@ Returns the movement that remained when the body stopped. To get more detailed i .. _class_KinematicBody_set_safe_margin: -- void **set_safe_margin** **(** :ref:`float` pixels **)** +- void **set_safe_margin** **(** :ref:`float` pixels **)** .. _class_KinematicBody_test_move: -- :ref:`bool` **test_move** **(** :ref:`Transform` from, :ref:`Vector3` rel_vec **)** +- :ref:`bool` **test_move** **(** :ref:`Transform` from, :ref:`Vector3` rel_vec **)** Checks for collisions without moving the body. Virtually sets the node's position, scale and rotation to that of the given :ref:`Transform`, then tries to move the body along the vector ``rel_vec``. Returns ``true`` if a collision would occur. diff --git a/classes/class_kinematicbody2d.rst b/classes/class_kinematicbody2d.rst index 945e97dc6..271c25e53 100644 --- a/classes/class_kinematicbody2d.rst +++ b/classes/class_kinematicbody2d.rst @@ -19,29 +19,29 @@ Kinematic body 2D node. Member Functions ---------------- -+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_floor_velocity` **(** **)** const | -+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_safe_margin` **(** **)** const | -+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`KinematicCollision2D` | :ref:`get_slide_collision` **(** :ref:`int` slide_idx **)** | -+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_slide_count` **(** **)** const | -+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_on_ceiling` **(** **)** const | -+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_on_floor` **(** **)** const | -+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_on_wall` **(** **)** const | -+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`KinematicCollision2D` | :ref:`move_and_collide` **(** :ref:`Vector2` rel_vec **)** | -+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`move_and_slide` **(** :ref:`Vector2` linear_velocity, :ref:`Vector2` floor_normal=Vector2( 0, 0 ), :ref:`float` slope_stop_min_velocity=5, :ref:`int` max_bounces=4, :ref:`float` floor_max_angle=0.785398 **)** | -+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_safe_margin` **(** :ref:`float` pixels **)** | -+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`test_move` **(** :ref:`Transform2D` from, :ref:`Vector2` rel_vec **)** | -+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_floor_velocity` **(** **)** const | ++----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_safe_margin` **(** **)** const | ++----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`KinematicCollision2D` | :ref:`get_slide_collision` **(** :ref:`int` slide_idx **)** | ++----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_slide_count` **(** **)** const | ++----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_on_ceiling` **(** **)** const | ++----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_on_floor` **(** **)** const | ++----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_on_wall` **(** **)** const | ++----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`KinematicCollision2D` | :ref:`move_and_collide` **(** :ref:`Vector2` rel_vec **)** | ++----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`move_and_slide` **(** :ref:`Vector2` linear_velocity, :ref:`Vector2` floor_normal=Vector2( 0, 0 ), :ref:`float` slope_stop_min_velocity=5, :ref:`int` max_bounces=4, :ref:`float` floor_max_angle=0.785398 **)** | ++----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_safe_margin` **(** :ref:`float` pixels **)** | ++----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`test_move` **(** :ref:`Transform2D` from, :ref:`Vector2` rel_vec **)** | ++----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -65,53 +65,53 @@ Member Function Description .. _class_KinematicBody2D_get_floor_velocity: -- :ref:`Vector2` **get_floor_velocity** **(** **)** const +- :ref:`Vector2` **get_floor_velocity** **(** **)** const Returns the velocity of the floor. Only updates when calling :ref:`move_and_slide`. .. _class_KinematicBody2D_get_safe_margin: -- :ref:`float` **get_safe_margin** **(** **)** const +- :ref:`float` **get_safe_margin** **(** **)** const .. _class_KinematicBody2D_get_slide_collision: -- :ref:`KinematicCollision2D` **get_slide_collision** **(** :ref:`int` slide_idx **)** +- :ref:`KinematicCollision2D` **get_slide_collision** **(** :ref:`int` slide_idx **)** Returns a :ref:`KinematicCollision2D`, which contains information about a collision that occured during the last :ref:`move_and_slide` call. Since the body can collide several times in a single call to :ref:`move_and_slide`, you must specify the index of the collision in the range 0 to (:ref:`get_slide_count`()-1). .. _class_KinematicBody2D_get_slide_count: -- :ref:`int` **get_slide_count** **(** **)** const +- :ref:`int` **get_slide_count** **(** **)** const Returns the number of times the body collided and changed direction during the last call to :ref:`move_and_slide`. .. _class_KinematicBody2D_is_on_ceiling: -- :ref:`bool` **is_on_ceiling** **(** **)** const +- :ref:`bool` **is_on_ceiling** **(** **)** const Returns ``true`` if the body is on the ceiling. Only updates when calling :ref:`move_and_slide`. .. _class_KinematicBody2D_is_on_floor: -- :ref:`bool` **is_on_floor** **(** **)** const +- :ref:`bool` **is_on_floor** **(** **)** const Returns ``true`` if the body is on the floor. Only updates when calling :ref:`move_and_slide`. .. _class_KinematicBody2D_is_on_wall: -- :ref:`bool` **is_on_wall** **(** **)** const +- :ref:`bool` **is_on_wall** **(** **)** const Returns ``true`` if the body is on a wall. Only updates when calling :ref:`move_and_slide`. .. _class_KinematicBody2D_move_and_collide: -- :ref:`KinematicCollision2D` **move_and_collide** **(** :ref:`Vector2` rel_vec **)** +- :ref:`KinematicCollision2D` **move_and_collide** **(** :ref:`Vector2` rel_vec **)** Moves the body along the vector ``rel_vec``. The body will stop if it collides. Returns a :ref:`KinematicCollision2D`, which contains information about the collision. .. _class_KinematicBody2D_move_and_slide: -- :ref:`Vector2` **move_and_slide** **(** :ref:`Vector2` linear_velocity, :ref:`Vector2` floor_normal=Vector2( 0, 0 ), :ref:`float` slope_stop_min_velocity=5, :ref:`int` max_bounces=4, :ref:`float` floor_max_angle=0.785398 **)** +- :ref:`Vector2` **move_and_slide** **(** :ref:`Vector2` linear_velocity, :ref:`Vector2` floor_normal=Vector2( 0, 0 ), :ref:`float` slope_stop_min_velocity=5, :ref:`int` max_bounces=4, :ref:`float` floor_max_angle=0.785398 **)** Moves the body along a vector. If the body collides with another, it will slide along the other body rather than stop immediately. If the other body is a :ref:`KinematicBody2D` or :ref:`RigidBody2D`, it will also be affected by the motion of the other body. You can use this to make moving or rotating platforms, or to make nodes push other nodes. @@ -129,11 +129,11 @@ Returns the movement that remained when the body stopped. To get more detailed i .. _class_KinematicBody2D_set_safe_margin: -- void **set_safe_margin** **(** :ref:`float` pixels **)** +- void **set_safe_margin** **(** :ref:`float` pixels **)** .. _class_KinematicBody2D_test_move: -- :ref:`bool` **test_move** **(** :ref:`Transform2D` from, :ref:`Vector2` rel_vec **)** +- :ref:`bool` **test_move** **(** :ref:`Transform2D` from, :ref:`Vector2` rel_vec **)** Checks for collisions without moving the body. Virtually sets the node's position, scale and rotation to that of the given :ref:`Transform2D`, then tries to move the body along the vector ``rel_vec``. Returns ``true`` if a collision would occur. diff --git a/classes/class_kinematiccollision.rst b/classes/class_kinematiccollision.rst index 8c07a4f9f..6d48e82a5 100644 --- a/classes/class_kinematiccollision.rst +++ b/classes/class_kinematiccollision.rst @@ -19,29 +19,29 @@ Collision data for KinematicBody2D collisions. Member Functions ---------------- -+--------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_collider` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collider_id` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_collider_metadata` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_collider_shape` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collider_shape_index` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_collider_velocity` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_local_shape` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_normal` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_position` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_remainder` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_travel` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------+ ++--------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_collider` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collider_id` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_collider_metadata` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_collider_shape` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collider_shape_index` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_collider_velocity` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_local_shape` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_normal` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_position` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_remainder` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_travel` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -103,46 +103,46 @@ Member Function Description .. _class_KinematicCollision_get_collider: -- :ref:`Object` **get_collider** **(** **)** const +- :ref:`Object` **get_collider** **(** **)** const .. _class_KinematicCollision_get_collider_id: -- :ref:`int` **get_collider_id** **(** **)** const +- :ref:`int` **get_collider_id** **(** **)** const .. _class_KinematicCollision_get_collider_metadata: -- :ref:`Variant` **get_collider_metadata** **(** **)** const +- :ref:`Variant` **get_collider_metadata** **(** **)** const .. _class_KinematicCollision_get_collider_shape: -- :ref:`Object` **get_collider_shape** **(** **)** const +- :ref:`Object` **get_collider_shape** **(** **)** const .. _class_KinematicCollision_get_collider_shape_index: -- :ref:`int` **get_collider_shape_index** **(** **)** const +- :ref:`int` **get_collider_shape_index** **(** **)** const .. _class_KinematicCollision_get_collider_velocity: -- :ref:`Vector3` **get_collider_velocity** **(** **)** const +- :ref:`Vector3` **get_collider_velocity** **(** **)** const .. _class_KinematicCollision_get_local_shape: -- :ref:`Object` **get_local_shape** **(** **)** const +- :ref:`Object` **get_local_shape** **(** **)** const .. _class_KinematicCollision_get_normal: -- :ref:`Vector3` **get_normal** **(** **)** const +- :ref:`Vector3` **get_normal** **(** **)** const .. _class_KinematicCollision_get_position: -- :ref:`Vector3` **get_position** **(** **)** const +- :ref:`Vector3` **get_position** **(** **)** const .. _class_KinematicCollision_get_remainder: -- :ref:`Vector3` **get_remainder** **(** **)** const +- :ref:`Vector3` **get_remainder** **(** **)** const .. _class_KinematicCollision_get_travel: -- :ref:`Vector3` **get_travel** **(** **)** const +- :ref:`Vector3` **get_travel** **(** **)** const diff --git a/classes/class_kinematiccollision2d.rst b/classes/class_kinematiccollision2d.rst index 144089a81..4b57f4538 100644 --- a/classes/class_kinematiccollision2d.rst +++ b/classes/class_kinematiccollision2d.rst @@ -19,29 +19,29 @@ Collision data for KinematicBody2D collisions. Member Functions ---------------- -+--------------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_collider` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collider_id` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_collider_metadata` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_collider_shape` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collider_shape_index` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_collider_velocity` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_local_shape` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_normal` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_position` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_remainder` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_travel` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------+ ++--------------------------------+--------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_collider` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collider_id` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_collider_metadata` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_collider_shape` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collider_shape_index` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_collider_velocity` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_local_shape` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_normal` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_position` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_remainder` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_travel` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -103,46 +103,46 @@ Member Function Description .. _class_KinematicCollision2D_get_collider: -- :ref:`Object` **get_collider** **(** **)** const +- :ref:`Object` **get_collider** **(** **)** const .. _class_KinematicCollision2D_get_collider_id: -- :ref:`int` **get_collider_id** **(** **)** const +- :ref:`int` **get_collider_id** **(** **)** const .. _class_KinematicCollision2D_get_collider_metadata: -- :ref:`Variant` **get_collider_metadata** **(** **)** const +- :ref:`Variant` **get_collider_metadata** **(** **)** const .. _class_KinematicCollision2D_get_collider_shape: -- :ref:`Object` **get_collider_shape** **(** **)** const +- :ref:`Object` **get_collider_shape** **(** **)** const .. _class_KinematicCollision2D_get_collider_shape_index: -- :ref:`int` **get_collider_shape_index** **(** **)** const +- :ref:`int` **get_collider_shape_index** **(** **)** const .. _class_KinematicCollision2D_get_collider_velocity: -- :ref:`Vector2` **get_collider_velocity** **(** **)** const +- :ref:`Vector2` **get_collider_velocity** **(** **)** const .. _class_KinematicCollision2D_get_local_shape: -- :ref:`Object` **get_local_shape** **(** **)** const +- :ref:`Object` **get_local_shape** **(** **)** const .. _class_KinematicCollision2D_get_normal: -- :ref:`Vector2` **get_normal** **(** **)** const +- :ref:`Vector2` **get_normal** **(** **)** const .. _class_KinematicCollision2D_get_position: -- :ref:`Vector2` **get_position** **(** **)** const +- :ref:`Vector2` **get_position** **(** **)** const .. _class_KinematicCollision2D_get_remainder: -- :ref:`Vector2` **get_remainder** **(** **)** const +- :ref:`Vector2` **get_remainder** **(** **)** const .. _class_KinematicCollision2D_get_travel: -- :ref:`Vector2` **get_travel** **(** **)** const +- :ref:`Vector2` **get_travel** **(** **)** const diff --git a/classes/class_label.rst b/classes/class_label.rst index 94ccee6b6..21acf9af8 100644 --- a/classes/class_label.rst +++ b/classes/class_label.rst @@ -19,55 +19,55 @@ Displays plain text in a line or wrapped inside a rectangle. For formatted text, Member Functions ---------------- -+------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_align` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_line_count` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_line_height` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_lines_skipped` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_max_lines_visible` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_percent_visible` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_text` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_total_character_count` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_valign` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_visible_characters` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_visible_line_count` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_autowrap` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_clipping_text` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_uppercase` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_align` **(** :ref:`int` align **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_autowrap` **(** :ref:`bool` enable **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_clip_text` **(** :ref:`bool` enable **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_lines_skipped` **(** :ref:`int` lines_skipped **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_max_lines_visible` **(** :ref:`int` lines_visible **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_percent_visible` **(** :ref:`float` percent_visible **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_text` **(** :ref:`String` text **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_uppercase` **(** :ref:`bool` enable **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_valign` **(** :ref:`int` valign **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_visible_characters` **(** :ref:`int` amount **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------------+ ++------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_align` **(** **)** const | ++------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_line_count` **(** **)** const | ++------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_line_height` **(** **)** const | ++------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_lines_skipped` **(** **)** const | ++------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_max_lines_visible` **(** **)** const | ++------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_percent_visible` **(** **)** const | ++------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_text` **(** **)** const | ++------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_total_character_count` **(** **)** const | ++------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_valign` **(** **)** const | ++------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_visible_characters` **(** **)** const | ++------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_visible_line_count` **(** **)** const | ++------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_autowrap` **(** **)** const | ++------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_clipping_text` **(** **)** const | ++------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_uppercase` **(** **)** const | ++------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_align` **(** :ref:`int` align **)** | ++------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_autowrap` **(** :ref:`bool` enable **)** | ++------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_clip_text` **(** :ref:`bool` enable **)** | ++------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_lines_skipped` **(** :ref:`int` lines_skipped **)** | ++------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_max_lines_visible` **(** :ref:`int` lines_visible **)** | ++------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_percent_visible` **(** :ref:`float` percent_visible **)** | ++------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_text` **(** :ref:`String` text **)** | ++------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_uppercase` **(** :ref:`bool` enable **)** | ++------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_valign` **(** :ref:`int` valign **)** | ++------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_visible_characters` **(** :ref:`int` amount **)** | ++------------------------------+-------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -131,145 +131,145 @@ Member Function Description .. _class_Label_get_align: -- :ref:`int` **get_align** **(** **)** const +- :ref:`int` **get_align** **(** **)** const Returns the alignment mode (any of the ALIGN\_\* enumeration values). .. _class_Label_get_line_count: -- :ref:`int` **get_line_count** **(** **)** const +- :ref:`int` **get_line_count** **(** **)** const Returns the amount of lines of text the Label has. .. _class_Label_get_line_height: -- :ref:`int` **get_line_height** **(** **)** const +- :ref:`int` **get_line_height** **(** **)** const Returns the font size in pixels. .. _class_Label_get_lines_skipped: -- :ref:`int` **get_lines_skipped** **(** **)** const +- :ref:`int` **get_lines_skipped** **(** **)** const Returns the the number of lines to skip before displaying. .. _class_Label_get_max_lines_visible: -- :ref:`int` **get_max_lines_visible** **(** **)** const +- :ref:`int` **get_max_lines_visible** **(** **)** const Returns the maximum number of lines to display. Returns -1 if unrestricted. .. _class_Label_get_percent_visible: -- :ref:`float` **get_percent_visible** **(** **)** const +- :ref:`float` **get_percent_visible** **(** **)** const Returns the maximum number of characters to display as a percentage of the total text. .. _class_Label_get_text: -- :ref:`String` **get_text** **(** **)** const +- :ref:`String` **get_text** **(** **)** const Returns the label text. Text can contain newlines. .. _class_Label_get_total_character_count: -- :ref:`int` **get_total_character_count** **(** **)** const +- :ref:`int` **get_total_character_count** **(** **)** const Returns the total length of the text. .. _class_Label_get_valign: -- :ref:`int` **get_valign** **(** **)** const +- :ref:`int` **get_valign** **(** **)** const Returns the vertical alignment mode (any of the VALIGN\_\* enumeration values). .. _class_Label_get_visible_characters: -- :ref:`int` **get_visible_characters** **(** **)** const +- :ref:`int` **get_visible_characters** **(** **)** const Returns the restricted number of characters to display. Returns -1 if unrestricted. .. _class_Label_get_visible_line_count: -- :ref:`int` **get_visible_line_count** **(** **)** const +- :ref:`int` **get_visible_line_count** **(** **)** const Returns the number of lines shown. Useful if the ``Label`` 's height cannot currently display all lines. .. _class_Label_has_autowrap: -- :ref:`bool` **has_autowrap** **(** **)** const +- :ref:`bool` **has_autowrap** **(** **)** const Returns ``true`` if *autowrap* mode (see :ref:`set_autowrap`). .. _class_Label_is_clipping_text: -- :ref:`bool` **is_clipping_text** **(** **)** const +- :ref:`bool` **is_clipping_text** **(** **)** const Returns ``true`` if text would be cut off if it is too wide. .. _class_Label_is_uppercase: -- :ref:`bool` **is_uppercase** **(** **)** const +- :ref:`bool` **is_uppercase** **(** **)** const Returns ``true`` if text is displayed in all capitals. .. _class_Label_set_align: -- void **set_align** **(** :ref:`int` align **)** +- void **set_align** **(** :ref:`int` align **)** Sets the alignment mode to any of the ALIGN\_\* enumeration values. .. _class_Label_set_autowrap: -- void **set_autowrap** **(** :ref:`bool` enable **)** +- void **set_autowrap** **(** :ref:`bool` enable **)** Set *autowrap* mode. When enabled, autowrap will fit text to the control width, breaking sentences when they exceed the available horizontal space. When disabled, the label minimum width becomes the width of the longest row, and the minimum height large enough to fit all rows. .. _class_Label_set_clip_text: -- void **set_clip_text** **(** :ref:`bool` enable **)** +- void **set_clip_text** **(** :ref:`bool` enable **)** Cuts off the rest of the text if it is too wide. .. _class_Label_set_lines_skipped: -- void **set_lines_skipped** **(** :ref:`int` lines_skipped **)** +- void **set_lines_skipped** **(** :ref:`int` lines_skipped **)** Sets the number of lines to skip before displaying. Useful for scrolling text. .. _class_Label_set_max_lines_visible: -- void **set_max_lines_visible** **(** :ref:`int` lines_visible **)** +- void **set_max_lines_visible** **(** :ref:`int` lines_visible **)** Restricts the number of lines to display. Set to -1 to disable. .. _class_Label_set_percent_visible: -- void **set_percent_visible** **(** :ref:`float` percent_visible **)** +- void **set_percent_visible** **(** :ref:`float` percent_visible **)** Restricts the number of characters to display (as a percentage of the total text). .. _class_Label_set_text: -- void **set_text** **(** :ref:`String` text **)** +- void **set_text** **(** :ref:`String` text **)** Set the label text. Text can contain newlines. .. _class_Label_set_uppercase: -- void **set_uppercase** **(** :ref:`bool` enable **)** +- void **set_uppercase** **(** :ref:`bool` enable **)** Display text in all capitals. .. _class_Label_set_valign: -- void **set_valign** **(** :ref:`int` valign **)** +- void **set_valign** **(** :ref:`int` valign **)** Sets the vertical alignment mode to any of the VALIGN\_\* enumeration values. .. _class_Label_set_visible_characters: -- void **set_visible_characters** **(** :ref:`int` amount **)** +- void **set_visible_characters** **(** :ref:`int` amount **)** Restricts the number of characters to display. Set to -1 to disable. diff --git a/classes/class_largetexture.rst b/classes/class_largetexture.rst index 17db71040..ad57ace6f 100644 --- a/classes/class_largetexture.rst +++ b/classes/class_largetexture.rst @@ -19,23 +19,23 @@ A Texture capable of storing many smaller Textures with offsets. Member Functions ---------------- -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`add_piece` **(** :ref:`Vector2` ofs, :ref:`Texture` texture **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_piece_count` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_piece_offset` **(** :ref:`int` idx **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_piece_texture` **(** :ref:`int` idx **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_piece_offset` **(** :ref:`int` idx, :ref:`Vector2` ofs **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_piece_texture` **(** :ref:`int` idx, :ref:`Texture` texture **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_size` **(** :ref:`Vector2` size **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`add_piece` **(** :ref:`Vector2` ofs, :ref:`Texture` texture **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_piece_count` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_piece_offset` **(** :ref:`int` idx **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_piece_texture` **(** :ref:`int` idx **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_piece_offset` **(** :ref:`int` idx, :ref:`Vector2` ofs **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_piece_texture` **(** :ref:`int` idx, :ref:`Texture` texture **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_size` **(** :ref:`Vector2` size **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -63,49 +63,49 @@ Member Function Description .. _class_LargeTexture_add_piece: -- :ref:`int` **add_piece** **(** :ref:`Vector2` ofs, :ref:`Texture` texture **)** +- :ref:`int` **add_piece** **(** :ref:`Vector2` ofs, :ref:`Texture` texture **)** Add another :ref:`Texture` to this ``LargeTexture``, starting on offset "ofs". .. _class_LargeTexture_clear: -- void **clear** **(** **)** +- void **clear** **(** **)** Clears the ``LargeTexture``. .. _class_LargeTexture_get_piece_count: -- :ref:`int` **get_piece_count** **(** **)** const +- :ref:`int` **get_piece_count** **(** **)** const Returns the number of pieces currently in this ``LargeTexture``. .. _class_LargeTexture_get_piece_offset: -- :ref:`Vector2` **get_piece_offset** **(** :ref:`int` idx **)** const +- :ref:`Vector2` **get_piece_offset** **(** :ref:`int` idx **)** const Returns the offset of the piece with index "idx". .. _class_LargeTexture_get_piece_texture: -- :ref:`Texture` **get_piece_texture** **(** :ref:`int` idx **)** const +- :ref:`Texture` **get_piece_texture** **(** :ref:`int` idx **)** const Returns the :ref:`Texture` of the piece with index "idx". .. _class_LargeTexture_set_piece_offset: -- void **set_piece_offset** **(** :ref:`int` idx, :ref:`Vector2` ofs **)** +- void **set_piece_offset** **(** :ref:`int` idx, :ref:`Vector2` ofs **)** Sets the offset of the piece with index "idx" to "ofs". .. _class_LargeTexture_set_piece_texture: -- void **set_piece_texture** **(** :ref:`int` idx, :ref:`Texture` texture **)** +- void **set_piece_texture** **(** :ref:`int` idx, :ref:`Texture` texture **)** Sets the :ref:`Texture` of the piece with index "idx" to "ofs". .. _class_LargeTexture_set_size: -- void **set_size** **(** :ref:`Vector2` size **)** +- void **set_size** **(** :ref:`Vector2` size **)** Sets the size of this ``LargeTexture``. diff --git a/classes/class_light.rst b/classes/class_light.rst index ea2fb121a..c8e932a68 100644 --- a/classes/class_light.rst +++ b/classes/class_light.rst @@ -21,39 +21,39 @@ Provides a base class for different kinds of light nodes. Member Functions ---------------- -+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_color` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_cull_mask` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_param` **(** :ref:`int` param **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_shadow_color` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_shadow_reverse_cull_face` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_shadow` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_editor_only` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_negative` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_color` **(** :ref:`Color` color **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cull_mask` **(** :ref:`int` cull_mask **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_editor_only` **(** :ref:`bool` editor_only **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_negative` **(** :ref:`bool` enabled **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_param` **(** :ref:`int` param, :ref:`float` value **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shadow` **(** :ref:`bool` enabled **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shadow_color` **(** :ref:`Color` shadow_color **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shadow_reverse_cull_face` **(** :ref:`bool` enable **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------------+ ++----------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_color` **(** **)** const | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_cull_mask` **(** **)** const | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_param` **(** :ref:`int` param **)** const | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_shadow_color` **(** **)** const | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_shadow_reverse_cull_face` **(** **)** const | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_shadow` **(** **)** const | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_editor_only` **(** **)** const | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_negative` **(** **)** const | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_color` **(** :ref:`Color` color **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cull_mask` **(** :ref:`int` cull_mask **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_editor_only` **(** :ref:`bool` editor_only **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_negative` **(** :ref:`bool` enabled **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_param` **(** :ref:`int` param, :ref:`float` value **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shadow` **(** :ref:`bool` enabled **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shadow_color` **(** :ref:`Color` shadow_color **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shadow_reverse_cull_face` **(** :ref:`bool` enable **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -131,66 +131,66 @@ Member Function Description .. _class_Light_get_color: -- :ref:`Color` **get_color** **(** **)** const +- :ref:`Color` **get_color** **(** **)** const .. _class_Light_get_cull_mask: -- :ref:`int` **get_cull_mask** **(** **)** const +- :ref:`int` **get_cull_mask** **(** **)** const .. _class_Light_get_param: -- :ref:`float` **get_param** **(** :ref:`int` param **)** const +- :ref:`float` **get_param** **(** :ref:`int` param **)** const .. _class_Light_get_shadow_color: -- :ref:`Color` **get_shadow_color** **(** **)** const +- :ref:`Color` **get_shadow_color** **(** **)** const .. _class_Light_get_shadow_reverse_cull_face: -- :ref:`bool` **get_shadow_reverse_cull_face** **(** **)** const +- :ref:`bool` **get_shadow_reverse_cull_face** **(** **)** const .. _class_Light_has_shadow: -- :ref:`bool` **has_shadow** **(** **)** const +- :ref:`bool` **has_shadow** **(** **)** const .. _class_Light_is_editor_only: -- :ref:`bool` **is_editor_only** **(** **)** const +- :ref:`bool` **is_editor_only** **(** **)** const .. _class_Light_is_negative: -- :ref:`bool` **is_negative** **(** **)** const +- :ref:`bool` **is_negative** **(** **)** const .. _class_Light_set_color: -- void **set_color** **(** :ref:`Color` color **)** +- void **set_color** **(** :ref:`Color` color **)** .. _class_Light_set_cull_mask: -- void **set_cull_mask** **(** :ref:`int` cull_mask **)** +- void **set_cull_mask** **(** :ref:`int` cull_mask **)** .. _class_Light_set_editor_only: -- void **set_editor_only** **(** :ref:`bool` editor_only **)** +- void **set_editor_only** **(** :ref:`bool` editor_only **)** .. _class_Light_set_negative: -- void **set_negative** **(** :ref:`bool` enabled **)** +- void **set_negative** **(** :ref:`bool` enabled **)** .. _class_Light_set_param: -- void **set_param** **(** :ref:`int` param, :ref:`float` value **)** +- void **set_param** **(** :ref:`int` param, :ref:`float` value **)** .. _class_Light_set_shadow: -- void **set_shadow** **(** :ref:`bool` enabled **)** +- void **set_shadow** **(** :ref:`bool` enabled **)** .. _class_Light_set_shadow_color: -- void **set_shadow_color** **(** :ref:`Color` shadow_color **)** +- void **set_shadow_color** **(** :ref:`Color` shadow_color **)** .. _class_Light_set_shadow_reverse_cull_face: -- void **set_shadow_reverse_cull_face** **(** :ref:`bool` enable **)** +- void **set_shadow_reverse_cull_face** **(** :ref:`bool` enable **)** diff --git a/classes/class_light2d.rst b/classes/class_light2d.rst index 1b0c46f8d..eccab66e2 100644 --- a/classes/class_light2d.rst +++ b/classes/class_light2d.rst @@ -19,91 +19,91 @@ Casts light in a 2D environment. Member Functions ---------------- -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_color` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_energy` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_height` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_cull_mask` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_shadow_cull_mask` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_layer_range_max` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_layer_range_min` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_mode` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_shadow_buffer_size` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_shadow_color` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_shadow_filter` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_shadow_gradient_length` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_shadow_smooth` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_texture` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_texture_offset` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_texture_scale` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_z_range_max` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_z_range_min` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_editor_only` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_enabled` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_shadow_enabled` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_color` **(** :ref:`Color` color **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_editor_only` **(** :ref:`bool` editor_only **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_enabled` **(** :ref:`bool` enabled **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_energy` **(** :ref:`float` energy **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_height` **(** :ref:`float` height **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_cull_mask` **(** :ref:`int` item_cull_mask **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_shadow_cull_mask` **(** :ref:`int` item_shadow_cull_mask **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_layer_range_max` **(** :ref:`int` layer **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_layer_range_min` **(** :ref:`int` layer **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mode` **(** :ref:`int` mode **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shadow_buffer_size` **(** :ref:`int` size **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shadow_color` **(** :ref:`Color` shadow_color **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shadow_enabled` **(** :ref:`bool` enabled **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shadow_filter` **(** :ref:`int` filter **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shadow_gradient_length` **(** :ref:`float` multiplier **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shadow_smooth` **(** :ref:`float` smooth **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture` **(** :ref:`Texture` texture **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture_offset` **(** :ref:`Vector2` texture_offset **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture_scale` **(** :ref:`float` texture_scale **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_z_range_max` **(** :ref:`int` z **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_z_range_min` **(** :ref:`int` z **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_color` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_energy` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_height` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_item_cull_mask` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_item_shadow_cull_mask` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_layer_range_max` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_layer_range_min` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_mode` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_shadow_buffer_size` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_shadow_color` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_shadow_filter` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_shadow_gradient_length` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_shadow_smooth` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_texture` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_texture_offset` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_texture_scale` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_z_range_max` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_z_range_min` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_editor_only` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_enabled` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_shadow_enabled` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_color` **(** :ref:`Color` color **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_editor_only` **(** :ref:`bool` editor_only **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_enabled` **(** :ref:`bool` enabled **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_energy` **(** :ref:`float` energy **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_height` **(** :ref:`float` height **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_cull_mask` **(** :ref:`int` item_cull_mask **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_shadow_cull_mask` **(** :ref:`int` item_shadow_cull_mask **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_layer_range_max` **(** :ref:`int` layer **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_layer_range_min` **(** :ref:`int` layer **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_mode` **(** :ref:`int` mode **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shadow_buffer_size` **(** :ref:`int` size **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shadow_color` **(** :ref:`Color` shadow_color **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shadow_enabled` **(** :ref:`bool` enabled **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shadow_filter` **(** :ref:`int` filter **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shadow_gradient_length` **(** :ref:`float` multiplier **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shadow_smooth` **(** :ref:`float` smooth **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_texture` **(** :ref:`Texture` texture **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_texture_offset` **(** :ref:`Vector2` texture_offset **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_texture_scale` **(** :ref:`float` texture_scale **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_z_range_max` **(** :ref:`int` z **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_z_range_min` **(** :ref:`int` z **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -217,233 +217,233 @@ Member Function Description .. _class_Light2D_get_color: -- :ref:`Color` **get_color** **(** **)** const +- :ref:`Color` **get_color** **(** **)** const Return the color of the Light2D. .. _class_Light2D_get_energy: -- :ref:`float` **get_energy** **(** **)** const +- :ref:`float` **get_energy** **(** **)** const Return the energy value of the Light2D. .. _class_Light2D_get_height: -- :ref:`float` **get_height** **(** **)** const +- :ref:`float` **get_height** **(** **)** const Return the height of the Light2D. Used with 2D normalmapping. .. _class_Light2D_get_item_cull_mask: -- :ref:`int` **get_item_cull_mask** **(** **)** const +- :ref:`int` **get_item_cull_mask** **(** **)** const .. _class_Light2D_get_item_shadow_cull_mask: -- :ref:`int` **get_item_shadow_cull_mask** **(** **)** const +- :ref:`int` **get_item_shadow_cull_mask** **(** **)** const .. _class_Light2D_get_layer_range_max: -- :ref:`int` **get_layer_range_max** **(** **)** const +- :ref:`int` **get_layer_range_max** **(** **)** const Set the maximum layer value of objects of the scene that are affected by the Light2D. .. _class_Light2D_get_layer_range_min: -- :ref:`int` **get_layer_range_min** **(** **)** const +- :ref:`int` **get_layer_range_min** **(** **)** const Get the minimum layer value of objects of the scene that are affected by the Light2D. .. _class_Light2D_get_mode: -- :ref:`int` **get_mode** **(** **)** const +- :ref:`int` **get_mode** **(** **)** const Return the current mode set to the Light2D. .. _class_Light2D_get_shadow_buffer_size: -- :ref:`int` **get_shadow_buffer_size** **(** **)** const +- :ref:`int` **get_shadow_buffer_size** **(** **)** const Return the shadow buffer size. .. _class_Light2D_get_shadow_color: -- :ref:`Color` **get_shadow_color** **(** **)** const +- :ref:`Color` **get_shadow_color** **(** **)** const Return the color of casted shadows for this Light2D. .. _class_Light2D_get_shadow_filter: -- :ref:`int` **get_shadow_filter** **(** **)** const +- :ref:`int` **get_shadow_filter** **(** **)** const .. _class_Light2D_get_shadow_gradient_length: -- :ref:`float` **get_shadow_gradient_length** **(** **)** const +- :ref:`float` **get_shadow_gradient_length** **(** **)** const .. _class_Light2D_get_shadow_smooth: -- :ref:`float` **get_shadow_smooth** **(** **)** const +- :ref:`float` **get_shadow_smooth** **(** **)** const .. _class_Light2D_get_texture: -- :ref:`Texture` **get_texture** **(** **)** const +- :ref:`Texture` **get_texture** **(** **)** const Return the texture of the Light2D. .. _class_Light2D_get_texture_offset: -- :ref:`Vector2` **get_texture_offset** **(** **)** const +- :ref:`Vector2` **get_texture_offset** **(** **)** const Return the offset of the light texture. .. _class_Light2D_get_texture_scale: -- :ref:`float` **get_texture_scale** **(** **)** const +- :ref:`float` **get_texture_scale** **(** **)** const Return the scale value of the light texture. .. _class_Light2D_get_z_range_max: -- :ref:`int` **get_z_range_max** **(** **)** const +- :ref:`int` **get_z_range_max** **(** **)** const Get the maximum Z value that objects of the scene can be in order to be affected by the Light2D. .. _class_Light2D_get_z_range_min: -- :ref:`int` **get_z_range_min** **(** **)** const +- :ref:`int` **get_z_range_min** **(** **)** const Get the minimum Z value that objects of the scene have to be in order to be affected by the Light2D. .. _class_Light2D_is_editor_only: -- :ref:`bool` **is_editor_only** **(** **)** const +- :ref:`bool` **is_editor_only** **(** **)** const .. _class_Light2D_is_enabled: -- :ref:`bool` **is_enabled** **(** **)** const +- :ref:`bool` **is_enabled** **(** **)** const Return true if the Light2D is enabled, false if it is not. .. _class_Light2D_is_shadow_enabled: -- :ref:`bool` **is_shadow_enabled** **(** **)** const +- :ref:`bool` **is_shadow_enabled** **(** **)** const Return true if shadow casting is enabled for this Light2D, else return false. .. _class_Light2D_set_color: -- void **set_color** **(** :ref:`Color` color **)** +- void **set_color** **(** :ref:`Color` color **)** Set the color of the Light2D. .. _class_Light2D_set_editor_only: -- void **set_editor_only** **(** :ref:`bool` editor_only **)** +- void **set_editor_only** **(** :ref:`bool` editor_only **)** .. _class_Light2D_set_enabled: -- void **set_enabled** **(** :ref:`bool` enabled **)** +- void **set_enabled** **(** :ref:`bool` enabled **)** Switches the Light2D on or off, depending on the 'enabled' parameter. .. _class_Light2D_set_energy: -- void **set_energy** **(** :ref:`float` energy **)** +- void **set_energy** **(** :ref:`float` energy **)** Set the energy value of the Light2D. The bigger the value, the stronger the light. .. _class_Light2D_set_height: -- void **set_height** **(** :ref:`float` height **)** +- void **set_height** **(** :ref:`float` height **)** Set the height of the Light2D. Used with 2D normalmapping. .. _class_Light2D_set_item_cull_mask: -- void **set_item_cull_mask** **(** :ref:`int` item_cull_mask **)** +- void **set_item_cull_mask** **(** :ref:`int` item_cull_mask **)** Set the item mask of the Light2D to 'item_mask' value. .. _class_Light2D_set_item_shadow_cull_mask: -- void **set_item_shadow_cull_mask** **(** :ref:`int` item_shadow_cull_mask **)** +- void **set_item_shadow_cull_mask** **(** :ref:`int` item_shadow_cull_mask **)** Set the item shadow mask to 'item_shadow_mask' value. .. _class_Light2D_set_layer_range_max: -- void **set_layer_range_max** **(** :ref:`int` layer **)** +- void **set_layer_range_max** **(** :ref:`int` layer **)** Set the maximum layer value of objects of the scene that are affected by the Light2D. .. _class_Light2D_set_layer_range_min: -- void **set_layer_range_min** **(** :ref:`int` layer **)** +- void **set_layer_range_min** **(** :ref:`int` layer **)** Set the minimum layer value of objects of the scene that are affected by the Light2D. .. _class_Light2D_set_mode: -- void **set_mode** **(** :ref:`int` mode **)** +- void **set_mode** **(** :ref:`int` mode **)** Set the behaviour mode of the Light2D. Use constants defined in the constants section. .. _class_Light2D_set_shadow_buffer_size: -- void **set_shadow_buffer_size** **(** :ref:`int` size **)** +- void **set_shadow_buffer_size** **(** :ref:`int` size **)** Set the shadow buffer size. .. _class_Light2D_set_shadow_color: -- void **set_shadow_color** **(** :ref:`Color` shadow_color **)** +- void **set_shadow_color** **(** :ref:`Color` shadow_color **)** Set the color of casted shadows for this Light2D. .. _class_Light2D_set_shadow_enabled: -- void **set_shadow_enabled** **(** :ref:`bool` enabled **)** +- void **set_shadow_enabled** **(** :ref:`bool` enabled **)** Enable or disable shadows casting from this Light2D according to the 'enabled' parameter. .. _class_Light2D_set_shadow_filter: -- void **set_shadow_filter** **(** :ref:`int` filter **)** +- void **set_shadow_filter** **(** :ref:`int` filter **)** .. _class_Light2D_set_shadow_gradient_length: -- void **set_shadow_gradient_length** **(** :ref:`float` multiplier **)** +- void **set_shadow_gradient_length** **(** :ref:`float` multiplier **)** .. _class_Light2D_set_shadow_smooth: -- void **set_shadow_smooth** **(** :ref:`float` smooth **)** +- void **set_shadow_smooth** **(** :ref:`float` smooth **)** .. _class_Light2D_set_texture: -- void **set_texture** **(** :ref:`Texture` texture **)** +- void **set_texture** **(** :ref:`Texture` texture **)** Set the texture of the Light2D. .. _class_Light2D_set_texture_offset: -- void **set_texture_offset** **(** :ref:`Vector2` texture_offset **)** +- void **set_texture_offset** **(** :ref:`Vector2` texture_offset **)** Set the offset of the light texture. .. _class_Light2D_set_texture_scale: -- void **set_texture_scale** **(** :ref:`float` texture_scale **)** +- void **set_texture_scale** **(** :ref:`float` texture_scale **)** Set the scale value of the light texture. .. _class_Light2D_set_z_range_max: -- void **set_z_range_max** **(** :ref:`int` z **)** +- void **set_z_range_max** **(** :ref:`int` z **)** Set the maximum Z value that objects of the scene can be in order to be affected by the Light2D. .. _class_Light2D_set_z_range_min: -- void **set_z_range_min** **(** :ref:`int` z **)** +- void **set_z_range_min** **(** :ref:`int` z **)** Set the minimum Z value that objects of the scene have to be in order to be affected by the Light2D. diff --git a/classes/class_lightoccluder2d.rst b/classes/class_lightoccluder2d.rst index cb85e6a6f..6329ba43c 100644 --- a/classes/class_lightoccluder2d.rst +++ b/classes/class_lightoccluder2d.rst @@ -19,15 +19,15 @@ Occludes light cast by a Light2D, casting shadows. Member Functions ---------------- -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_occluder_light_mask` **(** **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`OccluderPolygon2D` | :ref:`get_occluder_polygon` **(** **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_occluder_light_mask` **(** :ref:`int` mask **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_occluder_polygon` **(** :ref:`OccluderPolygon2D` polygon **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_occluder_light_mask` **(** **)** const | ++----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`OccluderPolygon2D` | :ref:`get_occluder_polygon` **(** **)** const | ++----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_occluder_light_mask` **(** :ref:`int` mask **)** | ++----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_occluder_polygon` **(** :ref:`OccluderPolygon2D` polygon **)** | ++----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -51,25 +51,25 @@ Member Function Description .. _class_LightOccluder2D_get_occluder_light_mask: -- :ref:`int` **get_occluder_light_mask** **(** **)** const +- :ref:`int` **get_occluder_light_mask** **(** **)** const Return the light mask of the LightOccluder2D. .. _class_LightOccluder2D_get_occluder_polygon: -- :ref:`OccluderPolygon2D` **get_occluder_polygon** **(** **)** const +- :ref:`OccluderPolygon2D` **get_occluder_polygon** **(** **)** const Return the OccluderPolygon2D that defines the LightOccluder2D. .. _class_LightOccluder2D_set_occluder_light_mask: -- void **set_occluder_light_mask** **(** :ref:`int` mask **)** +- void **set_occluder_light_mask** **(** :ref:`int` mask **)** Set the LightOccluder2D light mask. The LightOccluder2D will cast shadows only from Light2Ds that belong to the same light mask(s). .. _class_LightOccluder2D_set_occluder_polygon: -- void **set_occluder_polygon** **(** :ref:`OccluderPolygon2D` polygon **)** +- void **set_occluder_polygon** **(** :ref:`OccluderPolygon2D` polygon **)** Set the OccluderPolygon2D that defines the LightOccluder2D. diff --git a/classes/class_line2d.rst b/classes/class_line2d.rst index 5230c9648..75cbfac51 100644 --- a/classes/class_line2d.rst +++ b/classes/class_line2d.rst @@ -19,61 +19,61 @@ A 2D line. Member Functions ---------------- -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_point` **(** :ref:`Vector2` position **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_begin_cap_mode` **(** **)** const | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_default_color` **(** **)** const | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_end_cap_mode` **(** **)** const | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Gradient` | :ref:`get_gradient` **(** **)** const | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_joint_mode` **(** **)** const | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_point_count` **(** **)** const | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_point_position` **(** :ref:`int` i **)** const | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_points` **(** **)** const | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_round_precision` **(** **)** const | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_sharp_limit` **(** **)** const | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_texture` **(** **)** const | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_texture_mode` **(** **)** const | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_width` **(** **)** const | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_point` **(** :ref:`int` i **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_begin_cap_mode` **(** :ref:`int` mode **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_default_color` **(** :ref:`Color` color **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_end_cap_mode` **(** :ref:`int` mode **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_gradient` **(** :ref:`Gradient` color **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_joint_mode` **(** :ref:`int` mode **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_position` **(** :ref:`int` i, :ref:`Vector2` position **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_points` **(** :ref:`PoolVector2Array` points **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_round_precision` **(** :ref:`int` precision **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sharp_limit` **(** :ref:`float` limit **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture` **(** :ref:`Texture` texture **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture_mode` **(** :ref:`int` mode **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_width` **(** :ref:`float` width **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_point` **(** :ref:`Vector2` position **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_begin_cap_mode` **(** **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_default_color` **(** **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_end_cap_mode` **(** **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Gradient` | :ref:`get_gradient` **(** **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_joint_mode` **(** **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_point_count` **(** **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_point_position` **(** :ref:`int` i **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`get_points` **(** **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_round_precision` **(** **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_sharp_limit` **(** **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_texture` **(** **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_texture_mode` **(** **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_width` **(** **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_point` **(** :ref:`int` i **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_begin_cap_mode` **(** :ref:`int` mode **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_default_color` **(** :ref:`Color` color **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_end_cap_mode` **(** :ref:`int` mode **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_gradient` **(** :ref:`Gradient` color **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_joint_mode` **(** :ref:`int` mode **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_position` **(** :ref:`int` i, :ref:`Vector2` position **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_points` **(** :ref:`PoolVector2Array` points **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_round_precision` **(** :ref:`int` precision **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_sharp_limit` **(** :ref:`float` limit **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_texture` **(** :ref:`Texture` texture **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_texture_mode` **(** :ref:`int` mode **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_width` **(** :ref:`float` width **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -145,120 +145,120 @@ Member Function Description .. _class_Line2D_add_point: -- void **add_point** **(** :ref:`Vector2` position **)** +- void **add_point** **(** :ref:`Vector2` position **)** Add a point at the ``position``. Appends the point at the end of the line. .. _class_Line2D_get_begin_cap_mode: -- :ref:`int` **get_begin_cap_mode** **(** **)** const +- :ref:`int` **get_begin_cap_mode** **(** **)** const .. _class_Line2D_get_default_color: -- :ref:`Color` **get_default_color** **(** **)** const +- :ref:`Color` **get_default_color** **(** **)** const .. _class_Line2D_get_end_cap_mode: -- :ref:`int` **get_end_cap_mode** **(** **)** const +- :ref:`int` **get_end_cap_mode** **(** **)** const .. _class_Line2D_get_gradient: -- :ref:`Gradient` **get_gradient** **(** **)** const +- :ref:`Gradient` **get_gradient** **(** **)** const .. _class_Line2D_get_joint_mode: -- :ref:`int` **get_joint_mode** **(** **)** const +- :ref:`int` **get_joint_mode** **(** **)** const .. _class_Line2D_get_point_count: -- :ref:`int` **get_point_count** **(** **)** const +- :ref:`int` **get_point_count** **(** **)** const Returns the Line2D's amount of points. .. _class_Line2D_get_point_position: -- :ref:`Vector2` **get_point_position** **(** :ref:`int` i **)** const +- :ref:`Vector2` **get_point_position** **(** :ref:`int` i **)** const Returns point ``i[code]'s position. .. _class_Line2D_get_points: -- :ref:`PoolVector2Array` **get_points** **(** **)** const +- :ref:`PoolVector2Array` **get_points** **(** **)** const .. _class_Line2D_get_round_precision: -- :ref:`int` **get_round_precision** **(** **)** const +- :ref:`int` **get_round_precision** **(** **)** const .. _class_Line2D_get_sharp_limit: -- :ref:`float` **get_sharp_limit** **(** **)** const +- :ref:`float` **get_sharp_limit** **(** **)** const .. _class_Line2D_get_texture: -- :ref:`Texture` **get_texture** **(** **)** const +- :ref:`Texture` **get_texture** **(** **)** const .. _class_Line2D_get_texture_mode: -- :ref:`int` **get_texture_mode** **(** **)** const +- :ref:`int` **get_texture_mode** **(** **)** const .. _class_Line2D_get_width: -- :ref:`float` **get_width** **(** **)** const +- :ref:`float` **get_width** **(** **)** const .. _class_Line2D_remove_point: -- void **remove_point** **(** :ref:`int` i **)** +- void **remove_point** **(** :ref:`int` i **)** Remove the point at index ``i`` from the line. .. _class_Line2D_set_begin_cap_mode: -- void **set_begin_cap_mode** **(** :ref:`int` mode **)** +- void **set_begin_cap_mode** **(** :ref:`int` mode **)** .. _class_Line2D_set_default_color: -- void **set_default_color** **(** :ref:`Color` color **)** +- void **set_default_color** **(** :ref:`Color` color **)** .. _class_Line2D_set_end_cap_mode: -- void **set_end_cap_mode** **(** :ref:`int` mode **)** +- void **set_end_cap_mode** **(** :ref:`int` mode **)** .. _class_Line2D_set_gradient: -- void **set_gradient** **(** :ref:`Gradient` color **)** +- void **set_gradient** **(** :ref:`Gradient` color **)** .. _class_Line2D_set_joint_mode: -- void **set_joint_mode** **(** :ref:`int` mode **)** +- void **set_joint_mode** **(** :ref:`int` mode **)** .. _class_Line2D_set_point_position: -- void **set_point_position** **(** :ref:`int` i, :ref:`Vector2` position **)** +- void **set_point_position** **(** :ref:`int` i, :ref:`Vector2` position **)** Overwites the position in point ``i`` with the supplied ``position``. .. _class_Line2D_set_points: -- void **set_points** **(** :ref:`PoolVector2Array` points **)** +- void **set_points** **(** :ref:`PoolVector2Array` points **)** .. _class_Line2D_set_round_precision: -- void **set_round_precision** **(** :ref:`int` precision **)** +- void **set_round_precision** **(** :ref:`int` precision **)** .. _class_Line2D_set_sharp_limit: -- void **set_sharp_limit** **(** :ref:`float` limit **)** +- void **set_sharp_limit** **(** :ref:`float` limit **)** .. _class_Line2D_set_texture: -- void **set_texture** **(** :ref:`Texture` texture **)** +- void **set_texture** **(** :ref:`Texture` texture **)** .. _class_Line2D_set_texture_mode: -- void **set_texture_mode** **(** :ref:`int` mode **)** +- void **set_texture_mode** **(** :ref:`int` mode **)** .. _class_Line2D_set_width: -- void **set_width** **(** :ref:`float` width **)** +- void **set_width** **(** :ref:`float` width **)** diff --git a/classes/class_lineedit.rst b/classes/class_lineedit.rst index 8b99d0ec6..9e02c82bd 100644 --- a/classes/class_lineedit.rst +++ b/classes/class_lineedit.rst @@ -19,76 +19,76 @@ Control that provides single line string editing. Member Functions ---------------- -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append_at_cursor` **(** :ref:`String` text **)** | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`cursor_get_blink_enabled` **(** **)** const | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`cursor_get_blink_speed` **(** **)** const | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cursor_set_blink_enabled` **(** :ref:`bool` enabled **)** | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cursor_set_blink_speed` **(** :ref:`float` blink_speed **)** | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_align` **(** **)** const | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_cursor_position` **(** **)** const | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_expand_to_text_length` **(** **)** const | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_max_length` **(** **)** const | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PopupMenu` | :ref:`get_menu` **(** **)** const | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_placeholder` **(** **)** const | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_placeholder_alpha` **(** **)** const | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_text` **(** **)** const | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_editable` **(** **)** const | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_secret` **(** **)** const | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`menu_option` **(** :ref:`int` option **)** | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`select` **(** :ref:`int` from=0, :ref:`int` to=-1 **)** | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`select_all` **(** **)** | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_align` **(** :ref:`int` align **)** | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cursor_position` **(** :ref:`int` position **)** | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_editable` **(** :ref:`bool` enabled **)** | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_expand_to_text_length` **(** :ref:`bool` enabled **)** | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_max_length` **(** :ref:`int` chars **)** | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_placeholder` **(** :ref:`String` text **)** | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_placeholder_alpha` **(** :ref:`float` alpha **)** | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_secret` **(** :ref:`bool` enabled **)** | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_text` **(** :ref:`String` text **)** | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append_at_cursor` **(** :ref:`String` text **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`cursor_get_blink_enabled` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`cursor_get_blink_speed` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`cursor_set_blink_enabled` **(** :ref:`bool` enabled **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`cursor_set_blink_speed` **(** :ref:`float` blink_speed **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_align` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_cursor_position` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_expand_to_text_length` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_max_length` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PopupMenu` | :ref:`get_menu` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_placeholder` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_placeholder_alpha` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_text` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_editable` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_secret` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`menu_option` **(** :ref:`int` option **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`select` **(** :ref:`int` from=0, :ref:`int` to=-1 **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`select_all` **(** **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_align` **(** :ref:`int` align **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cursor_position` **(** :ref:`int` position **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_editable` **(** :ref:`bool` enabled **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_expand_to_text_length` **(** :ref:`bool` enabled **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_max_length` **(** :ref:`int` chars **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_placeholder` **(** :ref:`String` text **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_placeholder_alpha` **(** :ref:`float` alpha **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_secret` **(** :ref:`bool` enabled **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_text` **(** :ref:`String` text **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_LineEdit_text_changed: -- **text_changed** **(** :ref:`String` text **)** +- **text_changed** **(** :ref:`String` text **)** When the text changes, this signal is emitted. .. _class_LineEdit_text_entered: -- **text_entered** **(** :ref:`String` text **)** +- **text_entered** **(** :ref:`String` text **)** This signal is emitted when the user presses KEY_ENTER on the :ref:`LineEdit`. This signal is often used as an alternate confirmation mechanism in dialogs. @@ -166,107 +166,107 @@ Member Function Description .. _class_LineEdit_append_at_cursor: -- void **append_at_cursor** **(** :ref:`String` text **)** +- void **append_at_cursor** **(** :ref:`String` text **)** Append text at cursor, scrolling the :ref:`LineEdit` when needed. .. _class_LineEdit_clear: -- void **clear** **(** **)** +- void **clear** **(** **)** Clear the :ref:`LineEdit` text. .. _class_LineEdit_cursor_get_blink_enabled: -- :ref:`bool` **cursor_get_blink_enabled** **(** **)** const +- :ref:`bool` **cursor_get_blink_enabled** **(** **)** const Gets whether the line edit caret is blinking. .. _class_LineEdit_cursor_get_blink_speed: -- :ref:`float` **cursor_get_blink_speed** **(** **)** const +- :ref:`float` **cursor_get_blink_speed** **(** **)** const Gets the line edit caret blink speed. .. _class_LineEdit_cursor_set_blink_enabled: -- void **cursor_set_blink_enabled** **(** :ref:`bool` enabled **)** +- void **cursor_set_blink_enabled** **(** :ref:`bool` enabled **)** Set the line edit caret to blink. .. _class_LineEdit_cursor_set_blink_speed: -- void **cursor_set_blink_speed** **(** :ref:`float` blink_speed **)** +- void **cursor_set_blink_speed** **(** :ref:`float` blink_speed **)** Set the line edit caret blink speed. Cannot be less then or equal to 0. .. _class_LineEdit_get_align: -- :ref:`int` **get_align** **(** **)** const +- :ref:`int` **get_align** **(** **)** const Return the align mode of the :ref:`LineEdit`. .. _class_LineEdit_get_cursor_position: -- :ref:`int` **get_cursor_position** **(** **)** const +- :ref:`int` **get_cursor_position** **(** **)** const Return the cursor position inside the :ref:`LineEdit`. .. _class_LineEdit_get_expand_to_text_length: -- :ref:`bool` **get_expand_to_text_length** **(** **)** const +- :ref:`bool` **get_expand_to_text_length** **(** **)** const .. _class_LineEdit_get_max_length: -- :ref:`int` **get_max_length** **(** **)** const +- :ref:`int` **get_max_length** **(** **)** const Return the maximum amount of characters the :ref:`LineEdit` can edit. If 0 is returned, no limit exists. .. _class_LineEdit_get_menu: -- :ref:`PopupMenu` **get_menu** **(** **)** const +- :ref:`PopupMenu` **get_menu** **(** **)** const Return the :ref:`PopupMenu` of this :ref:`LineEdit`. .. _class_LineEdit_get_placeholder: -- :ref:`String` **get_placeholder** **(** **)** const +- :ref:`String` **get_placeholder** **(** **)** const Return the placeholder text. .. _class_LineEdit_get_placeholder_alpha: -- :ref:`float` **get_placeholder_alpha** **(** **)** const +- :ref:`float` **get_placeholder_alpha** **(** **)** const Return transparency of the placeholder text. .. _class_LineEdit_get_text: -- :ref:`String` **get_text** **(** **)** const +- :ref:`String` **get_text** **(** **)** const Return the text in the :ref:`LineEdit`. .. _class_LineEdit_is_editable: -- :ref:`bool` **is_editable** **(** **)** const +- :ref:`bool` **is_editable** **(** **)** const Return the *editable* status of the :ref:`LineEdit` (see :ref:`set_editable`). .. _class_LineEdit_is_secret: -- :ref:`bool` **is_secret** **(** **)** const +- :ref:`bool` **is_secret** **(** **)** const Return the *secret* status of the :ref:`LineEdit` (see :ref:`set_secret`). .. _class_LineEdit_menu_option: -- void **menu_option** **(** :ref:`int` option **)** +- void **menu_option** **(** :ref:`int` option **)** Execute a given action as defined in the MENU\_\* enum. .. _class_LineEdit_select: -- void **select** **(** :ref:`int` from=0, :ref:`int` to=-1 **)** +- void **select** **(** :ref:`int` from=0, :ref:`int` to=-1 **)** Select the text inside :ref:`LineEdit` by the given character positions. ``from`` is default to the beginning. ``to`` is default to the end. @@ -278,59 +278,59 @@ Select the text inside :ref:`LineEdit` by the given character po .. _class_LineEdit_select_all: -- void **select_all** **(** **)** +- void **select_all** **(** **)** Select the whole string. .. _class_LineEdit_set_align: -- void **set_align** **(** :ref:`int` align **)** +- void **set_align** **(** :ref:`int` align **)** Set text alignment of the :ref:`LineEdit`. .. _class_LineEdit_set_cursor_position: -- void **set_cursor_position** **(** :ref:`int` position **)** +- void **set_cursor_position** **(** :ref:`int` position **)** Set the cursor position inside the :ref:`LineEdit`, causing it to scroll if needed. .. _class_LineEdit_set_editable: -- void **set_editable** **(** :ref:`bool` enabled **)** +- void **set_editable** **(** :ref:`bool` enabled **)** Set the *editable* status of the :ref:`LineEdit`. When disabled, existing text can't be modified and new text can't be added. .. _class_LineEdit_set_expand_to_text_length: -- void **set_expand_to_text_length** **(** :ref:`bool` enabled **)** +- void **set_expand_to_text_length** **(** :ref:`bool` enabled **)** .. _class_LineEdit_set_max_length: -- void **set_max_length** **(** :ref:`int` chars **)** +- void **set_max_length** **(** :ref:`int` chars **)** Set the maximum amount of characters the :ref:`LineEdit` can edit, and cropping existing text in case it exceeds that limit. Setting 0 removes the limit. .. _class_LineEdit_set_placeholder: -- void **set_placeholder** **(** :ref:`String` text **)** +- void **set_placeholder** **(** :ref:`String` text **)** Set the placeholder text. .. _class_LineEdit_set_placeholder_alpha: -- void **set_placeholder_alpha** **(** :ref:`float` alpha **)** +- void **set_placeholder_alpha** **(** :ref:`float` alpha **)** Set transparency of the placeholder text. .. _class_LineEdit_set_secret: -- void **set_secret** **(** :ref:`bool` enabled **)** +- void **set_secret** **(** :ref:`bool` enabled **)** Set the *secret* status of the :ref:`LineEdit`. When enabled, every character is displayed as "\*". .. _class_LineEdit_set_text: -- void **set_text** **(** :ref:`String` text **)** +- void **set_text** **(** :ref:`String` text **)** Set the text in the :ref:`LineEdit`, clearing the existing one and the selection. diff --git a/classes/class_lineshape2d.rst b/classes/class_lineshape2d.rst index 6f9b06603..15cfe70b4 100644 --- a/classes/class_lineshape2d.rst +++ b/classes/class_lineshape2d.rst @@ -19,15 +19,15 @@ Line shape for 2D collisions. Member Functions ---------------- -+--------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_d` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_normal` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------+ -| void | :ref:`set_d` **(** :ref:`float` d **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------+ -| void | :ref:`set_normal` **(** :ref:`Vector2` normal **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------+ ++--------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_d` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_normal` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------+ +| void | :ref:`set_d` **(** :ref:`float` d **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------+ +| void | :ref:`set_normal` **(** :ref:`Vector2` normal **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -51,25 +51,25 @@ Member Function Description .. _class_LineShape2D_get_d: -- :ref:`float` **get_d** **(** **)** const +- :ref:`float` **get_d** **(** **)** const Return the line distance from the origin. .. _class_LineShape2D_get_normal: -- :ref:`Vector2` **get_normal** **(** **)** const +- :ref:`Vector2` **get_normal** **(** **)** const Return the line normal. .. _class_LineShape2D_set_d: -- void **set_d** **(** :ref:`float` d **)** +- void **set_d** **(** :ref:`float` d **)** Set the line distance from the origin. .. _class_LineShape2D_set_normal: -- void **set_normal** **(** :ref:`Vector2` normal **)** +- void **set_normal** **(** :ref:`Vector2` normal **)** Set the line normal. diff --git a/classes/class_linkbutton.rst b/classes/class_linkbutton.rst index 2f982f046..a0b75a0a4 100644 --- a/classes/class_linkbutton.rst +++ b/classes/class_linkbutton.rst @@ -19,15 +19,15 @@ Simple button used to represent a link to some resource Member Functions ---------------- -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_text` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_underline_mode` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_text` **(** :ref:`String` text **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_underline_mode` **(** :ref:`int` underline_mode **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ ++------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_text` **(** **)** const | ++------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_underline_mode` **(** **)** const | ++------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_text` **(** :ref:`String` text **)** | ++------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_underline_mode` **(** :ref:`int` underline_mode **)** | ++------------------------------+-----------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -58,25 +58,25 @@ Member Function Description .. _class_LinkButton_get_text: -- :ref:`String` **get_text** **(** **)** const +- :ref:`String` **get_text** **(** **)** const Returns the text of the button. .. _class_LinkButton_get_underline_mode: -- :ref:`int` **get_underline_mode** **(** **)** const +- :ref:`int` **get_underline_mode** **(** **)** const Returns the underline mode for this button. .. _class_LinkButton_set_text: -- void **set_text** **(** :ref:`String` text **)** +- void **set_text** **(** :ref:`String` text **)** Sets the text of the button. .. _class_LinkButton_set_underline_mode: -- void **set_underline_mode** **(** :ref:`int` underline_mode **)** +- void **set_underline_mode** **(** :ref:`int` underline_mode **)** Sets the underline mode for this button, the argument must be one of the :ref:`LinkButton` constants (see constants section). diff --git a/classes/class_listener.rst b/classes/class_listener.rst index 26c5047ee..3a348f07c 100644 --- a/classes/class_listener.rst +++ b/classes/class_listener.rst @@ -19,33 +19,33 @@ Brief Description Member Functions ---------------- -+------------------------------------+-----------------------------------------------------------------------------------------+ -| void | :ref:`clear_current` **(** **)** | -+------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_listener_transform` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_current` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------+ -| void | :ref:`make_current` **(** **)** | -+------------------------------------+-----------------------------------------------------------------------------------------+ ++------------------------------------+----------------------------------------------------------------------------------------+ +| void | :ref:`clear_current` **(** **)** | ++------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`get_listener_transform` **(** **)** const | ++------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_current` **(** **)** const | ++------------------------------------+----------------------------------------------------------------------------------------+ +| void | :ref:`make_current` **(** **)** | ++------------------------------------+----------------------------------------------------------------------------------------+ Member Function Description --------------------------- .. _class_Listener_clear_current: -- void **clear_current** **(** **)** +- void **clear_current** **(** **)** .. _class_Listener_get_listener_transform: -- :ref:`Transform` **get_listener_transform** **(** **)** const +- :ref:`Transform` **get_listener_transform** **(** **)** const .. _class_Listener_is_current: -- :ref:`bool` **is_current** **(** **)** const +- :ref:`bool` **is_current** **(** **)** const .. _class_Listener_make_current: -- void **make_current** **(** **)** +- void **make_current** **(** **)** diff --git a/classes/class_mainloop.rst b/classes/class_mainloop.rst index 9c0938776..ae29c4f0f 100644 --- a/classes/class_mainloop.rst +++ b/classes/class_mainloop.rst @@ -21,33 +21,33 @@ Main loop is the abstract main loop base class. Member Functions ---------------- -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_drop_files` **(** :ref:`PoolStringArray` files, :ref:`int` screen **)** virtual | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_finalize` **(** **)** virtual | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_idle` **(** :ref:`float` delta **)** virtual | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_initialize` **(** **)** virtual | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_input_event` **(** :ref:`InputEvent` ev **)** virtual | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_input_text` **(** :ref:`String` text **)** virtual | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_iteration` **(** :ref:`float` delta **)** virtual | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`finish` **(** **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`idle` **(** :ref:`float` delta **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`init` **(** **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`input_event` **(** :ref:`InputEvent` ev **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`input_text` **(** :ref:`String` text **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`iteration` **(** :ref:`float` delta **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_drop_files` **(** :ref:`PoolStringArray` files, :ref:`int` screen **)** virtual | ++--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_finalize` **(** **)** virtual | ++--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_idle` **(** :ref:`float` delta **)** virtual | ++--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_initialize` **(** **)** virtual | ++--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_input_event` **(** :ref:`InputEvent` ev **)** virtual | ++--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_input_text` **(** :ref:`String` text **)** virtual | ++--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_iteration` **(** :ref:`float` delta **)** virtual | ++--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`finish` **(** **)** | ++--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`idle` **(** :ref:`float` delta **)** | ++--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`init` **(** **)** | ++--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`input_event` **(** :ref:`InputEvent` ev **)** | ++--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`input_text` **(** :ref:`String` text **)** | ++--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`iteration` **(** :ref:`float` delta **)** | ++--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -72,60 +72,60 @@ Member Function Description .. _class_MainLoop__drop_files: -- void **_drop_files** **(** :ref:`PoolStringArray` files, :ref:`int` screen **)** virtual +- void **_drop_files** **(** :ref:`PoolStringArray` files, :ref:`int` screen **)** virtual .. _class_MainLoop__finalize: -- void **_finalize** **(** **)** virtual +- void **_finalize** **(** **)** virtual Called before the program exits. .. _class_MainLoop__idle: -- void **_idle** **(** :ref:`float` delta **)** virtual +- void **_idle** **(** :ref:`float` delta **)** virtual Called each idle frame with time since last call as an only argument. .. _class_MainLoop__initialize: -- void **_initialize** **(** **)** virtual +- void **_initialize** **(** **)** virtual Called once during initialization. .. _class_MainLoop__input_event: -- void **_input_event** **(** :ref:`InputEvent` ev **)** virtual +- void **_input_event** **(** :ref:`InputEvent` ev **)** virtual .. _class_MainLoop__input_text: -- void **_input_text** **(** :ref:`String` text **)** virtual +- void **_input_text** **(** :ref:`String` text **)** virtual .. _class_MainLoop__iteration: -- void **_iteration** **(** :ref:`float` delta **)** virtual +- void **_iteration** **(** :ref:`float` delta **)** virtual .. _class_MainLoop_finish: -- void **finish** **(** **)** +- void **finish** **(** **)** .. _class_MainLoop_idle: -- :ref:`bool` **idle** **(** :ref:`float` delta **)** +- :ref:`bool` **idle** **(** :ref:`float` delta **)** .. _class_MainLoop_init: -- void **init** **(** **)** +- void **init** **(** **)** .. _class_MainLoop_input_event: -- void **input_event** **(** :ref:`InputEvent` ev **)** +- void **input_event** **(** :ref:`InputEvent` ev **)** .. _class_MainLoop_input_text: -- void **input_text** **(** :ref:`String` text **)** +- void **input_text** **(** :ref:`String` text **)** .. _class_MainLoop_iteration: -- :ref:`bool` **iteration** **(** :ref:`float` delta **)** +- :ref:`bool` **iteration** **(** :ref:`float` delta **)** diff --git a/classes/class_marshalls.rst b/classes/class_marshalls.rst index 76c209f44..be2090aad 100644 --- a/classes/class_marshalls.rst +++ b/classes/class_marshalls.rst @@ -19,19 +19,19 @@ Data transformation (marshalling) and encoding helpers. Member Functions ---------------- -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`base64_to_raw` **(** :ref:`String` base64_str **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`base64_to_utf8` **(** :ref:`String` base64_str **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`base64_to_variant` **(** :ref:`String` base64_str **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`raw_to_base64` **(** :ref:`PoolByteArray` array **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`utf8_to_base64` **(** :ref:`String` utf8_str **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`variant_to_base64` **(** :ref:`Variant` variant **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`base64_to_raw` **(** :ref:`String` base64_str **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`base64_to_utf8` **(** :ref:`String` base64_str **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`base64_to_variant` **(** :ref:`String` base64_str **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`raw_to_base64` **(** :ref:`PoolByteArray` array **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`utf8_to_base64` **(** :ref:`String` utf8_str **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`variant_to_base64` **(** :ref:`Variant` variant **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -43,37 +43,37 @@ Member Function Description .. _class_Marshalls_base64_to_raw: -- :ref:`PoolByteArray` **base64_to_raw** **(** :ref:`String` base64_str **)** +- :ref:`PoolByteArray` **base64_to_raw** **(** :ref:`String` base64_str **)** Return :ref:`PoolByteArray` of a given base64 encoded String. .. _class_Marshalls_base64_to_utf8: -- :ref:`String` **base64_to_utf8** **(** :ref:`String` base64_str **)** +- :ref:`String` **base64_to_utf8** **(** :ref:`String` base64_str **)** Return utf8 String of a given base64 encoded String. .. _class_Marshalls_base64_to_variant: -- :ref:`Variant` **base64_to_variant** **(** :ref:`String` base64_str **)** +- :ref:`Variant` **base64_to_variant** **(** :ref:`String` base64_str **)** Return :ref:`Variant` of a given base64 encoded String. .. _class_Marshalls_raw_to_base64: -- :ref:`String` **raw_to_base64** **(** :ref:`PoolByteArray` array **)** +- :ref:`String` **raw_to_base64** **(** :ref:`PoolByteArray` array **)** Return base64 encoded String of a given :ref:`PoolByteArray`. .. _class_Marshalls_utf8_to_base64: -- :ref:`String` **utf8_to_base64** **(** :ref:`String` utf8_str **)** +- :ref:`String` **utf8_to_base64** **(** :ref:`String` utf8_str **)** Return base64 encoded String of a given utf8 String. .. _class_Marshalls_variant_to_base64: -- :ref:`String` **variant_to_base64** **(** :ref:`Variant` variant **)** +- :ref:`String` **variant_to_base64** **(** :ref:`Variant` variant **)** Return base64 encoded String of a given :ref:`Variant`. diff --git a/classes/class_material.rst b/classes/class_material.rst index 2f36d3790..4879172d8 100644 --- a/classes/class_material.rst +++ b/classes/class_material.rst @@ -21,15 +21,15 @@ Abstract base :ref:`Resource` for coloring and shading geometry. Member Functions ---------------- -+----------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`Material` | :ref:`get_next_pass` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_render_priority` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_next_pass` **(** :ref:`Material` next_pass **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_render_priority` **(** :ref:`int` priority **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------+ ++----------------------------------+-----------------------------------------------------------------------------------------------------------+ +| :ref:`Material` | :ref:`get_next_pass` **(** **)** const | ++----------------------------------+-----------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_render_priority` **(** **)** const | ++----------------------------------+-----------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_next_pass` **(** :ref:`Material` next_pass **)** | ++----------------------------------+-----------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_render_priority` **(** :ref:`int` priority **)** | ++----------------------------------+-----------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -59,18 +59,18 @@ Member Function Description .. _class_Material_get_next_pass: -- :ref:`Material` **get_next_pass** **(** **)** const +- :ref:`Material` **get_next_pass** **(** **)** const .. _class_Material_get_render_priority: -- :ref:`int` **get_render_priority** **(** **)** const +- :ref:`int` **get_render_priority** **(** **)** const .. _class_Material_set_next_pass: -- void **set_next_pass** **(** :ref:`Material` next_pass **)** +- void **set_next_pass** **(** :ref:`Material` next_pass **)** .. _class_Material_set_render_priority: -- void **set_render_priority** **(** :ref:`int` priority **)** +- void **set_render_priority** **(** :ref:`int` priority **)** diff --git a/classes/class_menubutton.rst b/classes/class_menubutton.rst index 3a1818043..294733d26 100644 --- a/classes/class_menubutton.rst +++ b/classes/class_menubutton.rst @@ -19,16 +19,16 @@ Special button that brings up a :ref:`PopupMenu` when clicked. Member Functions ---------------- -+------------------------------------+-----------------------------------------------------------+ -| :ref:`PopupMenu` | :ref:`get_popup` **(** **)** | -+------------------------------------+-----------------------------------------------------------+ ++------------------------------------+----------------------------------------------------------+ +| :ref:`PopupMenu` | :ref:`get_popup` **(** **)** | ++------------------------------------+----------------------------------------------------------+ Signals ------- .. _class_MenuButton_about_to_show: -- **about_to_show** **(** **)** +- **about_to_show** **(** **)** Emitted when :ref:`PopupMenu` of this MenuButton is about to show. @@ -51,7 +51,7 @@ Member Function Description .. _class_MenuButton_get_popup: -- :ref:`PopupMenu` **get_popup** **(** **)** +- :ref:`PopupMenu` **get_popup** **(** **)** Return the :ref:`PopupMenu` contained in this button. diff --git a/classes/class_mesh.rst b/classes/class_mesh.rst index 722c50fdb..8bda06aab 100644 --- a/classes/class_mesh.rst +++ b/classes/class_mesh.rst @@ -21,17 +21,17 @@ A :ref:`Resource` that contains vertex-array based geometry. Member Functions ---------------- -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`Shape` | :ref:`create_convex_shape` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`Mesh` | :ref:`create_outline` **(** :ref:`float` margin **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`Shape` | :ref:`create_trimesh_shape` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`TriangleMesh` | :ref:`generate_triangle_mesh` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`get_faces` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------+ +| :ref:`Shape` | :ref:`create_convex_shape` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------+ +| :ref:`Mesh` | :ref:`create_outline` **(** :ref:`float` margin **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------+ +| :ref:`Shape` | :ref:`create_trimesh_shape` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------+ +| :ref:`TriangleMesh` | :ref:`generate_triangle_mesh` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`get_faces` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -88,31 +88,31 @@ Member Function Description .. _class_Mesh_create_convex_shape: -- :ref:`Shape` **create_convex_shape** **(** **)** const +- :ref:`Shape` **create_convex_shape** **(** **)** const Calculate a :ref:`ConvexPolygonShape` from the mesh. .. _class_Mesh_create_outline: -- :ref:`Mesh` **create_outline** **(** :ref:`float` margin **)** const +- :ref:`Mesh` **create_outline** **(** :ref:`float` margin **)** const Calculate an outline mesh at a defined offset (margin) from the original mesh. Note: Typically returns the vertices in reverse order (e.g. clockwise to anti-clockwise). .. _class_Mesh_create_trimesh_shape: -- :ref:`Shape` **create_trimesh_shape** **(** **)** const +- :ref:`Shape` **create_trimesh_shape** **(** **)** const Calculate a :ref:`ConcavePolygonShape` from the mesh. .. _class_Mesh_generate_triangle_mesh: -- :ref:`TriangleMesh` **generate_triangle_mesh** **(** **)** const +- :ref:`TriangleMesh` **generate_triangle_mesh** **(** **)** const Generate a :ref:`TriangleMesh` from the mesh. .. _class_Mesh_get_faces: -- :ref:`PoolVector3Array` **get_faces** **(** **)** const +- :ref:`PoolVector3Array` **get_faces** **(** **)** const Returns all the vertices that make up the faces of the mesh. Each three vertices represent one triangle. diff --git a/classes/class_meshdatatool.rst b/classes/class_meshdatatool.rst index 41e175e28..9d35fc950 100644 --- a/classes/class_meshdatatool.rst +++ b/classes/class_meshdatatool.rst @@ -19,237 +19,237 @@ Brief Description Member Functions ---------------- -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`commit_to_surface` **(** :ref:`ArrayMesh` mesh **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`create_from_surface` **(** :ref:`ArrayMesh` mesh, :ref:`int` surface **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_edge_count` **(** **)** const | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_edge_faces` **(** :ref:`int` idx **)** const | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_edge_meta` **(** :ref:`int` idx **)** const | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_edge_vertex` **(** :ref:`int` idx, :ref:`int` vertex **)** const | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_face_count` **(** **)** const | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_face_edge` **(** :ref:`int` idx, :ref:`int` edge **)** const | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_face_meta` **(** :ref:`int` idx **)** const | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_face_normal` **(** :ref:`int` idx **)** const | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_face_vertex` **(** :ref:`int` idx, :ref:`int` vertex **)** const | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_format` **(** **)** const | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Material` | :ref:`get_material` **(** **)** const | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_vertex` **(** :ref:`int` idx **)** const | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_vertex_bones` **(** :ref:`int` idx **)** const | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_vertex_color` **(** :ref:`int` idx **)** const | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_vertex_count` **(** **)** const | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_vertex_edges` **(** :ref:`int` idx **)** const | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_vertex_faces` **(** :ref:`int` idx **)** const | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_vertex_meta` **(** :ref:`int` idx **)** const | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_vertex_normal` **(** :ref:`int` idx **)** const | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Plane` | :ref:`get_vertex_tangent` **(** :ref:`int` idx **)** const | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_vertex_uv` **(** :ref:`int` idx **)** const | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_vertex_uv2` **(** :ref:`int` idx **)** const | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolRealArray` | :ref:`get_vertex_weights` **(** :ref:`int` idx **)** const | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_edge_meta` **(** :ref:`int` idx, :ref:`Variant` meta **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_face_meta` **(** :ref:`int` idx, :ref:`Variant` meta **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_material` **(** :ref:`Material` material **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertex` **(** :ref:`int` idx, :ref:`Vector3` vertex **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertex_bones` **(** :ref:`int` idx, :ref:`PoolIntArray` bones **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertex_color` **(** :ref:`int` idx, :ref:`Color` color **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertex_meta` **(** :ref:`int` idx, :ref:`Variant` meta **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertex_normal` **(** :ref:`int` idx, :ref:`Vector3` normal **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertex_tangent` **(** :ref:`int` idx, :ref:`Plane` tangent **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertex_uv` **(** :ref:`int` idx, :ref:`Vector2` uv **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertex_uv2` **(** :ref:`int` idx, :ref:`Vector2` uv2 **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertex_weights` **(** :ref:`int` idx, :ref:`PoolRealArray` weights **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`commit_to_surface` **(** :ref:`ArrayMesh` mesh **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`create_from_surface` **(** :ref:`ArrayMesh` mesh, :ref:`int` surface **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_edge_count` **(** **)** const | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`get_edge_faces` **(** :ref:`int` idx **)** const | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_edge_meta` **(** :ref:`int` idx **)** const | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_edge_vertex` **(** :ref:`int` idx, :ref:`int` vertex **)** const | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_face_count` **(** **)** const | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_face_edge` **(** :ref:`int` idx, :ref:`int` edge **)** const | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_face_meta` **(** :ref:`int` idx **)** const | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_face_normal` **(** :ref:`int` idx **)** const | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_face_vertex` **(** :ref:`int` idx, :ref:`int` vertex **)** const | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_format` **(** **)** const | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Material` | :ref:`get_material` **(** **)** const | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_vertex` **(** :ref:`int` idx **)** const | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`get_vertex_bones` **(** :ref:`int` idx **)** const | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_vertex_color` **(** :ref:`int` idx **)** const | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_vertex_count` **(** **)** const | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`get_vertex_edges` **(** :ref:`int` idx **)** const | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`get_vertex_faces` **(** :ref:`int` idx **)** const | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_vertex_meta` **(** :ref:`int` idx **)** const | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_vertex_normal` **(** :ref:`int` idx **)** const | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Plane` | :ref:`get_vertex_tangent` **(** :ref:`int` idx **)** const | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_vertex_uv` **(** :ref:`int` idx **)** const | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_vertex_uv2` **(** :ref:`int` idx **)** const | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolRealArray` | :ref:`get_vertex_weights` **(** :ref:`int` idx **)** const | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_edge_meta` **(** :ref:`int` idx, :ref:`Variant` meta **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_face_meta` **(** :ref:`int` idx, :ref:`Variant` meta **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_material` **(** :ref:`Material` material **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vertex` **(** :ref:`int` idx, :ref:`Vector3` vertex **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vertex_bones` **(** :ref:`int` idx, :ref:`PoolIntArray` bones **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vertex_color` **(** :ref:`int` idx, :ref:`Color` color **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vertex_meta` **(** :ref:`int` idx, :ref:`Variant` meta **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vertex_normal` **(** :ref:`int` idx, :ref:`Vector3` normal **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vertex_tangent` **(** :ref:`int` idx, :ref:`Plane` tangent **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vertex_uv` **(** :ref:`int` idx, :ref:`Vector2` uv **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vertex_uv2` **(** :ref:`int` idx, :ref:`Vector2` uv2 **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vertex_weights` **(** :ref:`int` idx, :ref:`PoolRealArray` weights **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Function Description --------------------------- .. _class_MeshDataTool_clear: -- void **clear** **(** **)** +- void **clear** **(** **)** .. _class_MeshDataTool_commit_to_surface: -- :ref:`int` **commit_to_surface** **(** :ref:`ArrayMesh` mesh **)** +- :ref:`int` **commit_to_surface** **(** :ref:`ArrayMesh` mesh **)** .. _class_MeshDataTool_create_from_surface: -- :ref:`int` **create_from_surface** **(** :ref:`ArrayMesh` mesh, :ref:`int` surface **)** +- :ref:`int` **create_from_surface** **(** :ref:`ArrayMesh` mesh, :ref:`int` surface **)** .. _class_MeshDataTool_get_edge_count: -- :ref:`int` **get_edge_count** **(** **)** const +- :ref:`int` **get_edge_count** **(** **)** const .. _class_MeshDataTool_get_edge_faces: -- :ref:`PoolIntArray` **get_edge_faces** **(** :ref:`int` idx **)** const +- :ref:`PoolIntArray` **get_edge_faces** **(** :ref:`int` idx **)** const .. _class_MeshDataTool_get_edge_meta: -- :ref:`Variant` **get_edge_meta** **(** :ref:`int` idx **)** const +- :ref:`Variant` **get_edge_meta** **(** :ref:`int` idx **)** const .. _class_MeshDataTool_get_edge_vertex: -- :ref:`int` **get_edge_vertex** **(** :ref:`int` idx, :ref:`int` vertex **)** const +- :ref:`int` **get_edge_vertex** **(** :ref:`int` idx, :ref:`int` vertex **)** const .. _class_MeshDataTool_get_face_count: -- :ref:`int` **get_face_count** **(** **)** const +- :ref:`int` **get_face_count** **(** **)** const .. _class_MeshDataTool_get_face_edge: -- :ref:`int` **get_face_edge** **(** :ref:`int` idx, :ref:`int` edge **)** const +- :ref:`int` **get_face_edge** **(** :ref:`int` idx, :ref:`int` edge **)** const .. _class_MeshDataTool_get_face_meta: -- :ref:`Variant` **get_face_meta** **(** :ref:`int` idx **)** const +- :ref:`Variant` **get_face_meta** **(** :ref:`int` idx **)** const .. _class_MeshDataTool_get_face_normal: -- :ref:`Vector3` **get_face_normal** **(** :ref:`int` idx **)** const +- :ref:`Vector3` **get_face_normal** **(** :ref:`int` idx **)** const .. _class_MeshDataTool_get_face_vertex: -- :ref:`int` **get_face_vertex** **(** :ref:`int` idx, :ref:`int` vertex **)** const +- :ref:`int` **get_face_vertex** **(** :ref:`int` idx, :ref:`int` vertex **)** const .. _class_MeshDataTool_get_format: -- :ref:`int` **get_format** **(** **)** const +- :ref:`int` **get_format** **(** **)** const .. _class_MeshDataTool_get_material: -- :ref:`Material` **get_material** **(** **)** const +- :ref:`Material` **get_material** **(** **)** const .. _class_MeshDataTool_get_vertex: -- :ref:`Vector3` **get_vertex** **(** :ref:`int` idx **)** const +- :ref:`Vector3` **get_vertex** **(** :ref:`int` idx **)** const .. _class_MeshDataTool_get_vertex_bones: -- :ref:`PoolIntArray` **get_vertex_bones** **(** :ref:`int` idx **)** const +- :ref:`PoolIntArray` **get_vertex_bones** **(** :ref:`int` idx **)** const .. _class_MeshDataTool_get_vertex_color: -- :ref:`Color` **get_vertex_color** **(** :ref:`int` idx **)** const +- :ref:`Color` **get_vertex_color** **(** :ref:`int` idx **)** const .. _class_MeshDataTool_get_vertex_count: -- :ref:`int` **get_vertex_count** **(** **)** const +- :ref:`int` **get_vertex_count** **(** **)** const .. _class_MeshDataTool_get_vertex_edges: -- :ref:`PoolIntArray` **get_vertex_edges** **(** :ref:`int` idx **)** const +- :ref:`PoolIntArray` **get_vertex_edges** **(** :ref:`int` idx **)** const .. _class_MeshDataTool_get_vertex_faces: -- :ref:`PoolIntArray` **get_vertex_faces** **(** :ref:`int` idx **)** const +- :ref:`PoolIntArray` **get_vertex_faces** **(** :ref:`int` idx **)** const .. _class_MeshDataTool_get_vertex_meta: -- :ref:`Variant` **get_vertex_meta** **(** :ref:`int` idx **)** const +- :ref:`Variant` **get_vertex_meta** **(** :ref:`int` idx **)** const .. _class_MeshDataTool_get_vertex_normal: -- :ref:`Vector3` **get_vertex_normal** **(** :ref:`int` idx **)** const +- :ref:`Vector3` **get_vertex_normal** **(** :ref:`int` idx **)** const .. _class_MeshDataTool_get_vertex_tangent: -- :ref:`Plane` **get_vertex_tangent** **(** :ref:`int` idx **)** const +- :ref:`Plane` **get_vertex_tangent** **(** :ref:`int` idx **)** const .. _class_MeshDataTool_get_vertex_uv: -- :ref:`Vector2` **get_vertex_uv** **(** :ref:`int` idx **)** const +- :ref:`Vector2` **get_vertex_uv** **(** :ref:`int` idx **)** const .. _class_MeshDataTool_get_vertex_uv2: -- :ref:`Vector2` **get_vertex_uv2** **(** :ref:`int` idx **)** const +- :ref:`Vector2` **get_vertex_uv2** **(** :ref:`int` idx **)** const .. _class_MeshDataTool_get_vertex_weights: -- :ref:`PoolRealArray` **get_vertex_weights** **(** :ref:`int` idx **)** const +- :ref:`PoolRealArray` **get_vertex_weights** **(** :ref:`int` idx **)** const .. _class_MeshDataTool_set_edge_meta: -- void **set_edge_meta** **(** :ref:`int` idx, :ref:`Variant` meta **)** +- void **set_edge_meta** **(** :ref:`int` idx, :ref:`Variant` meta **)** .. _class_MeshDataTool_set_face_meta: -- void **set_face_meta** **(** :ref:`int` idx, :ref:`Variant` meta **)** +- void **set_face_meta** **(** :ref:`int` idx, :ref:`Variant` meta **)** .. _class_MeshDataTool_set_material: -- void **set_material** **(** :ref:`Material` material **)** +- void **set_material** **(** :ref:`Material` material **)** .. _class_MeshDataTool_set_vertex: -- void **set_vertex** **(** :ref:`int` idx, :ref:`Vector3` vertex **)** +- void **set_vertex** **(** :ref:`int` idx, :ref:`Vector3` vertex **)** .. _class_MeshDataTool_set_vertex_bones: -- void **set_vertex_bones** **(** :ref:`int` idx, :ref:`PoolIntArray` bones **)** +- void **set_vertex_bones** **(** :ref:`int` idx, :ref:`PoolIntArray` bones **)** .. _class_MeshDataTool_set_vertex_color: -- void **set_vertex_color** **(** :ref:`int` idx, :ref:`Color` color **)** +- void **set_vertex_color** **(** :ref:`int` idx, :ref:`Color` color **)** .. _class_MeshDataTool_set_vertex_meta: -- void **set_vertex_meta** **(** :ref:`int` idx, :ref:`Variant` meta **)** +- void **set_vertex_meta** **(** :ref:`int` idx, :ref:`Variant` meta **)** .. _class_MeshDataTool_set_vertex_normal: -- void **set_vertex_normal** **(** :ref:`int` idx, :ref:`Vector3` normal **)** +- void **set_vertex_normal** **(** :ref:`int` idx, :ref:`Vector3` normal **)** .. _class_MeshDataTool_set_vertex_tangent: -- void **set_vertex_tangent** **(** :ref:`int` idx, :ref:`Plane` tangent **)** +- void **set_vertex_tangent** **(** :ref:`int` idx, :ref:`Plane` tangent **)** .. _class_MeshDataTool_set_vertex_uv: -- void **set_vertex_uv** **(** :ref:`int` idx, :ref:`Vector2` uv **)** +- void **set_vertex_uv** **(** :ref:`int` idx, :ref:`Vector2` uv **)** .. _class_MeshDataTool_set_vertex_uv2: -- void **set_vertex_uv2** **(** :ref:`int` idx, :ref:`Vector2` uv2 **)** +- void **set_vertex_uv2** **(** :ref:`int` idx, :ref:`Vector2` uv2 **)** .. _class_MeshDataTool_set_vertex_weights: -- void **set_vertex_weights** **(** :ref:`int` idx, :ref:`PoolRealArray` weights **)** +- void **set_vertex_weights** **(** :ref:`int` idx, :ref:`PoolRealArray` weights **)** diff --git a/classes/class_meshinstance.rst b/classes/class_meshinstance.rst index ec32d97b5..5e5b6727a 100644 --- a/classes/class_meshinstance.rst +++ b/classes/class_meshinstance.rst @@ -19,25 +19,25 @@ Node that instances meshes into a scenario. Member Functions ---------------- -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_convex_collision` **(** **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_debug_tangents` **(** **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_trimesh_collision` **(** **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Mesh` | :ref:`get_mesh` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_skeleton_path` **(** **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Material` | :ref:`get_surface_material` **(** :ref:`int` surface **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mesh` **(** :ref:`Mesh` mesh **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_skeleton_path` **(** :ref:`NodePath` skeleton_path **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_surface_material` **(** :ref:`int` surface, :ref:`Material` material **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create_convex_collision` **(** **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create_debug_tangents` **(** **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create_trimesh_collision` **(** **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Mesh` | :ref:`get_mesh` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_skeleton_path` **(** **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Material` | :ref:`get_surface_material` **(** :ref:`int` surface **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_mesh` **(** :ref:`Mesh` mesh **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_skeleton_path` **(** :ref:`NodePath` skeleton_path **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_surface_material` **(** :ref:`int` surface, :ref:`Material` material **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -61,47 +61,47 @@ Member Function Description .. _class_MeshInstance_create_convex_collision: -- void **create_convex_collision** **(** **)** +- void **create_convex_collision** **(** **)** This helper creates a :ref:`StaticBody` child :ref:`Node` with a :ref:`ConvexPolygonShape` :ref:`CollisionShape` calculated from the mesh geometry. It's mainly used for testing. .. _class_MeshInstance_create_debug_tangents: -- void **create_debug_tangents** **(** **)** +- void **create_debug_tangents** **(** **)** .. _class_MeshInstance_create_trimesh_collision: -- void **create_trimesh_collision** **(** **)** +- void **create_trimesh_collision** **(** **)** This helper creates a :ref:`StaticBody` child :ref:`Node` with a :ref:`ConcavePolygonShape` :ref:`CollisionShape` calculated from the mesh geometry. It's mainly used for testing. .. _class_MeshInstance_get_mesh: -- :ref:`Mesh` **get_mesh** **(** **)** const +- :ref:`Mesh` **get_mesh** **(** **)** const Returns the current :ref:`Mesh` resource for the instance. .. _class_MeshInstance_get_skeleton_path: -- :ref:`NodePath` **get_skeleton_path** **(** **)** +- :ref:`NodePath` **get_skeleton_path** **(** **)** .. _class_MeshInstance_get_surface_material: -- :ref:`Material` **get_surface_material** **(** :ref:`int` surface **)** const +- :ref:`Material` **get_surface_material** **(** :ref:`int` surface **)** const Returns the :ref:`Material` for a surface of the :ref:`Mesh` resource. .. _class_MeshInstance_set_mesh: -- void **set_mesh** **(** :ref:`Mesh` mesh **)** +- void **set_mesh** **(** :ref:`Mesh` mesh **)** .. _class_MeshInstance_set_skeleton_path: -- void **set_skeleton_path** **(** :ref:`NodePath` skeleton_path **)** +- void **set_skeleton_path** **(** :ref:`NodePath` skeleton_path **)** .. _class_MeshInstance_set_surface_material: -- void **set_surface_material** **(** :ref:`int` surface, :ref:`Material` material **)** +- void **set_surface_material** **(** :ref:`int` surface, :ref:`Material` material **)** Sets the :ref:`Material` for a surface of the :ref:`Mesh` resource. diff --git a/classes/class_meshlibrary.rst b/classes/class_meshlibrary.rst index 1e41c0a05..50b8c1eea 100644 --- a/classes/class_meshlibrary.rst +++ b/classes/class_meshlibrary.rst @@ -19,39 +19,39 @@ Library of meshes. Member Functions ---------------- -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_item` **(** :ref:`int` id **)** | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_item_by_name` **(** :ref:`String` name **)** const | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_item_list` **(** **)** const | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Mesh` | :ref:`get_item_mesh` **(** :ref:`int` id **)** const | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_item_name` **(** :ref:`int` id **)** const | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NavigationMesh` | :ref:`get_item_navmesh` **(** :ref:`int` id **)** const | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_item_preview` **(** :ref:`int` id **)** const | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_item_shapes` **(** :ref:`int` id **)** const | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_last_unused_item_id` **(** **)** const | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_item` **(** :ref:`int` id **)** | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_mesh` **(** :ref:`int` id, :ref:`Mesh` mesh **)** | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_name` **(** :ref:`int` id, :ref:`String` name **)** | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_navmesh` **(** :ref:`int` id, :ref:`NavigationMesh` navmesh **)** | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_preview` **(** :ref:`int` id, :ref:`Texture` texture **)** | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_shapes` **(** :ref:`int` id, :ref:`Array` shapes **)** | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create_item` **(** :ref:`int` id **)** | ++----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find_item_by_name` **(** :ref:`String` name **)** const | ++----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`get_item_list` **(** **)** const | ++----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Mesh` | :ref:`get_item_mesh` **(** :ref:`int` id **)** const | ++----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_item_name` **(** :ref:`int` id **)** const | ++----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NavigationMesh` | :ref:`get_item_navmesh` **(** :ref:`int` id **)** const | ++----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_item_preview` **(** :ref:`int` id **)** const | ++----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_item_shapes` **(** :ref:`int` id **)** const | ++----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_last_unused_item_id` **(** **)** const | ++----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_item` **(** :ref:`int` id **)** | ++----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_mesh` **(** :ref:`int` id, :ref:`Mesh` mesh **)** | ++----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_name` **(** :ref:`int` id, :ref:`String` name **)** | ++----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_navmesh` **(** :ref:`int` id, :ref:`NavigationMesh` navmesh **)** | ++----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_preview` **(** :ref:`int` id, :ref:`Texture` texture **)** | ++----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_shapes` **(** :ref:`int` id, :ref:`Array` shapes **)** | ++----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -63,84 +63,84 @@ Member Function Description .. _class_MeshLibrary_clear: -- void **clear** **(** **)** +- void **clear** **(** **)** Clear the library. .. _class_MeshLibrary_create_item: -- void **create_item** **(** :ref:`int` id **)** +- void **create_item** **(** :ref:`int` id **)** Create a new item in the library, supplied an id. .. _class_MeshLibrary_find_item_by_name: -- :ref:`int` **find_item_by_name** **(** :ref:`String` name **)** const +- :ref:`int` **find_item_by_name** **(** :ref:`String` name **)** const .. _class_MeshLibrary_get_item_list: -- :ref:`PoolIntArray` **get_item_list** **(** **)** const +- :ref:`PoolIntArray` **get_item_list** **(** **)** const Return the list of items. .. _class_MeshLibrary_get_item_mesh: -- :ref:`Mesh` **get_item_mesh** **(** :ref:`int` id **)** const +- :ref:`Mesh` **get_item_mesh** **(** :ref:`int` id **)** const Return the mesh of the item. .. _class_MeshLibrary_get_item_name: -- :ref:`String` **get_item_name** **(** :ref:`int` id **)** const +- :ref:`String` **get_item_name** **(** :ref:`int` id **)** const Return the name of the item. .. _class_MeshLibrary_get_item_navmesh: -- :ref:`NavigationMesh` **get_item_navmesh** **(** :ref:`int` id **)** const +- :ref:`NavigationMesh` **get_item_navmesh** **(** :ref:`int` id **)** const .. _class_MeshLibrary_get_item_preview: -- :ref:`Texture` **get_item_preview** **(** :ref:`int` id **)** const +- :ref:`Texture` **get_item_preview** **(** :ref:`int` id **)** const .. _class_MeshLibrary_get_item_shapes: -- :ref:`Array` **get_item_shapes** **(** :ref:`int` id **)** const +- :ref:`Array` **get_item_shapes** **(** :ref:`int` id **)** const .. _class_MeshLibrary_get_last_unused_item_id: -- :ref:`int` **get_last_unused_item_id** **(** **)** const +- :ref:`int` **get_last_unused_item_id** **(** **)** const Get an unused id for a new item. .. _class_MeshLibrary_remove_item: -- void **remove_item** **(** :ref:`int` id **)** +- void **remove_item** **(** :ref:`int` id **)** Remove the item. .. _class_MeshLibrary_set_item_mesh: -- void **set_item_mesh** **(** :ref:`int` id, :ref:`Mesh` mesh **)** +- void **set_item_mesh** **(** :ref:`int` id, :ref:`Mesh` mesh **)** Set the mesh of the item. .. _class_MeshLibrary_set_item_name: -- void **set_item_name** **(** :ref:`int` id, :ref:`String` name **)** +- void **set_item_name** **(** :ref:`int` id, :ref:`String` name **)** Set the name of the item. .. _class_MeshLibrary_set_item_navmesh: -- void **set_item_navmesh** **(** :ref:`int` id, :ref:`NavigationMesh` navmesh **)** +- void **set_item_navmesh** **(** :ref:`int` id, :ref:`NavigationMesh` navmesh **)** .. _class_MeshLibrary_set_item_preview: -- void **set_item_preview** **(** :ref:`int` id, :ref:`Texture` texture **)** +- void **set_item_preview** **(** :ref:`int` id, :ref:`Texture` texture **)** .. _class_MeshLibrary_set_item_shapes: -- void **set_item_shapes** **(** :ref:`int` id, :ref:`Array` shapes **)** +- void **set_item_shapes** **(** :ref:`int` id, :ref:`Array` shapes **)** diff --git a/classes/class_mobilevrinterface.rst b/classes/class_mobilevrinterface.rst index feaeb2cb1..1f9b7f043 100644 --- a/classes/class_mobilevrinterface.rst +++ b/classes/class_mobilevrinterface.rst @@ -19,31 +19,31 @@ Generic mobile VR implementation Member Functions ---------------- -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_display_to_lens` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_display_width` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_iod` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_k1` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_k2` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_oversample` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_display_to_lens` **(** :ref:`float` display_to_lens **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_display_width` **(** :ref:`float` display_width **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_iod` **(** :ref:`float` iod **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_k1` **(** :ref:`float` k **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_k2` **(** :ref:`float` k **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_oversample` **(** :ref:`float` oversample **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_display_to_lens` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_display_width` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_iod` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_k1` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_k2` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_oversample` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_display_to_lens` **(** :ref:`float` display_to_lens **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_display_width` **(** :ref:`float` display_width **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_iod` **(** :ref:`float` iod **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_k1` **(** :ref:`float` k **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_k2` **(** :ref:`float` k **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_oversample` **(** :ref:`float` oversample **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -85,73 +85,73 @@ Member Function Description .. _class_MobileVRInterface_get_display_to_lens: -- :ref:`float` **get_display_to_lens** **(** **)** const +- :ref:`float` **get_display_to_lens** **(** **)** const Returns the distance between the display and the lens. .. _class_MobileVRInterface_get_display_width: -- :ref:`float` **get_display_width** **(** **)** const +- :ref:`float` **get_display_width** **(** **)** const Return the width of the LCD screen of the device. .. _class_MobileVRInterface_get_iod: -- :ref:`float` **get_iod** **(** **)** const +- :ref:`float` **get_iod** **(** **)** const Returns the interocular distance. .. _class_MobileVRInterface_get_k1: -- :ref:`float` **get_k1** **(** **)** const +- :ref:`float` **get_k1** **(** **)** const Returns the k1 lens constant. .. _class_MobileVRInterface_get_k2: -- :ref:`float` **get_k2** **(** **)** const +- :ref:`float` **get_k2** **(** **)** const Retuns the k2 lens constant .. _class_MobileVRInterface_get_oversample: -- :ref:`float` **get_oversample** **(** **)** const +- :ref:`float` **get_oversample** **(** **)** const Returns the oversampling setting. .. _class_MobileVRInterface_set_display_to_lens: -- void **set_display_to_lens** **(** :ref:`float` display_to_lens **)** +- void **set_display_to_lens** **(** :ref:`float` display_to_lens **)** Sets the distance between display and the lens. .. _class_MobileVRInterface_set_display_width: -- void **set_display_width** **(** :ref:`float` display_width **)** +- void **set_display_width** **(** :ref:`float` display_width **)** Sets the width of the LCD screen of the device. .. _class_MobileVRInterface_set_iod: -- void **set_iod** **(** :ref:`float` iod **)** +- void **set_iod** **(** :ref:`float` iod **)** Sets the interocular distance. .. _class_MobileVRInterface_set_k1: -- void **set_k1** **(** :ref:`float` k **)** +- void **set_k1** **(** :ref:`float` k **)** Sets the k1 lens constant. .. _class_MobileVRInterface_set_k2: -- void **set_k2** **(** :ref:`float` k **)** +- void **set_k2** **(** :ref:`float` k **)** Sets the k2 lens constant. .. _class_MobileVRInterface_set_oversample: -- void **set_oversample** **(** :ref:`float` oversample **)** +- void **set_oversample** **(** :ref:`float` oversample **)** Sets the oversampling setting. diff --git a/classes/class_multimesh.rst b/classes/class_multimesh.rst index b74e3a2b1..3a0406d56 100644 --- a/classes/class_multimesh.rst +++ b/classes/class_multimesh.rst @@ -19,33 +19,33 @@ Provides high performance mesh instancing. Member Functions ---------------- -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect3` | :ref:`get_aabb` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_color_format` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_instance_color` **(** :ref:`int` instance **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_instance_count` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_instance_transform` **(** :ref:`int` instance **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Mesh` | :ref:`get_mesh` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_transform_format` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_color_format` **(** :ref:`int` format **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_instance_color` **(** :ref:`int` instance, :ref:`Color` color **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_instance_count` **(** :ref:`int` count **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_instance_transform` **(** :ref:`int` instance, :ref:`Transform` transform **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mesh` **(** :ref:`Mesh` mesh **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_transform_format` **(** :ref:`int` format **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect3` | :ref:`get_aabb` **(** **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_color_format` **(** **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_instance_color` **(** :ref:`int` instance **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_instance_count` **(** **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`get_instance_transform` **(** :ref:`int` instance **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Mesh` | :ref:`get_mesh` **(** **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_transform_format` **(** **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_color_format` **(** :ref:`int` format **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_instance_color` **(** :ref:`int` instance, :ref:`Color` color **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_instance_count` **(** :ref:`int` count **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_instance_transform` **(** :ref:`int` instance, :ref:`Transform` transform **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_mesh` **(** :ref:`Mesh` mesh **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_transform_format` **(** :ref:`int` format **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -100,72 +100,72 @@ Member Function Description .. _class_MultiMesh_get_aabb: -- :ref:`Rect3` **get_aabb** **(** **)** const +- :ref:`Rect3` **get_aabb** **(** **)** const Return the visibility Rect3. .. _class_MultiMesh_get_color_format: -- :ref:`int` **get_color_format** **(** **)** const +- :ref:`int` **get_color_format** **(** **)** const .. _class_MultiMesh_get_instance_color: -- :ref:`Color` **get_instance_color** **(** :ref:`int` instance **)** const +- :ref:`Color` **get_instance_color** **(** :ref:`int` instance **)** const Get the color of a specific instance. .. _class_MultiMesh_get_instance_count: -- :ref:`int` **get_instance_count** **(** **)** const +- :ref:`int` **get_instance_count** **(** **)** const Return the amount of instances that is going to be drawn. .. _class_MultiMesh_get_instance_transform: -- :ref:`Transform` **get_instance_transform** **(** :ref:`int` instance **)** const +- :ref:`Transform` **get_instance_transform** **(** :ref:`int` instance **)** const Return the transform of a specific instance. .. _class_MultiMesh_get_mesh: -- :ref:`Mesh` **get_mesh** **(** **)** const +- :ref:`Mesh` **get_mesh** **(** **)** const Return the :ref:`Mesh` resource drawn as multiple instances. .. _class_MultiMesh_get_transform_format: -- :ref:`int` **get_transform_format** **(** **)** const +- :ref:`int` **get_transform_format** **(** **)** const .. _class_MultiMesh_set_color_format: -- void **set_color_format** **(** :ref:`int` format **)** +- void **set_color_format** **(** :ref:`int` format **)** .. _class_MultiMesh_set_instance_color: -- void **set_instance_color** **(** :ref:`int` instance, :ref:`Color` color **)** +- void **set_instance_color** **(** :ref:`int` instance, :ref:`Color` color **)** Set the color of a specific instance. .. _class_MultiMesh_set_instance_count: -- void **set_instance_count** **(** :ref:`int` count **)** +- void **set_instance_count** **(** :ref:`int` count **)** Set the amount of instances that is going to be drawn. Changing this number will erase all the existing instance transform and color data. .. _class_MultiMesh_set_instance_transform: -- void **set_instance_transform** **(** :ref:`int` instance, :ref:`Transform` transform **)** +- void **set_instance_transform** **(** :ref:`int` instance, :ref:`Transform` transform **)** Set the transform for a specific instance. .. _class_MultiMesh_set_mesh: -- void **set_mesh** **(** :ref:`Mesh` mesh **)** +- void **set_mesh** **(** :ref:`Mesh` mesh **)** Set the :ref:`Mesh` resource to be drawn in multiple instances. .. _class_MultiMesh_set_transform_format: -- void **set_transform_format** **(** :ref:`int` format **)** +- void **set_transform_format** **(** :ref:`int` format **)** diff --git a/classes/class_multimeshinstance.rst b/classes/class_multimeshinstance.rst index af4817d58..f56b6d34a 100644 --- a/classes/class_multimeshinstance.rst +++ b/classes/class_multimeshinstance.rst @@ -19,11 +19,11 @@ Node that instances a :ref:`MultiMesh`. Member Functions ---------------- -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`MultiMesh` | :ref:`get_multimesh` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_multimesh` **(** :ref:`MultiMesh` multimesh **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ ++------------------------------------+---------------------------------------------------------------------------------------------------------------------+ +| :ref:`MultiMesh` | :ref:`get_multimesh` **(** **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_multimesh` **(** :ref:`MultiMesh` multimesh **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -43,13 +43,13 @@ Member Function Description .. _class_MultiMeshInstance_get_multimesh: -- :ref:`MultiMesh` **get_multimesh** **(** **)** const +- :ref:`MultiMesh` **get_multimesh** **(** **)** const Return the :ref:`MultiMesh` that is used for instancing. .. _class_MultiMeshInstance_set_multimesh: -- void **set_multimesh** **(** :ref:`MultiMesh` multimesh **)** +- void **set_multimesh** **(** :ref:`MultiMesh` multimesh **)** Set the :ref:`MultiMesh` to be instanced. diff --git a/classes/class_mutex.rst b/classes/class_mutex.rst index a21bccc93..8d88ba70f 100644 --- a/classes/class_mutex.rst +++ b/classes/class_mutex.rst @@ -19,13 +19,13 @@ A synchronization Mutex. Member Functions ---------------- -+------------------------+----------------------------------------------------+ -| void | :ref:`lock` **(** **)** | -+------------------------+----------------------------------------------------+ -| :ref:`int` | :ref:`try_lock` **(** **)** | -+------------------------+----------------------------------------------------+ -| void | :ref:`unlock` **(** **)** | -+------------------------+----------------------------------------------------+ ++------------------------+---------------------------------------------------+ +| void | :ref:`lock` **(** **)** | ++------------------------+---------------------------------------------------+ +| :ref:`int` | :ref:`try_lock` **(** **)** | ++------------------------+---------------------------------------------------+ +| void | :ref:`unlock` **(** **)** | ++------------------------+---------------------------------------------------+ Description ----------- @@ -37,19 +37,19 @@ Member Function Description .. _class_Mutex_lock: -- void **lock** **(** **)** +- void **lock** **(** **)** Lock this :ref:`Mutex`, blocks until it is unlocked by the current owner. .. _class_Mutex_try_lock: -- :ref:`int` **try_lock** **(** **)** +- :ref:`int` **try_lock** **(** **)** Try locking this :ref:`Mutex`, does not block. Returns OK on success else ERR_BUSY. .. _class_Mutex_unlock: -- void **unlock** **(** **)** +- void **unlock** **(** **)** Unlock this :ref:`Mutex`, leaving it to others threads. diff --git a/classes/class_nativescript.rst b/classes/class_nativescript.rst index 2e94d464c..391b16869 100644 --- a/classes/class_nativescript.rst +++ b/classes/class_nativescript.rst @@ -19,17 +19,17 @@ Brief Description Member Functions ---------------- -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_class_name` **(** **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`GDNativeLibrary` | :ref:`get_library` **(** **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`new` **(** **)** vararg | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_class_name` **(** :ref:`String` class_name **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_library` **(** :ref:`GDNativeLibrary` library **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_class_name` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`GDNativeLibrary` | :ref:`get_library` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`new` **(** **)** vararg | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_class_name` **(** :ref:`String` class_name **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_library` **(** :ref:`GDNativeLibrary` library **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -48,22 +48,22 @@ Member Function Description .. _class_NativeScript_get_class_name: -- :ref:`String` **get_class_name** **(** **)** const +- :ref:`String` **get_class_name** **(** **)** const .. _class_NativeScript_get_library: -- :ref:`GDNativeLibrary` **get_library** **(** **)** const +- :ref:`GDNativeLibrary` **get_library** **(** **)** const .. _class_NativeScript_new: -- :ref:`Object` **new** **(** **)** vararg +- :ref:`Object` **new** **(** **)** vararg .. _class_NativeScript_set_class_name: -- void **set_class_name** **(** :ref:`String` class_name **)** +- void **set_class_name** **(** :ref:`String` class_name **)** .. _class_NativeScript_set_library: -- void **set_library** **(** :ref:`GDNativeLibrary` library **)** +- void **set_library** **(** :ref:`GDNativeLibrary` library **)** diff --git a/classes/class_navigation.rst b/classes/class_navigation.rst index 4f055bdd5..c8eca133b 100644 --- a/classes/class_navigation.rst +++ b/classes/class_navigation.rst @@ -19,27 +19,27 @@ Brief Description Member Functions ---------------- -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_closest_point` **(** :ref:`Vector3` to_point **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_closest_point_normal` **(** :ref:`Vector3` to_point **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_closest_point_owner` **(** :ref:`Vector3` to_point **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_closest_point_to_segment` **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` use_collision=false **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`get_simple_path` **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` optimize=true **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_up_vector` **(** **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`navmesh_create` **(** :ref:`NavigationMesh` mesh, :ref:`Transform` xform, :ref:`Object` owner=null **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`navmesh_remove` **(** :ref:`int` id **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`navmesh_set_transform` **(** :ref:`int` id, :ref:`Transform` xform **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_up_vector` **(** :ref:`Vector3` up **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_closest_point` **(** :ref:`Vector3` to_point **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_closest_point_normal` **(** :ref:`Vector3` to_point **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_closest_point_owner` **(** :ref:`Vector3` to_point **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_closest_point_to_segment` **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` use_collision=false **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`get_simple_path` **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` optimize=true **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_up_vector` **(** **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`navmesh_create` **(** :ref:`NavigationMesh` mesh, :ref:`Transform` xform, :ref:`Object` owner=null **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`navmesh_remove` **(** :ref:`int` id **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`navmesh_set_transform` **(** :ref:`int` id, :ref:`Transform` xform **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_up_vector` **(** :ref:`Vector3` up **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -54,42 +54,42 @@ Member Function Description .. _class_Navigation_get_closest_point: -- :ref:`Vector3` **get_closest_point** **(** :ref:`Vector3` to_point **)** +- :ref:`Vector3` **get_closest_point** **(** :ref:`Vector3` to_point **)** .. _class_Navigation_get_closest_point_normal: -- :ref:`Vector3` **get_closest_point_normal** **(** :ref:`Vector3` to_point **)** +- :ref:`Vector3` **get_closest_point_normal** **(** :ref:`Vector3` to_point **)** .. _class_Navigation_get_closest_point_owner: -- :ref:`Object` **get_closest_point_owner** **(** :ref:`Vector3` to_point **)** +- :ref:`Object` **get_closest_point_owner** **(** :ref:`Vector3` to_point **)** .. _class_Navigation_get_closest_point_to_segment: -- :ref:`Vector3` **get_closest_point_to_segment** **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` use_collision=false **)** +- :ref:`Vector3` **get_closest_point_to_segment** **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` use_collision=false **)** .. _class_Navigation_get_simple_path: -- :ref:`PoolVector3Array` **get_simple_path** **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` optimize=true **)** +- :ref:`PoolVector3Array` **get_simple_path** **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` optimize=true **)** .. _class_Navigation_get_up_vector: -- :ref:`Vector3` **get_up_vector** **(** **)** const +- :ref:`Vector3` **get_up_vector** **(** **)** const .. _class_Navigation_navmesh_create: -- :ref:`int` **navmesh_create** **(** :ref:`NavigationMesh` mesh, :ref:`Transform` xform, :ref:`Object` owner=null **)** +- :ref:`int` **navmesh_create** **(** :ref:`NavigationMesh` mesh, :ref:`Transform` xform, :ref:`Object` owner=null **)** .. _class_Navigation_navmesh_remove: -- void **navmesh_remove** **(** :ref:`int` id **)** +- void **navmesh_remove** **(** :ref:`int` id **)** .. _class_Navigation_navmesh_set_transform: -- void **navmesh_set_transform** **(** :ref:`int` id, :ref:`Transform` xform **)** +- void **navmesh_set_transform** **(** :ref:`int` id, :ref:`Transform` xform **)** .. _class_Navigation_set_up_vector: -- void **set_up_vector** **(** :ref:`Vector3` up **)** +- void **set_up_vector** **(** :ref:`Vector3` up **)** diff --git a/classes/class_navigation2d.rst b/classes/class_navigation2d.rst index 118efcfc0..11bafc674 100644 --- a/classes/class_navigation2d.rst +++ b/classes/class_navigation2d.rst @@ -19,45 +19,45 @@ Brief Description Member Functions ---------------- -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_closest_point` **(** :ref:`Vector2` to_point **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_closest_point_owner` **(** :ref:`Vector2` to_point **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_simple_path` **(** :ref:`Vector2` start, :ref:`Vector2` end, :ref:`bool` optimize=true **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`navpoly_create` **(** :ref:`NavigationPolygon` mesh, :ref:`Transform2D` xform, :ref:`Object` owner=null **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`navpoly_remove` **(** :ref:`int` id **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`navpoly_set_transform` **(** :ref:`int` id, :ref:`Transform2D` xform **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_closest_point` **(** :ref:`Vector2` to_point **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_closest_point_owner` **(** :ref:`Vector2` to_point **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`get_simple_path` **(** :ref:`Vector2` start, :ref:`Vector2` end, :ref:`bool` optimize=true **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`navpoly_create` **(** :ref:`NavigationPolygon` mesh, :ref:`Transform2D` xform, :ref:`Object` owner=null **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`navpoly_remove` **(** :ref:`int` id **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`navpoly_set_transform` **(** :ref:`int` id, :ref:`Transform2D` xform **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Function Description --------------------------- .. _class_Navigation2D_get_closest_point: -- :ref:`Vector2` **get_closest_point** **(** :ref:`Vector2` to_point **)** +- :ref:`Vector2` **get_closest_point** **(** :ref:`Vector2` to_point **)** .. _class_Navigation2D_get_closest_point_owner: -- :ref:`Object` **get_closest_point_owner** **(** :ref:`Vector2` to_point **)** +- :ref:`Object` **get_closest_point_owner** **(** :ref:`Vector2` to_point **)** .. _class_Navigation2D_get_simple_path: -- :ref:`PoolVector2Array` **get_simple_path** **(** :ref:`Vector2` start, :ref:`Vector2` end, :ref:`bool` optimize=true **)** +- :ref:`PoolVector2Array` **get_simple_path** **(** :ref:`Vector2` start, :ref:`Vector2` end, :ref:`bool` optimize=true **)** .. _class_Navigation2D_navpoly_create: -- :ref:`int` **navpoly_create** **(** :ref:`NavigationPolygon` mesh, :ref:`Transform2D` xform, :ref:`Object` owner=null **)** +- :ref:`int` **navpoly_create** **(** :ref:`NavigationPolygon` mesh, :ref:`Transform2D` xform, :ref:`Object` owner=null **)** .. _class_Navigation2D_navpoly_remove: -- void **navpoly_remove** **(** :ref:`int` id **)** +- void **navpoly_remove** **(** :ref:`int` id **)** .. _class_Navigation2D_navpoly_set_transform: -- void **navpoly_set_transform** **(** :ref:`int` id, :ref:`Transform2D` xform **)** +- void **navpoly_set_transform** **(** :ref:`int` id, :ref:`Transform2D` xform **)** diff --git a/classes/class_navigationmesh.rst b/classes/class_navigationmesh.rst index f686ecddd..124e8a1b2 100644 --- a/classes/class_navigationmesh.rst +++ b/classes/class_navigationmesh.rst @@ -19,89 +19,89 @@ Brief Description Member Functions ---------------- -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_polygon` **(** :ref:`PoolIntArray` polygon **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_polygons` **(** **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_from_mesh` **(** :ref:`Mesh` mesh **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_agent_height` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_agent_max_climb` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_agent_max_slope` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_agent_radius` **(** **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_cell_height` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_cell_size` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_detail_sample_distance` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_detail_sample_max_error` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_edge_max_error` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_edge_max_length` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_filter_ledge_spans` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_filter_low_hanging_obstacles` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_filter_walkable_low_height_spans` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_polygon` **(** :ref:`int` idx **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_polygon_count` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_region_merge_size` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_region_min_size` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_sample_partition_type` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`get_vertices` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_verts_per_poly` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_agent_height` **(** :ref:`float` agent_height **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_agent_max_climb` **(** :ref:`float` agent_max_climb **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_agent_max_slope` **(** :ref:`float` agent_max_slope **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_agent_radius` **(** :ref:`float` agent_radius **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cell_height` **(** :ref:`float` cell_height **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cell_size` **(** :ref:`float` cell_size **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_detail_sample_distance` **(** :ref:`float` detail_sample_dist **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_detail_sample_max_error` **(** :ref:`float` detail_sample_max_error **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_edge_max_error` **(** :ref:`float` edge_max_error **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_edge_max_length` **(** :ref:`float` edge_max_length **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_filter_ledge_spans` **(** :ref:`bool` filter_ledge_spans **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_filter_low_hanging_obstacles` **(** :ref:`bool` filter_low_hanging_obstacles **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_filter_walkable_low_height_spans` **(** :ref:`bool` filter_walkable_low_height_spans **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_region_merge_size` **(** :ref:`float` region_merge_size **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_region_min_size` **(** :ref:`float` region_min_size **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sample_partition_type` **(** :ref:`int` sample_partition_type **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertices` **(** :ref:`PoolVector3Array` vertices **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_verts_per_poly` **(** :ref:`float` verts_per_poly **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_polygon` **(** :ref:`PoolIntArray` polygon **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_polygons` **(** **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create_from_mesh` **(** :ref:`Mesh` mesh **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_agent_height` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_agent_max_climb` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_agent_max_slope` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_agent_radius` **(** **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_cell_height` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_cell_size` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_detail_sample_distance` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_detail_sample_max_error` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_edge_max_error` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_edge_max_length` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_filter_ledge_spans` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_filter_low_hanging_obstacles` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_filter_walkable_low_height_spans` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`get_polygon` **(** :ref:`int` idx **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_polygon_count` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_region_merge_size` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_region_min_size` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_sample_partition_type` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`get_vertices` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_verts_per_poly` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_agent_height` **(** :ref:`float` agent_height **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_agent_max_climb` **(** :ref:`float` agent_max_climb **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_agent_max_slope` **(** :ref:`float` agent_max_slope **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_agent_radius` **(** :ref:`float` agent_radius **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cell_height` **(** :ref:`float` cell_height **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cell_size` **(** :ref:`float` cell_size **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_detail_sample_distance` **(** :ref:`float` detail_sample_dist **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_detail_sample_max_error` **(** :ref:`float` detail_sample_max_error **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_edge_max_error` **(** :ref:`float` edge_max_error **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_edge_max_length` **(** :ref:`float` edge_max_length **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_filter_ledge_spans` **(** :ref:`bool` filter_ledge_spans **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_filter_low_hanging_obstacles` **(** :ref:`bool` filter_low_hanging_obstacles **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_filter_walkable_low_height_spans` **(** :ref:`bool` filter_walkable_low_height_spans **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_region_merge_size` **(** :ref:`float` region_merge_size **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_region_min_size` **(** :ref:`float` region_min_size **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_sample_partition_type` **(** :ref:`int` sample_partition_type **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vertices` **(** :ref:`PoolVector3Array` vertices **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_verts_per_poly` **(** :ref:`float` verts_per_poly **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -195,166 +195,166 @@ Member Function Description .. _class_NavigationMesh_add_polygon: -- void **add_polygon** **(** :ref:`PoolIntArray` polygon **)** +- void **add_polygon** **(** :ref:`PoolIntArray` polygon **)** .. _class_NavigationMesh_clear_polygons: -- void **clear_polygons** **(** **)** +- void **clear_polygons** **(** **)** .. _class_NavigationMesh_create_from_mesh: -- void **create_from_mesh** **(** :ref:`Mesh` mesh **)** +- void **create_from_mesh** **(** :ref:`Mesh` mesh **)** .. _class_NavigationMesh_get_agent_height: -- :ref:`float` **get_agent_height** **(** **)** const +- :ref:`float` **get_agent_height** **(** **)** const .. _class_NavigationMesh_get_agent_max_climb: -- :ref:`float` **get_agent_max_climb** **(** **)** const +- :ref:`float` **get_agent_max_climb** **(** **)** const .. _class_NavigationMesh_get_agent_max_slope: -- :ref:`float` **get_agent_max_slope** **(** **)** const +- :ref:`float` **get_agent_max_slope** **(** **)** const .. _class_NavigationMesh_get_agent_radius: -- :ref:`float` **get_agent_radius** **(** **)** +- :ref:`float` **get_agent_radius** **(** **)** .. _class_NavigationMesh_get_cell_height: -- :ref:`float` **get_cell_height** **(** **)** const +- :ref:`float` **get_cell_height** **(** **)** const .. _class_NavigationMesh_get_cell_size: -- :ref:`float` **get_cell_size** **(** **)** const +- :ref:`float` **get_cell_size** **(** **)** const .. _class_NavigationMesh_get_detail_sample_distance: -- :ref:`float` **get_detail_sample_distance** **(** **)** const +- :ref:`float` **get_detail_sample_distance** **(** **)** const .. _class_NavigationMesh_get_detail_sample_max_error: -- :ref:`float` **get_detail_sample_max_error** **(** **)** const +- :ref:`float` **get_detail_sample_max_error** **(** **)** const .. _class_NavigationMesh_get_edge_max_error: -- :ref:`float` **get_edge_max_error** **(** **)** const +- :ref:`float` **get_edge_max_error** **(** **)** const .. _class_NavigationMesh_get_edge_max_length: -- :ref:`float` **get_edge_max_length** **(** **)** const +- :ref:`float` **get_edge_max_length** **(** **)** const .. _class_NavigationMesh_get_filter_ledge_spans: -- :ref:`bool` **get_filter_ledge_spans** **(** **)** const +- :ref:`bool` **get_filter_ledge_spans** **(** **)** const .. _class_NavigationMesh_get_filter_low_hanging_obstacles: -- :ref:`bool` **get_filter_low_hanging_obstacles** **(** **)** const +- :ref:`bool` **get_filter_low_hanging_obstacles** **(** **)** const .. _class_NavigationMesh_get_filter_walkable_low_height_spans: -- :ref:`bool` **get_filter_walkable_low_height_spans** **(** **)** const +- :ref:`bool` **get_filter_walkable_low_height_spans** **(** **)** const .. _class_NavigationMesh_get_polygon: -- :ref:`PoolIntArray` **get_polygon** **(** :ref:`int` idx **)** +- :ref:`PoolIntArray` **get_polygon** **(** :ref:`int` idx **)** .. _class_NavigationMesh_get_polygon_count: -- :ref:`int` **get_polygon_count** **(** **)** const +- :ref:`int` **get_polygon_count** **(** **)** const .. _class_NavigationMesh_get_region_merge_size: -- :ref:`float` **get_region_merge_size** **(** **)** const +- :ref:`float` **get_region_merge_size** **(** **)** const .. _class_NavigationMesh_get_region_min_size: -- :ref:`float` **get_region_min_size** **(** **)** const +- :ref:`float` **get_region_min_size** **(** **)** const .. _class_NavigationMesh_get_sample_partition_type: -- :ref:`int` **get_sample_partition_type** **(** **)** const +- :ref:`int` **get_sample_partition_type** **(** **)** const .. _class_NavigationMesh_get_vertices: -- :ref:`PoolVector3Array` **get_vertices** **(** **)** const +- :ref:`PoolVector3Array` **get_vertices** **(** **)** const .. _class_NavigationMesh_get_verts_per_poly: -- :ref:`float` **get_verts_per_poly** **(** **)** const +- :ref:`float` **get_verts_per_poly** **(** **)** const .. _class_NavigationMesh_set_agent_height: -- void **set_agent_height** **(** :ref:`float` agent_height **)** +- void **set_agent_height** **(** :ref:`float` agent_height **)** .. _class_NavigationMesh_set_agent_max_climb: -- void **set_agent_max_climb** **(** :ref:`float` agent_max_climb **)** +- void **set_agent_max_climb** **(** :ref:`float` agent_max_climb **)** .. _class_NavigationMesh_set_agent_max_slope: -- void **set_agent_max_slope** **(** :ref:`float` agent_max_slope **)** +- void **set_agent_max_slope** **(** :ref:`float` agent_max_slope **)** .. _class_NavigationMesh_set_agent_radius: -- void **set_agent_radius** **(** :ref:`float` agent_radius **)** +- void **set_agent_radius** **(** :ref:`float` agent_radius **)** .. _class_NavigationMesh_set_cell_height: -- void **set_cell_height** **(** :ref:`float` cell_height **)** +- void **set_cell_height** **(** :ref:`float` cell_height **)** .. _class_NavigationMesh_set_cell_size: -- void **set_cell_size** **(** :ref:`float` cell_size **)** +- void **set_cell_size** **(** :ref:`float` cell_size **)** .. _class_NavigationMesh_set_detail_sample_distance: -- void **set_detail_sample_distance** **(** :ref:`float` detail_sample_dist **)** +- void **set_detail_sample_distance** **(** :ref:`float` detail_sample_dist **)** .. _class_NavigationMesh_set_detail_sample_max_error: -- void **set_detail_sample_max_error** **(** :ref:`float` detail_sample_max_error **)** +- void **set_detail_sample_max_error** **(** :ref:`float` detail_sample_max_error **)** .. _class_NavigationMesh_set_edge_max_error: -- void **set_edge_max_error** **(** :ref:`float` edge_max_error **)** +- void **set_edge_max_error** **(** :ref:`float` edge_max_error **)** .. _class_NavigationMesh_set_edge_max_length: -- void **set_edge_max_length** **(** :ref:`float` edge_max_length **)** +- void **set_edge_max_length** **(** :ref:`float` edge_max_length **)** .. _class_NavigationMesh_set_filter_ledge_spans: -- void **set_filter_ledge_spans** **(** :ref:`bool` filter_ledge_spans **)** +- void **set_filter_ledge_spans** **(** :ref:`bool` filter_ledge_spans **)** .. _class_NavigationMesh_set_filter_low_hanging_obstacles: -- void **set_filter_low_hanging_obstacles** **(** :ref:`bool` filter_low_hanging_obstacles **)** +- void **set_filter_low_hanging_obstacles** **(** :ref:`bool` filter_low_hanging_obstacles **)** .. _class_NavigationMesh_set_filter_walkable_low_height_spans: -- void **set_filter_walkable_low_height_spans** **(** :ref:`bool` filter_walkable_low_height_spans **)** +- void **set_filter_walkable_low_height_spans** **(** :ref:`bool` filter_walkable_low_height_spans **)** .. _class_NavigationMesh_set_region_merge_size: -- void **set_region_merge_size** **(** :ref:`float` region_merge_size **)** +- void **set_region_merge_size** **(** :ref:`float` region_merge_size **)** .. _class_NavigationMesh_set_region_min_size: -- void **set_region_min_size** **(** :ref:`float` region_min_size **)** +- void **set_region_min_size** **(** :ref:`float` region_min_size **)** .. _class_NavigationMesh_set_sample_partition_type: -- void **set_sample_partition_type** **(** :ref:`int` sample_partition_type **)** +- void **set_sample_partition_type** **(** :ref:`int` sample_partition_type **)** .. _class_NavigationMesh_set_vertices: -- void **set_vertices** **(** :ref:`PoolVector3Array` vertices **)** +- void **set_vertices** **(** :ref:`PoolVector3Array` vertices **)** .. _class_NavigationMesh_set_verts_per_poly: -- void **set_verts_per_poly** **(** :ref:`float` verts_per_poly **)** +- void **set_verts_per_poly** **(** :ref:`float` verts_per_poly **)** diff --git a/classes/class_navigationmeshinstance.rst b/classes/class_navigationmeshinstance.rst index cf12884d7..408d05ada 100644 --- a/classes/class_navigationmeshinstance.rst +++ b/classes/class_navigationmeshinstance.rst @@ -19,15 +19,15 @@ Brief Description Member Functions ---------------- -+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NavigationMesh` | :ref:`get_navigation_mesh` **(** **)** const | -+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_enabled` **(** **)** const | -+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_enabled` **(** :ref:`bool` enabled **)** | -+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_navigation_mesh` **(** :ref:`NavigationMesh` navmesh **)** | -+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NavigationMesh` | :ref:`get_navigation_mesh` **(** **)** const | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_enabled` **(** **)** const | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_enabled` **(** :ref:`bool` enabled **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_navigation_mesh` **(** :ref:`NavigationMesh` navmesh **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -46,18 +46,18 @@ Member Function Description .. _class_NavigationMeshInstance_get_navigation_mesh: -- :ref:`NavigationMesh` **get_navigation_mesh** **(** **)** const +- :ref:`NavigationMesh` **get_navigation_mesh** **(** **)** const .. _class_NavigationMeshInstance_is_enabled: -- :ref:`bool` **is_enabled** **(** **)** const +- :ref:`bool` **is_enabled** **(** **)** const .. _class_NavigationMeshInstance_set_enabled: -- void **set_enabled** **(** :ref:`bool` enabled **)** +- void **set_enabled** **(** :ref:`bool` enabled **)** .. _class_NavigationMeshInstance_set_navigation_mesh: -- void **set_navigation_mesh** **(** :ref:`NavigationMesh` navmesh **)** +- void **set_navigation_mesh** **(** :ref:`NavigationMesh` navmesh **)** diff --git a/classes/class_navigationpolygon.rst b/classes/class_navigationpolygon.rst index ec8c7d9bf..bb01552b8 100644 --- a/classes/class_navigationpolygon.rst +++ b/classes/class_navigationpolygon.rst @@ -19,35 +19,35 @@ Brief Description Member Functions ---------------- -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_outline` **(** :ref:`PoolVector2Array` outline **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_outline_at_index` **(** :ref:`PoolVector2Array` outline, :ref:`int` index **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_polygon` **(** :ref:`PoolIntArray` polygon **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_outlines` **(** **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_polygons` **(** **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_outline` **(** :ref:`int` idx **)** const | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_outline_count` **(** **)** const | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_polygon` **(** :ref:`int` idx **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_polygon_count` **(** **)** const | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_vertices` **(** **)** const | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`make_polygons_from_outlines` **(** **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_outline` **(** :ref:`int` idx **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_outline` **(** :ref:`int` idx, :ref:`PoolVector2Array` outline **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertices` **(** :ref:`PoolVector2Array` vertices **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_outline` **(** :ref:`PoolVector2Array` outline **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_outline_at_index` **(** :ref:`PoolVector2Array` outline, :ref:`int` index **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_polygon` **(** :ref:`PoolIntArray` polygon **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_outlines` **(** **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_polygons` **(** **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`get_outline` **(** :ref:`int` idx **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_outline_count` **(** **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`get_polygon` **(** :ref:`int` idx **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_polygon_count` **(** **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`get_vertices` **(** **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`make_polygons_from_outlines` **(** **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_outline` **(** :ref:`int` idx **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_outline` **(** :ref:`int` idx, :ref:`PoolVector2Array` outline **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vertices` **(** :ref:`PoolVector2Array` vertices **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -70,58 +70,58 @@ Member Function Description .. _class_NavigationPolygon_add_outline: -- void **add_outline** **(** :ref:`PoolVector2Array` outline **)** +- void **add_outline** **(** :ref:`PoolVector2Array` outline **)** .. _class_NavigationPolygon_add_outline_at_index: -- void **add_outline_at_index** **(** :ref:`PoolVector2Array` outline, :ref:`int` index **)** +- void **add_outline_at_index** **(** :ref:`PoolVector2Array` outline, :ref:`int` index **)** .. _class_NavigationPolygon_add_polygon: -- void **add_polygon** **(** :ref:`PoolIntArray` polygon **)** +- void **add_polygon** **(** :ref:`PoolIntArray` polygon **)** .. _class_NavigationPolygon_clear_outlines: -- void **clear_outlines** **(** **)** +- void **clear_outlines** **(** **)** .. _class_NavigationPolygon_clear_polygons: -- void **clear_polygons** **(** **)** +- void **clear_polygons** **(** **)** .. _class_NavigationPolygon_get_outline: -- :ref:`PoolVector2Array` **get_outline** **(** :ref:`int` idx **)** const +- :ref:`PoolVector2Array` **get_outline** **(** :ref:`int` idx **)** const .. _class_NavigationPolygon_get_outline_count: -- :ref:`int` **get_outline_count** **(** **)** const +- :ref:`int` **get_outline_count** **(** **)** const .. _class_NavigationPolygon_get_polygon: -- :ref:`PoolIntArray` **get_polygon** **(** :ref:`int` idx **)** +- :ref:`PoolIntArray` **get_polygon** **(** :ref:`int` idx **)** .. _class_NavigationPolygon_get_polygon_count: -- :ref:`int` **get_polygon_count** **(** **)** const +- :ref:`int` **get_polygon_count** **(** **)** const .. _class_NavigationPolygon_get_vertices: -- :ref:`PoolVector2Array` **get_vertices** **(** **)** const +- :ref:`PoolVector2Array` **get_vertices** **(** **)** const .. _class_NavigationPolygon_make_polygons_from_outlines: -- void **make_polygons_from_outlines** **(** **)** +- void **make_polygons_from_outlines** **(** **)** .. _class_NavigationPolygon_remove_outline: -- void **remove_outline** **(** :ref:`int` idx **)** +- void **remove_outline** **(** :ref:`int` idx **)** .. _class_NavigationPolygon_set_outline: -- void **set_outline** **(** :ref:`int` idx, :ref:`PoolVector2Array` outline **)** +- void **set_outline** **(** :ref:`int` idx, :ref:`PoolVector2Array` outline **)** .. _class_NavigationPolygon_set_vertices: -- void **set_vertices** **(** :ref:`PoolVector2Array` vertices **)** +- void **set_vertices** **(** :ref:`PoolVector2Array` vertices **)** diff --git a/classes/class_navigationpolygoninstance.rst b/classes/class_navigationpolygoninstance.rst index 28d34bbe8..27a0fd9d7 100644 --- a/classes/class_navigationpolygoninstance.rst +++ b/classes/class_navigationpolygoninstance.rst @@ -19,15 +19,15 @@ Brief Description Member Functions ---------------- -+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NavigationPolygon` | :ref:`get_navigation_polygon` **(** **)** const | -+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_enabled` **(** **)** const | -+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_enabled` **(** :ref:`bool` enabled **)** | -+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_navigation_polygon` **(** :ref:`NavigationPolygon` navpoly **)** | -+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NavigationPolygon` | :ref:`get_navigation_polygon` **(** **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_enabled` **(** **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_enabled` **(** :ref:`bool` enabled **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_navigation_polygon` **(** :ref:`NavigationPolygon` navpoly **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -46,18 +46,18 @@ Member Function Description .. _class_NavigationPolygonInstance_get_navigation_polygon: -- :ref:`NavigationPolygon` **get_navigation_polygon** **(** **)** const +- :ref:`NavigationPolygon` **get_navigation_polygon** **(** **)** const .. _class_NavigationPolygonInstance_is_enabled: -- :ref:`bool` **is_enabled** **(** **)** const +- :ref:`bool` **is_enabled** **(** **)** const .. _class_NavigationPolygonInstance_set_enabled: -- void **set_enabled** **(** :ref:`bool` enabled **)** +- void **set_enabled** **(** :ref:`bool` enabled **)** .. _class_NavigationPolygonInstance_set_navigation_polygon: -- void **set_navigation_polygon** **(** :ref:`NavigationPolygon` navpoly **)** +- void **set_navigation_polygon** **(** :ref:`NavigationPolygon` navpoly **)** diff --git a/classes/class_networkedmultiplayerenet.rst b/classes/class_networkedmultiplayerenet.rst index a982b155f..5d26a0a42 100644 --- a/classes/class_networkedmultiplayerenet.rst +++ b/classes/class_networkedmultiplayerenet.rst @@ -19,19 +19,19 @@ PacketPeer implementation using the ENet library. Member Functions ---------------- -+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`close_connection` **(** **)** | -+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`create_client` **(** :ref:`String` ip, :ref:`int` port, :ref:`int` in_bandwidth=0, :ref:`int` out_bandwidth=0 **)** | -+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`create_server` **(** :ref:`int` port, :ref:`int` max_clients=32, :ref:`int` in_bandwidth=0, :ref:`int` out_bandwidth=0 **)** | -+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_compression_mode` **(** **)** const | -+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bind_ip` **(** :ref:`String` ip **)** | -+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_compression_mode` **(** :ref:`int` mode **)** | -+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`close_connection` **(** **)** | ++------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`create_client` **(** :ref:`String` ip, :ref:`int` port, :ref:`int` in_bandwidth=0, :ref:`int` out_bandwidth=0 **)** | ++------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`create_server` **(** :ref:`int` port, :ref:`int` max_clients=32, :ref:`int` in_bandwidth=0, :ref:`int` out_bandwidth=0 **)** | ++------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_compression_mode` **(** **)** const | ++------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bind_ip` **(** :ref:`String` ip **)** | ++------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_compression_mode` **(** :ref:`int` mode **)** | ++------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -52,30 +52,30 @@ Member Function Description .. _class_NetworkedMultiplayerENet_close_connection: -- void **close_connection** **(** **)** +- void **close_connection** **(** **)** .. _class_NetworkedMultiplayerENet_create_client: -- :ref:`int` **create_client** **(** :ref:`String` ip, :ref:`int` port, :ref:`int` in_bandwidth=0, :ref:`int` out_bandwidth=0 **)** +- :ref:`int` **create_client** **(** :ref:`String` ip, :ref:`int` port, :ref:`int` in_bandwidth=0, :ref:`int` out_bandwidth=0 **)** Create client that connects to a server at address ``ip`` using specified ``port``. .. _class_NetworkedMultiplayerENet_create_server: -- :ref:`int` **create_server** **(** :ref:`int` port, :ref:`int` max_clients=32, :ref:`int` in_bandwidth=0, :ref:`int` out_bandwidth=0 **)** +- :ref:`int` **create_server** **(** :ref:`int` port, :ref:`int` max_clients=32, :ref:`int` in_bandwidth=0, :ref:`int` out_bandwidth=0 **)** Create server that listens to connections via ``port``. .. _class_NetworkedMultiplayerENet_get_compression_mode: -- :ref:`int` **get_compression_mode** **(** **)** const +- :ref:`int` **get_compression_mode** **(** **)** const .. _class_NetworkedMultiplayerENet_set_bind_ip: -- void **set_bind_ip** **(** :ref:`String` ip **)** +- void **set_bind_ip** **(** :ref:`String` ip **)** .. _class_NetworkedMultiplayerENet_set_compression_mode: -- void **set_compression_mode** **(** :ref:`int` mode **)** +- void **set_compression_mode** **(** :ref:`int` mode **)** diff --git a/classes/class_networkedmultiplayerpeer.rst b/classes/class_networkedmultiplayerpeer.rst index 1f52f5dd1..a8d507fc4 100644 --- a/classes/class_networkedmultiplayerpeer.rst +++ b/classes/class_networkedmultiplayerpeer.rst @@ -21,54 +21,54 @@ Brief Description Member Functions ---------------- -+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_connection_status` **(** **)** const | -+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_packet_peer` **(** **)** const | -+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_unique_id` **(** **)** const | -+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_refusing_new_connections` **(** **)** const | -+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`poll` **(** **)** | -+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_refuse_new_connections` **(** :ref:`bool` enable **)** | -+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_target_peer` **(** :ref:`int` id **)** | -+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_transfer_mode` **(** :ref:`int` mode **)** | -+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_connection_status` **(** **)** const | ++--------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_packet_peer` **(** **)** const | ++--------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_unique_id` **(** **)** const | ++--------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_refusing_new_connections` **(** **)** const | ++--------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`poll` **(** **)** | ++--------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_refuse_new_connections` **(** :ref:`bool` enable **)** | ++--------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_target_peer` **(** :ref:`int` id **)** | ++--------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_transfer_mode` **(** :ref:`int` mode **)** | ++--------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_NetworkedMultiplayerPeer_connection_failed: -- **connection_failed** **(** **)** +- **connection_failed** **(** **)** Emitted when failed to connect to server. .. _class_NetworkedMultiplayerPeer_connection_succeeded: -- **connection_succeeded** **(** **)** +- **connection_succeeded** **(** **)** Emitted when successfully connected to server. .. _class_NetworkedMultiplayerPeer_peer_connected: -- **peer_connected** **(** :ref:`int` id **)** +- **peer_connected** **(** :ref:`int` id **)** Emitted by the server when a client is connected. .. _class_NetworkedMultiplayerPeer_peer_disconnected: -- **peer_disconnected** **(** :ref:`int` id **)** +- **peer_disconnected** **(** :ref:`int` id **)** Emitted by the server when a client is disconnected. .. _class_NetworkedMultiplayerPeer_server_disconnected: -- **server_disconnected** **(** **)** +- **server_disconnected** **(** **)** Emitted by clients when server is disconnected. @@ -90,38 +90,38 @@ Member Function Description .. _class_NetworkedMultiplayerPeer_get_connection_status: -- :ref:`int` **get_connection_status** **(** **)** const +- :ref:`int` **get_connection_status** **(** **)** const .. _class_NetworkedMultiplayerPeer_get_packet_peer: -- :ref:`int` **get_packet_peer** **(** **)** const +- :ref:`int` **get_packet_peer** **(** **)** const .. _class_NetworkedMultiplayerPeer_get_unique_id: -- :ref:`int` **get_unique_id** **(** **)** const +- :ref:`int` **get_unique_id** **(** **)** const .. _class_NetworkedMultiplayerPeer_is_refusing_new_connections: -- :ref:`bool` **is_refusing_new_connections** **(** **)** const +- :ref:`bool` **is_refusing_new_connections** **(** **)** const Return whether this :ref:`NetworkedMultiplayerPeer` is refusing new connections. .. _class_NetworkedMultiplayerPeer_poll: -- void **poll** **(** **)** +- void **poll** **(** **)** .. _class_NetworkedMultiplayerPeer_set_refuse_new_connections: -- void **set_refuse_new_connections** **(** :ref:`bool` enable **)** +- void **set_refuse_new_connections** **(** :ref:`bool` enable **)** If ``endable`` is true, this :ref:`NetworkedMultiplayerPeer` will refuse new connections. .. _class_NetworkedMultiplayerPeer_set_target_peer: -- void **set_target_peer** **(** :ref:`int` id **)** +- void **set_target_peer** **(** :ref:`int` id **)** .. _class_NetworkedMultiplayerPeer_set_transfer_mode: -- void **set_transfer_mode** **(** :ref:`int` mode **)** +- void **set_transfer_mode** **(** :ref:`int` mode **)** diff --git a/classes/class_nil.rst b/classes/class_nil.rst index b4f91b5eb..a5fd3080d 100644 --- a/classes/class_nil.rst +++ b/classes/class_nil.rst @@ -17,165 +17,165 @@ Brief Description Member Functions ---------------- -+-------+----------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`PoolColorArray` from **)** | -+-------+----------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`PoolVector3Array` from **)** | -+-------+----------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`PoolVector2Array` from **)** | -+-------+----------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`PoolStringArray` from **)** | -+-------+----------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`PoolRealArray` from **)** | -+-------+----------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`PoolIntArray` from **)** | -+-------+----------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`PoolByteArray` from **)** | -+-------+----------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Array` from **)** | -+-------+----------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Dictionary` from **)** | -+-------+----------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Object` from **)** | -+-------+----------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`RID` from **)** | -+-------+----------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`NodePath` from **)** | -+-------+----------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Color` from **)** | -+-------+----------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Transform` from **)** | -+-------+----------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Basis` from **)** | -+-------+----------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Rect3` from **)** | -+-------+----------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Quat` from **)** | -+-------+----------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Plane` from **)** | -+-------+----------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Transform2D` from **)** | -+-------+----------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Vector3` from **)** | -+-------+----------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Rect2` from **)** | -+-------+----------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Vector2` from **)** | -+-------+----------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`String` from **)** | -+-------+----------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`float` from **)** | -+-------+----------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`int` from **)** | -+-------+----------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`bool` from **)** | -+-------+----------------------------------------------------------------------------------------------+ ++-------+--------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`PoolColorArray` from **)** | ++-------+--------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`PoolVector3Array` from **)** | ++-------+--------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`PoolVector2Array` from **)** | ++-------+--------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`PoolStringArray` from **)** | ++-------+--------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`PoolRealArray` from **)** | ++-------+--------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`PoolIntArray` from **)** | ++-------+--------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`PoolByteArray` from **)** | ++-------+--------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`Array` from **)** | ++-------+--------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`Dictionary` from **)** | ++-------+--------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`Object` from **)** | ++-------+--------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`RID` from **)** | ++-------+--------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`NodePath` from **)** | ++-------+--------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`Color` from **)** | ++-------+--------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`Transform` from **)** | ++-------+--------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`Basis` from **)** | ++-------+--------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`Rect3` from **)** | ++-------+--------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`Quat` from **)** | ++-------+--------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`Plane` from **)** | ++-------+--------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`Transform2D` from **)** | ++-------+--------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`Vector3` from **)** | ++-------+--------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`Rect2` from **)** | ++-------+--------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`Vector2` from **)** | ++-------+--------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`String` from **)** | ++-------+--------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`float` from **)** | ++-------+--------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`int` from **)** | ++-------+--------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`bool` from **)** | ++-------+--------------------------------------------------------------------------------------------+ Member Function Description --------------------------- .. _class_Nil_Nil: -- void **Nil** **(** :ref:`PoolColorArray` from **)** +- void **Nil** **(** :ref:`PoolColorArray` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`PoolVector3Array` from **)** +- void **Nil** **(** :ref:`PoolVector3Array` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`PoolVector2Array` from **)** +- void **Nil** **(** :ref:`PoolVector2Array` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`PoolStringArray` from **)** +- void **Nil** **(** :ref:`PoolStringArray` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`PoolRealArray` from **)** +- void **Nil** **(** :ref:`PoolRealArray` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`PoolIntArray` from **)** +- void **Nil** **(** :ref:`PoolIntArray` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`PoolByteArray` from **)** +- void **Nil** **(** :ref:`PoolByteArray` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`Array` from **)** +- void **Nil** **(** :ref:`Array` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`Dictionary` from **)** +- void **Nil** **(** :ref:`Dictionary` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`Object` from **)** +- void **Nil** **(** :ref:`Object` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`RID` from **)** +- void **Nil** **(** :ref:`RID` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`NodePath` from **)** +- void **Nil** **(** :ref:`NodePath` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`Color` from **)** +- void **Nil** **(** :ref:`Color` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`Transform` from **)** +- void **Nil** **(** :ref:`Transform` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`Basis` from **)** +- void **Nil** **(** :ref:`Basis` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`Rect3` from **)** +- void **Nil** **(** :ref:`Rect3` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`Quat` from **)** +- void **Nil** **(** :ref:`Quat` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`Plane` from **)** +- void **Nil** **(** :ref:`Plane` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`Transform2D` from **)** +- void **Nil** **(** :ref:`Transform2D` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`Vector3` from **)** +- void **Nil** **(** :ref:`Vector3` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`Rect2` from **)** +- void **Nil** **(** :ref:`Rect2` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`Vector2` from **)** +- void **Nil** **(** :ref:`Vector2` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`String` from **)** +- void **Nil** **(** :ref:`String` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`float` from **)** +- void **Nil** **(** :ref:`float` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`int` from **)** +- void **Nil** **(** :ref:`int` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`bool` from **)** +- void **Nil** **(** :ref:`bool` from **)** diff --git a/classes/class_ninepatchrect.rst b/classes/class_ninepatchrect.rst index 599b352c2..d09b1590c 100644 --- a/classes/class_ninepatchrect.rst +++ b/classes/class_ninepatchrect.rst @@ -19,38 +19,38 @@ Scalable texture-based frame that tiles the texture's centers and sides, but kee Member Functions ---------------- -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_h_axis_stretch_mode` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_patch_margin` **(** :ref:`int` margin **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_region_rect` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_texture` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_v_axis_stretch_mode` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_draw_center_enabled` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_draw_center` **(** :ref:`bool` draw_center **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_h_axis_stretch_mode` **(** :ref:`int` mode **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_patch_margin` **(** :ref:`int` margin, :ref:`int` value **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_region_rect` **(** :ref:`Rect2` rect **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture` **(** :ref:`Texture` texture **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_v_axis_stretch_mode` **(** :ref:`int` mode **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_h_axis_stretch_mode` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_patch_margin` **(** :ref:`int` margin **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_region_rect` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_texture` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_v_axis_stretch_mode` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_draw_center_enabled` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_draw_center` **(** :ref:`bool` draw_center **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_h_axis_stretch_mode` **(** :ref:`int` mode **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_patch_margin` **(** :ref:`int` margin, :ref:`int` value **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_region_rect` **(** :ref:`Rect2` rect **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_texture` **(** :ref:`Texture` texture **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_v_axis_stretch_mode` **(** :ref:`int` mode **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_NinePatchRect_texture_changed: -- **texture_changed** **(** **)** +- **texture_changed** **(** **)** Fired when the node's texture changes. @@ -112,50 +112,50 @@ Member Function Description .. _class_NinePatchRect_get_h_axis_stretch_mode: -- :ref:`int` **get_h_axis_stretch_mode** **(** **)** const +- :ref:`int` **get_h_axis_stretch_mode** **(** **)** const .. _class_NinePatchRect_get_patch_margin: -- :ref:`int` **get_patch_margin** **(** :ref:`int` margin **)** const +- :ref:`int` **get_patch_margin** **(** :ref:`int` margin **)** const .. _class_NinePatchRect_get_region_rect: -- :ref:`Rect2` **get_region_rect** **(** **)** const +- :ref:`Rect2` **get_region_rect** **(** **)** const .. _class_NinePatchRect_get_texture: -- :ref:`Texture` **get_texture** **(** **)** const +- :ref:`Texture` **get_texture** **(** **)** const .. _class_NinePatchRect_get_v_axis_stretch_mode: -- :ref:`int` **get_v_axis_stretch_mode** **(** **)** const +- :ref:`int` **get_v_axis_stretch_mode** **(** **)** const .. _class_NinePatchRect_is_draw_center_enabled: -- :ref:`bool` **is_draw_center_enabled** **(** **)** const +- :ref:`bool` **is_draw_center_enabled** **(** **)** const .. _class_NinePatchRect_set_draw_center: -- void **set_draw_center** **(** :ref:`bool` draw_center **)** +- void **set_draw_center** **(** :ref:`bool` draw_center **)** .. _class_NinePatchRect_set_h_axis_stretch_mode: -- void **set_h_axis_stretch_mode** **(** :ref:`int` mode **)** +- void **set_h_axis_stretch_mode** **(** :ref:`int` mode **)** .. _class_NinePatchRect_set_patch_margin: -- void **set_patch_margin** **(** :ref:`int` margin, :ref:`int` value **)** +- void **set_patch_margin** **(** :ref:`int` margin, :ref:`int` value **)** .. _class_NinePatchRect_set_region_rect: -- void **set_region_rect** **(** :ref:`Rect2` rect **)** +- void **set_region_rect** **(** :ref:`Rect2` rect **)** .. _class_NinePatchRect_set_texture: -- void **set_texture** **(** :ref:`Texture` texture **)** +- void **set_texture** **(** :ref:`Texture` texture **)** .. _class_NinePatchRect_set_v_axis_stretch_mode: -- void **set_v_axis_stretch_mode** **(** :ref:`int` mode **)** +- void **set_v_axis_stretch_mode** **(** :ref:`int` mode **)** diff --git a/classes/class_node.rst b/classes/class_node.rst index 9b919d41c..55cb00357 100644 --- a/classes/class_node.rst +++ b/classes/class_node.rst @@ -21,198 +21,198 @@ Base class for all the *scene* elements. Member Functions ---------------- -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_enter_tree` **(** **)** virtual | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_exit_tree` **(** **)** virtual | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_input` **(** :ref:`InputEvent` event **)** virtual | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_physics_process` **(** :ref:`float` delta **)** virtual | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_process` **(** :ref:`float` delta **)** virtual | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_ready` **(** **)** virtual | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_unhandled_input` **(** :ref:`InputEvent` event **)** virtual | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_unhandled_key_input` **(** :ref:`InputEventKey` event **)** virtual | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_child` **(** :ref:`Node` node, :ref:`bool` legible_unique_name=false **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_child_below_node` **(** :ref:`Node` node, :ref:`Node` child_node, :ref:`bool` legible_unique_name=false **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_to_group` **(** :ref:`String` group, :ref:`bool` persistent=false **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_process` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`duplicate` **(** :ref:`int` flags=15 **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`find_node` **(** :ref:`String` mask, :ref:`bool` recursive=true, :ref:`bool` owned=true **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_child` **(** :ref:`int` idx **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_child_count` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_children` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_filename` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_groups` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_index` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_name` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_network_master` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_node` **(** :ref:`NodePath` path **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_node_and_resource` **(** :ref:`NodePath` path **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_owner` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_parent` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_path` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_path_to` **(** :ref:`Node` node **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_pause_mode` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_physics_process_delta_time` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_position_in_parent` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_process_delta_time` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_scene_instance_load_placeholder` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`SceneTree` | :ref:`get_tree` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Viewport` | :ref:`get_viewport` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_node` **(** :ref:`NodePath` path **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_node_and_resource` **(** :ref:`NodePath` path **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_a_parent_of` **(** :ref:`Node` node **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_displayed_folded` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_greater_than` **(** :ref:`Node` node **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_in_group` **(** :ref:`String` group **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_inside_tree` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_network_master` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_physics_processing` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_physics_processing_internal` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_processing` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_processing_input` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_processing_internal` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_processing_unhandled_input` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_processing_unhandled_key_input` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`move_child` **(** :ref:`Node` child_node, :ref:`int` to_position **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`print_stray_nodes` **(** **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`print_tree` **(** **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`propagate_call` **(** :ref:`String` method, :ref:`Array` args=[ ], :ref:`bool` parent_first=false **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`propagate_notification` **(** :ref:`int` what **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`queue_free` **(** **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`raise` **(** **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_and_skip` **(** **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_child` **(** :ref:`Node` node **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_from_group` **(** :ref:`String` group **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`replace_by` **(** :ref:`Node` node, :ref:`bool` keep_data=false **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`request_ready` **(** **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`rpc` **(** :ref:`String` method **)** vararg | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rpc_config` **(** :ref:`String` method, :ref:`int` mode **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`rpc_id` **(** :ref:`int` peer_id, :ref:`String` method **)** vararg | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`rpc_unreliable` **(** :ref:`String` method **)** vararg | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`rpc_unreliable_id` **(** :ref:`int` peer_id, :ref:`String` method **)** vararg | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rset` **(** :ref:`String` property, :ref:`Variant` value **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rset_config` **(** :ref:`String` property, :ref:`int` mode **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rset_id` **(** :ref:`int` peer_id, :ref:`String` property, :ref:`Variant` value **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rset_unreliable` **(** :ref:`String` property, :ref:`Variant` value **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rset_unreliable_id` **(** :ref:`int` peer_id, :ref:`String` property, :ref:`Variant` value **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_display_folded` **(** :ref:`bool` fold **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_filename` **(** :ref:`String` filename **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_name` **(** :ref:`String` name **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_network_master` **(** :ref:`int` id, :ref:`bool` recursive=true **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_owner` **(** :ref:`Node` owner **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pause_mode` **(** :ref:`int` mode **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_physics_process` **(** :ref:`bool` enable **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_physics_process_internal` **(** :ref:`bool` enable **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_process` **(** :ref:`bool` enable **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_process_input` **(** :ref:`bool` enable **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_process_internal` **(** :ref:`bool` enable **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_process_unhandled_input` **(** :ref:`bool` enable **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_process_unhandled_key_input` **(** :ref:`bool` enable **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_scene_instance_load_placeholder` **(** :ref:`bool` load_placeholder **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_enter_tree` **(** **)** virtual | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_exit_tree` **(** **)** virtual | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_input` **(** :ref:`InputEvent` event **)** virtual | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_physics_process` **(** :ref:`float` delta **)** virtual | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_process` **(** :ref:`float` delta **)** virtual | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_ready` **(** **)** virtual | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_unhandled_input` **(** :ref:`InputEvent` event **)** virtual | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_unhandled_key_input` **(** :ref:`InputEventKey` event **)** virtual | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_child` **(** :ref:`Node` node, :ref:`bool` legible_unique_name=false **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_child_below_node` **(** :ref:`Node` node, :ref:`Node` child_node, :ref:`bool` legible_unique_name=false **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_to_group` **(** :ref:`String` group, :ref:`bool` persistent=false **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_process` **(** **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`duplicate` **(** :ref:`int` flags=15 **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`find_node` **(** :ref:`String` mask, :ref:`bool` recursive=true, :ref:`bool` owned=true **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`get_child` **(** :ref:`int` idx **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_child_count` **(** **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_children` **(** **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_filename` **(** **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_groups` **(** **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_index` **(** **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_name` **(** **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_network_master` **(** **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`get_node` **(** :ref:`NodePath` path **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_node_and_resource` **(** :ref:`NodePath` path **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`get_owner` **(** **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`get_parent` **(** **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_path` **(** **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_path_to` **(** :ref:`Node` node **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_pause_mode` **(** **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_physics_process_delta_time` **(** **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_position_in_parent` **(** **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_process_delta_time` **(** **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_scene_instance_load_placeholder` **(** **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`SceneTree` | :ref:`get_tree` **(** **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Viewport` | :ref:`get_viewport` **(** **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_node` **(** :ref:`NodePath` path **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_node_and_resource` **(** :ref:`NodePath` path **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_a_parent_of` **(** :ref:`Node` node **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_displayed_folded` **(** **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_greater_than` **(** :ref:`Node` node **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_in_group` **(** :ref:`String` group **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_inside_tree` **(** **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_network_master` **(** **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_physics_processing` **(** **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_physics_processing_internal` **(** **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_processing` **(** **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_processing_input` **(** **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_processing_internal` **(** **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_processing_unhandled_input` **(** **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_processing_unhandled_key_input` **(** **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`move_child` **(** :ref:`Node` child_node, :ref:`int` to_position **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`print_stray_nodes` **(** **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`print_tree` **(** **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`propagate_call` **(** :ref:`String` method, :ref:`Array` args=[ ], :ref:`bool` parent_first=false **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`propagate_notification` **(** :ref:`int` what **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`queue_free` **(** **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`raise` **(** **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_and_skip` **(** **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_child` **(** :ref:`Node` node **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_from_group` **(** :ref:`String` group **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`replace_by` **(** :ref:`Node` node, :ref:`bool` keep_data=false **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`request_ready` **(** **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`rpc` **(** :ref:`String` method **)** vararg | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rpc_config` **(** :ref:`String` method, :ref:`int` mode **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`rpc_id` **(** :ref:`int` peer_id, :ref:`String` method **)** vararg | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`rpc_unreliable` **(** :ref:`String` method **)** vararg | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`rpc_unreliable_id` **(** :ref:`int` peer_id, :ref:`String` method **)** vararg | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rset` **(** :ref:`String` property, :ref:`Variant` value **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rset_config` **(** :ref:`String` property, :ref:`int` mode **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rset_id` **(** :ref:`int` peer_id, :ref:`String` property, :ref:`Variant` value **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rset_unreliable` **(** :ref:`String` property, :ref:`Variant` value **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rset_unreliable_id` **(** :ref:`int` peer_id, :ref:`String` property, :ref:`Variant` value **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_display_folded` **(** :ref:`bool` fold **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_filename` **(** :ref:`String` filename **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_name` **(** :ref:`String` name **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_network_master` **(** :ref:`int` id, :ref:`bool` recursive=true **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_owner` **(** :ref:`Node` owner **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pause_mode` **(** :ref:`int` mode **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_physics_process` **(** :ref:`bool` enable **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_physics_process_internal` **(** :ref:`bool` enable **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_process` **(** :ref:`bool` enable **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_process_input` **(** :ref:`bool` enable **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_process_internal` **(** :ref:`bool` enable **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_process_unhandled_input` **(** :ref:`bool` enable **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_process_unhandled_key_input` **(** :ref:`bool` enable **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_scene_instance_load_placeholder` **(** :ref:`bool` load_placeholder **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_Node_renamed: -- **renamed** **(** **)** +- **renamed** **(** **)** Emitted when the node is renamed. .. _class_Node_tree_entered: -- **tree_entered** **(** **)** +- **tree_entered** **(** **)** Emitted when Node enters the tree. .. _class_Node_tree_exited: -- **tree_exited** **(** **)** +- **tree_exited** **(** **)** Emitted when Node exits the tree. @@ -294,7 +294,7 @@ Member Function Description .. _class_Node__enter_tree: -- void **_enter_tree** **(** **)** virtual +- void **_enter_tree** **(** **)** virtual Called when the node enters the :ref:`SceneTree` (e.g. upon instancing, scene changing or after calling :ref:`add_child` in a script). If the node has children, its :ref:`_enter_tree` callback will be called first, and then that of the children. @@ -302,7 +302,7 @@ Corresponds to the NOTIFICATION_ENTER_TREE notification in :ref:`Object._notific .. _class_Node__exit_tree: -- void **_exit_tree** **(** **)** virtual +- void **_exit_tree** **(** **)** virtual Called when the node leaves the :ref:`SceneTree` (e.g. upon freeing, scene changing or after calling :ref:`remove_child` in a script). If the node has children, its :ref:`_exit_tree` callback will be called last, after all its children have left the tree. @@ -310,13 +310,13 @@ Corresponds to the NOTIFICATION_EXIT_TREE notification in :ref:`Object._notifica .. _class_Node__input: -- void **_input** **(** :ref:`InputEvent` event **)** virtual +- void **_input** **(** :ref:`InputEvent` event **)** virtual Called when there is a change to input devices. Propagated through the node tree until a Node consumes it. .. _class_Node__physics_process: -- void **_physics_process** **(** :ref:`float` delta **)** virtual +- void **_physics_process** **(** :ref:`float` delta **)** virtual Called during the physics processing step of the main loop. Physics processing means that the frame rate is synced to the physics, i.e. the ``delta`` variable should be constant. @@ -326,7 +326,7 @@ Corresponds to the NOTIFICATION_PHYSICS_PROCESS notification in :ref:`Object._no .. _class_Node__process: -- void **_process** **(** :ref:`float` delta **)** virtual +- void **_process** **(** :ref:`float` delta **)** virtual Called during the processing step of the main loop. Processing happens at every frame and as fast as possible, so the ``delta`` time since the previous frame is not constant. @@ -336,7 +336,7 @@ Corresponds to the NOTIFICATION_PROCESS notification in :ref:`Object._notificati .. _class_Node__ready: -- void **_ready** **(** **)** virtual +- void **_ready** **(** **)** virtual Called when the node is "ready", i.e. when both the node and its children have entered the scene tree. If the node has children, their :ref:`_ready` callback gets triggered first, and the node will receive the ready notification only afterwards. @@ -344,17 +344,17 @@ Corresponds to the NOTIFICATION_READY notification in :ref:`Object._notification .. _class_Node__unhandled_input: -- void **_unhandled_input** **(** :ref:`InputEvent` event **)** virtual +- void **_unhandled_input** **(** :ref:`InputEvent` event **)** virtual Propagated to all nodes when the previous InputEvent is not consumed by any nodes. .. _class_Node__unhandled_key_input: -- void **_unhandled_key_input** **(** :ref:`InputEventKey` event **)** virtual +- void **_unhandled_key_input** **(** :ref:`InputEventKey` event **)** virtual .. _class_Node_add_child: -- void **add_child** **(** :ref:`Node` node, :ref:`bool` legible_unique_name=false **)** +- void **add_child** **(** :ref:`Node` node, :ref:`bool` legible_unique_name=false **)** Add a child :ref:`Node`. Nodes can have as many children as they want, but every child must have a unique name. Children nodes are automatically deleted when the parent node is deleted, so deleting a whole scene is performed by deleting its topmost node. @@ -362,23 +362,23 @@ The optional boolean argument enforces creating child nodes with human-readable .. _class_Node_add_child_below_node: -- void **add_child_below_node** **(** :ref:`Node` node, :ref:`Node` child_node, :ref:`bool` legible_unique_name=false **)** +- void **add_child_below_node** **(** :ref:`Node` node, :ref:`Node` child_node, :ref:`bool` legible_unique_name=false **)** .. _class_Node_add_to_group: -- void **add_to_group** **(** :ref:`String` group, :ref:`bool` persistent=false **)** +- void **add_to_group** **(** :ref:`String` group, :ref:`bool` persistent=false **)** Add a node to a group. Groups are helpers to name and organize a subset of nodes, like for example "enemies" or "collectables". A :ref:`Node` can be in any number of groups. Nodes can be assigned a group at any time, but will not be added to it until they are inside the scene tree (see :ref:`is_inside_tree`). .. _class_Node_can_process: -- :ref:`bool` **can_process** **(** **)** const +- :ref:`bool` **can_process** **(** **)** const Return true if the node can process, i.e. whether its pause mode allows processing while the scene tree is paused (see :ref:`set_pause_mode`). Always returns true if the scene tree is not paused, and false if the node is not in the tree. FIXME: Why FAIL_COND? .. _class_Node_duplicate: -- :ref:`Node` **duplicate** **(** :ref:`int` flags=15 **)** const +- :ref:`Node` **duplicate** **(** :ref:`int` flags=15 **)** const Duplicate the node, returning a new :ref:`Node`. @@ -386,59 +386,59 @@ You can fine-tune the behavior using the ``flags``, which are based on the DUPLI .. _class_Node_find_node: -- :ref:`Node` **find_node** **(** :ref:`String` mask, :ref:`bool` recursive=true, :ref:`bool` owned=true **)** const +- :ref:`Node` **find_node** **(** :ref:`String` mask, :ref:`bool` recursive=true, :ref:`bool` owned=true **)** const Find a descendant of this node whose name matches ``mask`` as in :ref:`String.match` (i.e. case sensitive, but '\*' matches zero or more characters and '?' matches any single character except '.'). Note that it does not match against the full path, just against individual node names. .. _class_Node_get_child: -- :ref:`Node` **get_child** **(** :ref:`int` idx **)** const +- :ref:`Node` **get_child** **(** :ref:`int` idx **)** const Return a child node by its index (see :ref:`get_child_count`). This method is often used for iterating all children of a node. .. _class_Node_get_child_count: -- :ref:`int` **get_child_count** **(** **)** const +- :ref:`int` **get_child_count** **(** **)** const Return the amount of child nodes. .. _class_Node_get_children: -- :ref:`Array` **get_children** **(** **)** const +- :ref:`Array` **get_children** **(** **)** const Return an array of references (:ref:`Node`) to the child nodes. .. _class_Node_get_filename: -- :ref:`String` **get_filename** **(** **)** const +- :ref:`String` **get_filename** **(** **)** const Return a filename that may be contained by the node. When a scene is instanced from a file, it topmost node contains the filename from where it was loaded (see :ref:`set_filename`). .. _class_Node_get_groups: -- :ref:`Array` **get_groups** **(** **)** const +- :ref:`Array` **get_groups** **(** **)** const Return an array listing the groups that the node is part of. .. _class_Node_get_index: -- :ref:`int` **get_index** **(** **)** const +- :ref:`int` **get_index** **(** **)** const Get the node index, i.e. its position among the siblings of its parent. .. _class_Node_get_name: -- :ref:`String` **get_name** **(** **)** const +- :ref:`String` **get_name** **(** **)** const Return the name of the node. This name is unique among the siblings (other child nodes from the same parent). .. _class_Node_get_network_master: -- :ref:`int` **get_network_master** **(** **)** const +- :ref:`int` **get_network_master** **(** **)** const .. _class_Node_get_node: -- :ref:`Node` **get_node** **(** :ref:`NodePath` path **)** const +- :ref:`Node` **get_node** **(** :ref:`NodePath` path **)** const Fetch a node. The :ref:`NodePath` must be valid (or else an error will be raised) and can be either the path to child node, a relative path (from the current node to another node), or an absolute path to a node. @@ -468,348 +468,348 @@ Possible paths are: .. _class_Node_get_node_and_resource: -- :ref:`Array` **get_node_and_resource** **(** :ref:`NodePath` path **)** +- :ref:`Array` **get_node_and_resource** **(** :ref:`NodePath` path **)** .. _class_Node_get_owner: -- :ref:`Node` **get_owner** **(** **)** const +- :ref:`Node` **get_owner** **(** **)** const Get the node owner (see :ref:`set_owner`). .. _class_Node_get_parent: -- :ref:`Node` **get_parent** **(** **)** const +- :ref:`Node` **get_parent** **(** **)** const Return the parent node of the current node, or an empty :ref:`Node` if the node lacks a parent. .. _class_Node_get_path: -- :ref:`NodePath` **get_path** **(** **)** const +- :ref:`NodePath` **get_path** **(** **)** const Return the absolute path of the current node. This only works if the current node is inside the scene tree (see :ref:`is_inside_tree`). .. _class_Node_get_path_to: -- :ref:`NodePath` **get_path_to** **(** :ref:`Node` node **)** const +- :ref:`NodePath` **get_path_to** **(** :ref:`Node` node **)** const Return the relative path from the current node to the specified node in "node" argument. Both nodes must be in the same scene, or else the function will fail. .. _class_Node_get_pause_mode: -- :ref:`int` **get_pause_mode** **(** **)** const +- :ref:`int` **get_pause_mode** **(** **)** const Return the pause mode (PAUSE_MODE\_\*) of this Node. .. _class_Node_get_physics_process_delta_time: -- :ref:`float` **get_physics_process_delta_time** **(** **)** const +- :ref:`float` **get_physics_process_delta_time** **(** **)** const Return the time elapsed since the last physics-bound frame (see :ref:`_physics_process`). This is always a constant value in physics processing unless the frames per second is changed in :ref:`OS`. .. _class_Node_get_position_in_parent: -- :ref:`int` **get_position_in_parent** **(** **)** const +- :ref:`int` **get_position_in_parent** **(** **)** const Return the order in the node tree branch, i.e. if called by the first child Node, return 0. .. _class_Node_get_process_delta_time: -- :ref:`float` **get_process_delta_time** **(** **)** const +- :ref:`float` **get_process_delta_time** **(** **)** const Return the time elapsed (in seconds) since the last process callback. This is almost always different each time. .. _class_Node_get_scene_instance_load_placeholder: -- :ref:`bool` **get_scene_instance_load_placeholder** **(** **)** const +- :ref:`bool` **get_scene_instance_load_placeholder** **(** **)** const .. _class_Node_get_tree: -- :ref:`SceneTree` **get_tree** **(** **)** const +- :ref:`SceneTree` **get_tree** **(** **)** const Return a :ref:`SceneTree` that this node is inside. .. _class_Node_get_viewport: -- :ref:`Viewport` **get_viewport** **(** **)** const +- :ref:`Viewport` **get_viewport** **(** **)** const .. _class_Node_has_node: -- :ref:`bool` **has_node** **(** :ref:`NodePath` path **)** const +- :ref:`bool` **has_node** **(** :ref:`NodePath` path **)** const Return whether the node that a given :ref:`NodePath` points too exists. .. _class_Node_has_node_and_resource: -- :ref:`bool` **has_node_and_resource** **(** :ref:`NodePath` path **)** const +- :ref:`bool` **has_node_and_resource** **(** :ref:`NodePath` path **)** const .. _class_Node_is_a_parent_of: -- :ref:`bool` **is_a_parent_of** **(** :ref:`Node` node **)** const +- :ref:`bool` **is_a_parent_of** **(** :ref:`Node` node **)** const Return *true* if the "node" argument is a direct or indirect child of the current node, otherwise return *false*. .. _class_Node_is_displayed_folded: -- :ref:`bool` **is_displayed_folded** **(** **)** const +- :ref:`bool` **is_displayed_folded** **(** **)** const .. _class_Node_is_greater_than: -- :ref:`bool` **is_greater_than** **(** :ref:`Node` node **)** const +- :ref:`bool` **is_greater_than** **(** :ref:`Node` node **)** const Return *true* if "node" occurs later in the scene hierarchy than the current node, otherwise return *false*. .. _class_Node_is_in_group: -- :ref:`bool` **is_in_group** **(** :ref:`String` group **)** const +- :ref:`bool` **is_in_group** **(** :ref:`String` group **)** const Return whether this Node is in the specified group. .. _class_Node_is_inside_tree: -- :ref:`bool` **is_inside_tree** **(** **)** const +- :ref:`bool` **is_inside_tree** **(** **)** const Return whether this Node is inside a :ref:`SceneTree`. .. _class_Node_is_network_master: -- :ref:`bool` **is_network_master** **(** **)** const +- :ref:`bool` **is_network_master** **(** **)** const .. _class_Node_is_physics_processing: -- :ref:`bool` **is_physics_processing** **(** **)** const +- :ref:`bool` **is_physics_processing** **(** **)** const Return true if physics processing is enabled (see :ref:`set_physics_process`). .. _class_Node_is_physics_processing_internal: -- :ref:`bool` **is_physics_processing_internal** **(** **)** const +- :ref:`bool` **is_physics_processing_internal** **(** **)** const .. _class_Node_is_processing: -- :ref:`bool` **is_processing** **(** **)** const +- :ref:`bool` **is_processing** **(** **)** const Return whether processing is enabled in the current node (see :ref:`set_process`). .. _class_Node_is_processing_input: -- :ref:`bool` **is_processing_input** **(** **)** const +- :ref:`bool` **is_processing_input** **(** **)** const Return true if the node is processing input (see :ref:`set_process_input`). .. _class_Node_is_processing_internal: -- :ref:`bool` **is_processing_internal** **(** **)** const +- :ref:`bool` **is_processing_internal** **(** **)** const .. _class_Node_is_processing_unhandled_input: -- :ref:`bool` **is_processing_unhandled_input** **(** **)** const +- :ref:`bool` **is_processing_unhandled_input** **(** **)** const Return true if the node is processing unhandled input (see :ref:`set_process_unhandled_input`). .. _class_Node_is_processing_unhandled_key_input: -- :ref:`bool` **is_processing_unhandled_key_input** **(** **)** const +- :ref:`bool` **is_processing_unhandled_key_input** **(** **)** const .. _class_Node_move_child: -- void **move_child** **(** :ref:`Node` child_node, :ref:`int` to_position **)** +- void **move_child** **(** :ref:`Node` child_node, :ref:`int` to_position **)** Move a child node to a different position (order) amongst the other children. Since calls, signals, etc are performed by tree order, changing the order of children nodes may be useful. .. _class_Node_print_stray_nodes: -- void **print_stray_nodes** **(** **)** +- void **print_stray_nodes** **(** **)** .. _class_Node_print_tree: -- void **print_tree** **(** **)** +- void **print_tree** **(** **)** Print the scene to stdout. Used mainly for debugging purposes. .. _class_Node_propagate_call: -- void **propagate_call** **(** :ref:`String` method, :ref:`Array` args=[ ], :ref:`bool` parent_first=false **)** +- void **propagate_call** **(** :ref:`String` method, :ref:`Array` args=[ ], :ref:`bool` parent_first=false **)** Calls the method (if present) with the arguments given in "args" on this Node and recursively on all children. If the parent_first argument is true then the method will be called on the current :ref:`Node` first, then on all children. If it is false then the children will get called first. .. _class_Node_propagate_notification: -- void **propagate_notification** **(** :ref:`int` what **)** +- void **propagate_notification** **(** :ref:`int` what **)** Notify the current node and all its children recursively by calling notification() in all of them. .. _class_Node_queue_free: -- void **queue_free** **(** **)** +- void **queue_free** **(** **)** Queues a node for deletion at the end of the current frame. When deleted, all of its children nodes will be deleted as well. This method ensures it's safe to delete the node, contrary to :ref:`Object.free`. Use :ref:`Object.is_queued_for_deletion` to know whether a node will be deleted at the end of the frame. .. _class_Node_raise: -- void **raise** **(** **)** +- void **raise** **(** **)** Move this node to the top of the array of nodes of the parent node. This is often useful on GUIs (:ref:`Control`), because their order of drawing fully depends on their order in the tree. .. _class_Node_remove_and_skip: -- void **remove_and_skip** **(** **)** +- void **remove_and_skip** **(** **)** Remove a node and set all its children as children of the parent node (if exists). All even subscriptions that pass by the removed node will be unsubscribed. .. _class_Node_remove_child: -- void **remove_child** **(** :ref:`Node` node **)** +- void **remove_child** **(** :ref:`Node` node **)** Remove a child :ref:`Node`. Node is NOT deleted and will have to be deleted manually. .. _class_Node_remove_from_group: -- void **remove_from_group** **(** :ref:`String` group **)** +- void **remove_from_group** **(** :ref:`String` group **)** Remove a node from a group. .. _class_Node_replace_by: -- void **replace_by** **(** :ref:`Node` node, :ref:`bool` keep_data=false **)** +- void **replace_by** **(** :ref:`Node` node, :ref:`bool` keep_data=false **)** Replace a node in a scene by a given one. Subscriptions that pass through this node will be lost. .. _class_Node_request_ready: -- void **request_ready** **(** **)** +- void **request_ready** **(** **)** Request that ``_ready`` be called again. .. _class_Node_rpc: -- :ref:`Variant` **rpc** **(** :ref:`String` method **)** vararg +- :ref:`Variant` **rpc** **(** :ref:`String` method **)** vararg Send a remote procedure call request to all peers on the network (and locally), optionally sending additional data as arguments. Call request will be received by nodes with the same :ref:`NodePath`. .. _class_Node_rpc_config: -- void **rpc_config** **(** :ref:`String` method, :ref:`int` mode **)** +- void **rpc_config** **(** :ref:`String` method, :ref:`int` mode **)** Change the method's RPC mode (one of RPC_MODE\_\* constants). .. _class_Node_rpc_id: -- :ref:`Variant` **rpc_id** **(** :ref:`int` peer_id, :ref:`String` method **)** vararg +- :ref:`Variant` **rpc_id** **(** :ref:`int` peer_id, :ref:`String` method **)** vararg Send a :ref:`rpc` to a specific peer identified by *peer_id*. .. _class_Node_rpc_unreliable: -- :ref:`Variant` **rpc_unreliable** **(** :ref:`String` method **)** vararg +- :ref:`Variant` **rpc_unreliable** **(** :ref:`String` method **)** vararg Send a :ref:`rpc` using an unreliable protocol. .. _class_Node_rpc_unreliable_id: -- :ref:`Variant` **rpc_unreliable_id** **(** :ref:`int` peer_id, :ref:`String` method **)** vararg +- :ref:`Variant` **rpc_unreliable_id** **(** :ref:`int` peer_id, :ref:`String` method **)** vararg Send a :ref:`rpc` to a specific peer identified by *peer_id* using an unreliable protocol. .. _class_Node_rset: -- void **rset** **(** :ref:`String` property, :ref:`Variant` value **)** +- void **rset** **(** :ref:`String` property, :ref:`Variant` value **)** Remotely change property's value on other peers (and locally). .. _class_Node_rset_config: -- void **rset_config** **(** :ref:`String` property, :ref:`int` mode **)** +- void **rset_config** **(** :ref:`String` property, :ref:`int` mode **)** Change the property's RPC mode (one of RPC_MODE\_\* constants). .. _class_Node_rset_id: -- void **rset_id** **(** :ref:`int` peer_id, :ref:`String` property, :ref:`Variant` value **)** +- void **rset_id** **(** :ref:`int` peer_id, :ref:`String` property, :ref:`Variant` value **)** Remotely change property's value on a specific peer identified by *peer_id*. .. _class_Node_rset_unreliable: -- void **rset_unreliable** **(** :ref:`String` property, :ref:`Variant` value **)** +- void **rset_unreliable** **(** :ref:`String` property, :ref:`Variant` value **)** Remotely change property's value on other peers (and locally) using an unreliable protocol. .. _class_Node_rset_unreliable_id: -- void **rset_unreliable_id** **(** :ref:`int` peer_id, :ref:`String` property, :ref:`Variant` value **)** +- void **rset_unreliable_id** **(** :ref:`int` peer_id, :ref:`String` property, :ref:`Variant` value **)** Remotely change property's value on a specific peer identified by *peer_id* using an unreliable protocol. .. _class_Node_set_display_folded: -- void **set_display_folded** **(** :ref:`bool` fold **)** +- void **set_display_folded** **(** :ref:`bool` fold **)** .. _class_Node_set_filename: -- void **set_filename** **(** :ref:`String` filename **)** +- void **set_filename** **(** :ref:`String` filename **)** A node can contain a filename. This filename should not be changed by the user, unless writing editors and tools. When a scene is instanced from a file, it topmost node contains the filename from where it was loaded. .. _class_Node_set_name: -- void **set_name** **(** :ref:`String` name **)** +- void **set_name** **(** :ref:`String` name **)** Set the name of the :ref:`Node`. Name must be unique within parent, and setting an already existing name will cause for the node to be automatically renamed. .. _class_Node_set_network_master: -- void **set_network_master** **(** :ref:`int` id, :ref:`bool` recursive=true **)** +- void **set_network_master** **(** :ref:`int` id, :ref:`bool` recursive=true **)** .. _class_Node_set_owner: -- void **set_owner** **(** :ref:`Node` owner **)** +- void **set_owner** **(** :ref:`Node` owner **)** Set the node owner. A node can have any other node as owner (as long as a valid parent, grandparent, etc ascending in the tree). When saving a node (using SceneSaver) all the nodes it owns will be saved with it. This allows to create complex SceneTrees, with instancing and subinstancing. .. _class_Node_set_pause_mode: -- void **set_pause_mode** **(** :ref:`int` mode **)** +- void **set_pause_mode** **(** :ref:`int` mode **)** Set pause mode (PAUSE_MODE\_\*) of this Node. .. _class_Node_set_physics_process: -- void **set_physics_process** **(** :ref:`bool` enable **)** +- void **set_physics_process** **(** :ref:`bool` enable **)** Enables or disables the node's physics (alias fixed framerate) processing. When a node is being processed, it will receive a NOTIFICATION_PHYSICS_PROCESS at a fixed (usually 60 fps, check :ref:`OS` to change that) interval (and the :ref:`_physics_process` callback will be called if exists). It is common to check how much time was elapsed since the previous frame by calling :ref:`get_physics_process_delta_time`. .. _class_Node_set_physics_process_internal: -- void **set_physics_process_internal** **(** :ref:`bool` enable **)** +- void **set_physics_process_internal** **(** :ref:`bool` enable **)** .. _class_Node_set_process: -- void **set_process** **(** :ref:`bool` enable **)** +- void **set_process** **(** :ref:`bool` enable **)** Enables or disables node processing. When a node is being processed, it will receive a NOTIFICATION_PROCESS on every drawn frame (and the :ref:`_process` callback will be called if exists). It is common to check how much time was elapsed since the previous frame by calling :ref:`get_process_delta_time`. .. _class_Node_set_process_input: -- void **set_process_input** **(** :ref:`bool` enable **)** +- void **set_process_input** **(** :ref:`bool` enable **)** Enable input processing for node. This is not required for GUI controls! It hooks up the node to receive all input (see :ref:`_input`). .. _class_Node_set_process_internal: -- void **set_process_internal** **(** :ref:`bool` enable **)** +- void **set_process_internal** **(** :ref:`bool` enable **)** .. _class_Node_set_process_unhandled_input: -- void **set_process_unhandled_input** **(** :ref:`bool` enable **)** +- void **set_process_unhandled_input** **(** :ref:`bool` enable **)** Enable unhandled input processing for node. This is not required for GUI controls! It hooks up the node to receive all input that was not previously handled before (usually by a :ref:`Control`). (see :ref:`_unhandled_input`). .. _class_Node_set_process_unhandled_key_input: -- void **set_process_unhandled_key_input** **(** :ref:`bool` enable **)** +- void **set_process_unhandled_key_input** **(** :ref:`bool` enable **)** .. _class_Node_set_scene_instance_load_placeholder: -- void **set_scene_instance_load_placeholder** **(** :ref:`bool` load_placeholder **)** +- void **set_scene_instance_load_placeholder** **(** :ref:`bool` load_placeholder **)** diff --git a/classes/class_node2d.rst b/classes/class_node2d.rst index 2e66b81ea..a21a3fdb1 100644 --- a/classes/class_node2d.rst +++ b/classes/class_node2d.rst @@ -21,75 +21,75 @@ A 2D game object, parent of all 2D related nodes. Has a position, rotation, scal Member Functions ---------------- -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`apply_scale` **(** :ref:`Vector2` ratio **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`edit_set_pivot` **(** :ref:`Vector2` pivot **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_angle_to` **(** :ref:`Vector2` point **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_global_position` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_global_rotation` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_global_rotation_in_degrees` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_global_scale` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_position` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_relative_transform_to_parent` **(** :ref:`Node` parent **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_rotation` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_rotation_in_degrees` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_scale` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_z` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`global_translate` **(** :ref:`Vector2` offset **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_z_relative` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`look_at` **(** :ref:`Vector2` point **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`move_local_x` **(** :ref:`float` delta, :ref:`bool` scaled=false **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`move_local_y` **(** :ref:`float` delta, :ref:`bool` scaled=false **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rotate` **(** :ref:`float` radians **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_global_position` **(** :ref:`Vector2` position **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_global_rotation` **(** :ref:`float` radians **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_global_rotation_in_degrees` **(** :ref:`float` degrees **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_global_scale` **(** :ref:`Vector2` scale **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_global_transform` **(** :ref:`Transform2D` xform **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_position` **(** :ref:`Vector2` position **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rotation` **(** :ref:`float` radians **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rotation_in_degrees` **(** :ref:`float` degrees **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_scale` **(** :ref:`Vector2` scale **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_transform` **(** :ref:`Transform2D` xform **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_z` **(** :ref:`int` z **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_z_as_relative` **(** :ref:`bool` enable **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`to_global` **(** :ref:`Vector2` local_point **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`to_local` **(** :ref:`Vector2` global_point **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`translate` **(** :ref:`Vector2` offset **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`apply_scale` **(** :ref:`Vector2` ratio **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`edit_set_pivot` **(** :ref:`Vector2` pivot **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_angle_to` **(** :ref:`Vector2` point **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_global_position` **(** **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_global_rotation` **(** **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_global_rotation_in_degrees` **(** **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_global_scale` **(** **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_position` **(** **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_relative_transform_to_parent` **(** :ref:`Node` parent **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_rotation` **(** **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_rotation_in_degrees` **(** **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_scale` **(** **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_z` **(** **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`global_translate` **(** :ref:`Vector2` offset **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_z_relative` **(** **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`look_at` **(** :ref:`Vector2` point **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`move_local_x` **(** :ref:`float` delta, :ref:`bool` scaled=false **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`move_local_y` **(** :ref:`float` delta, :ref:`bool` scaled=false **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rotate` **(** :ref:`float` radians **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_global_position` **(** :ref:`Vector2` position **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_global_rotation` **(** :ref:`float` radians **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_global_rotation_in_degrees` **(** :ref:`float` degrees **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_global_scale` **(** :ref:`Vector2` scale **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_global_transform` **(** :ref:`Transform2D` xform **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_position` **(** :ref:`Vector2` position **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rotation` **(** :ref:`float` radians **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rotation_in_degrees` **(** :ref:`float` degrees **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_scale` **(** :ref:`Vector2` scale **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_transform` **(** :ref:`Transform2D` xform **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_z` **(** :ref:`int` z **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_z_as_relative` **(** :ref:`bool` enable **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`to_global` **(** :ref:`Vector2` local_point **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`to_local` **(** :ref:`Vector2` global_point **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`translate` **(** :ref:`Vector2` offset **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -153,201 +153,201 @@ Member Function Description .. _class_Node2D_apply_scale: -- void **apply_scale** **(** :ref:`Vector2` ratio **)** +- void **apply_scale** **(** :ref:`Vector2` ratio **)** Multiplies the current scale by the 'ratio' vector. .. _class_Node2D_edit_set_pivot: -- void **edit_set_pivot** **(** :ref:`Vector2` pivot **)** +- void **edit_set_pivot** **(** :ref:`Vector2` pivot **)** Set the pivot position of the 2D node to 'pivot' value. Only some Node2Ds implement this method. .. _class_Node2D_get_angle_to: -- :ref:`float` **get_angle_to** **(** :ref:`Vector2` point **)** const +- :ref:`float` **get_angle_to** **(** :ref:`Vector2` point **)** const Returns the angle between the node and the 'point' in radians. .. _class_Node2D_get_global_position: -- :ref:`Vector2` **get_global_position** **(** **)** const +- :ref:`Vector2` **get_global_position** **(** **)** const Returns the node's global position. .. _class_Node2D_get_global_rotation: -- :ref:`float` **get_global_rotation** **(** **)** const +- :ref:`float` **get_global_rotation** **(** **)** const Returns the node's global rotation in radians. .. _class_Node2D_get_global_rotation_in_degrees: -- :ref:`float` **get_global_rotation_in_degrees** **(** **)** const +- :ref:`float` **get_global_rotation_in_degrees** **(** **)** const Return the node's global rotation in degrees. .. _class_Node2D_get_global_scale: -- :ref:`Vector2` **get_global_scale** **(** **)** const +- :ref:`Vector2` **get_global_scale** **(** **)** const Returns the node's global scale. .. _class_Node2D_get_position: -- :ref:`Vector2` **get_position** **(** **)** const +- :ref:`Vector2` **get_position** **(** **)** const Returns the node's position. .. _class_Node2D_get_relative_transform_to_parent: -- :ref:`Transform2D` **get_relative_transform_to_parent** **(** :ref:`Node` parent **)** const +- :ref:`Transform2D` **get_relative_transform_to_parent** **(** :ref:`Node` parent **)** const Returns the :ref:`Transform2D` relative to this node's parent. .. _class_Node2D_get_rotation: -- :ref:`float` **get_rotation** **(** **)** const +- :ref:`float` **get_rotation** **(** **)** const Returns the node's rotation in radians. .. _class_Node2D_get_rotation_in_degrees: -- :ref:`float` **get_rotation_in_degrees** **(** **)** const +- :ref:`float` **get_rotation_in_degrees** **(** **)** const Returns the node's rotation in degrees. .. _class_Node2D_get_scale: -- :ref:`Vector2` **get_scale** **(** **)** const +- :ref:`Vector2` **get_scale** **(** **)** const Returns the node's scale. .. _class_Node2D_get_z: -- :ref:`int` **get_z** **(** **)** const +- :ref:`int` **get_z** **(** **)** const Returns the node's Z-index. .. _class_Node2D_global_translate: -- void **global_translate** **(** :ref:`Vector2` offset **)** +- void **global_translate** **(** :ref:`Vector2` offset **)** Adds the 'offset' vector to the node's global position. .. _class_Node2D_is_z_relative: -- :ref:`bool` **is_z_relative** **(** **)** const +- :ref:`bool` **is_z_relative** **(** **)** const Returns true if this node's Z-index is relative to its parent's. Else, returns false. .. _class_Node2D_look_at: -- void **look_at** **(** :ref:`Vector2` point **)** +- void **look_at** **(** :ref:`Vector2` point **)** Rotates the node so it points towards the 'point'. .. _class_Node2D_move_local_x: -- void **move_local_x** **(** :ref:`float` delta, :ref:`bool` scaled=false **)** +- void **move_local_x** **(** :ref:`float` delta, :ref:`bool` scaled=false **)** Apply a local translation on the node's X axis based on the process's 'delta'. If 'scaled' is false, normalizes the movement. .. _class_Node2D_move_local_y: -- void **move_local_y** **(** :ref:`float` delta, :ref:`bool` scaled=false **)** +- void **move_local_y** **(** :ref:`float` delta, :ref:`bool` scaled=false **)** Apply a local translation on the node's Y axis based on the process's 'delta'. If 'scaled' is false, normalizes the movement. .. _class_Node2D_rotate: -- void **rotate** **(** :ref:`float` radians **)** +- void **rotate** **(** :ref:`float` radians **)** Apply a rotation to the node, in radians, starting from its current rotation. .. _class_Node2D_set_global_position: -- void **set_global_position** **(** :ref:`Vector2` position **)** +- void **set_global_position** **(** :ref:`Vector2` position **)** Set the node's global position. .. _class_Node2D_set_global_rotation: -- void **set_global_rotation** **(** :ref:`float` radians **)** +- void **set_global_rotation** **(** :ref:`float` radians **)** Set the node's global rotation in radians. .. _class_Node2D_set_global_rotation_in_degrees: -- void **set_global_rotation_in_degrees** **(** :ref:`float` degrees **)** +- void **set_global_rotation_in_degrees** **(** :ref:`float` degrees **)** Set the node's global rotation in degrees. .. _class_Node2D_set_global_scale: -- void **set_global_scale** **(** :ref:`Vector2` scale **)** +- void **set_global_scale** **(** :ref:`Vector2` scale **)** Set the node's global scale. .. _class_Node2D_set_global_transform: -- void **set_global_transform** **(** :ref:`Transform2D` xform **)** +- void **set_global_transform** **(** :ref:`Transform2D` xform **)** Set the node's global :ref:`Transform2D`. .. _class_Node2D_set_position: -- void **set_position** **(** :ref:`Vector2` position **)** +- void **set_position** **(** :ref:`Vector2` position **)** Set the node's position. .. _class_Node2D_set_rotation: -- void **set_rotation** **(** :ref:`float` radians **)** +- void **set_rotation** **(** :ref:`float` radians **)** Set the node's rotation in radians. .. _class_Node2D_set_rotation_in_degrees: -- void **set_rotation_in_degrees** **(** :ref:`float` degrees **)** +- void **set_rotation_in_degrees** **(** :ref:`float` degrees **)** Set the node's rotation in degrees. .. _class_Node2D_set_scale: -- void **set_scale** **(** :ref:`Vector2` scale **)** +- void **set_scale** **(** :ref:`Vector2` scale **)** Set the node's scale. .. _class_Node2D_set_transform: -- void **set_transform** **(** :ref:`Transform2D` xform **)** +- void **set_transform** **(** :ref:`Transform2D` xform **)** Set the node's local :ref:`Transform2D`. .. _class_Node2D_set_z: -- void **set_z** **(** :ref:`int` z **)** +- void **set_z** **(** :ref:`int` z **)** Set the node's Z-index. .. _class_Node2D_set_z_as_relative: -- void **set_z_as_relative** **(** :ref:`bool` enable **)** +- void **set_z_as_relative** **(** :ref:`bool` enable **)** Make the node's Z-index relative to its parent's Z-index. If this node's Z-index is 2 and its parent's effective Z-index is 3, then this node's effective Z-index will be 2 + 3 = 5. .. _class_Node2D_to_global: -- :ref:`Vector2` **to_global** **(** :ref:`Vector2` local_point **)** const +- :ref:`Vector2` **to_global** **(** :ref:`Vector2` local_point **)** const .. _class_Node2D_to_local: -- :ref:`Vector2` **to_local** **(** :ref:`Vector2` global_point **)** const +- :ref:`Vector2` **to_local** **(** :ref:`Vector2` global_point **)** const .. _class_Node2D_translate: -- void **translate** **(** :ref:`Vector2` offset **)** +- void **translate** **(** :ref:`Vector2` offset **)** Translate the node locally by the 'offset' vector, starting from its current local position. diff --git a/classes/class_nodepath.rst b/classes/class_nodepath.rst index e2f51ec26..cca1b0622 100644 --- a/classes/class_nodepath.rst +++ b/classes/class_nodepath.rst @@ -17,23 +17,23 @@ Pre-parsed scene tree path. Member Functions ---------------- -+----------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`NodePath` **(** :ref:`String` from **)** | -+----------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_name` **(** :ref:`int` idx **)** | -+----------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_name_count` **(** **)** | -+----------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_property` **(** **)** | -+----------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_subname` **(** :ref:`int` idx **)** | -+----------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_subname_count` **(** **)** | -+----------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_absolute` **(** **)** | -+----------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_empty` **(** **)** | -+----------------------------------+-----------------------------------------------------------------------------------------+ ++----------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`NodePath` **(** :ref:`String` from **)** | ++----------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_name` **(** :ref:`int` idx **)** | ++----------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_name_count` **(** **)** | ++----------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_property` **(** **)** | ++----------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_subname` **(** :ref:`int` idx **)** | ++----------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_subname_count` **(** **)** | ++----------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_absolute` **(** **)** | ++----------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_empty` **(** **)** | ++----------------------------------+---------------------------------------------------------------------------------------+ Description ----------- @@ -49,49 +49,49 @@ Member Function Description .. _class_NodePath_NodePath: -- :ref:`NodePath` **NodePath** **(** :ref:`String` from **)** +- :ref:`NodePath` **NodePath** **(** :ref:`String` from **)** Create a NodePath from a string, e.g. "Path2D/PathFollow2D/Sprite:texture:size". A path is absolute if it starts with a slash. Absolute paths are only valid in the global scene tree, not within individual scenes. In a relative path, ``"."`` and ``".."`` indicate the current node and its parent. .. _class_NodePath_get_name: -- :ref:`String` **get_name** **(** :ref:`int` idx **)** +- :ref:`String` **get_name** **(** :ref:`int` idx **)** Get the node name indicated by ``idx`` (0 to :ref:`get_name_count`) .. _class_NodePath_get_name_count: -- :ref:`int` **get_name_count** **(** **)** +- :ref:`int` **get_name_count** **(** **)** Get the number of node names which make up the path. .. _class_NodePath_get_property: -- :ref:`String` **get_property** **(** **)** +- :ref:`String` **get_property** **(** **)** Get the path's property name, or an empty string if the path doesn't have a property. .. _class_NodePath_get_subname: -- :ref:`String` **get_subname** **(** :ref:`int` idx **)** +- :ref:`String` **get_subname** **(** :ref:`int` idx **)** Get the resource name indicated by ``idx`` (0 to :ref:`get_subname_count`) .. _class_NodePath_get_subname_count: -- :ref:`int` **get_subname_count** **(** **)** +- :ref:`int` **get_subname_count** **(** **)** Get the number of resource names in the path. .. _class_NodePath_is_absolute: -- :ref:`bool` **is_absolute** **(** **)** +- :ref:`bool` **is_absolute** **(** **)** Return true if the node path is absolute (not relative). .. _class_NodePath_is_empty: -- :ref:`bool` **is_empty** **(** **)** +- :ref:`bool` **is_empty** **(** **)** Return true if the node path is empty. diff --git a/classes/class_object.rst b/classes/class_object.rst index 704077cad..6f6dbe0b2 100644 --- a/classes/class_object.rst +++ b/classes/class_object.rst @@ -19,94 +19,94 @@ Base class for all non built-in types. Member Functions ---------------- -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_get` **(** :ref:`String` property **)** virtual | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`_get_property_list` **(** **)** virtual | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_init` **(** **)** virtual | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_notification` **(** :ref:`int` what **)** virtual | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`_set` **(** :ref:`String` property, :ref:`Variant` value **)** virtual | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_user_signal` **(** :ref:`String` signal, :ref:`Array` arguments=[ ] **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`call` **(** :ref:`String` method **)** vararg | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`call_deferred` **(** :ref:`String` method **)** vararg | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`callv` **(** :ref:`String` method, :ref:`Array` arg_array **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_translate_messages` **(** **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`connect` **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method, :ref:`Array` binds=[ ], :ref:`int` flags=0 **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`disconnect` **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`emit_signal` **(** :ref:`String` signal **)** vararg | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`free` **(** **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get` **(** :ref:`String` property **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_class` **(** **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_incoming_connections` **(** **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_instance_id` **(** **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_meta` **(** :ref:`String` name **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_meta_list` **(** **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_method_list` **(** **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_property_list` **(** **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Reference` | :ref:`get_script` **(** **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_signal_connection_list` **(** :ref:`String` signal **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_signal_list` **(** **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_meta` **(** :ref:`String` name **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_method` **(** :ref:`String` method **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_user_signal` **(** :ref:`String` signal **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_blocking_signals` **(** **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_class` **(** :ref:`String` type **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_connected` **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_queued_for_deletion` **(** **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`notification` **(** :ref:`int` what, :ref:`bool` reversed=false **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`property_list_changed_notify` **(** **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set` **(** :ref:`String` property, :ref:`Variant` value **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_block_signals` **(** :ref:`bool` enable **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_message_translation` **(** :ref:`bool` enable **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_meta` **(** :ref:`String` name, :ref:`Variant` value **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_script` **(** :ref:`Reference` script **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`tr` **(** :ref:`String` message **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_get` **(** :ref:`String` property **)** virtual | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`_get_property_list` **(** **)** virtual | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_init` **(** **)** virtual | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_notification` **(** :ref:`int` what **)** virtual | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`_set` **(** :ref:`String` property, :ref:`Variant` value **)** virtual | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_user_signal` **(** :ref:`String` signal, :ref:`Array` arguments=[ ] **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`call` **(** :ref:`String` method **)** vararg | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`call_deferred` **(** :ref:`String` method **)** vararg | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`callv` **(** :ref:`String` method, :ref:`Array` arg_array **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_translate_messages` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`connect` **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method, :ref:`Array` binds=[ ], :ref:`int` flags=0 **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`disconnect` **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`emit_signal` **(** :ref:`String` signal **)** vararg | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`free` **(** **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get` **(** :ref:`String` property **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_class` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_incoming_connections` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_instance_id` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_meta` **(** :ref:`String` name **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_meta_list` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_method_list` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_property_list` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Reference` | :ref:`get_script` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_signal_connection_list` **(** :ref:`String` signal **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_signal_list` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_meta` **(** :ref:`String` name **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_method` **(** :ref:`String` method **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_user_signal` **(** :ref:`String` signal **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_blocking_signals` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_class` **(** :ref:`String` type **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_connected` **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_queued_for_deletion` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`notification` **(** :ref:`int` what, :ref:`bool` reversed=false **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`property_list_changed_notify` **(** **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set` **(** :ref:`String` property, :ref:`Variant` value **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_block_signals` **(** :ref:`bool` enable **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_message_translation` **(** :ref:`bool` enable **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_meta` **(** :ref:`String` name, :ref:`Variant` value **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_script` **(** :ref:`Reference` script **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`tr` **(** :ref:`String` message **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_Object_script_changed: -- **script_changed** **(** **)** +- **script_changed** **(** **)** Numeric Constants @@ -136,91 +136,91 @@ Member Function Description .. _class_Object__get: -- void **_get** **(** :ref:`String` property **)** virtual +- void **_get** **(** :ref:`String` property **)** virtual Return a property, return null if the property does not exist. .. _class_Object__get_property_list: -- :ref:`Array` **_get_property_list** **(** **)** virtual +- :ref:`Array` **_get_property_list** **(** **)** virtual Return the property list, array of dictionaries, dictionaries must contain: name:String, type:int (see TYPE\_\* enum in :ref:`@Global Scope`) and optionally: hint:int (see PROPERTY_HINT\_\* in :ref:`@Global Scope`), hint_string:String, usage:int (see PROPERTY_USAGE\_\* in :ref:`@Global Scope`). .. _class_Object__init: -- void **_init** **(** **)** virtual +- void **_init** **(** **)** virtual .. _class_Object__notification: -- void **_notification** **(** :ref:`int` what **)** virtual +- void **_notification** **(** :ref:`int` what **)** virtual Notification request, the notification id is received. .. _class_Object__set: -- :ref:`bool` **_set** **(** :ref:`String` property, :ref:`Variant` value **)** virtual +- :ref:`bool` **_set** **(** :ref:`String` property, :ref:`Variant` value **)** virtual Set a property. Return true if the property was found. .. _class_Object_add_user_signal: -- void **add_user_signal** **(** :ref:`String` signal, :ref:`Array` arguments=[ ] **)** +- void **add_user_signal** **(** :ref:`String` signal, :ref:`Array` arguments=[ ] **)** Add a user signal (can be added anytime). Arguments are optional, but can be added as an array of dictionaries, each containing "name" and "type" (from :ref:`@Global Scope` TYPE\_\*). .. _class_Object_call: -- :ref:`Variant` **call** **(** :ref:`String` method **)** vararg +- :ref:`Variant` **call** **(** :ref:`String` method **)** vararg .. _class_Object_call_deferred: -- :ref:`Variant` **call_deferred** **(** :ref:`String` method **)** vararg +- :ref:`Variant` **call_deferred** **(** :ref:`String` method **)** vararg .. _class_Object_callv: -- :ref:`Variant` **callv** **(** :ref:`String` method, :ref:`Array` arg_array **)** +- :ref:`Variant` **callv** **(** :ref:`String` method, :ref:`Array` arg_array **)** .. _class_Object_can_translate_messages: -- :ref:`bool` **can_translate_messages** **(** **)** const +- :ref:`bool` **can_translate_messages** **(** **)** const Return true if this object can translate strings. .. _class_Object_connect: -- :ref:`int` **connect** **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method, :ref:`Array` binds=[ ], :ref:`int` flags=0 **)** +- :ref:`int` **connect** **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method, :ref:`Array` binds=[ ], :ref:`int` flags=0 **)** Connect a signal to a method at a target (member function). Binds are optional and are passed as extra arguments to the call. Flags specify optional deferred or one shot connections, see enum CONNECT\_\*. A signal can only be connected once to a method, and it will throw an error if already connected. If you want to avoid this, use :ref:`is_connected` to check. .. _class_Object_disconnect: -- void **disconnect** **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method **)** +- void **disconnect** **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method **)** Disconnect a signal from a method. .. _class_Object_emit_signal: -- :ref:`Variant` **emit_signal** **(** :ref:`String` signal **)** vararg +- :ref:`Variant` **emit_signal** **(** :ref:`String` signal **)** vararg .. _class_Object_free: -- void **free** **(** **)** +- void **free** **(** **)** .. _class_Object_get: -- :ref:`Variant` **get** **(** :ref:`String` property **)** const +- :ref:`Variant` **get** **(** :ref:`String` property **)** const Get a property from the object. .. _class_Object_get_class: -- :ref:`String` **get_class** **(** **)** const +- :ref:`String` **get_class** **(** **)** const Return the class of the object as a string. .. _class_Object_get_incoming_connections: -- :ref:`Array` **get_incoming_connections** **(** **)** const +- :ref:`Array` **get_incoming_connections** **(** **)** const Returns an :ref:`Array` of dictionaries with information about signals that are connected to this object. @@ -234,127 +234,127 @@ Inside each :ref:`Dictionary` there are 3 fields: .. _class_Object_get_instance_id: -- :ref:`int` **get_instance_id** **(** **)** const +- :ref:`int` **get_instance_id** **(** **)** const Return the instance ID. All objects have a unique instance ID. .. _class_Object_get_meta: -- :ref:`Variant` **get_meta** **(** :ref:`String` name **)** const +- :ref:`Variant` **get_meta** **(** :ref:`String` name **)** const Return a metadata from the object. .. _class_Object_get_meta_list: -- :ref:`PoolStringArray` **get_meta_list** **(** **)** const +- :ref:`PoolStringArray` **get_meta_list** **(** **)** const Return the list of metadata in the object. .. _class_Object_get_method_list: -- :ref:`Array` **get_method_list** **(** **)** const +- :ref:`Array` **get_method_list** **(** **)** const .. _class_Object_get_property_list: -- :ref:`Array` **get_property_list** **(** **)** const +- :ref:`Array` **get_property_list** **(** **)** const Return the list of properties as an array of dictionaries, dictionaries contain: name:String, type:int (see TYPE\_\* enum in :ref:`@Global Scope`) and optionally: hint:int (see PROPERTY_HINT\_\* in :ref:`@Global Scope`), hint_string:String, usage:int (see PROPERTY_USAGE\_\* in :ref:`@Global Scope`). .. _class_Object_get_script: -- :ref:`Reference` **get_script** **(** **)** const +- :ref:`Reference` **get_script** **(** **)** const Return the object script (or null if it doesn't have one). .. _class_Object_get_signal_connection_list: -- :ref:`Array` **get_signal_connection_list** **(** :ref:`String` signal **)** const +- :ref:`Array` **get_signal_connection_list** **(** :ref:`String` signal **)** const .. _class_Object_get_signal_list: -- :ref:`Array` **get_signal_list** **(** **)** const +- :ref:`Array` **get_signal_list** **(** **)** const Return the list of signals as an array of dictionaries. .. _class_Object_has_meta: -- :ref:`bool` **has_meta** **(** :ref:`String` name **)** const +- :ref:`bool` **has_meta** **(** :ref:`String` name **)** const Return true if a metadata is found with the requested name. .. _class_Object_has_method: -- :ref:`bool` **has_method** **(** :ref:`String` method **)** const +- :ref:`bool` **has_method** **(** :ref:`String` method **)** const .. _class_Object_has_user_signal: -- :ref:`bool` **has_user_signal** **(** :ref:`String` signal **)** const +- :ref:`bool` **has_user_signal** **(** :ref:`String` signal **)** const .. _class_Object_is_blocking_signals: -- :ref:`bool` **is_blocking_signals** **(** **)** const +- :ref:`bool` **is_blocking_signals** **(** **)** const Return true if signal emission blocking is enabled. .. _class_Object_is_class: -- :ref:`bool` **is_class** **(** :ref:`String` type **)** const +- :ref:`bool` **is_class** **(** :ref:`String` type **)** const Check the class of the object against a string (including inheritance). .. _class_Object_is_connected: -- :ref:`bool` **is_connected** **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method **)** const +- :ref:`bool` **is_connected** **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method **)** const Return true if a connection exists for a given signal and target/method. .. _class_Object_is_queued_for_deletion: -- :ref:`bool` **is_queued_for_deletion** **(** **)** const +- :ref:`bool` **is_queued_for_deletion** **(** **)** const .. _class_Object_notification: -- void **notification** **(** :ref:`int` what, :ref:`bool` reversed=false **)** +- void **notification** **(** :ref:`int` what, :ref:`bool` reversed=false **)** Notify the object of something. .. _class_Object_property_list_changed_notify: -- void **property_list_changed_notify** **(** **)** +- void **property_list_changed_notify** **(** **)** .. _class_Object_set: -- void **set** **(** :ref:`String` property, :ref:`Variant` value **)** +- void **set** **(** :ref:`String` property, :ref:`Variant` value **)** Set property into the object. .. _class_Object_set_block_signals: -- void **set_block_signals** **(** :ref:`bool` enable **)** +- void **set_block_signals** **(** :ref:`bool` enable **)** If set to true, signal emission is blocked. .. _class_Object_set_message_translation: -- void **set_message_translation** **(** :ref:`bool` enable **)** +- void **set_message_translation** **(** :ref:`bool` enable **)** Define whether this object can translate strings (with calls to :ref:`tr`). Default is true. .. _class_Object_set_meta: -- void **set_meta** **(** :ref:`String` name, :ref:`Variant` value **)** +- void **set_meta** **(** :ref:`String` name, :ref:`Variant` value **)** Set a metadata into the object. Metadata is serialized. Metadata can be *anything*. .. _class_Object_set_script: -- void **set_script** **(** :ref:`Reference` script **)** +- void **set_script** **(** :ref:`Reference` script **)** Set a script into the object, scripts extend the object functionality. .. _class_Object_tr: -- :ref:`String` **tr** **(** :ref:`String` message **)** const +- :ref:`String` **tr** **(** :ref:`String` message **)** const Translate a message. Only works if message translation is enabled (which it is by default). See :ref:`set_message_translation`. diff --git a/classes/class_occluderpolygon2d.rst b/classes/class_occluderpolygon2d.rst index 1c3790acb..f15068144 100644 --- a/classes/class_occluderpolygon2d.rst +++ b/classes/class_occluderpolygon2d.rst @@ -19,19 +19,19 @@ Brief Description Member Functions ---------------- -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_cull_mode` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_polygon` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_closed` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_closed` **(** :ref:`bool` closed **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cull_mode` **(** :ref:`int` cull_mode **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_polygon` **(** :ref:`PoolVector2Array` polygon **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_cull_mode` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`get_polygon` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_closed` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_closed` **(** :ref:`bool` closed **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cull_mode` **(** :ref:`int` cull_mode **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_polygon` **(** :ref:`PoolVector2Array` polygon **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -61,26 +61,26 @@ Member Function Description .. _class_OccluderPolygon2D_get_cull_mode: -- :ref:`int` **get_cull_mode** **(** **)** const +- :ref:`int` **get_cull_mode** **(** **)** const .. _class_OccluderPolygon2D_get_polygon: -- :ref:`PoolVector2Array` **get_polygon** **(** **)** const +- :ref:`PoolVector2Array` **get_polygon** **(** **)** const .. _class_OccluderPolygon2D_is_closed: -- :ref:`bool` **is_closed** **(** **)** const +- :ref:`bool` **is_closed** **(** **)** const .. _class_OccluderPolygon2D_set_closed: -- void **set_closed** **(** :ref:`bool` closed **)** +- void **set_closed** **(** :ref:`bool` closed **)** .. _class_OccluderPolygon2D_set_cull_mode: -- void **set_cull_mode** **(** :ref:`int` cull_mode **)** +- void **set_cull_mode** **(** :ref:`int` cull_mode **)** .. _class_OccluderPolygon2D_set_polygon: -- void **set_polygon** **(** :ref:`PoolVector2Array` polygon **)** +- void **set_polygon** **(** :ref:`PoolVector2Array` polygon **)** diff --git a/classes/class_omnilight.rst b/classes/class_omnilight.rst index e5b542a6d..5574dfb91 100644 --- a/classes/class_omnilight.rst +++ b/classes/class_omnilight.rst @@ -19,15 +19,15 @@ OmniDirectional Light, such as a light bulb or a candle. Member Functions ---------------- -+------------------------+--------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_shadow_detail` **(** **)** const | -+------------------------+--------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_shadow_mode` **(** **)** const | -+------------------------+--------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shadow_detail` **(** :ref:`int` detail **)** | -+------------------------+--------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shadow_mode` **(** :ref:`int` mode **)** | -+------------------------+--------------------------------------------------------------------------------------------------------+ ++------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_shadow_detail` **(** **)** const | ++------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_shadow_mode` **(** **)** const | ++------------------------+------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shadow_detail` **(** :ref:`int` detail **)** | ++------------------------+------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shadow_mode` **(** :ref:`int` mode **)** | ++------------------------+------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -67,18 +67,18 @@ Member Function Description .. _class_OmniLight_get_shadow_detail: -- :ref:`int` **get_shadow_detail** **(** **)** const +- :ref:`int` **get_shadow_detail** **(** **)** const .. _class_OmniLight_get_shadow_mode: -- :ref:`int` **get_shadow_mode** **(** **)** const +- :ref:`int` **get_shadow_mode** **(** **)** const .. _class_OmniLight_set_shadow_detail: -- void **set_shadow_detail** **(** :ref:`int` detail **)** +- void **set_shadow_detail** **(** :ref:`int` detail **)** .. _class_OmniLight_set_shadow_mode: -- void **set_shadow_mode** **(** :ref:`int` mode **)** +- void **set_shadow_mode** **(** :ref:`int` mode **)** diff --git a/classes/class_optionbutton.rst b/classes/class_optionbutton.rst index f56a9584f..f60a993d5 100644 --- a/classes/class_optionbutton.rst +++ b/classes/class_optionbutton.rst @@ -19,54 +19,54 @@ Button control that provides selectable options when pressed. Member Functions ---------------- -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_icon_item` **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_item` **(** :ref:`String` label, :ref:`int` id=-1 **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_separator` **(** **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_count` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_item_icon` **(** :ref:`int` idx **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_id` **(** :ref:`int` idx **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_item_metadata` **(** :ref:`int` idx **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_item_text` **(** :ref:`int` idx **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_selected` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_selected_id` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_selected_metadata` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_item_disabled` **(** :ref:`int` idx **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_item` **(** :ref:`int` idx **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`select` **(** :ref:`int` idx **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_disabled` **(** :ref:`int` idx, :ref:`bool` disabled **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_icon` **(** :ref:`int` idx, :ref:`Texture` texture **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_id` **(** :ref:`int` idx, :ref:`int` id **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_metadata` **(** :ref:`int` idx, :ref:`Variant` metadata **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_text` **(** :ref:`int` idx, :ref:`String` text **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_icon_item` **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_item` **(** :ref:`String` label, :ref:`int` id=-1 **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_separator` **(** **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_item_count` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_item_icon` **(** :ref:`int` idx **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_item_id` **(** :ref:`int` idx **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_item_metadata` **(** :ref:`int` idx **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_item_text` **(** :ref:`int` idx **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_selected` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_selected_id` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_selected_metadata` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_item_disabled` **(** :ref:`int` idx **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_item` **(** :ref:`int` idx **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`select` **(** :ref:`int` idx **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_disabled` **(** :ref:`int` idx, :ref:`bool` disabled **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_icon` **(** :ref:`int` idx, :ref:`Texture` texture **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_id` **(** :ref:`int` idx, :ref:`int` id **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_metadata` **(** :ref:`int` idx, :ref:`Variant` metadata **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_text` **(** :ref:`int` idx, :ref:`String` text **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_OptionButton_item_selected: -- **item_selected** **(** :ref:`int` ID **)** +- **item_selected** **(** :ref:`int` ID **)** This signal is emitted when the current item was changed by the user. ID of the item selected is passed as argument (if no IDs were added, ID will be just the item index). @@ -93,107 +93,107 @@ Member Function Description .. _class_OptionButton_add_icon_item: -- void **add_icon_item** **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id **)** +- void **add_icon_item** **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id **)** Add an item, with a "texture" icon, text "label" and (optionally) id. If no "id" is passed, "id" becomes the item index. New items are appended at the end. .. _class_OptionButton_add_item: -- void **add_item** **(** :ref:`String` label, :ref:`int` id=-1 **)** +- void **add_item** **(** :ref:`String` label, :ref:`int` id=-1 **)** Add an item, with text "label" and (optionally) id. If no "id" is passed, "id" becomes the item index. New items are appended at the end. .. _class_OptionButton_add_separator: -- void **add_separator** **(** **)** +- void **add_separator** **(** **)** Add a separator to the list of items. Separators help to group items. Separator also takes up an index and is appended at the end. .. _class_OptionButton_clear: -- void **clear** **(** **)** +- void **clear** **(** **)** Clear all the items in the :ref:`OptionButton`. .. _class_OptionButton_get_item_count: -- :ref:`int` **get_item_count** **(** **)** const +- :ref:`int` **get_item_count** **(** **)** const Return the amount of items in the OptionButton. .. _class_OptionButton_get_item_icon: -- :ref:`Texture` **get_item_icon** **(** :ref:`int` idx **)** const +- :ref:`Texture` **get_item_icon** **(** :ref:`int` idx **)** const Return the icon of the item at index "idx". .. _class_OptionButton_get_item_id: -- :ref:`int` **get_item_id** **(** :ref:`int` idx **)** const +- :ref:`int` **get_item_id** **(** :ref:`int` idx **)** const Return the ID of the item at index "idx". .. _class_OptionButton_get_item_metadata: -- :ref:`Variant` **get_item_metadata** **(** :ref:`int` idx **)** const +- :ref:`Variant` **get_item_metadata** **(** :ref:`int` idx **)** const .. _class_OptionButton_get_item_text: -- :ref:`String` **get_item_text** **(** :ref:`int` idx **)** const +- :ref:`String` **get_item_text** **(** :ref:`int` idx **)** const Return the text of the item at index "idx". .. _class_OptionButton_get_selected: -- :ref:`int` **get_selected** **(** **)** const +- :ref:`int` **get_selected** **(** **)** const Return the current item index .. _class_OptionButton_get_selected_id: -- :ref:`int` **get_selected_id** **(** **)** const +- :ref:`int` **get_selected_id** **(** **)** const .. _class_OptionButton_get_selected_metadata: -- :ref:`Variant` **get_selected_metadata** **(** **)** const +- :ref:`Variant` **get_selected_metadata** **(** **)** const .. _class_OptionButton_is_item_disabled: -- :ref:`bool` **is_item_disabled** **(** :ref:`int` idx **)** const +- :ref:`bool` **is_item_disabled** **(** :ref:`int` idx **)** const .. _class_OptionButton_remove_item: -- void **remove_item** **(** :ref:`int` idx **)** +- void **remove_item** **(** :ref:`int` idx **)** .. _class_OptionButton_select: -- void **select** **(** :ref:`int` idx **)** +- void **select** **(** :ref:`int` idx **)** Select an item by index and make it the current item. .. _class_OptionButton_set_item_disabled: -- void **set_item_disabled** **(** :ref:`int` idx, :ref:`bool` disabled **)** +- void **set_item_disabled** **(** :ref:`int` idx, :ref:`bool` disabled **)** .. _class_OptionButton_set_item_icon: -- void **set_item_icon** **(** :ref:`int` idx, :ref:`Texture` texture **)** +- void **set_item_icon** **(** :ref:`int` idx, :ref:`Texture` texture **)** Set the icon of an item at index "idx". .. _class_OptionButton_set_item_id: -- void **set_item_id** **(** :ref:`int` idx, :ref:`int` id **)** +- void **set_item_id** **(** :ref:`int` idx, :ref:`int` id **)** Set the ID of an item at index "idx". .. _class_OptionButton_set_item_metadata: -- void **set_item_metadata** **(** :ref:`int` idx, :ref:`Variant` metadata **)** +- void **set_item_metadata** **(** :ref:`int` idx, :ref:`Variant` metadata **)** .. _class_OptionButton_set_item_text: -- void **set_item_text** **(** :ref:`int` idx, :ref:`String` text **)** +- void **set_item_text** **(** :ref:`int` idx, :ref:`String` text **)** Set the text of an item at index "idx". diff --git a/classes/class_os.rst b/classes/class_os.rst index d09c598eb..3e75111d9 100644 --- a/classes/class_os.rst +++ b/classes/class_os.rst @@ -19,205 +19,205 @@ Operating System functions. Member Functions ---------------- -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`alert` **(** :ref:`String` text, :ref:`String` title="Alert!" **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_draw` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_use_threads` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`delay_msec` **(** :ref:`int` msec **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`delay_usec` **(** :ref:`int` usec **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`dump_memory_to_file` **(** :ref:`String` file **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`dump_resources_to_file` **(** :ref:`String` file **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`execute` **(** :ref:`String` path, :ref:`PoolStringArray` arguments, :ref:`bool` blocking, :ref:`Array` output=[ ] **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_scancode_from_string` **(** :ref:`String` string **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_borderless_window` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_clipboard` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_cmdline_args` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_current_screen` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_data_dir` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_date` **(** :ref:`bool` utc=false **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_datetime` **(** :ref:`bool` utc=false **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_datetime_from_unix_time` **(** :ref:`int` unix_time_val **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_dynamic_memory_usage` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_environment` **(** :ref:`String` environment **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_executable_path` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_exit_code` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_latin_keyboard_variant` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_locale` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_model_name` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_name` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_power_percent_left` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_power_seconds_left` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_power_state` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_process_id` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_processor_count` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_scancode_string` **(** :ref:`int` code **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_screen_count` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_screen_dpi` **(** :ref:`int` screen=-1 **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_screen_orientation` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_screen_position` **(** :ref:`int` screen=-1 **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_screen_size` **(** :ref:`int` screen=-1 **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_splash_tick_msec` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_static_memory_peak_usage` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_static_memory_usage` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_system_dir` **(** :ref:`int` dir **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_system_time_secs` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_ticks_msec` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_time` **(** :ref:`bool` utc=false **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_time_zone_info` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_unique_id` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_unix_time` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_unix_time_from_datetime` **(** :ref:`Dictionary` datetime **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_virtual_keyboard_height` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_window_position` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_window_size` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_environment` **(** :ref:`String` environment **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_feature` **(** :ref:`String` tag_name **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_touchscreen_ui_hint` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_virtual_keyboard` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`hide_virtual_keyboard` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_debug_build` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_in_low_processor_usage_mode` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_keep_screen_on` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_ok_left_and_cancel_right` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_scancode_unicode` **(** :ref:`int` code **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_stdout_verbose` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_userfs_persistent` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_vsync_enabled` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_window_fullscreen` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_window_maximized` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_window_minimized` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_window_resizable` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`kill` **(** :ref:`int` pid **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`native_video_is_playing` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`native_video_pause` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`native_video_play` **(** :ref:`String` path, :ref:`float` volume, :ref:`String` audio_track, :ref:`String` subtitle_track **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`native_video_stop` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`native_video_unpause` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`print_all_resources` **(** :ref:`String` tofile="" **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`print_all_textures_by_size` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`print_resources_by_type` **(** :ref:`PoolStringArray` types **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`print_resources_in_use` **(** :ref:`bool` short=false **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`request_attention` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_borderless_window` **(** :ref:`bool` borderless **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_clipboard` **(** :ref:`String` clipboard **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_current_screen` **(** :ref:`int` screen **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_exit_code` **(** :ref:`int` code **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_icon` **(** :ref:`Image` icon **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ime_position` **(** :ref:`Vector2` position **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_keep_screen_on` **(** :ref:`bool` enabled **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_low_processor_usage_mode` **(** :ref:`bool` enable **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_screen_orientation` **(** :ref:`int` orientation **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`set_thread_name` **(** :ref:`String` name **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_file_access_save_and_swap` **(** :ref:`bool` enabled **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_vsync` **(** :ref:`bool` enable **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_window_fullscreen` **(** :ref:`bool` enabled **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_window_maximized` **(** :ref:`bool` enabled **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_window_minimized` **(** :ref:`bool` enabled **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_window_position` **(** :ref:`Vector2` position **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_window_resizable` **(** :ref:`bool` enabled **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_window_size` **(** :ref:`Vector2` size **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_window_title` **(** :ref:`String` title **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`shell_open` **(** :ref:`String` uri **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`show_virtual_keyboard` **(** :ref:`String` existing_text="" **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`alert` **(** :ref:`String` text, :ref:`String` title="Alert!" **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_draw` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_use_threads` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`delay_msec` **(** :ref:`int` msec **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`delay_usec` **(** :ref:`int` usec **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`dump_memory_to_file` **(** :ref:`String` file **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`dump_resources_to_file` **(** :ref:`String` file **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`execute` **(** :ref:`String` path, :ref:`PoolStringArray` arguments, :ref:`bool` blocking, :ref:`Array` output=[ ] **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find_scancode_from_string` **(** :ref:`String` string **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_borderless_window` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_clipboard` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_cmdline_args` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_current_screen` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_data_dir` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_date` **(** :ref:`bool` utc=false **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_datetime` **(** :ref:`bool` utc=false **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_datetime_from_unix_time` **(** :ref:`int` unix_time_val **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_dynamic_memory_usage` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_environment` **(** :ref:`String` environment **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_executable_path` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_exit_code` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_latin_keyboard_variant` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_locale` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_model_name` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_name` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_power_percent_left` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_power_seconds_left` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_power_state` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_process_id` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_processor_count` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_scancode_string` **(** :ref:`int` code **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_screen_count` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_screen_dpi` **(** :ref:`int` screen=-1 **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_screen_orientation` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_screen_position` **(** :ref:`int` screen=-1 **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_screen_size` **(** :ref:`int` screen=-1 **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_splash_tick_msec` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_static_memory_peak_usage` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_static_memory_usage` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_system_dir` **(** :ref:`int` dir **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_system_time_secs` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_ticks_msec` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_time` **(** :ref:`bool` utc=false **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_time_zone_info` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_unique_id` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_unix_time` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_unix_time_from_datetime` **(** :ref:`Dictionary` datetime **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_virtual_keyboard_height` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_window_position` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_window_size` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_environment` **(** :ref:`String` environment **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_feature` **(** :ref:`String` tag_name **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_touchscreen_ui_hint` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_virtual_keyboard` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`hide_virtual_keyboard` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_debug_build` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_in_low_processor_usage_mode` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_keep_screen_on` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_ok_left_and_cancel_right` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_scancode_unicode` **(** :ref:`int` code **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_stdout_verbose` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_userfs_persistent` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_vsync_enabled` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_window_fullscreen` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_window_maximized` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_window_minimized` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_window_resizable` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`kill` **(** :ref:`int` pid **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`native_video_is_playing` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`native_video_pause` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`native_video_play` **(** :ref:`String` path, :ref:`float` volume, :ref:`String` audio_track, :ref:`String` subtitle_track **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`native_video_stop` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`native_video_unpause` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`print_all_resources` **(** :ref:`String` tofile="" **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`print_all_textures_by_size` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`print_resources_by_type` **(** :ref:`PoolStringArray` types **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`print_resources_in_use` **(** :ref:`bool` short=false **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`request_attention` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_borderless_window` **(** :ref:`bool` borderless **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_clipboard` **(** :ref:`String` clipboard **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_current_screen` **(** :ref:`int` screen **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_exit_code` **(** :ref:`int` code **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_icon` **(** :ref:`Image` icon **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ime_position` **(** :ref:`Vector2` position **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_keep_screen_on` **(** :ref:`bool` enabled **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_low_processor_usage_mode` **(** :ref:`bool` enable **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_screen_orientation` **(** :ref:`int` orientation **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`set_thread_name` **(** :ref:`String` name **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_file_access_save_and_swap` **(** :ref:`bool` enabled **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_vsync` **(** :ref:`bool` enable **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_window_fullscreen` **(** :ref:`bool` enabled **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_window_maximized` **(** :ref:`bool` enabled **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_window_minimized` **(** :ref:`bool` enabled **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_window_position` **(** :ref:`Vector2` position **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_window_resizable` **(** :ref:`bool` enabled **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_window_size` **(** :ref:`Vector2` size **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_window_title` **(** :ref:`String` title **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`shell_open` **(** :ref:`String` uri **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`show_virtual_keyboard` **(** :ref:`String` existing_text="" **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -272,37 +272,37 @@ Member Function Description .. _class_OS_alert: -- void **alert** **(** :ref:`String` text, :ref:`String` title="Alert!" **)** +- void **alert** **(** :ref:`String` text, :ref:`String` title="Alert!" **)** Displays a modal dialog box utilizing the host OS. .. _class_OS_can_draw: -- :ref:`bool` **can_draw** **(** **)** const +- :ref:`bool` **can_draw** **(** **)** const Returns ``true`` if the host OS allows drawing. .. _class_OS_can_use_threads: -- :ref:`bool` **can_use_threads** **(** **)** const +- :ref:`bool` **can_use_threads** **(** **)** const Returns ``true`` if the current host platform is using multiple threads. .. _class_OS_delay_msec: -- void **delay_msec** **(** :ref:`int` msec **)** const +- void **delay_msec** **(** :ref:`int` msec **)** const Delay executing of the current thread by given milliseconds. .. _class_OS_delay_usec: -- void **delay_usec** **(** :ref:`int` usec **)** const +- void **delay_usec** **(** :ref:`int` usec **)** const Delay executing of the current thread by given microseconds. .. _class_OS_dump_memory_to_file: -- void **dump_memory_to_file** **(** :ref:`String` file **)** +- void **dump_memory_to_file** **(** :ref:`String` file **)** Dumps the memory allocation ringlist to a file (only works in debug). @@ -310,7 +310,7 @@ Entry format per line: "Address - Size - Description" .. _class_OS_dump_resources_to_file: -- void **dump_resources_to_file** **(** :ref:`String` file **)** +- void **dump_resources_to_file** **(** :ref:`String` file **)** Dumps all used resources to file (only works in debug). @@ -320,61 +320,61 @@ At the end of the file is a statistic of all used Resource Types. .. _class_OS_execute: -- :ref:`int` **execute** **(** :ref:`String` path, :ref:`PoolStringArray` arguments, :ref:`bool` blocking, :ref:`Array` output=[ ] **)** +- :ref:`int` **execute** **(** :ref:`String` path, :ref:`PoolStringArray` arguments, :ref:`bool` blocking, :ref:`Array` output=[ ] **)** Execute the binary file in given path, optionally blocking until it returns. A process ID is returned. .. _class_OS_find_scancode_from_string: -- :ref:`int` **find_scancode_from_string** **(** :ref:`String` string **)** const +- :ref:`int` **find_scancode_from_string** **(** :ref:`String` string **)** const Returns the scancode of the given string (e.g. "Escape") .. _class_OS_get_borderless_window: -- :ref:`bool` **get_borderless_window** **(** **)** const +- :ref:`bool` **get_borderless_window** **(** **)** const Returns true if the current window is borderless. .. _class_OS_get_clipboard: -- :ref:`String` **get_clipboard** **(** **)** const +- :ref:`String` **get_clipboard** **(** **)** const Get clipboard from the host OS. .. _class_OS_get_cmdline_args: -- :ref:`PoolStringArray` **get_cmdline_args** **(** **)** +- :ref:`PoolStringArray` **get_cmdline_args** **(** **)** Returns the command line arguments passed to the engine. .. _class_OS_get_current_screen: -- :ref:`int` **get_current_screen** **(** **)** const +- :ref:`int` **get_current_screen** **(** **)** const Returns the current screen index (0 padded). .. _class_OS_get_data_dir: -- :ref:`String` **get_data_dir** **(** **)** const +- :ref:`String` **get_data_dir** **(** **)** const Returns the absolute directory path of user data path(user://). .. _class_OS_get_date: -- :ref:`Dictionary` **get_date** **(** :ref:`bool` utc=false **)** const +- :ref:`Dictionary` **get_date** **(** :ref:`bool` utc=false **)** const Returns current date as a dictionary of keys: year, month, day, weekday, dst (daylight savings time). .. _class_OS_get_datetime: -- :ref:`Dictionary` **get_datetime** **(** :ref:`bool` utc=false **)** const +- :ref:`Dictionary` **get_datetime** **(** :ref:`bool` utc=false **)** const Returns current datetime as a dictionary of keys: year, month, day, weekday, dst (daylight savings time), hour, minute, second. .. _class_OS_get_datetime_from_unix_time: -- :ref:`Dictionary` **get_datetime_from_unix_time** **(** :ref:`int` unix_time_val **)** const +- :ref:`Dictionary` **get_datetime_from_unix_time** **(** :ref:`int` unix_time_val **)** const Get a dictionary of time values when given epoch time. @@ -382,29 +382,29 @@ Dictionary Time values will be a union of values from :ref:`get_time` **get_dynamic_memory_usage** **(** **)** const +- :ref:`int` **get_dynamic_memory_usage** **(** **)** const Returns the total amount of dynamic memory used (only works in debug). .. _class_OS_get_environment: -- :ref:`String` **get_environment** **(** :ref:`String` environment **)** const +- :ref:`String` **get_environment** **(** :ref:`String` environment **)** const Returns an environment variable. .. _class_OS_get_executable_path: -- :ref:`String` **get_executable_path** **(** **)** const +- :ref:`String` **get_executable_path** **(** **)** const Returns the path to the current engine executable. .. _class_OS_get_exit_code: -- :ref:`int` **get_exit_code** **(** **)** const +- :ref:`int` **get_exit_code** **(** **)** const .. _class_OS_get_latin_keyboard_variant: -- :ref:`String` **get_latin_keyboard_variant** **(** **)** const +- :ref:`String` **get_latin_keyboard_variant** **(** **)** const Returns the current latin keyboard variant as a String. @@ -412,67 +412,67 @@ Possible return values are: "QWERTY", "AZERTY", "QZERTY", "DVORAK", "NEO" or "ER .. _class_OS_get_locale: -- :ref:`String` **get_locale** **(** **)** const +- :ref:`String` **get_locale** **(** **)** const Returns the host OS locale. .. _class_OS_get_model_name: -- :ref:`String` **get_model_name** **(** **)** const +- :ref:`String` **get_model_name** **(** **)** const Returns the model name of the current device. .. _class_OS_get_name: -- :ref:`String` **get_name** **(** **)** const +- :ref:`String` **get_name** **(** **)** const Returns the name of the host OS. Possible values are: "Android", "Haiku", "iOS", "HTML5", "OSX", "Server", "Windows", "UWP", "X11". .. _class_OS_get_power_percent_left: -- :ref:`int` **get_power_percent_left** **(** **)** +- :ref:`int` **get_power_percent_left** **(** **)** Returns the amount of battery left in the device as a percentage. .. _class_OS_get_power_seconds_left: -- :ref:`int` **get_power_seconds_left** **(** **)** +- :ref:`int` **get_power_seconds_left** **(** **)** Returns the time in seconds before the device runs out of battery. .. _class_OS_get_power_state: -- :ref:`int` **get_power_state** **(** **)** +- :ref:`int` **get_power_state** **(** **)** Returns the current state of the device regarding battery and power. See ``POWERSTATE\_\*`` constants. .. _class_OS_get_process_id: -- :ref:`int` **get_process_id** **(** **)** const +- :ref:`int` **get_process_id** **(** **)** const Returns the game process ID .. _class_OS_get_processor_count: -- :ref:`int` **get_processor_count** **(** **)** const +- :ref:`int` **get_processor_count** **(** **)** const Returns the number of cores available in the host machine. .. _class_OS_get_scancode_string: -- :ref:`String` **get_scancode_string** **(** :ref:`int` code **)** const +- :ref:`String` **get_scancode_string** **(** :ref:`int` code **)** const Returns the given scancode as a string (e.g. Return values: "Escape", "Shift+Escape"). .. _class_OS_get_screen_count: -- :ref:`int` **get_screen_count** **(** **)** const +- :ref:`int` **get_screen_count** **(** **)** const Returns the number of displays attached to the host machine. .. _class_OS_get_screen_dpi: -- :ref:`int` **get_screen_dpi** **(** :ref:`int` screen=-1 **)** const +- :ref:`int` **get_screen_dpi** **(** :ref:`int` screen=-1 **)** const Returns the dots per inch density of the specified screen. @@ -494,83 +494,83 @@ xxxhdpi - 640 dpi .. _class_OS_get_screen_orientation: -- :ref:`int` **get_screen_orientation** **(** **)** const +- :ref:`int` **get_screen_orientation** **(** **)** const Returns the current screen orientation, the return value will be one of the SCREEN_ORIENTATION constants in this class. .. _class_OS_get_screen_position: -- :ref:`Vector2` **get_screen_position** **(** :ref:`int` screen=-1 **)** const +- :ref:`Vector2` **get_screen_position** **(** :ref:`int` screen=-1 **)** const Returns the position of the specified screen by index. If no screen index is provided, the current screen will be used. .. _class_OS_get_screen_size: -- :ref:`Vector2` **get_screen_size** **(** :ref:`int` screen=-1 **)** const +- :ref:`Vector2` **get_screen_size** **(** :ref:`int` screen=-1 **)** const Returns the dimensions in pixels of the specified screen. .. _class_OS_get_splash_tick_msec: -- :ref:`int` **get_splash_tick_msec** **(** **)** const +- :ref:`int` **get_splash_tick_msec** **(** **)** const .. _class_OS_get_static_memory_peak_usage: -- :ref:`int` **get_static_memory_peak_usage** **(** **)** const +- :ref:`int` **get_static_memory_peak_usage** **(** **)** const Returns the max amount of static memory used (only works in debug). .. _class_OS_get_static_memory_usage: -- :ref:`int` **get_static_memory_usage** **(** **)** const +- :ref:`int` **get_static_memory_usage** **(** **)** const Returns the amount of static memory being used by the program in bytes. .. _class_OS_get_system_dir: -- :ref:`String` **get_system_dir** **(** :ref:`int` dir **)** const +- :ref:`String` **get_system_dir** **(** :ref:`int` dir **)** const Returns the actual path to commonly used folders across different platforms. Available locations are specified in OS.SystemDir. .. _class_OS_get_system_time_secs: -- :ref:`int` **get_system_time_secs** **(** **)** const +- :ref:`int` **get_system_time_secs** **(** **)** const Returns the epoch time of the operating system in seconds. .. _class_OS_get_ticks_msec: -- :ref:`int` **get_ticks_msec** **(** **)** const +- :ref:`int` **get_ticks_msec** **(** **)** const Returns the amount of time passed in milliseconds since the engine started. .. _class_OS_get_time: -- :ref:`Dictionary` **get_time** **(** :ref:`bool` utc=false **)** const +- :ref:`Dictionary` **get_time** **(** :ref:`bool` utc=false **)** const Returns current time as a dictionary of keys: hour, minute, second. .. _class_OS_get_time_zone_info: -- :ref:`Dictionary` **get_time_zone_info** **(** **)** const +- :ref:`Dictionary` **get_time_zone_info** **(** **)** const Returns the current time zone as a dictionary with the keys: bias and name. .. _class_OS_get_unique_id: -- :ref:`String` **get_unique_id** **(** **)** const +- :ref:`String` **get_unique_id** **(** **)** const Returns a unique string. .. _class_OS_get_unix_time: -- :ref:`int` **get_unix_time** **(** **)** const +- :ref:`int` **get_unix_time** **(** **)** const Return the current unix timestamp. .. _class_OS_get_unix_time_from_datetime: -- :ref:`int` **get_unix_time_from_datetime** **(** :ref:`Dictionary` datetime **)** const +- :ref:`int` **get_unix_time_from_datetime** **(** :ref:`Dictionary` datetime **)** const Get an epoch time value from a dictionary of time values. @@ -580,51 +580,51 @@ You can pass the output from :ref:`get_datetime_from_unix_time` **get_virtual_keyboard_height** **(** **)** +- :ref:`int` **get_virtual_keyboard_height** **(** **)** .. _class_OS_get_window_position: -- :ref:`Vector2` **get_window_position** **(** **)** const +- :ref:`Vector2` **get_window_position** **(** **)** const Returns the window position relative to the screen, the origin is the top left corner, +Y axis goes to the bottom and +X axis goes to the right. .. _class_OS_get_window_size: -- :ref:`Vector2` **get_window_size** **(** **)** const +- :ref:`Vector2` **get_window_size** **(** **)** const Returns the size of the window (without counting window manager decorations). .. _class_OS_has_environment: -- :ref:`bool` **has_environment** **(** :ref:`String` environment **)** const +- :ref:`bool` **has_environment** **(** :ref:`String` environment **)** const Returns ``true`` if an environment variable exists. .. _class_OS_has_feature: -- :ref:`bool` **has_feature** **(** :ref:`String` tag_name **)** const +- :ref:`bool` **has_feature** **(** :ref:`String` tag_name **)** const .. _class_OS_has_touchscreen_ui_hint: -- :ref:`bool` **has_touchscreen_ui_hint** **(** **)** const +- :ref:`bool` **has_touchscreen_ui_hint** **(** **)** const Returns ``true`` if the device has a touchscreen or emulates one. .. _class_OS_has_virtual_keyboard: -- :ref:`bool` **has_virtual_keyboard** **(** **)** const +- :ref:`bool` **has_virtual_keyboard** **(** **)** const Returns ``true`` if the platform has a virtual keyboard, ``false`` otherwise. .. _class_OS_hide_virtual_keyboard: -- void **hide_virtual_keyboard** **(** **)** +- void **hide_virtual_keyboard** **(** **)** Hides the virtual keyboard if it is shown, does nothing otherwise. .. _class_OS_is_debug_build: -- :ref:`bool` **is_debug_build** **(** **)** const +- :ref:`bool` **is_debug_build** **(** **)** const Returns ``true`` if the build is a debug build. @@ -634,251 +634,251 @@ Returns ``false`` if the build is a release build. .. _class_OS_is_in_low_processor_usage_mode: -- :ref:`bool` **is_in_low_processor_usage_mode** **(** **)** const +- :ref:`bool` **is_in_low_processor_usage_mode** **(** **)** const Returns ``true`` if low cpu usage mode is enabled. .. _class_OS_is_keep_screen_on: -- :ref:`bool` **is_keep_screen_on** **(** **)** const +- :ref:`bool` **is_keep_screen_on** **(** **)** const Returns ``true`` if the screen is being kept on. .. _class_OS_is_ok_left_and_cancel_right: -- :ref:`bool` **is_ok_left_and_cancel_right** **(** **)** const +- :ref:`bool` **is_ok_left_and_cancel_right** **(** **)** const Returns ``true`` if the "Okay" button should appear on the left and "Cancel" on the right. .. _class_OS_is_scancode_unicode: -- :ref:`bool` **is_scancode_unicode** **(** :ref:`int` code **)** const +- :ref:`bool` **is_scancode_unicode** **(** :ref:`int` code **)** const Returns ``true`` if the input code has a unicode character. .. _class_OS_is_stdout_verbose: -- :ref:`bool` **is_stdout_verbose** **(** **)** const +- :ref:`bool` **is_stdout_verbose** **(** **)** const Returns ``true`` if the engine was executed with -v (verbose stdout). .. _class_OS_is_userfs_persistent: -- :ref:`bool` **is_userfs_persistent** **(** **)** const +- :ref:`bool` **is_userfs_persistent** **(** **)** const If ``true``, the ``user://`` file system is persistent, so that its state is the same after a player quits and starts the game again. Relevant to the HTML5 platform, where this persistence may be unavailable. .. _class_OS_is_vsync_enabled: -- :ref:`bool` **is_vsync_enabled** **(** **)** const +- :ref:`bool` **is_vsync_enabled** **(** **)** const Returns ``true`` if synchronizing the framerate to the monitor's refresh rate is enabled. .. _class_OS_is_window_fullscreen: -- :ref:`bool` **is_window_fullscreen** **(** **)** const +- :ref:`bool` **is_window_fullscreen** **(** **)** const Returns ``true`` if the window is in fullscreen mode. .. _class_OS_is_window_maximized: -- :ref:`bool` **is_window_maximized** **(** **)** const +- :ref:`bool` **is_window_maximized** **(** **)** const Returns ``true`` if the window is maximized. .. _class_OS_is_window_minimized: -- :ref:`bool` **is_window_minimized** **(** **)** const +- :ref:`bool` **is_window_minimized** **(** **)** const Returns ``true`` if the window is minimized. .. _class_OS_is_window_resizable: -- :ref:`bool` **is_window_resizable** **(** **)** const +- :ref:`bool` **is_window_resizable** **(** **)** const Returns ``true`` if the window is resizable. .. _class_OS_kill: -- :ref:`int` **kill** **(** :ref:`int` pid **)** +- :ref:`int` **kill** **(** :ref:`int` pid **)** Kill a process ID (this method can be used to kill processes that were not spawned by the game). .. _class_OS_native_video_is_playing: -- :ref:`bool` **native_video_is_playing** **(** **)** +- :ref:`bool` **native_video_is_playing** **(** **)** Returns ``true`` if native video is playing. .. _class_OS_native_video_pause: -- void **native_video_pause** **(** **)** +- void **native_video_pause** **(** **)** Pauses native video playback. .. _class_OS_native_video_play: -- :ref:`int` **native_video_play** **(** :ref:`String` path, :ref:`float` volume, :ref:`String` audio_track, :ref:`String` subtitle_track **)** +- :ref:`int` **native_video_play** **(** :ref:`String` path, :ref:`float` volume, :ref:`String` audio_track, :ref:`String` subtitle_track **)** Plays native video from the specified path, at the given volume and with audio and subtitle tracks. .. _class_OS_native_video_stop: -- void **native_video_stop** **(** **)** +- void **native_video_stop** **(** **)** Stops native video playback. .. _class_OS_native_video_unpause: -- void **native_video_unpause** **(** **)** +- void **native_video_unpause** **(** **)** Resumes native video playback. .. _class_OS_print_all_resources: -- void **print_all_resources** **(** :ref:`String` tofile="" **)** +- void **print_all_resources** **(** :ref:`String` tofile="" **)** Shows all resources in the game. Optionally the list can be written to a file. .. _class_OS_print_all_textures_by_size: -- void **print_all_textures_by_size** **(** **)** +- void **print_all_textures_by_size** **(** **)** Shows the list of loaded textures sorted by size in memory. .. _class_OS_print_resources_by_type: -- void **print_resources_by_type** **(** :ref:`PoolStringArray` types **)** +- void **print_resources_by_type** **(** :ref:`PoolStringArray` types **)** Shows the number of resources loaded by the game of the given types. .. _class_OS_print_resources_in_use: -- void **print_resources_in_use** **(** :ref:`bool` short=false **)** +- void **print_resources_in_use** **(** :ref:`bool` short=false **)** Shows all resources currently used by the game. .. _class_OS_request_attention: -- void **request_attention** **(** **)** +- void **request_attention** **(** **)** Request the user attention to the window. It'll flash the taskbar button on Windows or bounce the dock icon on OSX. .. _class_OS_set_borderless_window: -- void **set_borderless_window** **(** :ref:`bool` borderless **)** +- void **set_borderless_window** **(** :ref:`bool` borderless **)** Removes the window frame. .. _class_OS_set_clipboard: -- void **set_clipboard** **(** :ref:`String` clipboard **)** +- void **set_clipboard** **(** :ref:`String` clipboard **)** Sets clipboard to the OS. .. _class_OS_set_current_screen: -- void **set_current_screen** **(** :ref:`int` screen **)** +- void **set_current_screen** **(** :ref:`int` screen **)** Sets the current screen by index. .. _class_OS_set_exit_code: -- void **set_exit_code** **(** :ref:`int` code **)** +- void **set_exit_code** **(** :ref:`int` code **)** Sets the exit code that will be returned by the game. .. _class_OS_set_icon: -- void **set_icon** **(** :ref:`Image` icon **)** +- void **set_icon** **(** :ref:`Image` icon **)** Sets the game's icon. .. _class_OS_set_ime_position: -- void **set_ime_position** **(** :ref:`Vector2` position **)** +- void **set_ime_position** **(** :ref:`Vector2` position **)** .. _class_OS_set_keep_screen_on: -- void **set_keep_screen_on** **(** :ref:`bool` enabled **)** +- void **set_keep_screen_on** **(** :ref:`bool` enabled **)** Sets keep screen on if true, or goes to sleep by device setting if false. (for Android/iOS) .. _class_OS_set_low_processor_usage_mode: -- void **set_low_processor_usage_mode** **(** :ref:`bool` enable **)** +- void **set_low_processor_usage_mode** **(** :ref:`bool` enable **)** Set to ``true`` to enable the low cpu usage mode. In this mode, the screen only redraws when there are changes, and a considerable sleep time is inserted between frames. Use this in tool mode to reduce CPU usage. .. _class_OS_set_screen_orientation: -- void **set_screen_orientation** **(** :ref:`int` orientation **)** +- void **set_screen_orientation** **(** :ref:`int` orientation **)** Sets the current screen orientation, the argument value must be one of the SCREEN_ORIENTATION constants in this class. .. _class_OS_set_thread_name: -- :ref:`int` **set_thread_name** **(** :ref:`String` name **)** +- :ref:`int` **set_thread_name** **(** :ref:`String` name **)** Sets the name of the current thread. .. _class_OS_set_use_file_access_save_and_swap: -- void **set_use_file_access_save_and_swap** **(** :ref:`bool` enabled **)** +- void **set_use_file_access_save_and_swap** **(** :ref:`bool` enabled **)** Enables backup saves if ``enabled`` is ``true``. .. _class_OS_set_use_vsync: -- void **set_use_vsync** **(** :ref:`bool` enable **)** +- void **set_use_vsync** **(** :ref:`bool` enable **)** If ``true`` the framerate will synchronize to the monitor's refresh rate. .. _class_OS_set_window_fullscreen: -- void **set_window_fullscreen** **(** :ref:`bool` enabled **)** +- void **set_window_fullscreen** **(** :ref:`bool` enabled **)** Sets window fullscreen mode to the *enabled* argument, *enabled* is a toggle for the fullscreen mode, calling the function with *enabled* true when the screen is not on fullscreen mode will cause the screen to go to fullscreen mode, calling the function with *enabled* false when the screen is in fullscreen mode will cause the window to exit the fullscreen mode. .. _class_OS_set_window_maximized: -- void **set_window_maximized** **(** :ref:`bool` enabled **)** +- void **set_window_maximized** **(** :ref:`bool` enabled **)** Set ``true`` to maximize the window. .. _class_OS_set_window_minimized: -- void **set_window_minimized** **(** :ref:`bool` enabled **)** +- void **set_window_minimized** **(** :ref:`bool` enabled **)** Set ``true`` to minimize the window. .. _class_OS_set_window_position: -- void **set_window_position** **(** :ref:`Vector2` position **)** +- void **set_window_position** **(** :ref:`Vector2` position **)** Sets the position of the window to the specified position (this function could be restricted by the window manager, meaning that there could be some unreachable areas of the screen). .. _class_OS_set_window_resizable: -- void **set_window_resizable** **(** :ref:`bool` enabled **)** +- void **set_window_resizable** **(** :ref:`bool` enabled **)** Sets the window resizable state, if the window is not resizable it will preserve the dimensions specified in the project settings. .. _class_OS_set_window_size: -- void **set_window_size** **(** :ref:`Vector2` size **)** +- void **set_window_size** **(** :ref:`Vector2` size **)** Sets the window size to the specified size. .. _class_OS_set_window_title: -- void **set_window_title** **(** :ref:`String` title **)** +- void **set_window_title** **(** :ref:`String` title **)** Sets the window title to the specified string. .. _class_OS_shell_open: -- :ref:`int` **shell_open** **(** :ref:`String` uri **)** +- :ref:`int` **shell_open** **(** :ref:`String` uri **)** Requests the OS to open a resource with the most appropriate program. For example. @@ -888,7 +888,7 @@ Requests the OS to open a resource with the most appropriate program. For exampl .. _class_OS_show_virtual_keyboard: -- void **show_virtual_keyboard** **(** :ref:`String` existing_text="" **)** +- void **show_virtual_keyboard** **(** :ref:`String` existing_text="" **)** Shows the virtual keyboard if the platform has one. The *existing_text* parameter is useful for implementing your own LineEdit, as it tells the virtual keyboard what text has already been typed (the virtual keyboard uses it for auto-correct and predictions). diff --git a/classes/class_packeddatacontainer.rst b/classes/class_packeddatacontainer.rst index a1b209502..9710b249d 100644 --- a/classes/class_packeddatacontainer.rst +++ b/classes/class_packeddatacontainer.rst @@ -19,11 +19,11 @@ Brief Description Member Functions ---------------- -+------------------------+-----------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`pack` **(** :ref:`Variant` value **)** | -+------------------------+-----------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` **(** **)** const | -+------------------------+-----------------------------------------------------------------------------------------------+ ++------------------------+---------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`pack` **(** :ref:`Variant` value **)** | ++------------------------+---------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` **(** **)** const | ++------------------------+---------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -38,10 +38,10 @@ Member Function Description .. _class_PackedDataContainer_pack: -- :ref:`int` **pack** **(** :ref:`Variant` value **)** +- :ref:`int` **pack** **(** :ref:`Variant` value **)** .. _class_PackedDataContainer_size: -- :ref:`int` **size** **(** **)** const +- :ref:`int` **size** **(** **)** const diff --git a/classes/class_packeddatacontainerref.rst b/classes/class_packeddatacontainerref.rst index 53d252e6c..9a2560a74 100644 --- a/classes/class_packeddatacontainerref.rst +++ b/classes/class_packeddatacontainerref.rst @@ -19,15 +19,15 @@ Brief Description Member Functions ---------------- -+------------------------+-------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` **(** **)** const | -+------------------------+-------------------------------------------------------------------+ ++------------------------+------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` **(** **)** const | ++------------------------+------------------------------------------------------------------+ Member Function Description --------------------------- .. _class_PackedDataContainerRef_size: -- :ref:`int` **size** **(** **)** const +- :ref:`int` **size** **(** **)** const diff --git a/classes/class_packedscene.rst b/classes/class_packedscene.rst index 77996ff34..4b7823a91 100644 --- a/classes/class_packedscene.rst +++ b/classes/class_packedscene.rst @@ -19,15 +19,15 @@ Brief Description Member Functions ---------------- -+--------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_instance` **(** **)** const | -+--------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`SceneState` | :ref:`get_state` **(** **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`instance` **(** :ref:`int` edit_state=0 **)** const | -+--------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`pack` **(** :ref:`Node` path **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------+ ++--------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_instance` **(** **)** const | ++--------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`SceneState` | :ref:`get_state` **(** **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`instance` **(** :ref:`int` edit_state=0 **)** const | ++--------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`pack` **(** :ref:`Node` path **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -54,19 +54,19 @@ Member Function Description .. _class_PackedScene_can_instance: -- :ref:`bool` **can_instance** **(** **)** const +- :ref:`bool` **can_instance** **(** **)** const .. _class_PackedScene_get_state: -- :ref:`SceneState` **get_state** **(** **)** +- :ref:`SceneState` **get_state** **(** **)** .. _class_PackedScene_instance: -- :ref:`Node` **instance** **(** :ref:`int` edit_state=0 **)** const +- :ref:`Node` **instance** **(** :ref:`int` edit_state=0 **)** const .. _class_PackedScene_pack: -- :ref:`int` **pack** **(** :ref:`Node` path **)** +- :ref:`int` **pack** **(** :ref:`Node` path **)** Pack will ignore any sub-nodes not owned by given node. See :ref:`Node.set_owner`. diff --git a/classes/class_packetpeer.rst b/classes/class_packetpeer.rst index 36a387a8f..43491bde7 100644 --- a/classes/class_packetpeer.rst +++ b/classes/class_packetpeer.rst @@ -21,23 +21,23 @@ Abstraction and base class for packet-based protocols. Member Functions ---------------- -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_available_packet_count` **(** **)** const | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`get_packet` **(** **)** const | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_packet_error` **(** **)** const | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_var` **(** **)** const | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_object_decoding_allowed` **(** **)** const | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`put_packet` **(** :ref:`PoolByteArray` buffer **)** | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`put_var` **(** :ref:`Variant` var **)** | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_allow_object_decoding` **(** :ref:`bool` enable **)** | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_available_packet_count` **(** **)** const | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`get_packet` **(** **)** const | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_packet_error` **(** **)** const | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_var` **(** **)** const | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_object_decoding_allowed` **(** **)** const | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`put_packet` **(** :ref:`PoolByteArray` buffer **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`put_var` **(** :ref:`Variant` var **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_allow_object_decoding` **(** :ref:`bool` enable **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -49,46 +49,46 @@ Member Function Description .. _class_PacketPeer_get_available_packet_count: -- :ref:`int` **get_available_packet_count** **(** **)** const +- :ref:`int` **get_available_packet_count** **(** **)** const Return the number of packets currently available in the ring-buffer. .. _class_PacketPeer_get_packet: -- :ref:`PoolByteArray` **get_packet** **(** **)** const +- :ref:`PoolByteArray` **get_packet** **(** **)** const Get a raw packet. .. _class_PacketPeer_get_packet_error: -- :ref:`int` **get_packet_error** **(** **)** const +- :ref:`int` **get_packet_error** **(** **)** const Return the error state of the last packet received (via :ref:`get_packet` and :ref:`get_var`). .. _class_PacketPeer_get_var: -- :ref:`Variant` **get_var** **(** **)** const +- :ref:`Variant` **get_var** **(** **)** const Get a Variant. .. _class_PacketPeer_is_object_decoding_allowed: -- :ref:`bool` **is_object_decoding_allowed** **(** **)** const +- :ref:`bool` **is_object_decoding_allowed** **(** **)** const .. _class_PacketPeer_put_packet: -- :ref:`int` **put_packet** **(** :ref:`PoolByteArray` buffer **)** +- :ref:`int` **put_packet** **(** :ref:`PoolByteArray` buffer **)** Send a raw packet. .. _class_PacketPeer_put_var: -- :ref:`int` **put_var** **(** :ref:`Variant` var **)** +- :ref:`int` **put_var** **(** :ref:`Variant` var **)** Send a Variant as a packet. .. _class_PacketPeer_set_allow_object_decoding: -- void **set_allow_object_decoding** **(** :ref:`bool` enable **)** +- void **set_allow_object_decoding** **(** :ref:`bool` enable **)** diff --git a/classes/class_packetpeerstream.rst b/classes/class_packetpeerstream.rst index b45bcfa85..a289da83a 100644 --- a/classes/class_packetpeerstream.rst +++ b/classes/class_packetpeerstream.rst @@ -19,17 +19,17 @@ Wrapper to use a PacketPeer over a StreamPeer. Member Functions ---------------- -+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_input_buffer_max_size` **(** **)** const | -+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_output_buffer_max_size` **(** **)** const | -+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_input_buffer_max_size` **(** :ref:`int` max_size_bytes **)** | -+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_output_buffer_max_size` **(** :ref:`int` max_size_bytes **)** | -+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_stream_peer` **(** :ref:`Reference` peer **)** | -+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_input_buffer_max_size` **(** **)** const | ++------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_output_buffer_max_size` **(** **)** const | ++------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_input_buffer_max_size` **(** :ref:`int` max_size_bytes **)** | ++------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_output_buffer_max_size` **(** :ref:`int` max_size_bytes **)** | ++------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_stream_peer` **(** :ref:`Reference` peer **)** | ++------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -41,23 +41,23 @@ Member Function Description .. _class_PacketPeerStream_get_input_buffer_max_size: -- :ref:`int` **get_input_buffer_max_size** **(** **)** const +- :ref:`int` **get_input_buffer_max_size** **(** **)** const .. _class_PacketPeerStream_get_output_buffer_max_size: -- :ref:`int` **get_output_buffer_max_size** **(** **)** const +- :ref:`int` **get_output_buffer_max_size** **(** **)** const .. _class_PacketPeerStream_set_input_buffer_max_size: -- void **set_input_buffer_max_size** **(** :ref:`int` max_size_bytes **)** +- void **set_input_buffer_max_size** **(** :ref:`int` max_size_bytes **)** .. _class_PacketPeerStream_set_output_buffer_max_size: -- void **set_output_buffer_max_size** **(** :ref:`int` max_size_bytes **)** +- void **set_output_buffer_max_size** **(** :ref:`int` max_size_bytes **)** .. _class_PacketPeerStream_set_stream_peer: -- void **set_stream_peer** **(** :ref:`Reference` peer **)** +- void **set_stream_peer** **(** :ref:`Reference` peer **)** Set the :ref:`StreamPeer` object to be wrapped. diff --git a/classes/class_packetpeerudp.rst b/classes/class_packetpeerudp.rst index 2b63b5bc8..4797f0800 100644 --- a/classes/class_packetpeerudp.rst +++ b/classes/class_packetpeerudp.rst @@ -19,21 +19,21 @@ UDP packet peer. Member Functions ---------------- -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`close` **(** **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_packet_ip` **(** **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_packet_port` **(** **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_listening` **(** **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`listen` **(** :ref:`int` port, :ref:`String` bind_address="*", :ref:`int` recv_buf_size=65536 **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`set_dest_address` **(** :ref:`String` host, :ref:`int` port **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`wait` **(** **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`close` **(** **)** | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_packet_ip` **(** **)** const | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_packet_port` **(** **)** const | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_listening` **(** **)** const | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`listen` **(** :ref:`int` port, :ref:`String` bind_address="*", :ref:`int` recv_buf_size=65536 **)** | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`set_dest_address` **(** :ref:`String` host, :ref:`int` port **)** | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`wait` **(** **)** | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -45,31 +45,31 @@ Member Function Description .. _class_PacketPeerUDP_close: -- void **close** **(** **)** +- void **close** **(** **)** Close the UDP socket the :ref:`PacketPeerUDP` is currently listening on. .. _class_PacketPeerUDP_get_packet_ip: -- :ref:`String` **get_packet_ip** **(** **)** const +- :ref:`String` **get_packet_ip** **(** **)** const Return the IP of the remote peer that sent the last packet(that was received with :ref:`get_packet` or :ref:`get_var`). .. _class_PacketPeerUDP_get_packet_port: -- :ref:`int` **get_packet_port** **(** **)** const +- :ref:`int` **get_packet_port** **(** **)** const Return the port of the remote peer that sent the last packet(that was received with :ref:`get_packet` or :ref:`get_var`). .. _class_PacketPeerUDP_is_listening: -- :ref:`bool` **is_listening** **(** **)** const +- :ref:`bool` **is_listening** **(** **)** const Return whether this :ref:`PacketPeerUDP` is listening. .. _class_PacketPeerUDP_listen: -- :ref:`int` **listen** **(** :ref:`int` port, :ref:`String` bind_address="*", :ref:`int` recv_buf_size=65536 **)** +- :ref:`int` **listen** **(** :ref:`int` port, :ref:`String` bind_address="*", :ref:`int` recv_buf_size=65536 **)** Make this :ref:`PacketPeerUDP` listen on the "port" binding to "bind_address" with a buffer size "recv_buf_size". @@ -81,13 +81,13 @@ If "bind_address" is set to any valid address (e.g. "192.168.1.101", "::1", etc) .. _class_PacketPeerUDP_set_dest_address: -- :ref:`int` **set_dest_address** **(** :ref:`String` host, :ref:`int` port **)** +- :ref:`int` **set_dest_address** **(** :ref:`String` host, :ref:`int` port **)** Set the destination address and port for sending packets and variables, a hostname will be resolved using if valid. .. _class_PacketPeerUDP_wait: -- :ref:`int` **wait** **(** **)** +- :ref:`int` **wait** **(** **)** Wait for a packet to arrive on the listening port, see :ref:`listen`. diff --git a/classes/class_panoramasky.rst b/classes/class_panoramasky.rst index 2448540b2..f99de763f 100644 --- a/classes/class_panoramasky.rst +++ b/classes/class_panoramasky.rst @@ -19,11 +19,11 @@ Brief Description Member Functions ---------------- -+--------------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_panorama` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_panorama` **(** :ref:`Texture` texture **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------+ ++--------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_panorama` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_panorama` **(** :ref:`Texture` texture **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -38,10 +38,10 @@ Member Function Description .. _class_PanoramaSky_get_panorama: -- :ref:`Texture` **get_panorama** **(** **)** const +- :ref:`Texture` **get_panorama** **(** **)** const .. _class_PanoramaSky_set_panorama: -- void **set_panorama** **(** :ref:`Texture` texture **)** +- void **set_panorama** **(** :ref:`Texture` texture **)** diff --git a/classes/class_parallaxbackground.rst b/classes/class_parallaxbackground.rst index b16e0071d..f95b12081 100644 --- a/classes/class_parallaxbackground.rst +++ b/classes/class_parallaxbackground.rst @@ -19,31 +19,31 @@ A node used to create a parallax scrolling background. Member Functions ---------------- -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_limit_begin` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_limit_end` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_scroll_base_offset` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_scroll_base_scale` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_scroll_offset` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_ignore_camera_zoom` **(** **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ignore_camera_zoom` **(** :ref:`bool` ignore **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_limit_begin` **(** :ref:`Vector2` ofs **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_limit_end` **(** :ref:`Vector2` ofs **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_scroll_base_offset` **(** :ref:`Vector2` ofs **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_scroll_base_scale` **(** :ref:`Vector2` scale **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_scroll_offset` **(** :ref:`Vector2` ofs **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_limit_begin` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_limit_end` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_scroll_base_offset` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_scroll_base_scale` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_scroll_offset` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_ignore_camera_zoom` **(** **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ignore_camera_zoom` **(** :ref:`bool` ignore **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_limit_begin` **(** :ref:`Vector2` ofs **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_limit_end` **(** :ref:`Vector2` ofs **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_scroll_base_offset` **(** :ref:`Vector2` ofs **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_scroll_base_scale` **(** :ref:`Vector2` scale **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_scroll_offset` **(** :ref:`Vector2` ofs **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -83,70 +83,70 @@ Member Function Description .. _class_ParallaxBackground_get_limit_begin: -- :ref:`Vector2` **get_limit_begin** **(** **)** const +- :ref:`Vector2` **get_limit_begin** **(** **)** const Return the beginning limit. .. _class_ParallaxBackground_get_limit_end: -- :ref:`Vector2` **get_limit_end** **(** **)** const +- :ref:`Vector2` **get_limit_end** **(** **)** const Return the ending limit. .. _class_ParallaxBackground_get_scroll_base_offset: -- :ref:`Vector2` **get_scroll_base_offset** **(** **)** const +- :ref:`Vector2` **get_scroll_base_offset** **(** **)** const Return the base offset. .. _class_ParallaxBackground_get_scroll_base_scale: -- :ref:`Vector2` **get_scroll_base_scale** **(** **)** const +- :ref:`Vector2` **get_scroll_base_scale** **(** **)** const Return the base motion scale. .. _class_ParallaxBackground_get_scroll_offset: -- :ref:`Vector2` **get_scroll_offset** **(** **)** const +- :ref:`Vector2` **get_scroll_offset** **(** **)** const .. _class_ParallaxBackground_is_ignore_camera_zoom: -- :ref:`bool` **is_ignore_camera_zoom** **(** **)** +- :ref:`bool` **is_ignore_camera_zoom** **(** **)** Return ignoring camera zoom. .. _class_ParallaxBackground_set_ignore_camera_zoom: -- void **set_ignore_camera_zoom** **(** :ref:`bool` ignore **)** +- void **set_ignore_camera_zoom** **(** :ref:`bool` ignore **)** Set to true for all child :ref:`ParallaxLayer` nodes to not be affected by the zoom level of the camera. .. _class_ParallaxBackground_set_limit_begin: -- void **set_limit_begin** **(** :ref:`Vector2` ofs **)** +- void **set_limit_begin** **(** :ref:`Vector2` ofs **)** Set the left and top limits in pixels for scrolling to begin. If the camera is outside of this limit the background will not continue to scroll. If an axis is greater than or equal to the corresponding axis of limit_end, then it will not limit scrolling for that axis. .. _class_ParallaxBackground_set_limit_end: -- void **set_limit_end** **(** :ref:`Vector2` ofs **)** +- void **set_limit_end** **(** :ref:`Vector2` ofs **)** Set the right and bottom limits in pixels for scrolling to end. If the camera is outside of this limit the background will not continue to scroll. If an axis is less than or equal to the corresponding axis of limit_begin, then it will not limit scrolling for that axis. .. _class_ParallaxBackground_set_scroll_base_offset: -- void **set_scroll_base_offset** **(** :ref:`Vector2` ofs **)** +- void **set_scroll_base_offset** **(** :ref:`Vector2` ofs **)** Set the base offset in pixels of all children :ref:`ParallaxLayer` nodes. .. _class_ParallaxBackground_set_scroll_base_scale: -- void **set_scroll_base_scale** **(** :ref:`Vector2` scale **)** +- void **set_scroll_base_scale** **(** :ref:`Vector2` scale **)** Set the base motion scale of all children :ref:`ParallaxLayer` nodes. .. _class_ParallaxBackground_set_scroll_offset: -- void **set_scroll_offset** **(** :ref:`Vector2` ofs **)** +- void **set_scroll_offset** **(** :ref:`Vector2` ofs **)** diff --git a/classes/class_parallaxlayer.rst b/classes/class_parallaxlayer.rst index ff5a7ebe2..bb6baea1c 100644 --- a/classes/class_parallaxlayer.rst +++ b/classes/class_parallaxlayer.rst @@ -19,19 +19,19 @@ A parallax scrolling layer to be used with :ref:`ParallaxBackground` | :ref:`get_mirroring` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_motion_offset` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_motion_scale` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mirroring` **(** :ref:`Vector2` mirror **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_motion_offset` **(** :ref:`Vector2` offset **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_motion_scale` **(** :ref:`Vector2` scale **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_mirroring` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_motion_offset` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_motion_scale` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_mirroring` **(** :ref:`Vector2` mirror **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_motion_offset` **(** :ref:`Vector2` offset **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_motion_scale` **(** :ref:`Vector2` scale **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -59,33 +59,33 @@ Member Function Description .. _class_ParallaxLayer_get_mirroring: -- :ref:`Vector2` **get_mirroring** **(** **)** const +- :ref:`Vector2` **get_mirroring** **(** **)** const Return the mirroring of the ParallaxLayer. .. _class_ParallaxLayer_get_motion_offset: -- :ref:`Vector2` **get_motion_offset** **(** **)** const +- :ref:`Vector2` **get_motion_offset** **(** **)** const .. _class_ParallaxLayer_get_motion_scale: -- :ref:`Vector2` **get_motion_scale** **(** **)** const +- :ref:`Vector2` **get_motion_scale** **(** **)** const Return the motion scale of the ParallaxLayer. .. _class_ParallaxLayer_set_mirroring: -- void **set_mirroring** **(** :ref:`Vector2` mirror **)** +- void **set_mirroring** **(** :ref:`Vector2` mirror **)** Set the mirroring of the ParallaxLayer. If an axis is set to 0 then that axis will have no mirroring. .. _class_ParallaxLayer_set_motion_offset: -- void **set_motion_offset** **(** :ref:`Vector2` offset **)** +- void **set_motion_offset** **(** :ref:`Vector2` offset **)** .. _class_ParallaxLayer_set_motion_scale: -- void **set_motion_scale** **(** :ref:`Vector2` scale **)** +- void **set_motion_scale** **(** :ref:`Vector2` scale **)** Set the motion scale of the ParallaxLayer. If an axis is set to 0 then it will not move at all, it will stick with the camera. diff --git a/classes/class_particles.rst b/classes/class_particles.rst index 8a5ac87d2..65b5fe566 100644 --- a/classes/class_particles.rst +++ b/classes/class_particles.rst @@ -19,75 +19,75 @@ Brief Description Member Functions ---------------- -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect3` | :ref:`capture_aabb` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_amount` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_draw_order` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Mesh` | :ref:`get_draw_pass_mesh` **(** :ref:`int` pass **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_draw_passes` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_explosiveness_ratio` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_fixed_fps` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_fractional_delta` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_lifetime` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_one_shot` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_pre_process_time` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Material` | :ref:`get_process_material` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_randomness_ratio` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_speed_scale` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_use_local_coordinates` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect3` | :ref:`get_visibility_aabb` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_emitting` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`restart` **(** **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_amount` **(** :ref:`int` amount **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_draw_order` **(** :ref:`int` order **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_draw_pass_mesh` **(** :ref:`int` pass, :ref:`Mesh` mesh **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_draw_passes` **(** :ref:`int` passes **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_emitting` **(** :ref:`bool` emitting **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_explosiveness_ratio` **(** :ref:`float` ratio **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fixed_fps` **(** :ref:`int` fps **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fractional_delta` **(** :ref:`bool` enable **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_lifetime` **(** :ref:`float` secs **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_one_shot` **(** :ref:`bool` enable **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pre_process_time` **(** :ref:`float` secs **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_process_material` **(** :ref:`Material` material **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_randomness_ratio` **(** :ref:`float` ratio **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_speed_scale` **(** :ref:`float` scale **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_local_coordinates` **(** :ref:`bool` enable **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_visibility_aabb` **(** :ref:`Rect3` aabb **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect3` | :ref:`capture_aabb` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_amount` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_draw_order` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Mesh` | :ref:`get_draw_pass_mesh` **(** :ref:`int` pass **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_draw_passes` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_explosiveness_ratio` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_fixed_fps` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_fractional_delta` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_lifetime` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_one_shot` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_pre_process_time` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Material` | :ref:`get_process_material` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_randomness_ratio` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_speed_scale` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_use_local_coordinates` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect3` | :ref:`get_visibility_aabb` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_emitting` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`restart` **(** **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_amount` **(** :ref:`int` amount **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_draw_order` **(** :ref:`int` order **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_draw_pass_mesh` **(** :ref:`int` pass, :ref:`Mesh` mesh **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_draw_passes` **(** :ref:`int` passes **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_emitting` **(** :ref:`bool` emitting **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_explosiveness_ratio` **(** :ref:`float` ratio **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fixed_fps` **(** :ref:`int` fps **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fractional_delta` **(** :ref:`bool` enable **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_lifetime` **(** :ref:`float` secs **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_one_shot` **(** :ref:`bool` enable **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pre_process_time` **(** :ref:`float` secs **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_process_material` **(** :ref:`Material` material **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_randomness_ratio` **(** :ref:`float` ratio **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_speed_scale` **(** :ref:`float` scale **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_local_coordinates` **(** :ref:`bool` enable **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_visibility_aabb` **(** :ref:`Rect3` aabb **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -189,138 +189,138 @@ Member Function Description .. _class_Particles_capture_aabb: -- :ref:`Rect3` **capture_aabb** **(** **)** const +- :ref:`Rect3` **capture_aabb** **(** **)** const .. _class_Particles_get_amount: -- :ref:`int` **get_amount** **(** **)** const +- :ref:`int` **get_amount** **(** **)** const .. _class_Particles_get_draw_order: -- :ref:`int` **get_draw_order** **(** **)** const +- :ref:`int` **get_draw_order** **(** **)** const .. _class_Particles_get_draw_pass_mesh: -- :ref:`Mesh` **get_draw_pass_mesh** **(** :ref:`int` pass **)** const +- :ref:`Mesh` **get_draw_pass_mesh** **(** :ref:`int` pass **)** const .. _class_Particles_get_draw_passes: -- :ref:`int` **get_draw_passes** **(** **)** const +- :ref:`int` **get_draw_passes** **(** **)** const .. _class_Particles_get_explosiveness_ratio: -- :ref:`float` **get_explosiveness_ratio** **(** **)** const +- :ref:`float` **get_explosiveness_ratio** **(** **)** const .. _class_Particles_get_fixed_fps: -- :ref:`int` **get_fixed_fps** **(** **)** const +- :ref:`int` **get_fixed_fps** **(** **)** const .. _class_Particles_get_fractional_delta: -- :ref:`bool` **get_fractional_delta** **(** **)** const +- :ref:`bool` **get_fractional_delta** **(** **)** const .. _class_Particles_get_lifetime: -- :ref:`float` **get_lifetime** **(** **)** const +- :ref:`float` **get_lifetime** **(** **)** const .. _class_Particles_get_one_shot: -- :ref:`bool` **get_one_shot** **(** **)** const +- :ref:`bool` **get_one_shot** **(** **)** const .. _class_Particles_get_pre_process_time: -- :ref:`float` **get_pre_process_time** **(** **)** const +- :ref:`float` **get_pre_process_time** **(** **)** const .. _class_Particles_get_process_material: -- :ref:`Material` **get_process_material** **(** **)** const +- :ref:`Material` **get_process_material** **(** **)** const .. _class_Particles_get_randomness_ratio: -- :ref:`float` **get_randomness_ratio** **(** **)** const +- :ref:`float` **get_randomness_ratio** **(** **)** const .. _class_Particles_get_speed_scale: -- :ref:`float` **get_speed_scale** **(** **)** const +- :ref:`float` **get_speed_scale** **(** **)** const .. _class_Particles_get_use_local_coordinates: -- :ref:`bool` **get_use_local_coordinates** **(** **)** const +- :ref:`bool` **get_use_local_coordinates** **(** **)** const .. _class_Particles_get_visibility_aabb: -- :ref:`Rect3` **get_visibility_aabb** **(** **)** const +- :ref:`Rect3` **get_visibility_aabb** **(** **)** const .. _class_Particles_is_emitting: -- :ref:`bool` **is_emitting** **(** **)** const +- :ref:`bool` **is_emitting** **(** **)** const .. _class_Particles_restart: -- void **restart** **(** **)** +- void **restart** **(** **)** .. _class_Particles_set_amount: -- void **set_amount** **(** :ref:`int` amount **)** +- void **set_amount** **(** :ref:`int` amount **)** .. _class_Particles_set_draw_order: -- void **set_draw_order** **(** :ref:`int` order **)** +- void **set_draw_order** **(** :ref:`int` order **)** .. _class_Particles_set_draw_pass_mesh: -- void **set_draw_pass_mesh** **(** :ref:`int` pass, :ref:`Mesh` mesh **)** +- void **set_draw_pass_mesh** **(** :ref:`int` pass, :ref:`Mesh` mesh **)** .. _class_Particles_set_draw_passes: -- void **set_draw_passes** **(** :ref:`int` passes **)** +- void **set_draw_passes** **(** :ref:`int` passes **)** .. _class_Particles_set_emitting: -- void **set_emitting** **(** :ref:`bool` emitting **)** +- void **set_emitting** **(** :ref:`bool` emitting **)** .. _class_Particles_set_explosiveness_ratio: -- void **set_explosiveness_ratio** **(** :ref:`float` ratio **)** +- void **set_explosiveness_ratio** **(** :ref:`float` ratio **)** .. _class_Particles_set_fixed_fps: -- void **set_fixed_fps** **(** :ref:`int` fps **)** +- void **set_fixed_fps** **(** :ref:`int` fps **)** .. _class_Particles_set_fractional_delta: -- void **set_fractional_delta** **(** :ref:`bool` enable **)** +- void **set_fractional_delta** **(** :ref:`bool` enable **)** .. _class_Particles_set_lifetime: -- void **set_lifetime** **(** :ref:`float` secs **)** +- void **set_lifetime** **(** :ref:`float` secs **)** .. _class_Particles_set_one_shot: -- void **set_one_shot** **(** :ref:`bool` enable **)** +- void **set_one_shot** **(** :ref:`bool` enable **)** .. _class_Particles_set_pre_process_time: -- void **set_pre_process_time** **(** :ref:`float` secs **)** +- void **set_pre_process_time** **(** :ref:`float` secs **)** .. _class_Particles_set_process_material: -- void **set_process_material** **(** :ref:`Material` material **)** +- void **set_process_material** **(** :ref:`Material` material **)** .. _class_Particles_set_randomness_ratio: -- void **set_randomness_ratio** **(** :ref:`float` ratio **)** +- void **set_randomness_ratio** **(** :ref:`float` ratio **)** .. _class_Particles_set_speed_scale: -- void **set_speed_scale** **(** :ref:`float` scale **)** +- void **set_speed_scale** **(** :ref:`float` scale **)** .. _class_Particles_set_use_local_coordinates: -- void **set_use_local_coordinates** **(** :ref:`bool` enable **)** +- void **set_use_local_coordinates** **(** :ref:`bool` enable **)** .. _class_Particles_set_visibility_aabb: -- void **set_visibility_aabb** **(** :ref:`Rect3` aabb **)** +- void **set_visibility_aabb** **(** :ref:`Rect3` aabb **)** diff --git a/classes/class_particles2d.rst b/classes/class_particles2d.rst index 06ced1104..0c23005d6 100644 --- a/classes/class_particles2d.rst +++ b/classes/class_particles2d.rst @@ -19,83 +19,83 @@ Brief Description Member Functions ---------------- -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`capture_rect` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_amount` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_draw_order` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_explosiveness_ratio` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_fixed_fps` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_fractional_delta` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_h_frames` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_lifetime` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_normal_map` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_one_shot` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_pre_process_time` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Material` | :ref:`get_process_material` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_randomness_ratio` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_speed_scale` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_texture` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_use_local_coordinates` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_v_frames` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_visibility_rect` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_emitting` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`restart` **(** **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_amount` **(** :ref:`int` amount **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_draw_order` **(** :ref:`int` order **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_emitting` **(** :ref:`bool` emitting **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_explosiveness_ratio` **(** :ref:`float` ratio **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fixed_fps` **(** :ref:`int` fps **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fractional_delta` **(** :ref:`bool` enable **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_h_frames` **(** :ref:`int` frames **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_lifetime` **(** :ref:`float` secs **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_normal_map` **(** :ref:`Texture` texture **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_one_shot` **(** :ref:`bool` secs **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pre_process_time` **(** :ref:`float` secs **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_process_material` **(** :ref:`Material` material **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_randomness_ratio` **(** :ref:`float` ratio **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_speed_scale` **(** :ref:`float` scale **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture` **(** :ref:`Texture` texture **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_local_coordinates` **(** :ref:`bool` enable **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_v_frames` **(** :ref:`int` frames **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_visibility_rect` **(** :ref:`Rect2` aabb **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`capture_rect` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_amount` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_draw_order` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_explosiveness_ratio` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_fixed_fps` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_fractional_delta` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_h_frames` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_lifetime` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_normal_map` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_one_shot` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_pre_process_time` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Material` | :ref:`get_process_material` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_randomness_ratio` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_speed_scale` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_texture` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_use_local_coordinates` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_v_frames` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_visibility_rect` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_emitting` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`restart` **(** **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_amount` **(** :ref:`int` amount **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_draw_order` **(** :ref:`int` order **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_emitting` **(** :ref:`bool` emitting **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_explosiveness_ratio` **(** :ref:`float` ratio **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fixed_fps` **(** :ref:`int` fps **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fractional_delta` **(** :ref:`bool` enable **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_h_frames` **(** :ref:`int` frames **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_lifetime` **(** :ref:`float` secs **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_normal_map` **(** :ref:`Texture` texture **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_one_shot` **(** :ref:`bool` secs **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pre_process_time` **(** :ref:`float` secs **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_process_material` **(** :ref:`Material` material **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_randomness_ratio` **(** :ref:`float` ratio **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_speed_scale` **(** :ref:`float` scale **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_texture` **(** :ref:`Texture` texture **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_local_coordinates` **(** :ref:`bool` enable **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_v_frames` **(** :ref:`int` frames **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_visibility_rect` **(** :ref:`Rect2` aabb **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -191,168 +191,168 @@ Member Function Description .. _class_Particles2D_capture_rect: -- :ref:`Rect2` **capture_rect** **(** **)** const +- :ref:`Rect2` **capture_rect** **(** **)** const .. _class_Particles2D_get_amount: -- :ref:`int` **get_amount** **(** **)** const +- :ref:`int` **get_amount** **(** **)** const Returns the amount of particles spawned at each emission .. _class_Particles2D_get_draw_order: -- :ref:`int` **get_draw_order** **(** **)** const +- :ref:`int` **get_draw_order** **(** **)** const .. _class_Particles2D_get_explosiveness_ratio: -- :ref:`float` **get_explosiveness_ratio** **(** **)** const +- :ref:`float` **get_explosiveness_ratio** **(** **)** const .. _class_Particles2D_get_fixed_fps: -- :ref:`int` **get_fixed_fps** **(** **)** const +- :ref:`int` **get_fixed_fps** **(** **)** const .. _class_Particles2D_get_fractional_delta: -- :ref:`bool` **get_fractional_delta** **(** **)** const +- :ref:`bool` **get_fractional_delta** **(** **)** const .. _class_Particles2D_get_h_frames: -- :ref:`int` **get_h_frames** **(** **)** const +- :ref:`int` **get_h_frames** **(** **)** const .. _class_Particles2D_get_lifetime: -- :ref:`float` **get_lifetime** **(** **)** const +- :ref:`float` **get_lifetime** **(** **)** const Gets the amount of seconds that each particle will be visible. .. _class_Particles2D_get_normal_map: -- :ref:`Texture` **get_normal_map** **(** **)** const +- :ref:`Texture` **get_normal_map** **(** **)** const .. _class_Particles2D_get_one_shot: -- :ref:`bool` **get_one_shot** **(** **)** const +- :ref:`bool` **get_one_shot** **(** **)** const .. _class_Particles2D_get_pre_process_time: -- :ref:`float` **get_pre_process_time** **(** **)** const +- :ref:`float` **get_pre_process_time** **(** **)** const .. _class_Particles2D_get_process_material: -- :ref:`Material` **get_process_material** **(** **)** const +- :ref:`Material` **get_process_material** **(** **)** const .. _class_Particles2D_get_randomness_ratio: -- :ref:`float` **get_randomness_ratio** **(** **)** const +- :ref:`float` **get_randomness_ratio** **(** **)** const .. _class_Particles2D_get_speed_scale: -- :ref:`float` **get_speed_scale** **(** **)** const +- :ref:`float` **get_speed_scale** **(** **)** const .. _class_Particles2D_get_texture: -- :ref:`Texture` **get_texture** **(** **)** const +- :ref:`Texture` **get_texture** **(** **)** const Returns the texture for emitted particles .. _class_Particles2D_get_use_local_coordinates: -- :ref:`bool` **get_use_local_coordinates** **(** **)** const +- :ref:`bool` **get_use_local_coordinates** **(** **)** const .. _class_Particles2D_get_v_frames: -- :ref:`int` **get_v_frames** **(** **)** const +- :ref:`int` **get_v_frames** **(** **)** const .. _class_Particles2D_get_visibility_rect: -- :ref:`Rect2` **get_visibility_rect** **(** **)** const +- :ref:`Rect2` **get_visibility_rect** **(** **)** const .. _class_Particles2D_is_emitting: -- :ref:`bool` **is_emitting** **(** **)** const +- :ref:`bool` **is_emitting** **(** **)** const Returns whether this emitter is currently emitting or not .. _class_Particles2D_restart: -- void **restart** **(** **)** +- void **restart** **(** **)** .. _class_Particles2D_set_amount: -- void **set_amount** **(** :ref:`int` amount **)** +- void **set_amount** **(** :ref:`int` amount **)** Sets the amount of particles spawned at each emission .. _class_Particles2D_set_draw_order: -- void **set_draw_order** **(** :ref:`int` order **)** +- void **set_draw_order** **(** :ref:`int` order **)** .. _class_Particles2D_set_emitting: -- void **set_emitting** **(** :ref:`bool` emitting **)** +- void **set_emitting** **(** :ref:`bool` emitting **)** If this is set to true then the particle emitter will emit particles, if its false it will not. .. _class_Particles2D_set_explosiveness_ratio: -- void **set_explosiveness_ratio** **(** :ref:`float` ratio **)** +- void **set_explosiveness_ratio** **(** :ref:`float` ratio **)** .. _class_Particles2D_set_fixed_fps: -- void **set_fixed_fps** **(** :ref:`int` fps **)** +- void **set_fixed_fps** **(** :ref:`int` fps **)** .. _class_Particles2D_set_fractional_delta: -- void **set_fractional_delta** **(** :ref:`bool` enable **)** +- void **set_fractional_delta** **(** :ref:`bool` enable **)** .. _class_Particles2D_set_h_frames: -- void **set_h_frames** **(** :ref:`int` frames **)** +- void **set_h_frames** **(** :ref:`int` frames **)** .. _class_Particles2D_set_lifetime: -- void **set_lifetime** **(** :ref:`float` secs **)** +- void **set_lifetime** **(** :ref:`float` secs **)** Sets the amount of seconds that each particle will be visible. .. _class_Particles2D_set_normal_map: -- void **set_normal_map** **(** :ref:`Texture` texture **)** +- void **set_normal_map** **(** :ref:`Texture` texture **)** .. _class_Particles2D_set_one_shot: -- void **set_one_shot** **(** :ref:`bool` secs **)** +- void **set_one_shot** **(** :ref:`bool` secs **)** .. _class_Particles2D_set_pre_process_time: -- void **set_pre_process_time** **(** :ref:`float` secs **)** +- void **set_pre_process_time** **(** :ref:`float` secs **)** .. _class_Particles2D_set_process_material: -- void **set_process_material** **(** :ref:`Material` material **)** +- void **set_process_material** **(** :ref:`Material` material **)** .. _class_Particles2D_set_randomness_ratio: -- void **set_randomness_ratio** **(** :ref:`float` ratio **)** +- void **set_randomness_ratio** **(** :ref:`float` ratio **)** .. _class_Particles2D_set_speed_scale: -- void **set_speed_scale** **(** :ref:`float` scale **)** +- void **set_speed_scale** **(** :ref:`float` scale **)** .. _class_Particles2D_set_texture: -- void **set_texture** **(** :ref:`Texture` texture **)** +- void **set_texture** **(** :ref:`Texture` texture **)** .. _class_Particles2D_set_use_local_coordinates: -- void **set_use_local_coordinates** **(** :ref:`bool` enable **)** +- void **set_use_local_coordinates** **(** :ref:`bool` enable **)** .. _class_Particles2D_set_v_frames: -- void **set_v_frames** **(** :ref:`int` frames **)** +- void **set_v_frames** **(** :ref:`int` frames **)** .. _class_Particles2D_set_visibility_rect: -- void **set_visibility_rect** **(** :ref:`Rect2` aabb **)** +- void **set_visibility_rect** **(** :ref:`Rect2` aabb **)** diff --git a/classes/class_particlesmaterial.rst b/classes/class_particlesmaterial.rst index b3d804c9a..815294001 100644 --- a/classes/class_particlesmaterial.rst +++ b/classes/class_particlesmaterial.rst @@ -19,83 +19,83 @@ Particle properties for :ref:`Particles` and :ref:`Particles2D< Member Functions ---------------- -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_color` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_color_ramp` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_emission_box_extents` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_emission_color_texture` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_emission_normal_texture` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_emission_point_count` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_emission_point_texture` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_emission_shape` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_emission_sphere_radius` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_flag` **(** :ref:`int` flag **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_flatness` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_gravity` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_param` **(** :ref:`int` param **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_param_randomness` **(** :ref:`int` param **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_param_texture` **(** :ref:`int` param **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_spread` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`GradientTexture` | :ref:`get_trail_color_modifier` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_trail_divisor` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`CurveTexture` | :ref:`get_trail_size_modifier` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_color` **(** :ref:`Color` color **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_color_ramp` **(** :ref:`Texture` ramp **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_emission_box_extents` **(** :ref:`Vector3` extents **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_emission_color_texture` **(** :ref:`Texture` texture **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_emission_normal_texture` **(** :ref:`Texture` texture **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_emission_point_count` **(** :ref:`int` point_count **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_emission_point_texture` **(** :ref:`Texture` texture **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_emission_shape` **(** :ref:`int` shape **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_emission_sphere_radius` **(** :ref:`float` radius **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_flag` **(** :ref:`int` flag, :ref:`bool` enable **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_flatness` **(** :ref:`float` amount **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_gravity` **(** :ref:`Vector3` accel_vec **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_param` **(** :ref:`int` param, :ref:`float` value **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_param_randomness` **(** :ref:`int` param, :ref:`float` randomness **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_param_texture` **(** :ref:`int` param, :ref:`Texture` texture **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_spread` **(** :ref:`float` degrees **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_trail_color_modifier` **(** :ref:`GradientTexture` texture **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_trail_divisor` **(** :ref:`int` divisor **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_trail_size_modifier` **(** :ref:`CurveTexture` texture **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_color` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_color_ramp` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_emission_box_extents` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_emission_color_texture` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_emission_normal_texture` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_emission_point_count` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_emission_point_texture` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_emission_shape` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_emission_sphere_radius` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_flag` **(** :ref:`int` flag **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_flatness` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_gravity` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_param` **(** :ref:`int` param **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_param_randomness` **(** :ref:`int` param **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_param_texture` **(** :ref:`int` param **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_spread` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`GradientTexture` | :ref:`get_trail_color_modifier` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_trail_divisor` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`CurveTexture` | :ref:`get_trail_size_modifier` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_color` **(** :ref:`Color` color **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_color_ramp` **(** :ref:`Texture` ramp **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_emission_box_extents` **(** :ref:`Vector3` extents **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_emission_color_texture` **(** :ref:`Texture` texture **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_emission_normal_texture` **(** :ref:`Texture` texture **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_emission_point_count` **(** :ref:`int` point_count **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_emission_point_texture` **(** :ref:`Texture` texture **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_emission_shape` **(** :ref:`int` shape **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_emission_sphere_radius` **(** :ref:`float` radius **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_flag` **(** :ref:`int` flag, :ref:`bool` enable **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_flatness` **(** :ref:`float` amount **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_gravity` **(** :ref:`Vector3` accel_vec **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_param` **(** :ref:`int` param, :ref:`float` value **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_param_randomness` **(** :ref:`int` param, :ref:`float` randomness **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_param_texture` **(** :ref:`int` param, :ref:`Texture` texture **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_spread` **(** :ref:`float` degrees **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_trail_color_modifier` **(** :ref:`GradientTexture` texture **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_trail_divisor` **(** :ref:`int` divisor **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_trail_size_modifier` **(** :ref:`CurveTexture` texture **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -354,154 +354,154 @@ Member Function Description .. _class_ParticlesMaterial_get_color: -- :ref:`Color` **get_color** **(** **)** const +- :ref:`Color` **get_color** **(** **)** const .. _class_ParticlesMaterial_get_color_ramp: -- :ref:`Texture` **get_color_ramp** **(** **)** const +- :ref:`Texture` **get_color_ramp** **(** **)** const .. _class_ParticlesMaterial_get_emission_box_extents: -- :ref:`Vector3` **get_emission_box_extents** **(** **)** const +- :ref:`Vector3` **get_emission_box_extents** **(** **)** const .. _class_ParticlesMaterial_get_emission_color_texture: -- :ref:`Texture` **get_emission_color_texture** **(** **)** const +- :ref:`Texture` **get_emission_color_texture** **(** **)** const .. _class_ParticlesMaterial_get_emission_normal_texture: -- :ref:`Texture` **get_emission_normal_texture** **(** **)** const +- :ref:`Texture` **get_emission_normal_texture** **(** **)** const .. _class_ParticlesMaterial_get_emission_point_count: -- :ref:`int` **get_emission_point_count** **(** **)** const +- :ref:`int` **get_emission_point_count** **(** **)** const .. _class_ParticlesMaterial_get_emission_point_texture: -- :ref:`Texture` **get_emission_point_texture** **(** **)** const +- :ref:`Texture` **get_emission_point_texture** **(** **)** const .. _class_ParticlesMaterial_get_emission_shape: -- :ref:`int` **get_emission_shape** **(** **)** const +- :ref:`int` **get_emission_shape** **(** **)** const .. _class_ParticlesMaterial_get_emission_sphere_radius: -- :ref:`float` **get_emission_sphere_radius** **(** **)** const +- :ref:`float` **get_emission_sphere_radius** **(** **)** const .. _class_ParticlesMaterial_get_flag: -- :ref:`bool` **get_flag** **(** :ref:`int` flag **)** const +- :ref:`bool` **get_flag** **(** :ref:`int` flag **)** const .. _class_ParticlesMaterial_get_flatness: -- :ref:`float` **get_flatness** **(** **)** const +- :ref:`float` **get_flatness** **(** **)** const .. _class_ParticlesMaterial_get_gravity: -- :ref:`Vector3` **get_gravity** **(** **)** const +- :ref:`Vector3` **get_gravity** **(** **)** const .. _class_ParticlesMaterial_get_param: -- :ref:`float` **get_param** **(** :ref:`int` param **)** const +- :ref:`float` **get_param** **(** :ref:`int` param **)** const .. _class_ParticlesMaterial_get_param_randomness: -- :ref:`float` **get_param_randomness** **(** :ref:`int` param **)** const +- :ref:`float` **get_param_randomness** **(** :ref:`int` param **)** const .. _class_ParticlesMaterial_get_param_texture: -- :ref:`Texture` **get_param_texture** **(** :ref:`int` param **)** const +- :ref:`Texture` **get_param_texture** **(** :ref:`int` param **)** const .. _class_ParticlesMaterial_get_spread: -- :ref:`float` **get_spread** **(** **)** const +- :ref:`float` **get_spread** **(** **)** const .. _class_ParticlesMaterial_get_trail_color_modifier: -- :ref:`GradientTexture` **get_trail_color_modifier** **(** **)** const +- :ref:`GradientTexture` **get_trail_color_modifier** **(** **)** const .. _class_ParticlesMaterial_get_trail_divisor: -- :ref:`int` **get_trail_divisor** **(** **)** const +- :ref:`int` **get_trail_divisor** **(** **)** const .. _class_ParticlesMaterial_get_trail_size_modifier: -- :ref:`CurveTexture` **get_trail_size_modifier** **(** **)** const +- :ref:`CurveTexture` **get_trail_size_modifier** **(** **)** const .. _class_ParticlesMaterial_set_color: -- void **set_color** **(** :ref:`Color` color **)** +- void **set_color** **(** :ref:`Color` color **)** .. _class_ParticlesMaterial_set_color_ramp: -- void **set_color_ramp** **(** :ref:`Texture` ramp **)** +- void **set_color_ramp** **(** :ref:`Texture` ramp **)** .. _class_ParticlesMaterial_set_emission_box_extents: -- void **set_emission_box_extents** **(** :ref:`Vector3` extents **)** +- void **set_emission_box_extents** **(** :ref:`Vector3` extents **)** .. _class_ParticlesMaterial_set_emission_color_texture: -- void **set_emission_color_texture** **(** :ref:`Texture` texture **)** +- void **set_emission_color_texture** **(** :ref:`Texture` texture **)** .. _class_ParticlesMaterial_set_emission_normal_texture: -- void **set_emission_normal_texture** **(** :ref:`Texture` texture **)** +- void **set_emission_normal_texture** **(** :ref:`Texture` texture **)** .. _class_ParticlesMaterial_set_emission_point_count: -- void **set_emission_point_count** **(** :ref:`int` point_count **)** +- void **set_emission_point_count** **(** :ref:`int` point_count **)** .. _class_ParticlesMaterial_set_emission_point_texture: -- void **set_emission_point_texture** **(** :ref:`Texture` texture **)** +- void **set_emission_point_texture** **(** :ref:`Texture` texture **)** .. _class_ParticlesMaterial_set_emission_shape: -- void **set_emission_shape** **(** :ref:`int` shape **)** +- void **set_emission_shape** **(** :ref:`int` shape **)** .. _class_ParticlesMaterial_set_emission_sphere_radius: -- void **set_emission_sphere_radius** **(** :ref:`float` radius **)** +- void **set_emission_sphere_radius** **(** :ref:`float` radius **)** .. _class_ParticlesMaterial_set_flag: -- void **set_flag** **(** :ref:`int` flag, :ref:`bool` enable **)** +- void **set_flag** **(** :ref:`int` flag, :ref:`bool` enable **)** .. _class_ParticlesMaterial_set_flatness: -- void **set_flatness** **(** :ref:`float` amount **)** +- void **set_flatness** **(** :ref:`float` amount **)** .. _class_ParticlesMaterial_set_gravity: -- void **set_gravity** **(** :ref:`Vector3` accel_vec **)** +- void **set_gravity** **(** :ref:`Vector3` accel_vec **)** .. _class_ParticlesMaterial_set_param: -- void **set_param** **(** :ref:`int` param, :ref:`float` value **)** +- void **set_param** **(** :ref:`int` param, :ref:`float` value **)** .. _class_ParticlesMaterial_set_param_randomness: -- void **set_param_randomness** **(** :ref:`int` param, :ref:`float` randomness **)** +- void **set_param_randomness** **(** :ref:`int` param, :ref:`float` randomness **)** .. _class_ParticlesMaterial_set_param_texture: -- void **set_param_texture** **(** :ref:`int` param, :ref:`Texture` texture **)** +- void **set_param_texture** **(** :ref:`int` param, :ref:`Texture` texture **)** .. _class_ParticlesMaterial_set_spread: -- void **set_spread** **(** :ref:`float` degrees **)** +- void **set_spread** **(** :ref:`float` degrees **)** .. _class_ParticlesMaterial_set_trail_color_modifier: -- void **set_trail_color_modifier** **(** :ref:`GradientTexture` texture **)** +- void **set_trail_color_modifier** **(** :ref:`GradientTexture` texture **)** .. _class_ParticlesMaterial_set_trail_divisor: -- void **set_trail_divisor** **(** :ref:`int` divisor **)** +- void **set_trail_divisor** **(** :ref:`int` divisor **)** .. _class_ParticlesMaterial_set_trail_size_modifier: -- void **set_trail_size_modifier** **(** :ref:`CurveTexture` texture **)** +- void **set_trail_size_modifier** **(** :ref:`CurveTexture` texture **)** diff --git a/classes/class_path.rst b/classes/class_path.rst index 25fb695f4..fb42153e1 100644 --- a/classes/class_path.rst +++ b/classes/class_path.rst @@ -19,11 +19,11 @@ Container for a :ref:`Curve3D`. Member Functions ---------------- -+--------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`Curve3D` | :ref:`get_curve` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------+ -| void | :ref:`set_curve` **(** :ref:`Curve3D` curve **)** | -+--------------------------------+------------------------------------------------------------------------------------------+ ++--------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`Curve3D` | :ref:`get_curve` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------+ +| void | :ref:`set_curve` **(** :ref:`Curve3D` curve **)** | ++--------------------------------+----------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -43,13 +43,13 @@ Member Function Description .. _class_Path_get_curve: -- :ref:`Curve3D` **get_curve** **(** **)** const +- :ref:`Curve3D` **get_curve** **(** **)** const Returns the :ref:`Curve3D` contained. .. _class_Path_set_curve: -- void **set_curve** **(** :ref:`Curve3D` curve **)** +- void **set_curve** **(** :ref:`Curve3D` curve **)** Sets the :ref:`Curve3D`. diff --git a/classes/class_path2d.rst b/classes/class_path2d.rst index 504f6366d..e4651bc8e 100644 --- a/classes/class_path2d.rst +++ b/classes/class_path2d.rst @@ -19,11 +19,11 @@ Container for a :ref:`Curve2D`. Member Functions ---------------- -+--------------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`Curve2D` | :ref:`get_curve` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------+ -| void | :ref:`set_curve` **(** :ref:`Curve2D` curve **)** | -+--------------------------------+--------------------------------------------------------------------------------------------+ ++--------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`Curve2D` | :ref:`get_curve` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------+ +| void | :ref:`set_curve` **(** :ref:`Curve2D` curve **)** | ++--------------------------------+------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -43,13 +43,13 @@ Member Function Description .. _class_Path2D_get_curve: -- :ref:`Curve2D` **get_curve** **(** **)** const +- :ref:`Curve2D` **get_curve** **(** **)** const Returns the :ref:`Curve2D` contained. .. _class_Path2D_set_curve: -- void **set_curve** **(** :ref:`Curve2D` curve **)** +- void **set_curve** **(** :ref:`Curve2D` curve **)** Sets the :ref:`Curve2D`. diff --git a/classes/class_pathfollow.rst b/classes/class_pathfollow.rst index a81881736..644366741 100644 --- a/classes/class_pathfollow.rst +++ b/classes/class_pathfollow.rst @@ -19,35 +19,35 @@ Point sampler for a :ref:`Path`. Member Functions ---------------- -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_cubic_interpolation` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_h_offset` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_offset` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_rotation_mode` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_unit_offset` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_v_offset` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_loop` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cubic_interpolation` **(** :ref:`bool` enable **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_h_offset` **(** :ref:`float` h_offset **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_loop` **(** :ref:`bool` loop **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_offset` **(** :ref:`float` offset **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rotation_mode` **(** :ref:`int` rotation_mode **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_unit_offset` **(** :ref:`float` unit_offset **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_v_offset` **(** :ref:`float` v_offset **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ ++----------------------------+---------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_cubic_interpolation` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_h_offset` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_offset` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_rotation_mode` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_unit_offset` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_v_offset` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_loop` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cubic_interpolation` **(** :ref:`bool` enable **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_h_offset` **(** :ref:`float` h_offset **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_loop` **(** :ref:`bool` loop **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_offset` **(** :ref:`float` offset **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rotation_mode` **(** :ref:`int` rotation_mode **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_unit_offset` **(** :ref:`float` unit_offset **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_v_offset` **(** :ref:`float` v_offset **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -69,49 +69,49 @@ Member Function Description .. _class_PathFollow_get_cubic_interpolation: -- :ref:`bool` **get_cubic_interpolation** **(** **)** const +- :ref:`bool` **get_cubic_interpolation** **(** **)** const This method returns whether the position between two cached points (see :ref:`set_cubic_interpolation`) is interpolated linearly, or cubicly. .. _class_PathFollow_get_h_offset: -- :ref:`float` **get_h_offset** **(** **)** const +- :ref:`float` **get_h_offset** **(** **)** const Returns the X displacement this node has from its parent :ref:`Path`. .. _class_PathFollow_get_offset: -- :ref:`float` **get_offset** **(** **)** const +- :ref:`float` **get_offset** **(** **)** const Returns the distance along the path in 3D units. .. _class_PathFollow_get_rotation_mode: -- :ref:`int` **get_rotation_mode** **(** **)** const +- :ref:`int` **get_rotation_mode** **(** **)** const Returns the rotation mode. The constants below list which axes are allowed to rotate for each mode. .. _class_PathFollow_get_unit_offset: -- :ref:`float` **get_unit_offset** **(** **)** const +- :ref:`float` **get_unit_offset** **(** **)** const Returns the distance along the path as a number in the range 0.0 (for the first vertex) to 1.0 (for the last). .. _class_PathFollow_get_v_offset: -- :ref:`float` **get_v_offset** **(** **)** const +- :ref:`float` **get_v_offset** **(** **)** const Returns the Y displacement this node has from its parent :ref:`Path`. .. _class_PathFollow_has_loop: -- :ref:`bool` **has_loop** **(** **)** const +- :ref:`bool` **has_loop** **(** **)** const Returns whether this node wraps its offsets around, or truncates them to the path ends. .. _class_PathFollow_set_cubic_interpolation: -- void **set_cubic_interpolation** **(** :ref:`bool` enable **)** +- void **set_cubic_interpolation** **(** :ref:`bool` enable **)** The points along the :ref:`Curve3D` of the :ref:`Path` are precomputed before use, for faster calculations. The point at the requested offset is then calculated interpolating between two adjacent cached points. This may present a problem if the curve makes sharp turns, as the cached points may not follow the curve closely enough. @@ -121,7 +121,7 @@ This method controls whether the position between two cached points is interpola .. _class_PathFollow_set_h_offset: -- void **set_h_offset** **(** :ref:`float` h_offset **)** +- void **set_h_offset** **(** :ref:`float` h_offset **)** Moves this node in the X axis. As this node's position will be set every time its offset is set, this allows many PathFollow to share the same curve (and thus the same movement pattern), yet not return the same position for a given path offset. @@ -129,31 +129,31 @@ A similar effect may be achieved moving the this node's descendants. .. _class_PathFollow_set_loop: -- void **set_loop** **(** :ref:`bool` loop **)** +- void **set_loop** **(** :ref:`bool` loop **)** If set, any offset outside the path's length (whether set by :ref:`set_offset` or :ref:`set_unit_offset` will wrap around, instead of stopping at the ends. Set it for cyclic paths. .. _class_PathFollow_set_offset: -- void **set_offset** **(** :ref:`float` offset **)** +- void **set_offset** **(** :ref:`float` offset **)** Sets the distance from the first vertex, measured in 3D units along the path. This sets this node's position to a point within the path. .. _class_PathFollow_set_rotation_mode: -- void **set_rotation_mode** **(** :ref:`int` rotation_mode **)** +- void **set_rotation_mode** **(** :ref:`int` rotation_mode **)** Allows or forbids rotation on one or more axes, per the constants below. .. _class_PathFollow_set_unit_offset: -- void **set_unit_offset** **(** :ref:`float` unit_offset **)** +- void **set_unit_offset** **(** :ref:`float` unit_offset **)** Sets the distance from the first vertex, considering 0.0 as the first vertex and 1.0 as the last. This is just another way of expressing the offset within the path, as the offset supplied is multiplied internally by the path's length. .. _class_PathFollow_set_v_offset: -- void **set_v_offset** **(** :ref:`float` v_offset **)** +- void **set_v_offset** **(** :ref:`float` v_offset **)** Moves this node in the Y axis, for the same reasons of :ref:`set_h_offset`. diff --git a/classes/class_pathfollow2d.rst b/classes/class_pathfollow2d.rst index 908c3c407..b13a1ff47 100644 --- a/classes/class_pathfollow2d.rst +++ b/classes/class_pathfollow2d.rst @@ -19,35 +19,35 @@ Point sampler for a :ref:`Path2D`. Member Functions ---------------- -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_cubic_interpolation` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_h_offset` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_offset` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_unit_offset` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_v_offset` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_loop` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_rotating` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cubic_interpolation` **(** :ref:`bool` enable **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_h_offset` **(** :ref:`float` h_offset **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_loop` **(** :ref:`bool` loop **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_offset` **(** :ref:`float` offset **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rotate` **(** :ref:`bool` enable **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_unit_offset` **(** :ref:`float` unit_offset **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_v_offset` **(** :ref:`float` v_offset **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------+ ++----------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_cubic_interpolation` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_h_offset` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_offset` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_unit_offset` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_v_offset` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_loop` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_rotating` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cubic_interpolation` **(** :ref:`bool` enable **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_h_offset` **(** :ref:`float` h_offset **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_loop` **(** :ref:`bool` loop **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_offset` **(** :ref:`float` offset **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rotate` **(** :ref:`bool` enable **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_unit_offset` **(** :ref:`float` unit_offset **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_v_offset` **(** :ref:`float` v_offset **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -61,49 +61,49 @@ Member Function Description .. _class_PathFollow2D_get_cubic_interpolation: -- :ref:`bool` **get_cubic_interpolation** **(** **)** const +- :ref:`bool` **get_cubic_interpolation** **(** **)** const This method returns whether the position between two cached points (see :ref:`set_cubic_interpolation`) is interpolated linearly, or cubicly. .. _class_PathFollow2D_get_h_offset: -- :ref:`float` **get_h_offset** **(** **)** const +- :ref:`float` **get_h_offset** **(** **)** const Returns the horizontal displacement this node has from its parent :ref:`Path2D`. .. _class_PathFollow2D_get_offset: -- :ref:`float` **get_offset** **(** **)** const +- :ref:`float` **get_offset** **(** **)** const Returns the distance along the path in pixels. .. _class_PathFollow2D_get_unit_offset: -- :ref:`float` **get_unit_offset** **(** **)** const +- :ref:`float` **get_unit_offset** **(** **)** const Returns the distance along the path as a number in the range 0.0 (for the first vertex) to 1.0 (for the last). .. _class_PathFollow2D_get_v_offset: -- :ref:`float` **get_v_offset** **(** **)** const +- :ref:`float` **get_v_offset** **(** **)** const Returns the vertical displacement this node has from its parent :ref:`Path2D`. .. _class_PathFollow2D_has_loop: -- :ref:`bool` **has_loop** **(** **)** const +- :ref:`bool` **has_loop** **(** **)** const Returns whether this node wraps its offsets around, or truncates them to the path ends. .. _class_PathFollow2D_is_rotating: -- :ref:`bool` **is_rotating** **(** **)** const +- :ref:`bool` **is_rotating** **(** **)** const Returns whether this node rotates to follow the path. .. _class_PathFollow2D_set_cubic_interpolation: -- void **set_cubic_interpolation** **(** :ref:`bool` enable **)** +- void **set_cubic_interpolation** **(** :ref:`bool` enable **)** The points along the :ref:`Curve2D` of the :ref:`Path2D` are precomputed before use, for faster calculations. The point at the requested offset is then calculated interpolating between two adjacent cached points. This may present a problem if the curve makes sharp turns, as the cached points may not follow the curve closely enough. @@ -113,7 +113,7 @@ This method controls whether the position between two cached points is interpola .. _class_PathFollow2D_set_h_offset: -- void **set_h_offset** **(** :ref:`float` h_offset **)** +- void **set_h_offset** **(** :ref:`float` h_offset **)** Moves this node horizontally. As this node's position will be set every time its offset is set, this allows many PathFollow2D to share the same curve (and thus the same movement pattern), yet not return the same position for a given path offset. @@ -121,31 +121,31 @@ A similar effect may be achieved moving this node's descendants. .. _class_PathFollow2D_set_loop: -- void **set_loop** **(** :ref:`bool` loop **)** +- void **set_loop** **(** :ref:`bool` loop **)** If set, any offset outside the path's length (whether set by :ref:`set_offset` or :ref:`set_unit_offset` will wrap around, instead of stopping at the ends. Set it for cyclic paths. .. _class_PathFollow2D_set_offset: -- void **set_offset** **(** :ref:`float` offset **)** +- void **set_offset** **(** :ref:`float` offset **)** Sets the distance from the first vertex, measured in pixels along the path. This sets this node's position to a point within the path. .. _class_PathFollow2D_set_rotate: -- void **set_rotate** **(** :ref:`bool` enable **)** +- void **set_rotate** **(** :ref:`bool` enable **)** If set, this node rotates to follow the path, making its descendants rotate. .. _class_PathFollow2D_set_unit_offset: -- void **set_unit_offset** **(** :ref:`float` unit_offset **)** +- void **set_unit_offset** **(** :ref:`float` unit_offset **)** Sets the distance from the first vertex, considering 0.0 as the first vertex and 1.0 as the last. This is just another way of expressing the offset within the path, as the offset supplied is multiplied internally by the path's length. .. _class_PathFollow2D_set_v_offset: -- void **set_v_offset** **(** :ref:`float` v_offset **)** +- void **set_v_offset** **(** :ref:`float` v_offset **)** Moves the PathFollow2D vertically, for the same reasons of :ref:`set_h_offset`. diff --git a/classes/class_pckpacker.rst b/classes/class_pckpacker.rst index 19fbdf192..a0a6b816f 100644 --- a/classes/class_pckpacker.rst +++ b/classes/class_pckpacker.rst @@ -19,27 +19,27 @@ Brief Description Member Functions ---------------- -+------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`add_file` **(** :ref:`String` pck_path, :ref:`String` source_path **)** | -+------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`flush` **(** :ref:`bool` verbose **)** | -+------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`pck_start` **(** :ref:`String` pck_name, :ref:`int` alignment **)** | -+------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`add_file` **(** :ref:`String` pck_path, :ref:`String` source_path **)** | ++------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`flush` **(** :ref:`bool` verbose **)** | ++------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`pck_start` **(** :ref:`String` pck_name, :ref:`int` alignment **)** | ++------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ Member Function Description --------------------------- .. _class_PCKPacker_add_file: -- :ref:`int` **add_file** **(** :ref:`String` pck_path, :ref:`String` source_path **)** +- :ref:`int` **add_file** **(** :ref:`String` pck_path, :ref:`String` source_path **)** .. _class_PCKPacker_flush: -- :ref:`int` **flush** **(** :ref:`bool` verbose **)** +- :ref:`int` **flush** **(** :ref:`bool` verbose **)** .. _class_PCKPacker_pck_start: -- :ref:`int` **pck_start** **(** :ref:`String` pck_name, :ref:`int` alignment **)** +- :ref:`int` **pck_start** **(** :ref:`String` pck_name, :ref:`int` alignment **)** diff --git a/classes/class_performance.rst b/classes/class_performance.rst index 0e247598f..8daaf8745 100644 --- a/classes/class_performance.rst +++ b/classes/class_performance.rst @@ -19,9 +19,9 @@ Exposes performance related data. Member Functions ---------------- -+----------------------------+-----------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_monitor` **(** :ref:`int` monitor **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------+ ++----------------------------+---------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_monitor` **(** :ref:`int` monitor **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -67,7 +67,7 @@ Member Function Description .. _class_Performance_get_monitor: -- :ref:`float` **get_monitor** **(** :ref:`int` monitor **)** const +- :ref:`float` **get_monitor** **(** :ref:`int` monitor **)** const Returns the value of one of the available monitors. You should provide one of this class's constants as the argument, like this: diff --git a/classes/class_phashtranslation.rst b/classes/class_phashtranslation.rst index bbd47421d..b1b7a0231 100644 --- a/classes/class_phashtranslation.rst +++ b/classes/class_phashtranslation.rst @@ -19,9 +19,9 @@ Optimized translation. Member Functions ---------------- -+-------+-----------------------------------------------------------------------------------------------------------+ -| void | :ref:`generate` **(** :ref:`Translation` from **)** | -+-------+-----------------------------------------------------------------------------------------------------------+ ++-------+---------------------------------------------------------------------------------------------------------+ +| void | :ref:`generate` **(** :ref:`Translation` from **)** | ++-------+---------------------------------------------------------------------------------------------------------+ Description ----------- @@ -33,6 +33,6 @@ Member Function Description .. _class_PHashTranslation_generate: -- void **generate** **(** :ref:`Translation` from **)** +- void **generate** **(** :ref:`Translation` from **)** diff --git a/classes/class_physics2ddirectbodystate.rst b/classes/class_physics2ddirectbodystate.rst index bac49c9fe..f3f3178c8 100644 --- a/classes/class_physics2ddirectbodystate.rst +++ b/classes/class_physics2ddirectbodystate.rst @@ -21,61 +21,61 @@ Direct access object to a physics body in the :ref:`Physics2DServer` | :ref:`get_angular_velocity` **(** **)** const | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_contact_collider` **(** :ref:`int` contact_idx **)** const | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_contact_collider_id` **(** :ref:`int` contact_idx **)** const | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_contact_collider_object` **(** :ref:`int` contact_idx **)** const | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_contact_collider_position` **(** :ref:`int` contact_idx **)** const | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_contact_collider_shape` **(** :ref:`int` contact_idx **)** const | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_contact_collider_shape_metadata` **(** :ref:`int` contact_idx **)** const | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_contact_collider_velocity_at_position` **(** :ref:`int` contact_idx **)** const | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_contact_count` **(** **)** const | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_contact_local_normal` **(** :ref:`int` contact_idx **)** const | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_contact_local_position` **(** :ref:`int` contact_idx **)** const | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_contact_local_shape` **(** :ref:`int` contact_idx **)** const | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_inverse_inertia` **(** **)** const | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_inverse_mass` **(** **)** const | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_linear_velocity` **(** **)** const | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Physics2DDirectSpaceState` | :ref:`get_space_state` **(** **)** | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_step` **(** **)** const | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_total_angular_damp` **(** **)** const | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_total_gravity` **(** **)** const | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_total_linear_damp` **(** **)** const | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_transform` **(** **)** const | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`integrate_forces` **(** **)** | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_sleeping` **(** **)** const | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_angular_velocity` **(** :ref:`float` velocity **)** | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_linear_velocity` **(** :ref:`Vector2` velocity **)** | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sleep_state` **(** :ref:`bool` enabled **)** | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_transform` **(** :ref:`Transform2D` transform **)** | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_angular_velocity` **(** **)** const | ++--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_contact_collider` **(** :ref:`int` contact_idx **)** const | ++--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_contact_collider_id` **(** :ref:`int` contact_idx **)** const | ++--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_contact_collider_object` **(** :ref:`int` contact_idx **)** const | ++--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_contact_collider_position` **(** :ref:`int` contact_idx **)** const | ++--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_contact_collider_shape` **(** :ref:`int` contact_idx **)** const | ++--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_contact_collider_shape_metadata` **(** :ref:`int` contact_idx **)** const | ++--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_contact_collider_velocity_at_position` **(** :ref:`int` contact_idx **)** const | ++--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_contact_count` **(** **)** const | ++--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_contact_local_normal` **(** :ref:`int` contact_idx **)** const | ++--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_contact_local_position` **(** :ref:`int` contact_idx **)** const | ++--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_contact_local_shape` **(** :ref:`int` contact_idx **)** const | ++--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_inverse_inertia` **(** **)** const | ++--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_inverse_mass` **(** **)** const | ++--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_linear_velocity` **(** **)** const | ++--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Physics2DDirectSpaceState` | :ref:`get_space_state` **(** **)** | ++--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_step` **(** **)** const | ++--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_total_angular_damp` **(** **)** const | ++--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_total_gravity` **(** **)** const | ++--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_total_linear_damp` **(** **)** const | ++--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_transform` **(** **)** const | ++--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`integrate_forces` **(** **)** | ++--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_sleeping` **(** **)** const | ++--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_angular_velocity` **(** :ref:`float` velocity **)** | ++--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_linear_velocity` **(** :ref:`Vector2` velocity **)** | ++--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_sleep_state` **(** :ref:`bool` enabled **)** | ++--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_transform` **(** :ref:`Transform2D` transform **)** | ++--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -87,163 +87,163 @@ Member Function Description .. _class_Physics2DDirectBodyState_get_angular_velocity: -- :ref:`float` **get_angular_velocity** **(** **)** const +- :ref:`float` **get_angular_velocity** **(** **)** const Return the angular velocity of the body. .. _class_Physics2DDirectBodyState_get_contact_collider: -- :ref:`RID` **get_contact_collider** **(** :ref:`int` contact_idx **)** const +- :ref:`RID` **get_contact_collider** **(** :ref:`int` contact_idx **)** const Return the :ref:`RID` of the collider. .. _class_Physics2DDirectBodyState_get_contact_collider_id: -- :ref:`int` **get_contact_collider_id** **(** :ref:`int` contact_idx **)** const +- :ref:`int` **get_contact_collider_id** **(** :ref:`int` contact_idx **)** const Return the object id of the collider. .. _class_Physics2DDirectBodyState_get_contact_collider_object: -- :ref:`Object` **get_contact_collider_object** **(** :ref:`int` contact_idx **)** const +- :ref:`Object` **get_contact_collider_object** **(** :ref:`int` contact_idx **)** const Return the collider object, this depends on how it was created (will return a scene node if such was used to create it). .. _class_Physics2DDirectBodyState_get_contact_collider_position: -- :ref:`Vector2` **get_contact_collider_position** **(** :ref:`int` contact_idx **)** const +- :ref:`Vector2` **get_contact_collider_position** **(** :ref:`int` contact_idx **)** const Return the contact position in the collider. .. _class_Physics2DDirectBodyState_get_contact_collider_shape: -- :ref:`int` **get_contact_collider_shape** **(** :ref:`int` contact_idx **)** const +- :ref:`int` **get_contact_collider_shape** **(** :ref:`int` contact_idx **)** const Return the collider shape index. .. _class_Physics2DDirectBodyState_get_contact_collider_shape_metadata: -- :ref:`Variant` **get_contact_collider_shape_metadata** **(** :ref:`int` contact_idx **)** const +- :ref:`Variant` **get_contact_collider_shape_metadata** **(** :ref:`int` contact_idx **)** const Return the metadata of the collided shape. This metadata is different from :ref:`Object.get_meta`, and is set with :ref:`Physics2DServer.shape_set_data`. .. _class_Physics2DDirectBodyState_get_contact_collider_velocity_at_position: -- :ref:`Vector2` **get_contact_collider_velocity_at_position** **(** :ref:`int` contact_idx **)** const +- :ref:`Vector2` **get_contact_collider_velocity_at_position** **(** :ref:`int` contact_idx **)** const Return the linear velocity vector at contact point of the collider. .. _class_Physics2DDirectBodyState_get_contact_count: -- :ref:`int` **get_contact_count** **(** **)** const +- :ref:`int` **get_contact_count** **(** **)** const Return the amount of contacts this body has with other bodies. Note that by default this returns 0 unless bodies are configured to log contacts. .. _class_Physics2DDirectBodyState_get_contact_local_normal: -- :ref:`Vector2` **get_contact_local_normal** **(** :ref:`int` contact_idx **)** const +- :ref:`Vector2` **get_contact_local_normal** **(** :ref:`int` contact_idx **)** const Return the local normal (of this body) of the contact point. .. _class_Physics2DDirectBodyState_get_contact_local_position: -- :ref:`Vector2` **get_contact_local_position** **(** :ref:`int` contact_idx **)** const +- :ref:`Vector2` **get_contact_local_position** **(** :ref:`int` contact_idx **)** const Return the local position (of this body) of the contact point. .. _class_Physics2DDirectBodyState_get_contact_local_shape: -- :ref:`int` **get_contact_local_shape** **(** :ref:`int` contact_idx **)** const +- :ref:`int` **get_contact_local_shape** **(** :ref:`int` contact_idx **)** const Return the local shape index of the collision. .. _class_Physics2DDirectBodyState_get_inverse_inertia: -- :ref:`float` **get_inverse_inertia** **(** **)** const +- :ref:`float` **get_inverse_inertia** **(** **)** const Return the inverse of the inertia of the body. .. _class_Physics2DDirectBodyState_get_inverse_mass: -- :ref:`float` **get_inverse_mass** **(** **)** const +- :ref:`float` **get_inverse_mass** **(** **)** const Return the inverse of the mass of the body. .. _class_Physics2DDirectBodyState_get_linear_velocity: -- :ref:`Vector2` **get_linear_velocity** **(** **)** const +- :ref:`Vector2` **get_linear_velocity** **(** **)** const Return the current linear velocity of the body. .. _class_Physics2DDirectBodyState_get_space_state: -- :ref:`Physics2DDirectSpaceState` **get_space_state** **(** **)** +- :ref:`Physics2DDirectSpaceState` **get_space_state** **(** **)** Return the current state of space, useful for queries. .. _class_Physics2DDirectBodyState_get_step: -- :ref:`float` **get_step** **(** **)** const +- :ref:`float` **get_step** **(** **)** const Return the timestep (delta) used for the simulation. .. _class_Physics2DDirectBodyState_get_total_angular_damp: -- :ref:`float` **get_total_angular_damp** **(** **)** const +- :ref:`float` **get_total_angular_damp** **(** **)** const Return the rate at which the body stops rotating, if there are not any other forces moving it. .. _class_Physics2DDirectBodyState_get_total_gravity: -- :ref:`Vector2` **get_total_gravity** **(** **)** const +- :ref:`Vector2` **get_total_gravity** **(** **)** const Return the total gravity vector being currently applied to this body. .. _class_Physics2DDirectBodyState_get_total_linear_damp: -- :ref:`float` **get_total_linear_damp** **(** **)** const +- :ref:`float` **get_total_linear_damp** **(** **)** const Return the rate at which the body stops moving, if there are not any other forces moving it. .. _class_Physics2DDirectBodyState_get_transform: -- :ref:`Transform2D` **get_transform** **(** **)** const +- :ref:`Transform2D` **get_transform** **(** **)** const Return the transform matrix of the body. .. _class_Physics2DDirectBodyState_integrate_forces: -- void **integrate_forces** **(** **)** +- void **integrate_forces** **(** **)** Call the built-in force integration code. .. _class_Physics2DDirectBodyState_is_sleeping: -- :ref:`bool` **is_sleeping** **(** **)** const +- :ref:`bool` **is_sleeping** **(** **)** const Return true if this body is currently sleeping (not active). .. _class_Physics2DDirectBodyState_set_angular_velocity: -- void **set_angular_velocity** **(** :ref:`float` velocity **)** +- void **set_angular_velocity** **(** :ref:`float` velocity **)** Change the angular velocity of the body. .. _class_Physics2DDirectBodyState_set_linear_velocity: -- void **set_linear_velocity** **(** :ref:`Vector2` velocity **)** +- void **set_linear_velocity** **(** :ref:`Vector2` velocity **)** Change the linear velocity of the body. .. _class_Physics2DDirectBodyState_set_sleep_state: -- void **set_sleep_state** **(** :ref:`bool` enabled **)** +- void **set_sleep_state** **(** :ref:`bool` enabled **)** Set the sleeping state of the body, only affects character/rigid bodies. .. _class_Physics2DDirectBodyState_set_transform: -- void **set_transform** **(** :ref:`Transform2D` transform **)** +- void **set_transform** **(** :ref:`Transform2D` transform **)** Change the transform matrix of the body. diff --git a/classes/class_physics2ddirectspacestate.rst b/classes/class_physics2ddirectspacestate.rst index 6b72e06e4..b97e9ffde 100644 --- a/classes/class_physics2ddirectspacestate.rst +++ b/classes/class_physics2ddirectspacestate.rst @@ -19,19 +19,19 @@ Direct access object to a space in the :ref:`Physics2DServer` | :ref:`cast_motion` **(** :ref:`Physics2DShapeQueryParameters` shape **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`collide_shape` **(** :ref:`Physics2DShapeQueryParameters` shape, :ref:`int` max_results=32 **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_rest_info` **(** :ref:`Physics2DShapeQueryParameters` shape **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`intersect_point` **(** :ref:`Vector2` point, :ref:`int` max_results=32, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=2147483647, :ref:`int` type_mask=15 **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`intersect_ray` **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=2147483647, :ref:`int` type_mask=15 **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`intersect_shape` **(** :ref:`Physics2DShapeQueryParameters` shape, :ref:`int` max_results=32 **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`cast_motion` **(** :ref:`Physics2DShapeQueryParameters` shape **)** | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`collide_shape` **(** :ref:`Physics2DShapeQueryParameters` shape, :ref:`int` max_results=32 **)** | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_rest_info` **(** :ref:`Physics2DShapeQueryParameters` shape **)** | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`intersect_point` **(** :ref:`Vector2` point, :ref:`int` max_results=32, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=2147483647, :ref:`int` type_mask=15 **)** | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`intersect_ray` **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=2147483647, :ref:`int` type_mask=15 **)** | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`intersect_shape` **(** :ref:`Physics2DShapeQueryParameters` shape, :ref:`int` max_results=32 **)** | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -53,7 +53,7 @@ Member Function Description .. _class_Physics2DDirectSpaceState_cast_motion: -- :ref:`Array` **cast_motion** **(** :ref:`Physics2DShapeQueryParameters` shape **)** +- :ref:`Array` **cast_motion** **(** :ref:`Physics2DShapeQueryParameters` shape **)** Check whether the shape can travel to a point. If it can, the method will return an array with two floats: The first is the distance the shape can move in that direction without colliding, and the second is the distance at which it will collide. @@ -61,13 +61,13 @@ If the shape can not move, the array will be empty. .. _class_Physics2DDirectSpaceState_collide_shape: -- :ref:`Array` **collide_shape** **(** :ref:`Physics2DShapeQueryParameters` shape, :ref:`int` max_results=32 **)** +- :ref:`Array` **collide_shape** **(** :ref:`Physics2DShapeQueryParameters` shape, :ref:`int` max_results=32 **)** Check the intersections of a shape, given through a :ref:`Physics2DShapeQueryParameters` object, against the space. The resulting array contains a list of points where the shape intersects another. Like with :ref:`intersect_shape`, the number of returned results can be limited to save processing time. .. _class_Physics2DDirectSpaceState_get_rest_info: -- :ref:`Dictionary` **get_rest_info** **(** :ref:`Physics2DShapeQueryParameters` shape **)** +- :ref:`Dictionary` **get_rest_info** **(** :ref:`Physics2DShapeQueryParameters` shape **)** Check the intersections of a shape, given through a :ref:`Physics2DShapeQueryParameters` object, against the space. If it collides with more than a shape, the nearest one is selected. The returned object is a dictionary containing the following fields: @@ -91,7 +91,7 @@ If the shape did not intersect anything, then an empty dictionary (dir.empty()== .. _class_Physics2DDirectSpaceState_intersect_point: -- :ref:`Array` **intersect_point** **(** :ref:`Vector2` point, :ref:`int` max_results=32, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=2147483647, :ref:`int` type_mask=15 **)** +- :ref:`Array` **intersect_point** **(** :ref:`Vector2` point, :ref:`int` max_results=32, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=2147483647, :ref:`int` type_mask=15 **)** Check whether a point is inside any shape. The shapes the point is inside of are returned in an array containing dictionaries with the following fields: @@ -109,7 +109,7 @@ Additionally, the method can take an array of objects or :ref:`RID`\ .. _class_Physics2DDirectSpaceState_intersect_ray: -- :ref:`Dictionary` **intersect_ray** **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=2147483647, :ref:`int` type_mask=15 **)** +- :ref:`Dictionary` **intersect_ray** **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=2147483647, :ref:`int` type_mask=15 **)** Intersect a ray in a given space. The returned object is a dictionary with the following fields: @@ -133,7 +133,7 @@ Additionally, the method can take an array of objects or :ref:`RID`\ .. _class_Physics2DDirectSpaceState_intersect_shape: -- :ref:`Array` **intersect_shape** **(** :ref:`Physics2DShapeQueryParameters` shape, :ref:`int` max_results=32 **)** +- :ref:`Array` **intersect_shape** **(** :ref:`Physics2DShapeQueryParameters` shape, :ref:`int` max_results=32 **)** Check the intersections of a shape, given through a :ref:`Physics2DShapeQueryParameters` object, against the space. The intersected shapes are returned in an array containing dictionaries with the following fields: diff --git a/classes/class_physics2dserver.rst b/classes/class_physics2dserver.rst index 150d4e616..dc555a405 100644 --- a/classes/class_physics2dserver.rst +++ b/classes/class_physics2dserver.rst @@ -21,177 +21,177 @@ Physics 2D Server. Member Functions ---------------- -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_add_shape` **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform2D` transform=Transform2D( 1, 0, 0, 1, 0, 0 ) **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_attach_object_instance_id` **(** :ref:`RID` area, :ref:`int` id **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_clear_shapes` **(** :ref:`RID` area **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`area_create` **(** **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`area_get_object_instance_id` **(** :ref:`RID` area **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`area_get_param` **(** :ref:`RID` area, :ref:`int` param **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`area_get_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`area_get_shape_count` **(** :ref:`RID` area **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`area_get_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`area_get_space` **(** :ref:`RID` area **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`area_get_space_override_mode` **(** :ref:`RID` area **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`area_get_transform` **(** :ref:`RID` area **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_remove_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_collision_layer` **(** :ref:`RID` area, :ref:`int` layer **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_collision_mask` **(** :ref:`RID` area, :ref:`int` mask **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_monitor_callback` **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_param` **(** :ref:`RID` area, :ref:`int` param, :ref:`Variant` value **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_shape` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`RID` shape **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_shape_disabled` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`bool` disable **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`Transform2D` transform **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_space` **(** :ref:`RID` area, :ref:`RID` space **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_space_override_mode` **(** :ref:`RID` area, :ref:`int` mode **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_transform` **(** :ref:`RID` area, :ref:`Transform2D` transform **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_add_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_add_force` **(** :ref:`RID` body, :ref:`Vector2` offset, :ref:`Vector2` force **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_add_shape` **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform2D` transform=Transform2D( 1, 0, 0, 1, 0, 0 ) **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_apply_impulse` **(** :ref:`RID` body, :ref:`Vector2` position, :ref:`Vector2` impulse **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_attach_object_instance_id` **(** :ref:`RID` body, :ref:`int` id **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_clear_shapes` **(** :ref:`RID` body **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`body_create` **(** :ref:`int` mode=2, :ref:`bool` init_sleeping=false **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_collision_layer` **(** :ref:`RID` body **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_collision_mask` **(** :ref:`RID` body **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_continuous_collision_detection_mode` **(** :ref:`RID` body **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Physics2DDirectBodyState` | :ref:`body_get_direct_state` **(** :ref:`RID` body **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_max_contacts_reported` **(** :ref:`RID` body **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_mode` **(** :ref:`RID` body **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_object_instance_id` **(** :ref:`RID` body **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`body_get_param` **(** :ref:`RID` body, :ref:`int` param **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`body_get_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_shape_count` **(** :ref:`RID` body **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`body_get_shape_metadata` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`body_get_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`body_get_space` **(** :ref:`RID` body **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`body_get_state` **(** :ref:`RID` body, :ref:`int` state **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`body_is_omitting_force_integration` **(** :ref:`RID` body **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_remove_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_remove_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_axis_velocity` **(** :ref:`RID` body, :ref:`Vector2` axis_velocity **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_collision_layer` **(** :ref:`RID` body, :ref:`int` layer **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_collision_mask` **(** :ref:`RID` body, :ref:`int` mask **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_continuous_collision_detection_mode` **(** :ref:`RID` body, :ref:`int` mode **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_force_integration_callback` **(** :ref:`RID` body, :ref:`Object` receiver, :ref:`String` method, :ref:`Variant` userdata=null **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_max_contacts_reported` **(** :ref:`RID` body, :ref:`int` amount **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_mode` **(** :ref:`RID` body, :ref:`int` mode **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_omit_force_integration` **(** :ref:`RID` body, :ref:`bool` enable **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_param` **(** :ref:`RID` body, :ref:`int` param, :ref:`float` value **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_shape` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`RID` shape **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_shape_as_one_way_collision` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` enable **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_shape_disabled` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` disable **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_shape_metadata` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Variant` metadata **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Transform2D` transform **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_space` **(** :ref:`RID` body, :ref:`RID` space **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_state` **(** :ref:`RID` body, :ref:`int` state, :ref:`Variant` value **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`body_test_motion` **(** :ref:`RID` body, :ref:`Transform2D` from, :ref:`Vector2` motion, :ref:`float` margin=0.08, :ref:`Physics2DTestMotionResult` result=null **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`damped_spring_joint_create` **(** :ref:`Vector2` anchor_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a, :ref:`RID` body_b **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`damped_string_joint_get_param` **(** :ref:`RID` joint, :ref:`int` param **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`damped_string_joint_set_param` **(** :ref:`RID` joint, :ref:`int` param, :ref:`float` value **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`free_rid` **(** :ref:`RID` rid **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_process_info` **(** :ref:`int` process_info **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`groove_joint_create` **(** :ref:`Vector2` groove1_a, :ref:`Vector2` groove2_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a, :ref:`RID` body_b **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`joint_get_param` **(** :ref:`RID` joint, :ref:`int` param **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`joint_get_type` **(** :ref:`RID` joint **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`joint_set_param` **(** :ref:`RID` joint, :ref:`int` param, :ref:`float` value **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`pin_joint_create` **(** :ref:`Vector2` anchor, :ref:`RID` body_a, :ref:`RID` body_b **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_active` **(** :ref:`bool` active **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`shape_create` **(** :ref:`int` type **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`shape_get_data` **(** :ref:`RID` shape **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`shape_get_type` **(** :ref:`RID` shape **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shape_set_data` **(** :ref:`RID` shape, :ref:`Variant` data **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`space_create` **(** **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Physics2DDirectSpaceState` | :ref:`space_get_direct_state` **(** :ref:`RID` space **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`space_get_param` **(** :ref:`RID` space, :ref:`int` param **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`space_is_active` **(** :ref:`RID` space **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`space_set_active` **(** :ref:`RID` space, :ref:`bool` active **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`space_set_param` **(** :ref:`RID` space, :ref:`int` param, :ref:`float` value **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_add_shape` **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform2D` transform=Transform2D( 1, 0, 0, 1, 0, 0 ) **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_attach_object_instance_id` **(** :ref:`RID` area, :ref:`int` id **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_clear_shapes` **(** :ref:`RID` area **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`area_create` **(** **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`area_get_object_instance_id` **(** :ref:`RID` area **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`area_get_param` **(** :ref:`RID` area, :ref:`int` param **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`area_get_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`area_get_shape_count` **(** :ref:`RID` area **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`area_get_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`area_get_space` **(** :ref:`RID` area **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`area_get_space_override_mode` **(** :ref:`RID` area **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`area_get_transform` **(** :ref:`RID` area **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_remove_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_collision_layer` **(** :ref:`RID` area, :ref:`int` layer **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_collision_mask` **(** :ref:`RID` area, :ref:`int` mask **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_monitor_callback` **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_param` **(** :ref:`RID` area, :ref:`int` param, :ref:`Variant` value **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_shape` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`RID` shape **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_shape_disabled` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`bool` disable **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`Transform2D` transform **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_space` **(** :ref:`RID` area, :ref:`RID` space **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_space_override_mode` **(** :ref:`RID` area, :ref:`int` mode **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_transform` **(** :ref:`RID` area, :ref:`Transform2D` transform **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_add_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_add_force` **(** :ref:`RID` body, :ref:`Vector2` offset, :ref:`Vector2` force **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_add_shape` **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform2D` transform=Transform2D( 1, 0, 0, 1, 0, 0 ) **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_apply_impulse` **(** :ref:`RID` body, :ref:`Vector2` position, :ref:`Vector2` impulse **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_attach_object_instance_id` **(** :ref:`RID` body, :ref:`int` id **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_clear_shapes` **(** :ref:`RID` body **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`body_create` **(** :ref:`int` mode=2, :ref:`bool` init_sleeping=false **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`body_get_collision_layer` **(** :ref:`RID` body **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`body_get_collision_mask` **(** :ref:`RID` body **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`body_get_continuous_collision_detection_mode` **(** :ref:`RID` body **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Physics2DDirectBodyState` | :ref:`body_get_direct_state` **(** :ref:`RID` body **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`body_get_max_contacts_reported` **(** :ref:`RID` body **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`body_get_mode` **(** :ref:`RID` body **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`body_get_object_instance_id` **(** :ref:`RID` body **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`body_get_param` **(** :ref:`RID` body, :ref:`int` param **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`body_get_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`body_get_shape_count` **(** :ref:`RID` body **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`body_get_shape_metadata` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`body_get_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`body_get_space` **(** :ref:`RID` body **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`body_get_state` **(** :ref:`RID` body, :ref:`int` state **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`body_is_omitting_force_integration` **(** :ref:`RID` body **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_remove_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_remove_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_axis_velocity` **(** :ref:`RID` body, :ref:`Vector2` axis_velocity **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_collision_layer` **(** :ref:`RID` body, :ref:`int` layer **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_collision_mask` **(** :ref:`RID` body, :ref:`int` mask **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_continuous_collision_detection_mode` **(** :ref:`RID` body, :ref:`int` mode **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_force_integration_callback` **(** :ref:`RID` body, :ref:`Object` receiver, :ref:`String` method, :ref:`Variant` userdata=null **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_max_contacts_reported` **(** :ref:`RID` body, :ref:`int` amount **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_mode` **(** :ref:`RID` body, :ref:`int` mode **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_omit_force_integration` **(** :ref:`RID` body, :ref:`bool` enable **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_param` **(** :ref:`RID` body, :ref:`int` param, :ref:`float` value **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_shape` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`RID` shape **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_shape_as_one_way_collision` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` enable **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_shape_disabled` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` disable **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_shape_metadata` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Variant` metadata **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Transform2D` transform **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_space` **(** :ref:`RID` body, :ref:`RID` space **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_state` **(** :ref:`RID` body, :ref:`int` state, :ref:`Variant` value **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`body_test_motion` **(** :ref:`RID` body, :ref:`Transform2D` from, :ref:`Vector2` motion, :ref:`float` margin=0.08, :ref:`Physics2DTestMotionResult` result=null **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`damped_spring_joint_create` **(** :ref:`Vector2` anchor_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a, :ref:`RID` body_b **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`damped_string_joint_get_param` **(** :ref:`RID` joint, :ref:`int` param **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`damped_string_joint_set_param` **(** :ref:`RID` joint, :ref:`int` param, :ref:`float` value **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`free_rid` **(** :ref:`RID` rid **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_process_info` **(** :ref:`int` process_info **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`groove_joint_create` **(** :ref:`Vector2` groove1_a, :ref:`Vector2` groove2_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a, :ref:`RID` body_b **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`joint_get_param` **(** :ref:`RID` joint, :ref:`int` param **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`joint_get_type` **(** :ref:`RID` joint **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`joint_set_param` **(** :ref:`RID` joint, :ref:`int` param, :ref:`float` value **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`pin_joint_create` **(** :ref:`Vector2` anchor, :ref:`RID` body_a, :ref:`RID` body_b **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_active` **(** :ref:`bool` active **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`shape_create` **(** :ref:`int` type **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`shape_get_data` **(** :ref:`RID` shape **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`shape_get_type` **(** :ref:`RID` shape **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shape_set_data` **(** :ref:`RID` shape, :ref:`Variant` data **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`space_create` **(** **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Physics2DDirectSpaceState` | :ref:`space_get_direct_state` **(** :ref:`RID` space **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`space_get_param` **(** :ref:`RID` space, :ref:`int` param **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`space_is_active` **(** :ref:`RID` space **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`space_set_active` **(** :ref:`RID` space, :ref:`bool` active **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`space_set_param` **(** :ref:`RID` space, :ref:`int` param, :ref:`float` value **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -266,97 +266,97 @@ Member Function Description .. _class_Physics2DServer_area_add_shape: -- void **area_add_shape** **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform2D` transform=Transform2D( 1, 0, 0, 1, 0, 0 ) **)** +- void **area_add_shape** **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform2D` transform=Transform2D( 1, 0, 0, 1, 0, 0 ) **)** Adds a shape to the area, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index. .. _class_Physics2DServer_area_attach_object_instance_id: -- void **area_attach_object_instance_id** **(** :ref:`RID` area, :ref:`int` id **)** +- void **area_attach_object_instance_id** **(** :ref:`RID` area, :ref:`int` id **)** Assigns the area to a descendant of :ref:`Object`, so it can exist in the node tree. .. _class_Physics2DServer_area_clear_shapes: -- void **area_clear_shapes** **(** :ref:`RID` area **)** +- void **area_clear_shapes** **(** :ref:`RID` area **)** Removes all shapes from an area. It does not delete the shapes, so they can be reassigned later. .. _class_Physics2DServer_area_create: -- :ref:`RID` **area_create** **(** **)** +- :ref:`RID` **area_create** **(** **)** Creates an :ref:`Area2D`. .. _class_Physics2DServer_area_get_object_instance_id: -- :ref:`int` **area_get_object_instance_id** **(** :ref:`RID` area **)** const +- :ref:`int` **area_get_object_instance_id** **(** :ref:`RID` area **)** const Gets the instance ID of the object the area is assigned to. .. _class_Physics2DServer_area_get_param: -- :ref:`Variant` **area_get_param** **(** :ref:`RID` area, :ref:`int` param **)** const +- :ref:`Variant` **area_get_param** **(** :ref:`RID` area, :ref:`int` param **)** const Returns an area parameter value. A list of available parameters is on the AREA_PARAM\_\* constants. .. _class_Physics2DServer_area_get_shape: -- :ref:`RID` **area_get_shape** **(** :ref:`RID` area, :ref:`int` shape_idx **)** const +- :ref:`RID` **area_get_shape** **(** :ref:`RID` area, :ref:`int` shape_idx **)** const Returns the :ref:`RID` of the nth shape of an area. .. _class_Physics2DServer_area_get_shape_count: -- :ref:`int` **area_get_shape_count** **(** :ref:`RID` area **)** const +- :ref:`int` **area_get_shape_count** **(** :ref:`RID` area **)** const Returns the number of shapes assigned to an area. .. _class_Physics2DServer_area_get_shape_transform: -- :ref:`Transform2D` **area_get_shape_transform** **(** :ref:`RID` area, :ref:`int` shape_idx **)** const +- :ref:`Transform2D` **area_get_shape_transform** **(** :ref:`RID` area, :ref:`int` shape_idx **)** const Returns the transform matrix of a shape within an area. .. _class_Physics2DServer_area_get_space: -- :ref:`RID` **area_get_space** **(** :ref:`RID` area **)** const +- :ref:`RID` **area_get_space** **(** :ref:`RID` area **)** const Returns the space assigned to the area. .. _class_Physics2DServer_area_get_space_override_mode: -- :ref:`int` **area_get_space_override_mode** **(** :ref:`RID` area **)** const +- :ref:`int` **area_get_space_override_mode** **(** :ref:`RID` area **)** const Returns the space override mode for the area. .. _class_Physics2DServer_area_get_transform: -- :ref:`Transform2D` **area_get_transform** **(** :ref:`RID` area **)** const +- :ref:`Transform2D` **area_get_transform** **(** :ref:`RID` area **)** const Returns the transform matrix for an area. .. _class_Physics2DServer_area_remove_shape: -- void **area_remove_shape** **(** :ref:`RID` area, :ref:`int` shape_idx **)** +- void **area_remove_shape** **(** :ref:`RID` area, :ref:`int` shape_idx **)** Removes a shape from an area. It does not delete the shape, so it can be reassigned later. .. _class_Physics2DServer_area_set_collision_layer: -- void **area_set_collision_layer** **(** :ref:`RID` area, :ref:`int` layer **)** +- void **area_set_collision_layer** **(** :ref:`RID` area, :ref:`int` layer **)** Assigns the area to one or many physics layers. .. _class_Physics2DServer_area_set_collision_mask: -- void **area_set_collision_mask** **(** :ref:`RID` area, :ref:`int` mask **)** +- void **area_set_collision_mask** **(** :ref:`RID` area, :ref:`int` mask **)** Sets which physics layers the area will monitor. .. _class_Physics2DServer_area_set_monitor_callback: -- void **area_set_monitor_callback** **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** +- void **area_set_monitor_callback** **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** Sets the function to call when any body/area enters or exits the area. This callback will be called for any object interacting with the area, and takes five parameters: @@ -372,211 +372,211 @@ Sets the function to call when any body/area enters or exits the area. This call .. _class_Physics2DServer_area_set_param: -- void **area_set_param** **(** :ref:`RID` area, :ref:`int` param, :ref:`Variant` value **)** +- void **area_set_param** **(** :ref:`RID` area, :ref:`int` param, :ref:`Variant` value **)** Sets the value for an area parameter. A list of available parameters is on the AREA_PARAM\_\* constants. .. _class_Physics2DServer_area_set_shape: -- void **area_set_shape** **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`RID` shape **)** +- void **area_set_shape** **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`RID` shape **)** Substitutes a given area shape by another. The old shape is selected by its index, the new one by its :ref:`RID`. .. _class_Physics2DServer_area_set_shape_disabled: -- void **area_set_shape_disabled** **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`bool` disable **)** +- void **area_set_shape_disabled** **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`bool` disable **)** Disables a given shape in this area if ``disable is true`` .. _class_Physics2DServer_area_set_shape_transform: -- void **area_set_shape_transform** **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`Transform2D` transform **)** +- void **area_set_shape_transform** **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`Transform2D` transform **)** Sets the transform matrix for an area shape. .. _class_Physics2DServer_area_set_space: -- void **area_set_space** **(** :ref:`RID` area, :ref:`RID` space **)** +- void **area_set_space** **(** :ref:`RID` area, :ref:`RID` space **)** Assigns a space to the area. .. _class_Physics2DServer_area_set_space_override_mode: -- void **area_set_space_override_mode** **(** :ref:`RID` area, :ref:`int` mode **)** +- void **area_set_space_override_mode** **(** :ref:`RID` area, :ref:`int` mode **)** Sets the space override mode for the area. The modes are described in the constants AREA_SPACE_OVERRIDE\_\*. .. _class_Physics2DServer_area_set_transform: -- void **area_set_transform** **(** :ref:`RID` area, :ref:`Transform2D` transform **)** +- void **area_set_transform** **(** :ref:`RID` area, :ref:`Transform2D` transform **)** Sets the transform matrix for an area. .. _class_Physics2DServer_body_add_collision_exception: -- void **body_add_collision_exception** **(** :ref:`RID` body, :ref:`RID` excepted_body **)** +- void **body_add_collision_exception** **(** :ref:`RID` body, :ref:`RID` excepted_body **)** Adds a body to the list of bodies exempt from collisions. .. _class_Physics2DServer_body_add_force: -- void **body_add_force** **(** :ref:`RID` body, :ref:`Vector2` offset, :ref:`Vector2` force **)** +- void **body_add_force** **(** :ref:`RID` body, :ref:`Vector2` offset, :ref:`Vector2` force **)** Adds a positioned force to the applied force and torque. As with :ref:`body_apply_impulse`, both the force and the offset from the body origin are in global coordinates. A force differs from an impulse in that, while the two are forces, the impulse clears itself after being applied. .. _class_Physics2DServer_body_add_shape: -- void **body_add_shape** **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform2D` transform=Transform2D( 1, 0, 0, 1, 0, 0 ) **)** +- void **body_add_shape** **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform2D` transform=Transform2D( 1, 0, 0, 1, 0, 0 ) **)** Adds a shape to the body, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index. .. _class_Physics2DServer_body_apply_impulse: -- void **body_apply_impulse** **(** :ref:`RID` body, :ref:`Vector2` position, :ref:`Vector2` impulse **)** +- void **body_apply_impulse** **(** :ref:`RID` body, :ref:`Vector2` position, :ref:`Vector2` impulse **)** Adds a positioned impulse to the applied force and torque. Both the force and the offset from the body origin are in global coordinates. .. _class_Physics2DServer_body_attach_object_instance_id: -- void **body_attach_object_instance_id** **(** :ref:`RID` body, :ref:`int` id **)** +- void **body_attach_object_instance_id** **(** :ref:`RID` body, :ref:`int` id **)** Assigns the area to a descendant of :ref:`Object`, so it can exist in the node tree. .. _class_Physics2DServer_body_clear_shapes: -- void **body_clear_shapes** **(** :ref:`RID` body **)** +- void **body_clear_shapes** **(** :ref:`RID` body **)** Removes all shapes from a body. .. _class_Physics2DServer_body_create: -- :ref:`RID` **body_create** **(** :ref:`int` mode=2, :ref:`bool` init_sleeping=false **)** +- :ref:`RID` **body_create** **(** :ref:`int` mode=2, :ref:`bool` init_sleeping=false **)** Creates a physics body. The first parameter can be any value from constants BODY_MODE\*, for the type of body created. Additionally, the body can be created in sleeping state to save processing time. .. _class_Physics2DServer_body_get_collision_layer: -- :ref:`int` **body_get_collision_layer** **(** :ref:`RID` body **)** const +- :ref:`int` **body_get_collision_layer** **(** :ref:`RID` body **)** const Returns the physics layer or layers a body belongs to. .. _class_Physics2DServer_body_get_collision_mask: -- :ref:`int` **body_get_collision_mask** **(** :ref:`RID` body **)** const +- :ref:`int` **body_get_collision_mask** **(** :ref:`RID` body **)** const Returns the physics layer or layers a body can collide with. .. _class_Physics2DServer_body_get_continuous_collision_detection_mode: -- :ref:`int` **body_get_continuous_collision_detection_mode** **(** :ref:`RID` body **)** const +- :ref:`int` **body_get_continuous_collision_detection_mode** **(** :ref:`RID` body **)** const Returns the continuous collision detection mode. .. _class_Physics2DServer_body_get_direct_state: -- :ref:`Physics2DDirectBodyState` **body_get_direct_state** **(** :ref:`RID` body **)** +- :ref:`Physics2DDirectBodyState` **body_get_direct_state** **(** :ref:`RID` body **)** Returns the :ref:`Physics2DDirectBodyState` of the body. .. _class_Physics2DServer_body_get_max_contacts_reported: -- :ref:`int` **body_get_max_contacts_reported** **(** :ref:`RID` body **)** const +- :ref:`int` **body_get_max_contacts_reported** **(** :ref:`RID` body **)** const Returns the maximum contacts that can be reported. See :ref:`body_set_max_contacts_reported`. .. _class_Physics2DServer_body_get_mode: -- :ref:`int` **body_get_mode** **(** :ref:`RID` body **)** const +- :ref:`int` **body_get_mode** **(** :ref:`RID` body **)** const Returns the body mode. .. _class_Physics2DServer_body_get_object_instance_id: -- :ref:`int` **body_get_object_instance_id** **(** :ref:`RID` body **)** const +- :ref:`int` **body_get_object_instance_id** **(** :ref:`RID` body **)** const Gets the instance ID of the object the area is assigned to. .. _class_Physics2DServer_body_get_param: -- :ref:`float` **body_get_param** **(** :ref:`RID` body, :ref:`int` param **)** const +- :ref:`float` **body_get_param** **(** :ref:`RID` body, :ref:`int` param **)** const Returns the value of a body parameter. A list of available parameters is on the BODY_PARAM\_\* constants. .. _class_Physics2DServer_body_get_shape: -- :ref:`RID` **body_get_shape** **(** :ref:`RID` body, :ref:`int` shape_idx **)** const +- :ref:`RID` **body_get_shape** **(** :ref:`RID` body, :ref:`int` shape_idx **)** const Returns the :ref:`RID` of the nth shape of a body. .. _class_Physics2DServer_body_get_shape_count: -- :ref:`int` **body_get_shape_count** **(** :ref:`RID` body **)** const +- :ref:`int` **body_get_shape_count** **(** :ref:`RID` body **)** const Returns the number of shapes assigned to a body. .. _class_Physics2DServer_body_get_shape_metadata: -- :ref:`Variant` **body_get_shape_metadata** **(** :ref:`RID` body, :ref:`int` shape_idx **)** const +- :ref:`Variant` **body_get_shape_metadata** **(** :ref:`RID` body, :ref:`int` shape_idx **)** const Returns the metadata of a shape of a body. .. _class_Physics2DServer_body_get_shape_transform: -- :ref:`Transform2D` **body_get_shape_transform** **(** :ref:`RID` body, :ref:`int` shape_idx **)** const +- :ref:`Transform2D` **body_get_shape_transform** **(** :ref:`RID` body, :ref:`int` shape_idx **)** const Returns the transform matrix of a body shape. .. _class_Physics2DServer_body_get_space: -- :ref:`RID` **body_get_space** **(** :ref:`RID` body **)** const +- :ref:`RID` **body_get_space** **(** :ref:`RID` body **)** const Returns the :ref:`RID` of the space assigned to a body. .. _class_Physics2DServer_body_get_state: -- :ref:`Variant` **body_get_state** **(** :ref:`RID` body, :ref:`int` state **)** const +- :ref:`Variant` **body_get_state** **(** :ref:`RID` body, :ref:`int` state **)** const Returns a body state. .. _class_Physics2DServer_body_is_omitting_force_integration: -- :ref:`bool` **body_is_omitting_force_integration** **(** :ref:`RID` body **)** const +- :ref:`bool` **body_is_omitting_force_integration** **(** :ref:`RID` body **)** const Returns whether a body uses a callback function to calculate its own physics (see :ref:`body_set_force_integration_callback`). .. _class_Physics2DServer_body_remove_collision_exception: -- void **body_remove_collision_exception** **(** :ref:`RID` body, :ref:`RID` excepted_body **)** +- void **body_remove_collision_exception** **(** :ref:`RID` body, :ref:`RID` excepted_body **)** Removes a body from the list of bodies exempt from collisions. .. _class_Physics2DServer_body_remove_shape: -- void **body_remove_shape** **(** :ref:`RID` body, :ref:`int` shape_idx **)** +- void **body_remove_shape** **(** :ref:`RID` body, :ref:`int` shape_idx **)** Removes a shape from a body. The shape is not deleted, so it can be reused afterwards. .. _class_Physics2DServer_body_set_axis_velocity: -- void **body_set_axis_velocity** **(** :ref:`RID` body, :ref:`Vector2` axis_velocity **)** +- void **body_set_axis_velocity** **(** :ref:`RID` body, :ref:`Vector2` axis_velocity **)** Sets an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior. .. _class_Physics2DServer_body_set_collision_layer: -- void **body_set_collision_layer** **(** :ref:`RID` body, :ref:`int` layer **)** +- void **body_set_collision_layer** **(** :ref:`RID` body, :ref:`int` layer **)** Sets the physics layer or layers a body belongs to. .. _class_Physics2DServer_body_set_collision_mask: -- void **body_set_collision_mask** **(** :ref:`RID` body, :ref:`int` mask **)** +- void **body_set_collision_mask** **(** :ref:`RID` body, :ref:`int` mask **)** Sets the physics layer or layers a body can collide with. .. _class_Physics2DServer_body_set_continuous_collision_detection_mode: -- void **body_set_continuous_collision_detection_mode** **(** :ref:`RID` body, :ref:`int` mode **)** +- void **body_set_continuous_collision_detection_mode** **(** :ref:`RID` body, :ref:`int` mode **)** Sets the continuous collision detection mode from any of the CCD_MODE\_\* constants. @@ -584,205 +584,205 @@ Continuous collision detection tries to predict where a moving body will collide .. _class_Physics2DServer_body_set_force_integration_callback: -- void **body_set_force_integration_callback** **(** :ref:`RID` body, :ref:`Object` receiver, :ref:`String` method, :ref:`Variant` userdata=null **)** +- void **body_set_force_integration_callback** **(** :ref:`RID` body, :ref:`Object` receiver, :ref:`String` method, :ref:`Variant` userdata=null **)** Sets the function used to calculate physics for an object, if that object allows it (see :ref:`body_set_omit_force integration`). .. _class_Physics2DServer_body_set_max_contacts_reported: -- void **body_set_max_contacts_reported** **(** :ref:`RID` body, :ref:`int` amount **)** +- void **body_set_max_contacts_reported** **(** :ref:`RID` body, :ref:`int` amount **)** Sets the maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0. .. _class_Physics2DServer_body_set_mode: -- void **body_set_mode** **(** :ref:`RID` body, :ref:`int` mode **)** +- void **body_set_mode** **(** :ref:`RID` body, :ref:`int` mode **)** Sets the body mode, from one of the constants BODY_MODE\*. .. _class_Physics2DServer_body_set_omit_force_integration: -- void **body_set_omit_force_integration** **(** :ref:`RID` body, :ref:`bool` enable **)** +- void **body_set_omit_force_integration** **(** :ref:`RID` body, :ref:`bool` enable **)** Sets whether a body uses a callback function to calculate its own physics (see :ref:`body_set_force_integration_callback`). .. _class_Physics2DServer_body_set_param: -- void **body_set_param** **(** :ref:`RID` body, :ref:`int` param, :ref:`float` value **)** +- void **body_set_param** **(** :ref:`RID` body, :ref:`int` param, :ref:`float` value **)** Sets a body parameter. A list of available parameters is on the BODY_PARAM\_\* constants. .. _class_Physics2DServer_body_set_shape: -- void **body_set_shape** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`RID` shape **)** +- void **body_set_shape** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`RID` shape **)** Substitutes a given body shape by another. The old shape is selected by its index, the new one by its :ref:`RID`. .. _class_Physics2DServer_body_set_shape_as_one_way_collision: -- void **body_set_shape_as_one_way_collision** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` enable **)** +- void **body_set_shape_as_one_way_collision** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` enable **)** Enables one way collision on body if ``enable is true``. .. _class_Physics2DServer_body_set_shape_disabled: -- void **body_set_shape_disabled** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` disable **)** +- void **body_set_shape_disabled** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` disable **)** Disables shape in body if ``disable is true``. .. _class_Physics2DServer_body_set_shape_metadata: -- void **body_set_shape_metadata** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Variant` metadata **)** +- void **body_set_shape_metadata** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Variant` metadata **)** Sets metadata of a shape within a body. This metadata is different from :ref:`Object.set_meta`, and can be retrieved on shape queries. .. _class_Physics2DServer_body_set_shape_transform: -- void **body_set_shape_transform** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Transform2D` transform **)** +- void **body_set_shape_transform** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Transform2D` transform **)** Sets the transform matrix for a body shape. .. _class_Physics2DServer_body_set_space: -- void **body_set_space** **(** :ref:`RID` body, :ref:`RID` space **)** +- void **body_set_space** **(** :ref:`RID` body, :ref:`RID` space **)** Assigns a space to the body (see :ref:`create_space`). .. _class_Physics2DServer_body_set_state: -- void **body_set_state** **(** :ref:`RID` body, :ref:`int` state, :ref:`Variant` value **)** +- void **body_set_state** **(** :ref:`RID` body, :ref:`int` state, :ref:`Variant` value **)** Sets a body state (see BODY_STATE\* constants). .. _class_Physics2DServer_body_test_motion: -- :ref:`bool` **body_test_motion** **(** :ref:`RID` body, :ref:`Transform2D` from, :ref:`Vector2` motion, :ref:`float` margin=0.08, :ref:`Physics2DTestMotionResult` result=null **)** +- :ref:`bool` **body_test_motion** **(** :ref:`RID` body, :ref:`Transform2D` from, :ref:`Vector2` motion, :ref:`float` margin=0.08, :ref:`Physics2DTestMotionResult` result=null **)** Returns whether a body can move from a given point in a given direction. Apart from the boolean return value, a :ref:`Physics2DTestMotionResult` can be passed to return additional information in. .. _class_Physics2DServer_damped_spring_joint_create: -- :ref:`RID` **damped_spring_joint_create** **(** :ref:`Vector2` anchor_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a, :ref:`RID` body_b **)** +- :ref:`RID` **damped_spring_joint_create** **(** :ref:`Vector2` anchor_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a, :ref:`RID` body_b **)** Creates a damped spring joint between two bodies. If not specified, the second body is assumed to be the joint itself. .. _class_Physics2DServer_damped_string_joint_get_param: -- :ref:`float` **damped_string_joint_get_param** **(** :ref:`RID` joint, :ref:`int` param **)** const +- :ref:`float` **damped_string_joint_get_param** **(** :ref:`RID` joint, :ref:`int` param **)** const Returns the value of a damped spring joint parameter. .. _class_Physics2DServer_damped_string_joint_set_param: -- void **damped_string_joint_set_param** **(** :ref:`RID` joint, :ref:`int` param, :ref:`float` value **)** +- void **damped_string_joint_set_param** **(** :ref:`RID` joint, :ref:`int` param, :ref:`float` value **)** Sets a damped spring joint parameter. Parameters are explained in the DAMPED_STRING\* constants. .. _class_Physics2DServer_free_rid: -- void **free_rid** **(** :ref:`RID` rid **)** +- void **free_rid** **(** :ref:`RID` rid **)** Destroys any of the objects created by Physics2DServer. If the :ref:`RID` passed is not one of the objects that can be created by Physics2DServer, an error will be sent to the console. .. _class_Physics2DServer_get_process_info: -- :ref:`int` **get_process_info** **(** :ref:`int` process_info **)** +- :ref:`int` **get_process_info** **(** :ref:`int` process_info **)** Returns information about the current state of the 2D physics engine. The states are listed under the INFO\_\* constants. .. _class_Physics2DServer_groove_joint_create: -- :ref:`RID` **groove_joint_create** **(** :ref:`Vector2` groove1_a, :ref:`Vector2` groove2_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a, :ref:`RID` body_b **)** +- :ref:`RID` **groove_joint_create** **(** :ref:`Vector2` groove1_a, :ref:`Vector2` groove2_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a, :ref:`RID` body_b **)** Creates a groove joint between two bodies. If not specified, the bodyies are assumed to be the joint itself. .. _class_Physics2DServer_joint_get_param: -- :ref:`float` **joint_get_param** **(** :ref:`RID` joint, :ref:`int` param **)** const +- :ref:`float` **joint_get_param** **(** :ref:`RID` joint, :ref:`int` param **)** const Returns the value of a joint parameter. .. _class_Physics2DServer_joint_get_type: -- :ref:`int` **joint_get_type** **(** :ref:`RID` joint **)** const +- :ref:`int` **joint_get_type** **(** :ref:`RID` joint **)** const Returns the type of a joint (see JOINT\_\* constants). .. _class_Physics2DServer_joint_set_param: -- void **joint_set_param** **(** :ref:`RID` joint, :ref:`int` param, :ref:`float` value **)** +- void **joint_set_param** **(** :ref:`RID` joint, :ref:`int` param, :ref:`float` value **)** Sets a joint parameter. Parameters are explained in the JOINT_PARAM\* constants. .. _class_Physics2DServer_pin_joint_create: -- :ref:`RID` **pin_joint_create** **(** :ref:`Vector2` anchor, :ref:`RID` body_a, :ref:`RID` body_b **)** +- :ref:`RID` **pin_joint_create** **(** :ref:`Vector2` anchor, :ref:`RID` body_a, :ref:`RID` body_b **)** Creates a pin joint between two bodies. If not specified, the second body is assumed to be the joint itself. .. _class_Physics2DServer_set_active: -- void **set_active** **(** :ref:`bool` active **)** +- void **set_active** **(** :ref:`bool` active **)** Activates or deactivates the 2D physics engine. .. _class_Physics2DServer_shape_create: -- :ref:`RID` **shape_create** **(** :ref:`int` type **)** +- :ref:`RID` **shape_create** **(** :ref:`int` type **)** Creates a shape of type SHAPE\_\*. Does not assign it to a body or an area. To do so, you must use :ref:`area_set_shape` or :ref:`body_set_shape`. .. _class_Physics2DServer_shape_get_data: -- :ref:`Variant` **shape_get_data** **(** :ref:`RID` shape **)** const +- :ref:`Variant` **shape_get_data** **(** :ref:`RID` shape **)** const Returns the shape data. .. _class_Physics2DServer_shape_get_type: -- :ref:`int` **shape_get_type** **(** :ref:`RID` shape **)** const +- :ref:`int` **shape_get_type** **(** :ref:`RID` shape **)** const Returns the type of shape (see SHAPE\_\* constants). .. _class_Physics2DServer_shape_set_data: -- void **shape_set_data** **(** :ref:`RID` shape, :ref:`Variant` data **)** +- void **shape_set_data** **(** :ref:`RID` shape, :ref:`Variant` data **)** Sets the shape data that defines its shape and size. The data to be passed depends on the kind of shape created :ref:`shape_get_type`. .. _class_Physics2DServer_space_create: -- :ref:`RID` **space_create** **(** **)** +- :ref:`RID` **space_create** **(** **)** Creates a space. A space is a collection of parameters for the physics engine that can be assigned to an area or a body. It can be assigned to an area with :ref:`area_set_space`, or to a body with :ref:`body_set_space`. .. _class_Physics2DServer_space_get_direct_state: -- :ref:`Physics2DDirectSpaceState` **space_get_direct_state** **(** :ref:`RID` space **)** +- :ref:`Physics2DDirectSpaceState` **space_get_direct_state** **(** :ref:`RID` space **)** Returns the state of a space, a :ref:`Physics2DDirectSpaceState`. This object can be used to make collision/intersection queries. .. _class_Physics2DServer_space_get_param: -- :ref:`float` **space_get_param** **(** :ref:`RID` space, :ref:`int` param **)** const +- :ref:`float` **space_get_param** **(** :ref:`RID` space, :ref:`int` param **)** const Returns the value of a space parameter. .. _class_Physics2DServer_space_is_active: -- :ref:`bool` **space_is_active** **(** :ref:`RID` space **)** const +- :ref:`bool` **space_is_active** **(** :ref:`RID` space **)** const Returns whether the space is active. .. _class_Physics2DServer_space_set_active: -- void **space_set_active** **(** :ref:`RID` space, :ref:`bool` active **)** +- void **space_set_active** **(** :ref:`RID` space, :ref:`bool` active **)** Marks a space as active. It will not have an effect, unless it is assigned to an area or body. .. _class_Physics2DServer_space_set_param: -- void **space_set_param** **(** :ref:`RID` space, :ref:`int` param, :ref:`float` value **)** +- void **space_set_param** **(** :ref:`RID` space, :ref:`int` param, :ref:`float` value **)** Sets the value for a space parameter. A list of available parameters is on the SPACE_PARAM\_\* constants. diff --git a/classes/class_physics2dshapequeryparameters.rst b/classes/class_physics2dshapequeryparameters.rst index 8c129812b..83a027f33 100644 --- a/classes/class_physics2dshapequeryparameters.rst +++ b/classes/class_physics2dshapequeryparameters.rst @@ -19,37 +19,37 @@ Parameters to be sent to a 2D shape physics query. Member Functions ---------------- -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_layer` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_exclude` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_margin` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_motion` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_object_type_mask` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_shape_rid` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_transform` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_layer` **(** :ref:`int` collision_layer **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_exclude` **(** :ref:`Array` exclude **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_margin` **(** :ref:`float` margin **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_motion` **(** :ref:`Vector2` motion **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_object_type_mask` **(** :ref:`int` object_type_mask **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shape` **(** :ref:`Resource` shape **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shape_rid` **(** :ref:`RID` shape **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_transform` **(** :ref:`Transform2D` transform **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_layer` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_exclude` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_margin` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_motion` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_object_type_mask` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_shape_rid` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_transform` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_layer` **(** :ref:`int` collision_layer **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_exclude` **(** :ref:`Array` exclude **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_margin` **(** :ref:`float` margin **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_motion` **(** :ref:`Vector2` motion **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_object_type_mask` **(** :ref:`int` object_type_mask **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shape` **(** :ref:`Resource` shape **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shape_rid` **(** :ref:`RID` shape **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_transform` **(** :ref:`Transform2D` transform **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -61,91 +61,91 @@ Member Function Description .. _class_Physics2DShapeQueryParameters_get_collision_layer: -- :ref:`int` **get_collision_layer** **(** **)** const +- :ref:`int` **get_collision_layer** **(** **)** const Return the physics layer the shape belongs to. .. _class_Physics2DShapeQueryParameters_get_exclude: -- :ref:`Array` **get_exclude** **(** **)** const +- :ref:`Array` **get_exclude** **(** **)** const Return the list of objects, or object :ref:`RID`\ s, that will be excluded from collisions. .. _class_Physics2DShapeQueryParameters_get_margin: -- :ref:`float` **get_margin** **(** **)** const +- :ref:`float` **get_margin** **(** **)** const Return the collision margin for the shape. .. _class_Physics2DShapeQueryParameters_get_motion: -- :ref:`Vector2` **get_motion** **(** **)** const +- :ref:`Vector2` **get_motion** **(** **)** const Return the current movement speed of the shape. .. _class_Physics2DShapeQueryParameters_get_object_type_mask: -- :ref:`int` **get_object_type_mask** **(** **)** const +- :ref:`int` **get_object_type_mask** **(** **)** const Return the type of object the shape belongs to. .. _class_Physics2DShapeQueryParameters_get_shape_rid: -- :ref:`RID` **get_shape_rid** **(** **)** const +- :ref:`RID` **get_shape_rid** **(** **)** const Return the :ref:`RID` of the shape queried. .. _class_Physics2DShapeQueryParameters_get_transform: -- :ref:`Transform2D` **get_transform** **(** **)** const +- :ref:`Transform2D` **get_transform** **(** **)** const Return the transform matrix of the shape queried. .. _class_Physics2DShapeQueryParameters_set_collision_layer: -- void **set_collision_layer** **(** :ref:`int` collision_layer **)** +- void **set_collision_layer** **(** :ref:`int` collision_layer **)** Set the physics layer the shape belongs to. .. _class_Physics2DShapeQueryParameters_set_exclude: -- void **set_exclude** **(** :ref:`Array` exclude **)** +- void **set_exclude** **(** :ref:`Array` exclude **)** Set the list of objects, or object :ref:`RID`\ s, that will be excluded from collisions. .. _class_Physics2DShapeQueryParameters_set_margin: -- void **set_margin** **(** :ref:`float` margin **)** +- void **set_margin** **(** :ref:`float` margin **)** Set the collision margin for the shape. A collision margin is an amount (in pixels) that the shape will grow when computing collisions, to account for numerical imprecision. .. _class_Physics2DShapeQueryParameters_set_motion: -- void **set_motion** **(** :ref:`Vector2` motion **)** +- void **set_motion** **(** :ref:`Vector2` motion **)** Set the current movement speed of the shape. .. _class_Physics2DShapeQueryParameters_set_object_type_mask: -- void **set_object_type_mask** **(** :ref:`int` object_type_mask **)** +- void **set_object_type_mask** **(** :ref:`int` object_type_mask **)** Set the type of object the shape belongs to (see Physics2DDirectSpaceState.TYPE_MASK\_\*). .. _class_Physics2DShapeQueryParameters_set_shape: -- void **set_shape** **(** :ref:`Resource` shape **)** +- void **set_shape** **(** :ref:`Resource` shape **)** Set the :ref:`Shape2D` that will be used for collision/intersection queries. .. _class_Physics2DShapeQueryParameters_set_shape_rid: -- void **set_shape_rid** **(** :ref:`RID` shape **)** +- void **set_shape_rid** **(** :ref:`RID` shape **)** Set the :ref:`RID` of the shape to be used in queries. .. _class_Physics2DShapeQueryParameters_set_transform: -- void **set_transform** **(** :ref:`Transform2D` transform **)** +- void **set_transform** **(** :ref:`Transform2D` transform **)** Set the transformation matrix of the shape. This is necessary to set its position/rotation/scale. diff --git a/classes/class_physics2dshapequeryresult.rst b/classes/class_physics2dshapequeryresult.rst index 958ec855c..a616ca27d 100644 --- a/classes/class_physics2dshapequeryresult.rst +++ b/classes/class_physics2dshapequeryresult.rst @@ -19,39 +19,39 @@ Brief Description Member Functions ---------------- -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_result_count` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_result_object` **(** :ref:`int` idx **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_result_object_id` **(** :ref:`int` idx **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_result_object_shape` **(** :ref:`int` idx **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_result_rid` **(** :ref:`int` idx **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_result_count` **(** **)** const | ++------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_result_object` **(** :ref:`int` idx **)** const | ++------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_result_object_id` **(** :ref:`int` idx **)** const | ++------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_result_object_shape` **(** :ref:`int` idx **)** const | ++------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_result_rid` **(** :ref:`int` idx **)** const | ++------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ Member Function Description --------------------------- .. _class_Physics2DShapeQueryResult_get_result_count: -- :ref:`int` **get_result_count** **(** **)** const +- :ref:`int` **get_result_count** **(** **)** const .. _class_Physics2DShapeQueryResult_get_result_object: -- :ref:`Object` **get_result_object** **(** :ref:`int` idx **)** const +- :ref:`Object` **get_result_object** **(** :ref:`int` idx **)** const .. _class_Physics2DShapeQueryResult_get_result_object_id: -- :ref:`int` **get_result_object_id** **(** :ref:`int` idx **)** const +- :ref:`int` **get_result_object_id** **(** :ref:`int` idx **)** const .. _class_Physics2DShapeQueryResult_get_result_object_shape: -- :ref:`int` **get_result_object_shape** **(** :ref:`int` idx **)** const +- :ref:`int` **get_result_object_shape** **(** :ref:`int` idx **)** const .. _class_Physics2DShapeQueryResult_get_result_rid: -- :ref:`RID` **get_result_rid** **(** :ref:`int` idx **)** const +- :ref:`RID` **get_result_rid** **(** :ref:`int` idx **)** const diff --git a/classes/class_physics2dtestmotionresult.rst b/classes/class_physics2dtestmotionresult.rst index f9cd36db6..36fcc733e 100644 --- a/classes/class_physics2dtestmotionresult.rst +++ b/classes/class_physics2dtestmotionresult.rst @@ -19,63 +19,63 @@ Brief Description Member Functions ---------------- -+--------------------------------+--------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_collider` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collider_id` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_collider_rid` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collider_shape` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_collider_velocity` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_collision_normal` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_collision_point` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_motion` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_motion_remainder` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------+ ++--------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_collider` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collider_id` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_collider_rid` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collider_shape` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_collider_velocity` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_collision_normal` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_collision_point` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_motion` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_motion_remainder` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------+ Member Function Description --------------------------- .. _class_Physics2DTestMotionResult_get_collider: -- :ref:`Object` **get_collider** **(** **)** const +- :ref:`Object` **get_collider** **(** **)** const .. _class_Physics2DTestMotionResult_get_collider_id: -- :ref:`int` **get_collider_id** **(** **)** const +- :ref:`int` **get_collider_id** **(** **)** const .. _class_Physics2DTestMotionResult_get_collider_rid: -- :ref:`RID` **get_collider_rid** **(** **)** const +- :ref:`RID` **get_collider_rid** **(** **)** const .. _class_Physics2DTestMotionResult_get_collider_shape: -- :ref:`int` **get_collider_shape** **(** **)** const +- :ref:`int` **get_collider_shape** **(** **)** const .. _class_Physics2DTestMotionResult_get_collider_velocity: -- :ref:`Vector2` **get_collider_velocity** **(** **)** const +- :ref:`Vector2` **get_collider_velocity** **(** **)** const .. _class_Physics2DTestMotionResult_get_collision_normal: -- :ref:`Vector2` **get_collision_normal** **(** **)** const +- :ref:`Vector2` **get_collision_normal** **(** **)** const .. _class_Physics2DTestMotionResult_get_collision_point: -- :ref:`Vector2` **get_collision_point** **(** **)** const +- :ref:`Vector2` **get_collision_point** **(** **)** const .. _class_Physics2DTestMotionResult_get_motion: -- :ref:`Vector2` **get_motion** **(** **)** const +- :ref:`Vector2` **get_motion** **(** **)** const .. _class_Physics2DTestMotionResult_get_motion_remainder: -- :ref:`Vector2` **get_motion_remainder** **(** **)** const +- :ref:`Vector2` **get_motion_remainder** **(** **)** const diff --git a/classes/class_physicsbody.rst b/classes/class_physicsbody.rst index a5e230961..e2466f748 100644 --- a/classes/class_physicsbody.rst +++ b/classes/class_physicsbody.rst @@ -21,27 +21,27 @@ Base class for all objects affected by physics in 3D space. Member Functions ---------------- -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_collision_exception_with` **(** :ref:`Node` body **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_layer` **(** **)** const | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_mask` **(** **)** const | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_collision_exception_with` **(** :ref:`Node` body **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_layer` **(** :ref:`int` layer **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_mask` **(** :ref:`int` mask **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_collision_exception_with` **(** :ref:`Node` body **)** | ++--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_layer` **(** **)** const | ++--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | ++--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_mask` **(** **)** const | ++--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | ++--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_collision_exception_with` **(** :ref:`Node` body **)** | ++--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_layer` **(** :ref:`int` layer **)** | ++--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_mask` **(** :ref:`int` mask **)** | ++--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -69,46 +69,46 @@ Member Function Description .. _class_PhysicsBody_add_collision_exception_with: -- void **add_collision_exception_with** **(** :ref:`Node` body **)** +- void **add_collision_exception_with** **(** :ref:`Node` body **)** Adds a body to the list of bodies that this body can't collide with. .. _class_PhysicsBody_get_collision_layer: -- :ref:`int` **get_collision_layer** **(** **)** const +- :ref:`int` **get_collision_layer** **(** **)** const .. _class_PhysicsBody_get_collision_layer_bit: -- :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const +- :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const .. _class_PhysicsBody_get_collision_mask: -- :ref:`int` **get_collision_mask** **(** **)** const +- :ref:`int` **get_collision_mask** **(** **)** const .. _class_PhysicsBody_get_collision_mask_bit: -- :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const +- :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const .. _class_PhysicsBody_remove_collision_exception_with: -- void **remove_collision_exception_with** **(** :ref:`Node` body **)** +- void **remove_collision_exception_with** **(** :ref:`Node` body **)** Removes a body from the list of bodies that this body can't collide with. .. _class_PhysicsBody_set_collision_layer: -- void **set_collision_layer** **(** :ref:`int` layer **)** +- void **set_collision_layer** **(** :ref:`int` layer **)** .. _class_PhysicsBody_set_collision_layer_bit: -- void **set_collision_layer_bit** **(** :ref:`int` bit, :ref:`bool` value **)** +- void **set_collision_layer_bit** **(** :ref:`int` bit, :ref:`bool` value **)** .. _class_PhysicsBody_set_collision_mask: -- void **set_collision_mask** **(** :ref:`int` mask **)** +- void **set_collision_mask** **(** :ref:`int` mask **)** .. _class_PhysicsBody_set_collision_mask_bit: -- void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** +- void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** diff --git a/classes/class_physicsbody2d.rst b/classes/class_physicsbody2d.rst index 81446352c..a09d5b74c 100644 --- a/classes/class_physicsbody2d.rst +++ b/classes/class_physicsbody2d.rst @@ -21,27 +21,27 @@ Base class for all objects affected by physics in 2D space. Member Functions ---------------- -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_collision_exception_with` **(** :ref:`Node` body **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_layer` **(** **)** const | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_mask` **(** **)** const | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_collision_exception_with` **(** :ref:`Node` body **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_layer` **(** :ref:`int` layer **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_mask` **(** :ref:`int` mask **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_collision_exception_with` **(** :ref:`Node` body **)** | ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_layer` **(** **)** const | ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_mask` **(** **)** const | ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_collision_exception_with` **(** :ref:`Node` body **)** | ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_layer` **(** :ref:`int` layer **)** | ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_mask` **(** :ref:`int` mask **)** | ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -73,43 +73,43 @@ Member Function Description .. _class_PhysicsBody2D_add_collision_exception_with: -- void **add_collision_exception_with** **(** :ref:`Node` body **)** +- void **add_collision_exception_with** **(** :ref:`Node` body **)** Adds a body to the list of bodies that this body can't collide with. .. _class_PhysicsBody2D_get_collision_layer: -- :ref:`int` **get_collision_layer** **(** **)** const +- :ref:`int` **get_collision_layer** **(** **)** const Return the physics layer this area is in. .. _class_PhysicsBody2D_get_collision_layer_bit: -- :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const +- :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const Return an individual bit on the collision mask. .. _class_PhysicsBody2D_get_collision_mask: -- :ref:`int` **get_collision_mask** **(** **)** const +- :ref:`int` **get_collision_mask** **(** **)** const Return the physics layers this area can scan for collisions. .. _class_PhysicsBody2D_get_collision_mask_bit: -- :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const +- :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const Return an individual bit on the collision mask. .. _class_PhysicsBody2D_remove_collision_exception_with: -- void **remove_collision_exception_with** **(** :ref:`Node` body **)** +- void **remove_collision_exception_with** **(** :ref:`Node` body **)** Removes a body from the list of bodies that this body can't collide with. .. _class_PhysicsBody2D_set_collision_layer: -- void **set_collision_layer** **(** :ref:`int` layer **)** +- void **set_collision_layer** **(** :ref:`int` layer **)** Set the physics layers this area is in. @@ -119,19 +119,19 @@ A contact is detected if object A is in any of the layers that object B scans, o .. _class_PhysicsBody2D_set_collision_layer_bit: -- void **set_collision_layer_bit** **(** :ref:`int` bit, :ref:`bool` value **)** +- void **set_collision_layer_bit** **(** :ref:`int` bit, :ref:`bool` value **)** Set/clear individual bits on the layer mask. This makes getting a body in/out of only one layer easier. .. _class_PhysicsBody2D_set_collision_mask: -- void **set_collision_mask** **(** :ref:`int` mask **)** +- void **set_collision_mask** **(** :ref:`int` mask **)** Set the physics layers this area can scan for collisions. .. _class_PhysicsBody2D_set_collision_mask_bit: -- void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** +- void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier. diff --git a/classes/class_physicsdirectbodystate.rst b/classes/class_physicsdirectbodystate.rst index df29da0ba..a73a3a62e 100644 --- a/classes/class_physicsdirectbodystate.rst +++ b/classes/class_physicsdirectbodystate.rst @@ -21,195 +21,195 @@ Brief Description Member Functions ---------------- -+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_force` **(** :ref:`Vector3` force, :ref:`Vector3` position **)** | -+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`apply_impulse` **(** :ref:`Vector3` position, :ref:`Vector3` j **)** | -+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`apply_torqe_impulse` **(** :ref:`Vector3` j **)** | -+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_angular_velocity` **(** **)** const | -+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_center_of_mass` **(** **)** const | -+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_contact_collider` **(** :ref:`int` contact_idx **)** const | -+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_contact_collider_id` **(** :ref:`int` contact_idx **)** const | -+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_contact_collider_object` **(** :ref:`int` contact_idx **)** const | -+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_contact_collider_position` **(** :ref:`int` contact_idx **)** const | -+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_contact_collider_shape` **(** :ref:`int` contact_idx **)** const | -+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_contact_collider_velocity_at_position` **(** :ref:`int` contact_idx **)** const | -+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_contact_count` **(** **)** const | -+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_contact_local_normal` **(** :ref:`int` contact_idx **)** const | -+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_contact_local_position` **(** :ref:`int` contact_idx **)** const | -+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_contact_local_shape` **(** :ref:`int` contact_idx **)** const | -+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_inverse_inertia` **(** **)** const | -+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_inverse_mass` **(** **)** const | -+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_linear_velocity` **(** **)** const | -+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`get_principal_inertia_axes` **(** **)** const | -+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PhysicsDirectSpaceState` | :ref:`get_space_state` **(** **)** | -+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_step` **(** **)** const | -+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_total_angular_damp` **(** **)** const | -+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_total_gravity` **(** **)** const | -+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_total_linear_damp` **(** **)** const | -+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_transform` **(** **)** const | -+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`integrate_forces` **(** **)** | -+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_sleeping` **(** **)** const | -+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_angular_velocity` **(** :ref:`Vector3` velocity **)** | -+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_linear_velocity` **(** :ref:`Vector3` velocity **)** | -+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sleep_state` **(** :ref:`bool` enabled **)** | -+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_transform` **(** :ref:`Transform` transform **)** | -+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_force` **(** :ref:`Vector3` force, :ref:`Vector3` position **)** | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`apply_impulse` **(** :ref:`Vector3` position, :ref:`Vector3` j **)** | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`apply_torqe_impulse` **(** :ref:`Vector3` j **)** | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_angular_velocity` **(** **)** const | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_center_of_mass` **(** **)** const | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_contact_collider` **(** :ref:`int` contact_idx **)** const | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_contact_collider_id` **(** :ref:`int` contact_idx **)** const | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_contact_collider_object` **(** :ref:`int` contact_idx **)** const | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_contact_collider_position` **(** :ref:`int` contact_idx **)** const | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_contact_collider_shape` **(** :ref:`int` contact_idx **)** const | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_contact_collider_velocity_at_position` **(** :ref:`int` contact_idx **)** const | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_contact_count` **(** **)** const | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_contact_local_normal` **(** :ref:`int` contact_idx **)** const | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_contact_local_position` **(** :ref:`int` contact_idx **)** const | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_contact_local_shape` **(** :ref:`int` contact_idx **)** const | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_inverse_inertia` **(** **)** const | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_inverse_mass` **(** **)** const | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_linear_velocity` **(** **)** const | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`get_principal_inertia_axes` **(** **)** const | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PhysicsDirectSpaceState` | :ref:`get_space_state` **(** **)** | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_step` **(** **)** const | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_total_angular_damp` **(** **)** const | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_total_gravity` **(** **)** const | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_total_linear_damp` **(** **)** const | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`get_transform` **(** **)** const | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`integrate_forces` **(** **)** | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_sleeping` **(** **)** const | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_angular_velocity` **(** :ref:`Vector3` velocity **)** | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_linear_velocity` **(** :ref:`Vector3` velocity **)** | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_sleep_state` **(** :ref:`bool` enabled **)** | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_transform` **(** :ref:`Transform` transform **)** | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Function Description --------------------------- .. _class_PhysicsDirectBodyState_add_force: -- void **add_force** **(** :ref:`Vector3` force, :ref:`Vector3` position **)** +- void **add_force** **(** :ref:`Vector3` force, :ref:`Vector3` position **)** .. _class_PhysicsDirectBodyState_apply_impulse: -- void **apply_impulse** **(** :ref:`Vector3` position, :ref:`Vector3` j **)** +- void **apply_impulse** **(** :ref:`Vector3` position, :ref:`Vector3` j **)** .. _class_PhysicsDirectBodyState_apply_torqe_impulse: -- void **apply_torqe_impulse** **(** :ref:`Vector3` j **)** +- void **apply_torqe_impulse** **(** :ref:`Vector3` j **)** .. _class_PhysicsDirectBodyState_get_angular_velocity: -- :ref:`Vector3` **get_angular_velocity** **(** **)** const +- :ref:`Vector3` **get_angular_velocity** **(** **)** const .. _class_PhysicsDirectBodyState_get_center_of_mass: -- :ref:`Vector3` **get_center_of_mass** **(** **)** const +- :ref:`Vector3` **get_center_of_mass** **(** **)** const .. _class_PhysicsDirectBodyState_get_contact_collider: -- :ref:`RID` **get_contact_collider** **(** :ref:`int` contact_idx **)** const +- :ref:`RID` **get_contact_collider** **(** :ref:`int` contact_idx **)** const .. _class_PhysicsDirectBodyState_get_contact_collider_id: -- :ref:`int` **get_contact_collider_id** **(** :ref:`int` contact_idx **)** const +- :ref:`int` **get_contact_collider_id** **(** :ref:`int` contact_idx **)** const .. _class_PhysicsDirectBodyState_get_contact_collider_object: -- :ref:`Object` **get_contact_collider_object** **(** :ref:`int` contact_idx **)** const +- :ref:`Object` **get_contact_collider_object** **(** :ref:`int` contact_idx **)** const .. _class_PhysicsDirectBodyState_get_contact_collider_position: -- :ref:`Vector3` **get_contact_collider_position** **(** :ref:`int` contact_idx **)** const +- :ref:`Vector3` **get_contact_collider_position** **(** :ref:`int` contact_idx **)** const .. _class_PhysicsDirectBodyState_get_contact_collider_shape: -- :ref:`int` **get_contact_collider_shape** **(** :ref:`int` contact_idx **)** const +- :ref:`int` **get_contact_collider_shape** **(** :ref:`int` contact_idx **)** const .. _class_PhysicsDirectBodyState_get_contact_collider_velocity_at_position: -- :ref:`Vector3` **get_contact_collider_velocity_at_position** **(** :ref:`int` contact_idx **)** const +- :ref:`Vector3` **get_contact_collider_velocity_at_position** **(** :ref:`int` contact_idx **)** const .. _class_PhysicsDirectBodyState_get_contact_count: -- :ref:`int` **get_contact_count** **(** **)** const +- :ref:`int` **get_contact_count** **(** **)** const .. _class_PhysicsDirectBodyState_get_contact_local_normal: -- :ref:`Vector3` **get_contact_local_normal** **(** :ref:`int` contact_idx **)** const +- :ref:`Vector3` **get_contact_local_normal** **(** :ref:`int` contact_idx **)** const .. _class_PhysicsDirectBodyState_get_contact_local_position: -- :ref:`Vector3` **get_contact_local_position** **(** :ref:`int` contact_idx **)** const +- :ref:`Vector3` **get_contact_local_position** **(** :ref:`int` contact_idx **)** const .. _class_PhysicsDirectBodyState_get_contact_local_shape: -- :ref:`int` **get_contact_local_shape** **(** :ref:`int` contact_idx **)** const +- :ref:`int` **get_contact_local_shape** **(** :ref:`int` contact_idx **)** const .. _class_PhysicsDirectBodyState_get_inverse_inertia: -- :ref:`Vector3` **get_inverse_inertia** **(** **)** const +- :ref:`Vector3` **get_inverse_inertia** **(** **)** const .. _class_PhysicsDirectBodyState_get_inverse_mass: -- :ref:`float` **get_inverse_mass** **(** **)** const +- :ref:`float` **get_inverse_mass** **(** **)** const .. _class_PhysicsDirectBodyState_get_linear_velocity: -- :ref:`Vector3` **get_linear_velocity** **(** **)** const +- :ref:`Vector3` **get_linear_velocity** **(** **)** const .. _class_PhysicsDirectBodyState_get_principal_inertia_axes: -- :ref:`Basis` **get_principal_inertia_axes** **(** **)** const +- :ref:`Basis` **get_principal_inertia_axes** **(** **)** const .. _class_PhysicsDirectBodyState_get_space_state: -- :ref:`PhysicsDirectSpaceState` **get_space_state** **(** **)** +- :ref:`PhysicsDirectSpaceState` **get_space_state** **(** **)** .. _class_PhysicsDirectBodyState_get_step: -- :ref:`float` **get_step** **(** **)** const +- :ref:`float` **get_step** **(** **)** const .. _class_PhysicsDirectBodyState_get_total_angular_damp: -- :ref:`float` **get_total_angular_damp** **(** **)** const +- :ref:`float` **get_total_angular_damp** **(** **)** const .. _class_PhysicsDirectBodyState_get_total_gravity: -- :ref:`Vector3` **get_total_gravity** **(** **)** const +- :ref:`Vector3` **get_total_gravity** **(** **)** const .. _class_PhysicsDirectBodyState_get_total_linear_damp: -- :ref:`float` **get_total_linear_damp** **(** **)** const +- :ref:`float` **get_total_linear_damp** **(** **)** const .. _class_PhysicsDirectBodyState_get_transform: -- :ref:`Transform` **get_transform** **(** **)** const +- :ref:`Transform` **get_transform** **(** **)** const .. _class_PhysicsDirectBodyState_integrate_forces: -- void **integrate_forces** **(** **)** +- void **integrate_forces** **(** **)** .. _class_PhysicsDirectBodyState_is_sleeping: -- :ref:`bool` **is_sleeping** **(** **)** const +- :ref:`bool` **is_sleeping** **(** **)** const .. _class_PhysicsDirectBodyState_set_angular_velocity: -- void **set_angular_velocity** **(** :ref:`Vector3` velocity **)** +- void **set_angular_velocity** **(** :ref:`Vector3` velocity **)** .. _class_PhysicsDirectBodyState_set_linear_velocity: -- void **set_linear_velocity** **(** :ref:`Vector3` velocity **)** +- void **set_linear_velocity** **(** :ref:`Vector3` velocity **)** .. _class_PhysicsDirectBodyState_set_sleep_state: -- void **set_sleep_state** **(** :ref:`bool` enabled **)** +- void **set_sleep_state** **(** :ref:`bool` enabled **)** .. _class_PhysicsDirectBodyState_set_transform: -- void **set_transform** **(** :ref:`Transform` transform **)** +- void **set_transform** **(** :ref:`Transform` transform **)** diff --git a/classes/class_physicsdirectspacestate.rst b/classes/class_physicsdirectspacestate.rst index ed1840897..0ca38f485 100644 --- a/classes/class_physicsdirectspacestate.rst +++ b/classes/class_physicsdirectspacestate.rst @@ -19,17 +19,17 @@ Brief Description Member Functions ---------------- -+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`cast_motion` **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`Vector3` motion **)** | -+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`collide_shape` **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`int` max_results=32 **)** | -+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_rest_info` **(** :ref:`PhysicsShapeQueryParameters` shape **)** | -+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`intersect_ray` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=2147483647, :ref:`int` type_mask=15 **)** | -+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`intersect_shape` **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`int` max_results=32 **)** | -+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`cast_motion` **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`Vector3` motion **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`collide_shape` **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`int` max_results=32 **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_rest_info` **(** :ref:`PhysicsShapeQueryParameters` shape **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`intersect_ray` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=2147483647, :ref:`int` type_mask=15 **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`intersect_shape` **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`int` max_results=32 **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -46,22 +46,22 @@ Member Function Description .. _class_PhysicsDirectSpaceState_cast_motion: -- :ref:`Array` **cast_motion** **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`Vector3` motion **)** +- :ref:`Array` **cast_motion** **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`Vector3` motion **)** .. _class_PhysicsDirectSpaceState_collide_shape: -- :ref:`Array` **collide_shape** **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`int` max_results=32 **)** +- :ref:`Array` **collide_shape** **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`int` max_results=32 **)** .. _class_PhysicsDirectSpaceState_get_rest_info: -- :ref:`Dictionary` **get_rest_info** **(** :ref:`PhysicsShapeQueryParameters` shape **)** +- :ref:`Dictionary` **get_rest_info** **(** :ref:`PhysicsShapeQueryParameters` shape **)** .. _class_PhysicsDirectSpaceState_intersect_ray: -- :ref:`Dictionary` **intersect_ray** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=2147483647, :ref:`int` type_mask=15 **)** +- :ref:`Dictionary` **intersect_ray** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=2147483647, :ref:`int` type_mask=15 **)** .. _class_PhysicsDirectSpaceState_intersect_shape: -- :ref:`Array` **intersect_shape** **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`int` max_results=32 **)** +- :ref:`Array` **intersect_shape** **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`int` max_results=32 **)** diff --git a/classes/class_physicsserver.rst b/classes/class_physicsserver.rst index 800d26f4a..502d78446 100644 --- a/classes/class_physicsserver.rst +++ b/classes/class_physicsserver.rst @@ -21,213 +21,213 @@ Server interface for low level physics access. Member Functions ---------------- -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_add_shape` **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform` transform=Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_attach_object_instance_id` **(** :ref:`RID` area, :ref:`int` id **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_clear_shapes` **(** :ref:`RID` area **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`area_create` **(** **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`area_get_object_instance_id` **(** :ref:`RID` area **)** const | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`area_get_param` **(** :ref:`RID` area, :ref:`int` param **)** const | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`area_get_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** const | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`area_get_shape_count` **(** :ref:`RID` area **)** const | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`area_get_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx **)** const | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`area_get_space` **(** :ref:`RID` area **)** const | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`area_get_space_override_mode` **(** :ref:`RID` area **)** const | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`area_get_transform` **(** :ref:`RID` area **)** const | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`area_is_ray_pickable` **(** :ref:`RID` area **)** const | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_remove_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_collision_layer` **(** :ref:`RID` area, :ref:`int` layer **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_collision_mask` **(** :ref:`RID` area, :ref:`int` mask **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_monitor_callback` **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_param` **(** :ref:`RID` area, :ref:`int` param, :ref:`Variant` value **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_ray_pickable` **(** :ref:`RID` area, :ref:`bool` enable **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_shape` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`RID` shape **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`Transform` transform **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_space` **(** :ref:`RID` area, :ref:`RID` space **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_space_override_mode` **(** :ref:`RID` area, :ref:`int` mode **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_transform` **(** :ref:`RID` area, :ref:`Transform` transform **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_add_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_add_shape` **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform` transform=Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_apply_impulse` **(** :ref:`RID` body, :ref:`Vector3` position, :ref:`Vector3` impulse **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_apply_torque_impulse` **(** :ref:`RID` body, :ref:`Vector3` impulse **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_attach_object_instance_id` **(** :ref:`RID` body, :ref:`int` id **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_clear_shapes` **(** :ref:`RID` body **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`body_create` **(** :ref:`int` mode=2, :ref:`bool` init_sleeping=false **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_axis_lock` **(** :ref:`RID` body **)** const | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_collision_layer` **(** :ref:`RID` body **)** const | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_collision_mask` **(** :ref:`RID` body **)** const | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PhysicsDirectBodyState` | :ref:`body_get_direct_state` **(** :ref:`RID` body **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_max_contacts_reported` **(** :ref:`RID` body **)** const | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_mode` **(** :ref:`RID` body **)** const | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_object_instance_id` **(** :ref:`RID` body **)** const | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`body_get_param` **(** :ref:`RID` body, :ref:`int` param **)** const | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`body_get_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_shape_count` **(** :ref:`RID` body **)** const | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`body_get_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`body_get_space` **(** :ref:`RID` body **)** const | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`body_get_state` **(** :ref:`RID` body, :ref:`int` state **)** const | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`body_is_continuous_collision_detection_enabled` **(** :ref:`RID` body **)** const | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`body_is_omitting_force_integration` **(** :ref:`RID` body **)** const | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`body_is_ray_pickable` **(** :ref:`RID` body **)** const | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_remove_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_remove_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_axis_lock` **(** :ref:`RID` body, :ref:`int` axis **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_axis_velocity` **(** :ref:`RID` body, :ref:`Vector3` axis_velocity **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_collision_layer` **(** :ref:`RID` body, :ref:`int` layer **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_collision_mask` **(** :ref:`RID` body, :ref:`int` mask **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_enable_continuous_collision_detection` **(** :ref:`RID` body, :ref:`bool` enable **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_force_integration_callback` **(** :ref:`RID` body, :ref:`Object` receiver, :ref:`String` method, :ref:`Variant` userdata=null **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_max_contacts_reported` **(** :ref:`RID` body, :ref:`int` amount **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_mode` **(** :ref:`RID` body, :ref:`int` mode **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_omit_force_integration` **(** :ref:`RID` body, :ref:`bool` enable **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_param` **(** :ref:`RID` body, :ref:`int` param, :ref:`float` value **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_ray_pickable` **(** :ref:`RID` body, :ref:`bool` enable **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_shape` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`RID` shape **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Transform` transform **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_space` **(** :ref:`RID` body, :ref:`RID` space **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_state` **(** :ref:`RID` body, :ref:`int` state, :ref:`Variant` value **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`cone_twist_joint_get_param` **(** :ref:`RID` joint, :ref:`int` param **)** const | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cone_twist_joint_set_param` **(** :ref:`RID` joint, :ref:`int` param, :ref:`float` value **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`free_rid` **(** :ref:`RID` rid **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`generic_6dof_joint_get_flag` **(** :ref:`RID` joint, :ref:`int` axis, :ref:`int` flag **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`generic_6dof_joint_get_param` **(** :ref:`RID` joint, :ref:`int` axis, :ref:`int` param **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`generic_6dof_joint_set_flag` **(** :ref:`RID` joint, :ref:`int` axis, :ref:`int` flag, :ref:`bool` enable **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`generic_6dof_joint_set_param` **(** :ref:`RID` joint, :ref:`int` axis, :ref:`int` param, :ref:`float` value **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_process_info` **(** :ref:`int` process_info **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`hinge_joint_get_flag` **(** :ref:`RID` joint, :ref:`int` flag **)** const | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`hinge_joint_get_param` **(** :ref:`RID` joint, :ref:`int` param **)** const | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`hinge_joint_set_flag` **(** :ref:`RID` joint, :ref:`int` flag, :ref:`bool` enabled **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`hinge_joint_set_param` **(** :ref:`RID` joint, :ref:`int` param, :ref:`float` value **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`joint_create_cone_twist` **(** :ref:`RID` body_A, :ref:`Transform` local_ref_A, :ref:`RID` body_B, :ref:`Transform` local_ref_B **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`joint_create_generic_6dof` **(** :ref:`RID` body_A, :ref:`Transform` local_ref_A, :ref:`RID` body_B, :ref:`Transform` local_ref_B **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`joint_create_hinge` **(** :ref:`RID` body_A, :ref:`Transform` hinge_A, :ref:`RID` body_B, :ref:`Transform` hinge_B **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`joint_create_pin` **(** :ref:`RID` body_A, :ref:`Vector3` local_A, :ref:`RID` body_B, :ref:`Vector3` local_B **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`joint_create_slider` **(** :ref:`RID` body_A, :ref:`Transform` local_ref_A, :ref:`RID` body_B, :ref:`Transform` local_ref_B **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`joint_get_solver_priority` **(** :ref:`RID` joint **)** const | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`joint_get_type` **(** :ref:`RID` joint **)** const | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`joint_set_solver_priority` **(** :ref:`RID` joint, :ref:`int` priority **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`pin_joint_get_local_a` **(** :ref:`RID` joint **)** const | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`pin_joint_get_local_b` **(** :ref:`RID` joint **)** const | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`pin_joint_get_param` **(** :ref:`RID` joint, :ref:`int` param **)** const | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`pin_joint_set_local_a` **(** :ref:`RID` joint, :ref:`Vector3` local_A **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`pin_joint_set_local_b` **(** :ref:`RID` joint, :ref:`Vector3` local_B **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`pin_joint_set_param` **(** :ref:`RID` joint, :ref:`int` param, :ref:`float` value **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_active` **(** :ref:`bool` active **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`shape_create` **(** :ref:`int` type **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`shape_get_data` **(** :ref:`RID` shape **)** const | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`shape_get_type` **(** :ref:`RID` shape **)** const | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shape_set_data` **(** :ref:`RID` shape, :ref:`Variant` data **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`slider_joint_get_param` **(** :ref:`RID` joint, :ref:`int` param **)** const | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`slider_joint_set_param` **(** :ref:`RID` joint, :ref:`int` param, :ref:`float` value **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`space_create` **(** **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PhysicsDirectSpaceState` | :ref:`space_get_direct_state` **(** :ref:`RID` space **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`space_get_param` **(** :ref:`RID` space, :ref:`int` param **)** const | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`space_is_active` **(** :ref:`RID` space **)** const | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`space_set_active` **(** :ref:`RID` space, :ref:`bool` active **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`space_set_param` **(** :ref:`RID` space, :ref:`int` param, :ref:`float` value **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_add_shape` **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform` transform=Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_attach_object_instance_id` **(** :ref:`RID` area, :ref:`int` id **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_clear_shapes` **(** :ref:`RID` area **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`area_create` **(** **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`area_get_object_instance_id` **(** :ref:`RID` area **)** const | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`area_get_param` **(** :ref:`RID` area, :ref:`int` param **)** const | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`area_get_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** const | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`area_get_shape_count` **(** :ref:`RID` area **)** const | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`area_get_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx **)** const | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`area_get_space` **(** :ref:`RID` area **)** const | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`area_get_space_override_mode` **(** :ref:`RID` area **)** const | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`area_get_transform` **(** :ref:`RID` area **)** const | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`area_is_ray_pickable` **(** :ref:`RID` area **)** const | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_remove_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_collision_layer` **(** :ref:`RID` area, :ref:`int` layer **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_collision_mask` **(** :ref:`RID` area, :ref:`int` mask **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_monitor_callback` **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_param` **(** :ref:`RID` area, :ref:`int` param, :ref:`Variant` value **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_ray_pickable` **(** :ref:`RID` area, :ref:`bool` enable **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_shape` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`RID` shape **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`Transform` transform **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_space` **(** :ref:`RID` area, :ref:`RID` space **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_space_override_mode` **(** :ref:`RID` area, :ref:`int` mode **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_transform` **(** :ref:`RID` area, :ref:`Transform` transform **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_add_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_add_shape` **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform` transform=Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_apply_impulse` **(** :ref:`RID` body, :ref:`Vector3` position, :ref:`Vector3` impulse **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_apply_torque_impulse` **(** :ref:`RID` body, :ref:`Vector3` impulse **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_attach_object_instance_id` **(** :ref:`RID` body, :ref:`int` id **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_clear_shapes` **(** :ref:`RID` body **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`body_create` **(** :ref:`int` mode=2, :ref:`bool` init_sleeping=false **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`body_get_axis_lock` **(** :ref:`RID` body **)** const | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`body_get_collision_layer` **(** :ref:`RID` body **)** const | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`body_get_collision_mask` **(** :ref:`RID` body **)** const | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PhysicsDirectBodyState` | :ref:`body_get_direct_state` **(** :ref:`RID` body **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`body_get_max_contacts_reported` **(** :ref:`RID` body **)** const | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`body_get_mode` **(** :ref:`RID` body **)** const | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`body_get_object_instance_id` **(** :ref:`RID` body **)** const | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`body_get_param` **(** :ref:`RID` body, :ref:`int` param **)** const | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`body_get_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`body_get_shape_count` **(** :ref:`RID` body **)** const | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`body_get_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`body_get_space` **(** :ref:`RID` body **)** const | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`body_get_state` **(** :ref:`RID` body, :ref:`int` state **)** const | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`body_is_continuous_collision_detection_enabled` **(** :ref:`RID` body **)** const | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`body_is_omitting_force_integration` **(** :ref:`RID` body **)** const | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`body_is_ray_pickable` **(** :ref:`RID` body **)** const | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_remove_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_remove_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_axis_lock` **(** :ref:`RID` body, :ref:`int` axis **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_axis_velocity` **(** :ref:`RID` body, :ref:`Vector3` axis_velocity **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_collision_layer` **(** :ref:`RID` body, :ref:`int` layer **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_collision_mask` **(** :ref:`RID` body, :ref:`int` mask **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_enable_continuous_collision_detection` **(** :ref:`RID` body, :ref:`bool` enable **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_force_integration_callback` **(** :ref:`RID` body, :ref:`Object` receiver, :ref:`String` method, :ref:`Variant` userdata=null **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_max_contacts_reported` **(** :ref:`RID` body, :ref:`int` amount **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_mode` **(** :ref:`RID` body, :ref:`int` mode **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_omit_force_integration` **(** :ref:`RID` body, :ref:`bool` enable **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_param` **(** :ref:`RID` body, :ref:`int` param, :ref:`float` value **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_ray_pickable` **(** :ref:`RID` body, :ref:`bool` enable **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_shape` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`RID` shape **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Transform` transform **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_space` **(** :ref:`RID` body, :ref:`RID` space **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_state` **(** :ref:`RID` body, :ref:`int` state, :ref:`Variant` value **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`cone_twist_joint_get_param` **(** :ref:`RID` joint, :ref:`int` param **)** const | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`cone_twist_joint_set_param` **(** :ref:`RID` joint, :ref:`int` param, :ref:`float` value **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`free_rid` **(** :ref:`RID` rid **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`generic_6dof_joint_get_flag` **(** :ref:`RID` joint, :ref:`int` axis, :ref:`int` flag **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`generic_6dof_joint_get_param` **(** :ref:`RID` joint, :ref:`int` axis, :ref:`int` param **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`generic_6dof_joint_set_flag` **(** :ref:`RID` joint, :ref:`int` axis, :ref:`int` flag, :ref:`bool` enable **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`generic_6dof_joint_set_param` **(** :ref:`RID` joint, :ref:`int` axis, :ref:`int` param, :ref:`float` value **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_process_info` **(** :ref:`int` process_info **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`hinge_joint_get_flag` **(** :ref:`RID` joint, :ref:`int` flag **)** const | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`hinge_joint_get_param` **(** :ref:`RID` joint, :ref:`int` param **)** const | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`hinge_joint_set_flag` **(** :ref:`RID` joint, :ref:`int` flag, :ref:`bool` enabled **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`hinge_joint_set_param` **(** :ref:`RID` joint, :ref:`int` param, :ref:`float` value **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`joint_create_cone_twist` **(** :ref:`RID` body_A, :ref:`Transform` local_ref_A, :ref:`RID` body_B, :ref:`Transform` local_ref_B **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`joint_create_generic_6dof` **(** :ref:`RID` body_A, :ref:`Transform` local_ref_A, :ref:`RID` body_B, :ref:`Transform` local_ref_B **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`joint_create_hinge` **(** :ref:`RID` body_A, :ref:`Transform` hinge_A, :ref:`RID` body_B, :ref:`Transform` hinge_B **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`joint_create_pin` **(** :ref:`RID` body_A, :ref:`Vector3` local_A, :ref:`RID` body_B, :ref:`Vector3` local_B **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`joint_create_slider` **(** :ref:`RID` body_A, :ref:`Transform` local_ref_A, :ref:`RID` body_B, :ref:`Transform` local_ref_B **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`joint_get_solver_priority` **(** :ref:`RID` joint **)** const | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`joint_get_type` **(** :ref:`RID` joint **)** const | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`joint_set_solver_priority` **(** :ref:`RID` joint, :ref:`int` priority **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`pin_joint_get_local_a` **(** :ref:`RID` joint **)** const | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`pin_joint_get_local_b` **(** :ref:`RID` joint **)** const | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`pin_joint_get_param` **(** :ref:`RID` joint, :ref:`int` param **)** const | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`pin_joint_set_local_a` **(** :ref:`RID` joint, :ref:`Vector3` local_A **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`pin_joint_set_local_b` **(** :ref:`RID` joint, :ref:`Vector3` local_B **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`pin_joint_set_param` **(** :ref:`RID` joint, :ref:`int` param, :ref:`float` value **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_active` **(** :ref:`bool` active **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`shape_create` **(** :ref:`int` type **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`shape_get_data` **(** :ref:`RID` shape **)** const | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`shape_get_type` **(** :ref:`RID` shape **)** const | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shape_set_data` **(** :ref:`RID` shape, :ref:`Variant` data **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`slider_joint_get_param` **(** :ref:`RID` joint, :ref:`int` param **)** const | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`slider_joint_set_param` **(** :ref:`RID` joint, :ref:`int` param, :ref:`float` value **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`space_create` **(** **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PhysicsDirectSpaceState` | :ref:`space_get_direct_state` **(** :ref:`RID` space **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`space_get_param` **(** :ref:`RID` space, :ref:`int` param **)** const | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`space_is_active` **(** :ref:`RID` space **)** const | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`space_set_active` **(** :ref:`RID` space, :ref:`bool` active **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`space_set_param` **(** :ref:`RID` space, :ref:`int` param, :ref:`float` value **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -375,103 +375,103 @@ Member Function Description .. _class_PhysicsServer_area_add_shape: -- void **area_add_shape** **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform` transform=Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) **)** +- void **area_add_shape** **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform` transform=Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) **)** Adds a shape to the area, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index. .. _class_PhysicsServer_area_attach_object_instance_id: -- void **area_attach_object_instance_id** **(** :ref:`RID` area, :ref:`int` id **)** +- void **area_attach_object_instance_id** **(** :ref:`RID` area, :ref:`int` id **)** Assigns the area to a descendant of :ref:`Object`, so it can exist in the node tree. .. _class_PhysicsServer_area_clear_shapes: -- void **area_clear_shapes** **(** :ref:`RID` area **)** +- void **area_clear_shapes** **(** :ref:`RID` area **)** Removes all shapes from an area. It does not delete the shapes, so they can be reassigned later. .. _class_PhysicsServer_area_create: -- :ref:`RID` **area_create** **(** **)** +- :ref:`RID` **area_create** **(** **)** Creates an :ref:`Area`. .. _class_PhysicsServer_area_get_object_instance_id: -- :ref:`int` **area_get_object_instance_id** **(** :ref:`RID` area **)** const +- :ref:`int` **area_get_object_instance_id** **(** :ref:`RID` area **)** const Gets the instance ID of the object the area is assigned to. .. _class_PhysicsServer_area_get_param: -- :ref:`Variant` **area_get_param** **(** :ref:`RID` area, :ref:`int` param **)** const +- :ref:`Variant` **area_get_param** **(** :ref:`RID` area, :ref:`int` param **)** const Returns an area parameter value. A list of available parameters is on the AREA_PARAM\_\* constants. .. _class_PhysicsServer_area_get_shape: -- :ref:`RID` **area_get_shape** **(** :ref:`RID` area, :ref:`int` shape_idx **)** const +- :ref:`RID` **area_get_shape** **(** :ref:`RID` area, :ref:`int` shape_idx **)** const Returns the :ref:`RID` of the nth shape of an area. .. _class_PhysicsServer_area_get_shape_count: -- :ref:`int` **area_get_shape_count** **(** :ref:`RID` area **)** const +- :ref:`int` **area_get_shape_count** **(** :ref:`RID` area **)** const Returns the number of shapes assigned to an area. .. _class_PhysicsServer_area_get_shape_transform: -- :ref:`Transform` **area_get_shape_transform** **(** :ref:`RID` area, :ref:`int` shape_idx **)** const +- :ref:`Transform` **area_get_shape_transform** **(** :ref:`RID` area, :ref:`int` shape_idx **)** const Returns the transform matrix of a shape within an area. .. _class_PhysicsServer_area_get_space: -- :ref:`RID` **area_get_space** **(** :ref:`RID` area **)** const +- :ref:`RID` **area_get_space** **(** :ref:`RID` area **)** const Returns the space assigned to the area. .. _class_PhysicsServer_area_get_space_override_mode: -- :ref:`int` **area_get_space_override_mode** **(** :ref:`RID` area **)** const +- :ref:`int` **area_get_space_override_mode** **(** :ref:`RID` area **)** const Returns the space override mode for the area. .. _class_PhysicsServer_area_get_transform: -- :ref:`Transform` **area_get_transform** **(** :ref:`RID` area **)** const +- :ref:`Transform` **area_get_transform** **(** :ref:`RID` area **)** const Returns the transform matrix for an area. .. _class_PhysicsServer_area_is_ray_pickable: -- :ref:`bool` **area_is_ray_pickable** **(** :ref:`RID` area **)** const +- :ref:`bool` **area_is_ray_pickable** **(** :ref:`RID` area **)** const If ``true`` area collides with rays. .. _class_PhysicsServer_area_remove_shape: -- void **area_remove_shape** **(** :ref:`RID` area, :ref:`int` shape_idx **)** +- void **area_remove_shape** **(** :ref:`RID` area, :ref:`int` shape_idx **)** Removes a shape from an area. It does not delete the shape, so it can be reassigned later. .. _class_PhysicsServer_area_set_collision_layer: -- void **area_set_collision_layer** **(** :ref:`RID` area, :ref:`int` layer **)** +- void **area_set_collision_layer** **(** :ref:`RID` area, :ref:`int` layer **)** Assigns the area to one or many physics layers. .. _class_PhysicsServer_area_set_collision_mask: -- void **area_set_collision_mask** **(** :ref:`RID` area, :ref:`int` mask **)** +- void **area_set_collision_mask** **(** :ref:`RID` area, :ref:`int` mask **)** Sets which physics layers the area will monitor. .. _class_PhysicsServer_area_set_monitor_callback: -- void **area_set_monitor_callback** **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** +- void **area_set_monitor_callback** **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** Sets the function to call when any body/area enters or exits the area. This callback will be called for any object interacting with the area, and takes five parameters: @@ -487,103 +487,103 @@ Sets the function to call when any body/area enters or exits the area. This call .. _class_PhysicsServer_area_set_param: -- void **area_set_param** **(** :ref:`RID` area, :ref:`int` param, :ref:`Variant` value **)** +- void **area_set_param** **(** :ref:`RID` area, :ref:`int` param, :ref:`Variant` value **)** Sets the value for an area parameter. A list of available parameters is on the AREA_PARAM\_\* constants. .. _class_PhysicsServer_area_set_ray_pickable: -- void **area_set_ray_pickable** **(** :ref:`RID` area, :ref:`bool` enable **)** +- void **area_set_ray_pickable** **(** :ref:`RID` area, :ref:`bool` enable **)** Sets object pickable with rays. .. _class_PhysicsServer_area_set_shape: -- void **area_set_shape** **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`RID` shape **)** +- void **area_set_shape** **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`RID` shape **)** Substitutes a given area shape by another. The old shape is selected by its index, the new one by its :ref:`RID`. .. _class_PhysicsServer_area_set_shape_transform: -- void **area_set_shape_transform** **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`Transform` transform **)** +- void **area_set_shape_transform** **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`Transform` transform **)** Sets the transform matrix for an area shape. .. _class_PhysicsServer_area_set_space: -- void **area_set_space** **(** :ref:`RID` area, :ref:`RID` space **)** +- void **area_set_space** **(** :ref:`RID` area, :ref:`RID` space **)** Assigns a space to the area. .. _class_PhysicsServer_area_set_space_override_mode: -- void **area_set_space_override_mode** **(** :ref:`RID` area, :ref:`int` mode **)** +- void **area_set_space_override_mode** **(** :ref:`RID` area, :ref:`int` mode **)** Sets the space override mode for the area. The modes are described in the constants AREA_SPACE_OVERRIDE\_\*. .. _class_PhysicsServer_area_set_transform: -- void **area_set_transform** **(** :ref:`RID` area, :ref:`Transform` transform **)** +- void **area_set_transform** **(** :ref:`RID` area, :ref:`Transform` transform **)** Sets the transform matrix for an area. .. _class_PhysicsServer_body_add_collision_exception: -- void **body_add_collision_exception** **(** :ref:`RID` body, :ref:`RID` excepted_body **)** +- void **body_add_collision_exception** **(** :ref:`RID` body, :ref:`RID` excepted_body **)** Adds a body to the list of bodies exempt from collisions. .. _class_PhysicsServer_body_add_shape: -- void **body_add_shape** **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform` transform=Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) **)** +- void **body_add_shape** **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform` transform=Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) **)** Adds a shape to the body, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index. .. _class_PhysicsServer_body_apply_impulse: -- void **body_apply_impulse** **(** :ref:`RID` body, :ref:`Vector3` position, :ref:`Vector3` impulse **)** +- void **body_apply_impulse** **(** :ref:`RID` body, :ref:`Vector3` position, :ref:`Vector3` impulse **)** Gives the body a push at a ``position`` in the direction of the ``impulse``. .. _class_PhysicsServer_body_apply_torque_impulse: -- void **body_apply_torque_impulse** **(** :ref:`RID` body, :ref:`Vector3` impulse **)** +- void **body_apply_torque_impulse** **(** :ref:`RID` body, :ref:`Vector3` impulse **)** Gives the body a push to rotate it. .. _class_PhysicsServer_body_attach_object_instance_id: -- void **body_attach_object_instance_id** **(** :ref:`RID` body, :ref:`int` id **)** +- void **body_attach_object_instance_id** **(** :ref:`RID` body, :ref:`int` id **)** Assigns the area to a descendant of :ref:`Object`, so it can exist in the node tree. .. _class_PhysicsServer_body_clear_shapes: -- void **body_clear_shapes** **(** :ref:`RID` body **)** +- void **body_clear_shapes** **(** :ref:`RID` body **)** Removes all shapes from a body. .. _class_PhysicsServer_body_create: -- :ref:`RID` **body_create** **(** :ref:`int` mode=2, :ref:`bool` init_sleeping=false **)** +- :ref:`RID` **body_create** **(** :ref:`int` mode=2, :ref:`bool` init_sleeping=false **)** Creates a physics body. The first parameter can be any value from constants BODY_MODE\*, for the type of body created. Additionally, the body can be created in sleeping state to save processing time. .. _class_PhysicsServer_body_get_axis_lock: -- :ref:`int` **body_get_axis_lock** **(** :ref:`RID` body **)** const +- :ref:`int` **body_get_axis_lock** **(** :ref:`RID` body **)** const Gets the information, which Axis is locked if any. The can be any calue from the constants BODY_AXIS_LOCK\* .. _class_PhysicsServer_body_get_collision_layer: -- :ref:`int` **body_get_collision_layer** **(** :ref:`RID` body **)** const +- :ref:`int` **body_get_collision_layer** **(** :ref:`RID` body **)** const Returns the physics layer or layers a body belongs to. .. _class_PhysicsServer_body_get_collision_mask: -- :ref:`int` **body_get_collision_mask** **(** :ref:`RID` body **)** const +- :ref:`int` **body_get_collision_mask** **(** :ref:`RID` body **)** const Returns the physics layer or layers a body can collide with. @@ -591,85 +591,85 @@ Returns the physics layer or layers a body can collide with. .. _class_PhysicsServer_body_get_direct_state: -- :ref:`PhysicsDirectBodyState` **body_get_direct_state** **(** :ref:`RID` body **)** +- :ref:`PhysicsDirectBodyState` **body_get_direct_state** **(** :ref:`RID` body **)** Returns the :ref:`PhysicsDirectBodyState` of the body. .. _class_PhysicsServer_body_get_max_contacts_reported: -- :ref:`int` **body_get_max_contacts_reported** **(** :ref:`RID` body **)** const +- :ref:`int` **body_get_max_contacts_reported** **(** :ref:`RID` body **)** const Returns the maximum contacts that can be reported. See :ref:`body_set_max_contacts_reported`. .. _class_PhysicsServer_body_get_mode: -- :ref:`int` **body_get_mode** **(** :ref:`RID` body **)** const +- :ref:`int` **body_get_mode** **(** :ref:`RID` body **)** const Returns the body mode. .. _class_PhysicsServer_body_get_object_instance_id: -- :ref:`int` **body_get_object_instance_id** **(** :ref:`RID` body **)** const +- :ref:`int` **body_get_object_instance_id** **(** :ref:`RID` body **)** const Gets the instance ID of the object the area is assigned to. .. _class_PhysicsServer_body_get_param: -- :ref:`float` **body_get_param** **(** :ref:`RID` body, :ref:`int` param **)** const +- :ref:`float` **body_get_param** **(** :ref:`RID` body, :ref:`int` param **)** const Returns the value of a body parameter. A list of available parameters is on the BODY_PARAM\_\* constants. .. _class_PhysicsServer_body_get_shape: -- :ref:`RID` **body_get_shape** **(** :ref:`RID` body, :ref:`int` shape_idx **)** const +- :ref:`RID` **body_get_shape** **(** :ref:`RID` body, :ref:`int` shape_idx **)** const Returns the :ref:`RID` of the nth shape of a body. .. _class_PhysicsServer_body_get_shape_count: -- :ref:`int` **body_get_shape_count** **(** :ref:`RID` body **)** const +- :ref:`int` **body_get_shape_count** **(** :ref:`RID` body **)** const Returns the number of shapes assigned to a body. .. _class_PhysicsServer_body_get_shape_transform: -- :ref:`Transform` **body_get_shape_transform** **(** :ref:`RID` body, :ref:`int` shape_idx **)** const +- :ref:`Transform` **body_get_shape_transform** **(** :ref:`RID` body, :ref:`int` shape_idx **)** const Returns the transform matrix of a body shape. .. _class_PhysicsServer_body_get_space: -- :ref:`RID` **body_get_space** **(** :ref:`RID` body **)** const +- :ref:`RID` **body_get_space** **(** :ref:`RID` body **)** const Returns the :ref:`RID` of the space assigned to a body. .. _class_PhysicsServer_body_get_state: -- :ref:`Variant` **body_get_state** **(** :ref:`RID` body, :ref:`int` state **)** const +- :ref:`Variant` **body_get_state** **(** :ref:`RID` body, :ref:`int` state **)** const Returns a body state. .. _class_PhysicsServer_body_is_continuous_collision_detection_enabled: -- :ref:`bool` **body_is_continuous_collision_detection_enabled** **(** :ref:`RID` body **)** const +- :ref:`bool` **body_is_continuous_collision_detection_enabled** **(** :ref:`RID` body **)** const If ``true`` the continuous collision detection mode is enabled. .. _class_PhysicsServer_body_is_omitting_force_integration: -- :ref:`bool` **body_is_omitting_force_integration** **(** :ref:`RID` body **)** const +- :ref:`bool` **body_is_omitting_force_integration** **(** :ref:`RID` body **)** const Returns whether a body uses a callback function to calculate its own physics (see :ref:`body_set_force_integration_callback`). .. _class_PhysicsServer_body_is_ray_pickable: -- :ref:`bool` **body_is_ray_pickable** **(** :ref:`RID` body **)** const +- :ref:`bool` **body_is_ray_pickable** **(** :ref:`RID` body **)** const If ``true`` the body can be detected by rays .. _class_PhysicsServer_body_remove_collision_exception: -- void **body_remove_collision_exception** **(** :ref:`RID` body, :ref:`RID` excepted_body **)** +- void **body_remove_collision_exception** **(** :ref:`RID` body, :ref:`RID` excepted_body **)** Removes a body from the list of bodies exempt from collisions. @@ -677,37 +677,37 @@ Continuous collision detection tries to predict where a moving body will collide .. _class_PhysicsServer_body_remove_shape: -- void **body_remove_shape** **(** :ref:`RID` body, :ref:`int` shape_idx **)** +- void **body_remove_shape** **(** :ref:`RID` body, :ref:`int` shape_idx **)** Removes a shape from a body. The shape is not deleted, so it can be reused afterwards. .. _class_PhysicsServer_body_set_axis_lock: -- void **body_set_axis_lock** **(** :ref:`RID` body, :ref:`int` axis **)** +- void **body_set_axis_lock** **(** :ref:`RID` body, :ref:`int` axis **)** Locks velocity along one axis to 0 and only allows rotation along this axis, can also be set to disabled which disables this functionality. .. _class_PhysicsServer_body_set_axis_velocity: -- void **body_set_axis_velocity** **(** :ref:`RID` body, :ref:`Vector3` axis_velocity **)** +- void **body_set_axis_velocity** **(** :ref:`RID` body, :ref:`Vector3` axis_velocity **)** Sets an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior. .. _class_PhysicsServer_body_set_collision_layer: -- void **body_set_collision_layer** **(** :ref:`RID` body, :ref:`int` layer **)** +- void **body_set_collision_layer** **(** :ref:`RID` body, :ref:`int` layer **)** Sets the physics layer or layers a body belongs to. .. _class_PhysicsServer_body_set_collision_mask: -- void **body_set_collision_mask** **(** :ref:`RID` body, :ref:`int` mask **)** +- void **body_set_collision_mask** **(** :ref:`RID` body, :ref:`int` mask **)** Sets the physics layer or layers a body can collide with. .. _class_PhysicsServer_body_set_enable_continuous_collision_detection: -- void **body_set_enable_continuous_collision_detection** **(** :ref:`RID` body, :ref:`bool` enable **)** +- void **body_set_enable_continuous_collision_detection** **(** :ref:`RID` body, :ref:`bool` enable **)** If ``true`` the continuous collision detection mode is enabled. @@ -715,295 +715,295 @@ Continuous collision detection tries to predict where a moving body will collide .. _class_PhysicsServer_body_set_force_integration_callback: -- void **body_set_force_integration_callback** **(** :ref:`RID` body, :ref:`Object` receiver, :ref:`String` method, :ref:`Variant` userdata=null **)** +- void **body_set_force_integration_callback** **(** :ref:`RID` body, :ref:`Object` receiver, :ref:`String` method, :ref:`Variant` userdata=null **)** Sets the function used to calculate physics for an object, if that object allows it (see :ref:`body_set_omit_force integration`). .. _class_PhysicsServer_body_set_max_contacts_reported: -- void **body_set_max_contacts_reported** **(** :ref:`RID` body, :ref:`int` amount **)** +- void **body_set_max_contacts_reported** **(** :ref:`RID` body, :ref:`int` amount **)** Sets the maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0. .. _class_PhysicsServer_body_set_mode: -- void **body_set_mode** **(** :ref:`RID` body, :ref:`int` mode **)** +- void **body_set_mode** **(** :ref:`RID` body, :ref:`int` mode **)** Sets the body mode, from one of the constants BODY_MODE\*. .. _class_PhysicsServer_body_set_omit_force_integration: -- void **body_set_omit_force_integration** **(** :ref:`RID` body, :ref:`bool` enable **)** +- void **body_set_omit_force_integration** **(** :ref:`RID` body, :ref:`bool` enable **)** Sets whether a body uses a callback function to calculate its own physics (see :ref:`body_set_force_integration_callback`). .. _class_PhysicsServer_body_set_param: -- void **body_set_param** **(** :ref:`RID` body, :ref:`int` param, :ref:`float` value **)** +- void **body_set_param** **(** :ref:`RID` body, :ref:`int` param, :ref:`float` value **)** Sets a body parameter. A list of available parameters is on the BODY_PARAM\_\* constants. .. _class_PhysicsServer_body_set_ray_pickable: -- void **body_set_ray_pickable** **(** :ref:`RID` body, :ref:`bool` enable **)** +- void **body_set_ray_pickable** **(** :ref:`RID` body, :ref:`bool` enable **)** Sets the body pickable with rays if ``enabled`` is set. .. _class_PhysicsServer_body_set_shape: -- void **body_set_shape** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`RID` shape **)** +- void **body_set_shape** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`RID` shape **)** Substitutes a given body shape by another. The old shape is selected by its index, the new one by its :ref:`RID`. .. _class_PhysicsServer_body_set_shape_transform: -- void **body_set_shape_transform** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Transform` transform **)** +- void **body_set_shape_transform** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Transform` transform **)** Sets the transform matrix for a body shape. .. _class_PhysicsServer_body_set_space: -- void **body_set_space** **(** :ref:`RID` body, :ref:`RID` space **)** +- void **body_set_space** **(** :ref:`RID` body, :ref:`RID` space **)** Assigns a space to the body (see :ref:`create_space`). .. _class_PhysicsServer_body_set_state: -- void **body_set_state** **(** :ref:`RID` body, :ref:`int` state, :ref:`Variant` value **)** +- void **body_set_state** **(** :ref:`RID` body, :ref:`int` state, :ref:`Variant` value **)** Sets a body state (see BODY_STATE\* constants). .. _class_PhysicsServer_cone_twist_joint_get_param: -- :ref:`float` **cone_twist_joint_get_param** **(** :ref:`RID` joint, :ref:`int` param **)** const +- :ref:`float` **cone_twist_joint_get_param** **(** :ref:`RID` joint, :ref:`int` param **)** const Gets a cone_twist_joint parameter (see CONE_TWIST_JOINT\* constants). .. _class_PhysicsServer_cone_twist_joint_set_param: -- void **cone_twist_joint_set_param** **(** :ref:`RID` joint, :ref:`int` param, :ref:`float` value **)** +- void **cone_twist_joint_set_param** **(** :ref:`RID` joint, :ref:`int` param, :ref:`float` value **)** Sets a cone_twist_joint parameter (see CONE_TWIST_JOINT\* constants). .. _class_PhysicsServer_free_rid: -- void **free_rid** **(** :ref:`RID` rid **)** +- void **free_rid** **(** :ref:`RID` rid **)** Destroys any of the objects created by PhysicsServer. If the :ref:`RID` passed is not one of the objects that can be created by PhysicsServer, an error will be sent to the console. .. _class_PhysicsServer_generic_6dof_joint_get_flag: -- :ref:`bool` **generic_6dof_joint_get_flag** **(** :ref:`RID` joint, :ref:`int` axis, :ref:`int` flag **)** +- :ref:`bool` **generic_6dof_joint_get_flag** **(** :ref:`RID` joint, :ref:`int` axis, :ref:`int` flag **)** Gets a generic_6_DOF_joint flag (see G6DOF_JOINT_FLAG\* constants). .. _class_PhysicsServer_generic_6dof_joint_get_param: -- :ref:`float` **generic_6dof_joint_get_param** **(** :ref:`RID` joint, :ref:`int` axis, :ref:`int` param **)** +- :ref:`float` **generic_6dof_joint_get_param** **(** :ref:`RID` joint, :ref:`int` axis, :ref:`int` param **)** Gets a generic_6_DOF_joint parameter (see G6DOF_JOINT\* constants without the G6DOF_JOINT_FLAG\*). .. _class_PhysicsServer_generic_6dof_joint_set_flag: -- void **generic_6dof_joint_set_flag** **(** :ref:`RID` joint, :ref:`int` axis, :ref:`int` flag, :ref:`bool` enable **)** +- void **generic_6dof_joint_set_flag** **(** :ref:`RID` joint, :ref:`int` axis, :ref:`int` flag, :ref:`bool` enable **)** Sets a generic_6_DOF_joint flag (see G6DOF_JOINT_FLAG\* constants). .. _class_PhysicsServer_generic_6dof_joint_set_param: -- void **generic_6dof_joint_set_param** **(** :ref:`RID` joint, :ref:`int` axis, :ref:`int` param, :ref:`float` value **)** +- void **generic_6dof_joint_set_param** **(** :ref:`RID` joint, :ref:`int` axis, :ref:`int` param, :ref:`float` value **)** Sets a generic_6_DOF_joint parameter (see G6DOF_JOINT\* constants without the G6DOF_JOINT_FLAG\*). .. _class_PhysicsServer_get_process_info: -- :ref:`int` **get_process_info** **(** :ref:`int` process_info **)** +- :ref:`int` **get_process_info** **(** :ref:`int` process_info **)** Returns an Info defined by the ProcessInfo input given. .. _class_PhysicsServer_hinge_joint_get_flag: -- :ref:`bool` **hinge_joint_get_flag** **(** :ref:`RID` joint, :ref:`int` flag **)** const +- :ref:`bool` **hinge_joint_get_flag** **(** :ref:`RID` joint, :ref:`int` flag **)** const Gets a hinge_joint flag (see HINGE_JOINT_FLAG\* constants). .. _class_PhysicsServer_hinge_joint_get_param: -- :ref:`float` **hinge_joint_get_param** **(** :ref:`RID` joint, :ref:`int` param **)** const +- :ref:`float` **hinge_joint_get_param** **(** :ref:`RID` joint, :ref:`int` param **)** const Gets a hinge_joint parameter (see HINGE_JOINT\* constants without the HINGE_JOINT_FLAG\*). .. _class_PhysicsServer_hinge_joint_set_flag: -- void **hinge_joint_set_flag** **(** :ref:`RID` joint, :ref:`int` flag, :ref:`bool` enabled **)** +- void **hinge_joint_set_flag** **(** :ref:`RID` joint, :ref:`int` flag, :ref:`bool` enabled **)** Sets a hinge_joint flag (see HINGE_JOINT_FLAG\* constants). .. _class_PhysicsServer_hinge_joint_set_param: -- void **hinge_joint_set_param** **(** :ref:`RID` joint, :ref:`int` param, :ref:`float` value **)** +- void **hinge_joint_set_param** **(** :ref:`RID` joint, :ref:`int` param, :ref:`float` value **)** Sets a hinge_joint parameter (see HINGE_JOINT\* constants without the HINGE_JOINT_FLAG\*). .. _class_PhysicsServer_joint_create_cone_twist: -- :ref:`RID` **joint_create_cone_twist** **(** :ref:`RID` body_A, :ref:`Transform` local_ref_A, :ref:`RID` body_B, :ref:`Transform` local_ref_B **)** +- :ref:`RID` **joint_create_cone_twist** **(** :ref:`RID` body_A, :ref:`Transform` local_ref_A, :ref:`RID` body_B, :ref:`Transform` local_ref_B **)** Creates a :ref:`ConeTwistJoint`. .. _class_PhysicsServer_joint_create_generic_6dof: -- :ref:`RID` **joint_create_generic_6dof** **(** :ref:`RID` body_A, :ref:`Transform` local_ref_A, :ref:`RID` body_B, :ref:`Transform` local_ref_B **)** +- :ref:`RID` **joint_create_generic_6dof** **(** :ref:`RID` body_A, :ref:`Transform` local_ref_A, :ref:`RID` body_B, :ref:`Transform` local_ref_B **)** Creates a :ref:`Generic6DOFJoint`. .. _class_PhysicsServer_joint_create_hinge: -- :ref:`RID` **joint_create_hinge** **(** :ref:`RID` body_A, :ref:`Transform` hinge_A, :ref:`RID` body_B, :ref:`Transform` hinge_B **)** +- :ref:`RID` **joint_create_hinge** **(** :ref:`RID` body_A, :ref:`Transform` hinge_A, :ref:`RID` body_B, :ref:`Transform` hinge_B **)** Creates a :ref:`HingeJoint`. .. _class_PhysicsServer_joint_create_pin: -- :ref:`RID` **joint_create_pin** **(** :ref:`RID` body_A, :ref:`Vector3` local_A, :ref:`RID` body_B, :ref:`Vector3` local_B **)** +- :ref:`RID` **joint_create_pin** **(** :ref:`RID` body_A, :ref:`Vector3` local_A, :ref:`RID` body_B, :ref:`Vector3` local_B **)** Creates a :ref:`PinJoint`. .. _class_PhysicsServer_joint_create_slider: -- :ref:`RID` **joint_create_slider** **(** :ref:`RID` body_A, :ref:`Transform` local_ref_A, :ref:`RID` body_B, :ref:`Transform` local_ref_B **)** +- :ref:`RID` **joint_create_slider** **(** :ref:`RID` body_A, :ref:`Transform` local_ref_A, :ref:`RID` body_B, :ref:`Transform` local_ref_B **)** Creates a :ref:`SliderJoint`. .. _class_PhysicsServer_joint_get_solver_priority: -- :ref:`int` **joint_get_solver_priority** **(** :ref:`RID` joint **)** const +- :ref:`int` **joint_get_solver_priority** **(** :ref:`RID` joint **)** const Gets the priority value of the Joint. .. _class_PhysicsServer_joint_get_type: -- :ref:`int` **joint_get_type** **(** :ref:`RID` joint **)** const +- :ref:`int` **joint_get_type** **(** :ref:`RID` joint **)** const Returns the type of the Joint. .. _class_PhysicsServer_joint_set_solver_priority: -- void **joint_set_solver_priority** **(** :ref:`RID` joint, :ref:`int` priority **)** +- void **joint_set_solver_priority** **(** :ref:`RID` joint, :ref:`int` priority **)** Sets the priority value of the Joint. .. _class_PhysicsServer_pin_joint_get_local_a: -- :ref:`Vector3` **pin_joint_get_local_a** **(** :ref:`RID` joint **)** const +- :ref:`Vector3` **pin_joint_get_local_a** **(** :ref:`RID` joint **)** const Returns position of the joint in the local space of body a of the joint. .. _class_PhysicsServer_pin_joint_get_local_b: -- :ref:`Vector3` **pin_joint_get_local_b** **(** :ref:`RID` joint **)** const +- :ref:`Vector3` **pin_joint_get_local_b** **(** :ref:`RID` joint **)** const Returns position of the joint in the local space of body b of the joint. .. _class_PhysicsServer_pin_joint_get_param: -- :ref:`float` **pin_joint_get_param** **(** :ref:`RID` joint, :ref:`int` param **)** const +- :ref:`float` **pin_joint_get_param** **(** :ref:`RID` joint, :ref:`int` param **)** const Gets a pin_joint parameter (see PIN_JOINT\* constants). .. _class_PhysicsServer_pin_joint_set_local_a: -- void **pin_joint_set_local_a** **(** :ref:`RID` joint, :ref:`Vector3` local_A **)** +- void **pin_joint_set_local_a** **(** :ref:`RID` joint, :ref:`Vector3` local_A **)** Sets position of the joint in the local space of body a of the joint. .. _class_PhysicsServer_pin_joint_set_local_b: -- void **pin_joint_set_local_b** **(** :ref:`RID` joint, :ref:`Vector3` local_B **)** +- void **pin_joint_set_local_b** **(** :ref:`RID` joint, :ref:`Vector3` local_B **)** Sets position of the joint in the local space of body b of the joint. .. _class_PhysicsServer_pin_joint_set_param: -- void **pin_joint_set_param** **(** :ref:`RID` joint, :ref:`int` param, :ref:`float` value **)** +- void **pin_joint_set_param** **(** :ref:`RID` joint, :ref:`int` param, :ref:`float` value **)** Sets a pin_joint parameter (see PIN_JOINT\* constants). .. _class_PhysicsServer_set_active: -- void **set_active** **(** :ref:`bool` active **)** +- void **set_active** **(** :ref:`bool` active **)** Activates or deactivates the 3D physics engine. .. _class_PhysicsServer_shape_create: -- :ref:`RID` **shape_create** **(** :ref:`int` type **)** +- :ref:`RID` **shape_create** **(** :ref:`int` type **)** Creates a shape of type SHAPE\_\*. Does not assign it to a body or an area. To do so, you must use :ref:`area_set_shape` or :ref:`body_set_shape`. .. _class_PhysicsServer_shape_get_data: -- :ref:`Variant` **shape_get_data** **(** :ref:`RID` shape **)** const +- :ref:`Variant` **shape_get_data** **(** :ref:`RID` shape **)** const Returns the shape data. .. _class_PhysicsServer_shape_get_type: -- :ref:`int` **shape_get_type** **(** :ref:`RID` shape **)** const +- :ref:`int` **shape_get_type** **(** :ref:`RID` shape **)** const Returns the type of shape (see SHAPE\_\* constants). .. _class_PhysicsServer_shape_set_data: -- void **shape_set_data** **(** :ref:`RID` shape, :ref:`Variant` data **)** +- void **shape_set_data** **(** :ref:`RID` shape, :ref:`Variant` data **)** Sets the shape data that defines its shape and size. The data to be passed depends on the kind of shape created :ref:`shape_get_type`. .. _class_PhysicsServer_slider_joint_get_param: -- :ref:`float` **slider_joint_get_param** **(** :ref:`RID` joint, :ref:`int` param **)** const +- :ref:`float` **slider_joint_get_param** **(** :ref:`RID` joint, :ref:`int` param **)** const Gets a slider_joint parameter (see SLIDER_JOINT\* constants). .. _class_PhysicsServer_slider_joint_set_param: -- void **slider_joint_set_param** **(** :ref:`RID` joint, :ref:`int` param, :ref:`float` value **)** +- void **slider_joint_set_param** **(** :ref:`RID` joint, :ref:`int` param, :ref:`float` value **)** Gets a slider_joint parameter (see SLIDER_JOINT\* constants). .. _class_PhysicsServer_space_create: -- :ref:`RID` **space_create** **(** **)** +- :ref:`RID` **space_create** **(** **)** Creates a space. A space is a collection of parameters for the physics engine that can be assigned to an area or a body. It can be assigned to an area with :ref:`area_set_space`, or to a body with :ref:`body_set_space`. .. _class_PhysicsServer_space_get_direct_state: -- :ref:`PhysicsDirectSpaceState` **space_get_direct_state** **(** :ref:`RID` space **)** +- :ref:`PhysicsDirectSpaceState` **space_get_direct_state** **(** :ref:`RID` space **)** Returns the state of a space, a :ref:`PhysicsDirectSpaceState`. This object can be used to make collision/intersection queries. .. _class_PhysicsServer_space_get_param: -- :ref:`float` **space_get_param** **(** :ref:`RID` space, :ref:`int` param **)** const +- :ref:`float` **space_get_param** **(** :ref:`RID` space, :ref:`int` param **)** const Returns the value of a space parameter. .. _class_PhysicsServer_space_is_active: -- :ref:`bool` **space_is_active** **(** :ref:`RID` space **)** const +- :ref:`bool` **space_is_active** **(** :ref:`RID` space **)** const Returns whether the space is active. .. _class_PhysicsServer_space_set_active: -- void **space_set_active** **(** :ref:`RID` space, :ref:`bool` active **)** +- void **space_set_active** **(** :ref:`RID` space, :ref:`bool` active **)** Marks a space as active. It will not have an effect, unless it is assigned to an area or body. .. _class_PhysicsServer_space_set_param: -- void **space_set_param** **(** :ref:`RID` space, :ref:`int` param, :ref:`float` value **)** +- void **space_set_param** **(** :ref:`RID` space, :ref:`int` param, :ref:`float` value **)** Sets the value for a space parameter. A list of available parameters is on the SPACE_PARAM\_\* constants. diff --git a/classes/class_physicsshapequeryparameters.rst b/classes/class_physicsshapequeryparameters.rst index 7ccaf615a..46653e41c 100644 --- a/classes/class_physicsshapequeryparameters.rst +++ b/classes/class_physicsshapequeryparameters.rst @@ -19,87 +19,87 @@ Brief Description Member Functions ---------------- -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_layer` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_exclude` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_margin` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_object_type_mask` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_shape_rid` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_transform` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_layer` **(** :ref:`int` collision_layer **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_exclude` **(** :ref:`Array` exclude **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_margin` **(** :ref:`float` margin **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_object_type_mask` **(** :ref:`int` object_type_mask **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shape` **(** :ref:`Resource` shape **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shape_rid` **(** :ref:`RID` shape **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_transform` **(** :ref:`Transform` transform **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_layer` **(** **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_exclude` **(** **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_margin` **(** **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_object_type_mask` **(** **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_shape_rid` **(** **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`get_transform` **(** **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_layer` **(** :ref:`int` collision_layer **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_exclude` **(** :ref:`Array` exclude **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_margin` **(** :ref:`float` margin **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_object_type_mask` **(** :ref:`int` object_type_mask **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shape` **(** :ref:`Resource` shape **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shape_rid` **(** :ref:`RID` shape **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_transform` **(** :ref:`Transform` transform **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ Member Function Description --------------------------- .. _class_PhysicsShapeQueryParameters_get_collision_layer: -- :ref:`int` **get_collision_layer** **(** **)** const +- :ref:`int` **get_collision_layer** **(** **)** const .. _class_PhysicsShapeQueryParameters_get_exclude: -- :ref:`Array` **get_exclude** **(** **)** const +- :ref:`Array` **get_exclude** **(** **)** const .. _class_PhysicsShapeQueryParameters_get_margin: -- :ref:`float` **get_margin** **(** **)** const +- :ref:`float` **get_margin** **(** **)** const .. _class_PhysicsShapeQueryParameters_get_object_type_mask: -- :ref:`int` **get_object_type_mask** **(** **)** const +- :ref:`int` **get_object_type_mask** **(** **)** const .. _class_PhysicsShapeQueryParameters_get_shape_rid: -- :ref:`RID` **get_shape_rid** **(** **)** const +- :ref:`RID` **get_shape_rid** **(** **)** const .. _class_PhysicsShapeQueryParameters_get_transform: -- :ref:`Transform` **get_transform** **(** **)** const +- :ref:`Transform` **get_transform** **(** **)** const .. _class_PhysicsShapeQueryParameters_set_collision_layer: -- void **set_collision_layer** **(** :ref:`int` collision_layer **)** +- void **set_collision_layer** **(** :ref:`int` collision_layer **)** .. _class_PhysicsShapeQueryParameters_set_exclude: -- void **set_exclude** **(** :ref:`Array` exclude **)** +- void **set_exclude** **(** :ref:`Array` exclude **)** .. _class_PhysicsShapeQueryParameters_set_margin: -- void **set_margin** **(** :ref:`float` margin **)** +- void **set_margin** **(** :ref:`float` margin **)** .. _class_PhysicsShapeQueryParameters_set_object_type_mask: -- void **set_object_type_mask** **(** :ref:`int` object_type_mask **)** +- void **set_object_type_mask** **(** :ref:`int` object_type_mask **)** .. _class_PhysicsShapeQueryParameters_set_shape: -- void **set_shape** **(** :ref:`Resource` shape **)** +- void **set_shape** **(** :ref:`Resource` shape **)** .. _class_PhysicsShapeQueryParameters_set_shape_rid: -- void **set_shape_rid** **(** :ref:`RID` shape **)** +- void **set_shape_rid** **(** :ref:`RID` shape **)** .. _class_PhysicsShapeQueryParameters_set_transform: -- void **set_transform** **(** :ref:`Transform` transform **)** +- void **set_transform** **(** :ref:`Transform` transform **)** diff --git a/classes/class_physicsshapequeryresult.rst b/classes/class_physicsshapequeryresult.rst index 7d22c392e..55b81972f 100644 --- a/classes/class_physicsshapequeryresult.rst +++ b/classes/class_physicsshapequeryresult.rst @@ -19,39 +19,39 @@ Result of a shape query in Physics2DServer. Member Functions ---------------- -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_result_count` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_result_object` **(** :ref:`int` idx **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_result_object_id` **(** :ref:`int` idx **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_result_object_shape` **(** :ref:`int` idx **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_result_rid` **(** :ref:`int` idx **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_result_count` **(** **)** const | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_result_object` **(** :ref:`int` idx **)** const | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_result_object_id` **(** :ref:`int` idx **)** const | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_result_object_shape` **(** :ref:`int` idx **)** const | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_result_rid` **(** :ref:`int` idx **)** const | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ Member Function Description --------------------------- .. _class_PhysicsShapeQueryResult_get_result_count: -- :ref:`int` **get_result_count** **(** **)** const +- :ref:`int` **get_result_count** **(** **)** const .. _class_PhysicsShapeQueryResult_get_result_object: -- :ref:`Object` **get_result_object** **(** :ref:`int` idx **)** const +- :ref:`Object` **get_result_object** **(** :ref:`int` idx **)** const .. _class_PhysicsShapeQueryResult_get_result_object_id: -- :ref:`int` **get_result_object_id** **(** :ref:`int` idx **)** const +- :ref:`int` **get_result_object_id** **(** :ref:`int` idx **)** const .. _class_PhysicsShapeQueryResult_get_result_object_shape: -- :ref:`int` **get_result_object_shape** **(** :ref:`int` idx **)** const +- :ref:`int` **get_result_object_shape** **(** :ref:`int` idx **)** const .. _class_PhysicsShapeQueryResult_get_result_rid: -- :ref:`RID` **get_result_rid** **(** :ref:`int` idx **)** const +- :ref:`RID` **get_result_rid** **(** :ref:`int` idx **)** const diff --git a/classes/class_pinjoint.rst b/classes/class_pinjoint.rst index 2c046ebed..305e9ce00 100644 --- a/classes/class_pinjoint.rst +++ b/classes/class_pinjoint.rst @@ -19,11 +19,11 @@ Pin Joint for 3D Shapes. Member Functions ---------------- -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_param` **(** :ref:`int` param **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_param` **(** :ref:`int` param, :ref:`float` value **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------+ ++----------------------------+---------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_param` **(** :ref:`int` param **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_param` **(** :ref:`int` param, :ref:`float` value **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -66,10 +66,10 @@ Member Function Description .. _class_PinJoint_get_param: -- :ref:`float` **get_param** **(** :ref:`int` param **)** const +- :ref:`float` **get_param** **(** :ref:`int` param **)** const .. _class_PinJoint_set_param: -- void **set_param** **(** :ref:`int` param, :ref:`float` value **)** +- void **set_param** **(** :ref:`int` param, :ref:`float` value **)** diff --git a/classes/class_pinjoint2d.rst b/classes/class_pinjoint2d.rst index df218dade..a48a8b351 100644 --- a/classes/class_pinjoint2d.rst +++ b/classes/class_pinjoint2d.rst @@ -19,11 +19,11 @@ Pin Joint for 2D Shapes. Member Functions ---------------- -+----------------------------+-----------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_softness` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------+ -| void | :ref:`set_softness` **(** :ref:`float` softness **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------+ ++----------------------------+---------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_softness` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------+ +| void | :ref:`set_softness` **(** :ref:`float` softness **)** | ++----------------------------+---------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -43,10 +43,10 @@ Member Function Description .. _class_PinJoint2D_get_softness: -- :ref:`float` **get_softness** **(** **)** const +- :ref:`float` **get_softness** **(** **)** const .. _class_PinJoint2D_set_softness: -- void **set_softness** **(** :ref:`float` softness **)** +- void **set_softness** **(** :ref:`float` softness **)** diff --git a/classes/class_plane.rst b/classes/class_plane.rst index f595b2088..7c2c6e0be 100644 --- a/classes/class_plane.rst +++ b/classes/class_plane.rst @@ -17,33 +17,33 @@ Plane in hessian form. Member Functions ---------------- -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Plane` | :ref:`Plane` **(** :ref:`float` a, :ref:`float` b, :ref:`float` c, :ref:`float` d **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Plane` | :ref:`Plane` **(** :ref:`Vector3` v1, :ref:`Vector3` v2, :ref:`Vector3` v3 **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Plane` | :ref:`Plane` **(** :ref:`Vector3` normal, :ref:`float` d **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`center` **(** **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`distance_to` **(** :ref:`Vector3` point **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_any_point` **(** **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_point` **(** :ref:`Vector3` point, :ref:`float` epsilon=0.00001 **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`intersect_3` **(** :ref:`Plane` b, :ref:`Plane` c **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`intersects_ray` **(** :ref:`Vector3` from, :ref:`Vector3` dir **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`intersects_segment` **(** :ref:`Vector3` begin, :ref:`Vector3` end **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_point_over` **(** :ref:`Vector3` point **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Plane` | :ref:`normalized` **(** **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`project` **(** :ref:`Vector3` point **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Plane` | :ref:`Plane` **(** :ref:`float` a, :ref:`float` b, :ref:`float` c, :ref:`float` d **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Plane` | :ref:`Plane` **(** :ref:`Vector3` v1, :ref:`Vector3` v2, :ref:`Vector3` v3 **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Plane` | :ref:`Plane` **(** :ref:`Vector3` normal, :ref:`float` d **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`center` **(** **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`distance_to` **(** :ref:`Vector3` point **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_any_point` **(** **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_point` **(** :ref:`Vector3` point, :ref:`float` epsilon=0.00001 **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`intersect_3` **(** :ref:`Plane` b, :ref:`Plane` c **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`intersects_ray` **(** :ref:`Vector3` from, :ref:`Vector3` dir **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`intersects_segment` **(** :ref:`Vector3` begin, :ref:`Vector3` end **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_point_over` **(** :ref:`Vector3` point **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Plane` | :ref:`normalized` **(** **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`project` **(** :ref:`Vector3` point **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -79,79 +79,79 @@ Member Function Description .. _class_Plane_Plane: -- :ref:`Plane` **Plane** **(** :ref:`float` a, :ref:`float` b, :ref:`float` c, :ref:`float` d **)** +- :ref:`Plane` **Plane** **(** :ref:`float` a, :ref:`float` b, :ref:`float` c, :ref:`float` d **)** Creates a plane from the three parameters "a", "b", "c" and "d". .. _class_Plane_Plane: -- :ref:`Plane` **Plane** **(** :ref:`Vector3` v1, :ref:`Vector3` v2, :ref:`Vector3` v3 **)** +- :ref:`Plane` **Plane** **(** :ref:`Vector3` v1, :ref:`Vector3` v2, :ref:`Vector3` v3 **)** Creates a plane from three points. .. _class_Plane_Plane: -- :ref:`Plane` **Plane** **(** :ref:`Vector3` normal, :ref:`float` d **)** +- :ref:`Plane` **Plane** **(** :ref:`Vector3` normal, :ref:`float` d **)** Creates a plane from the normal and the plane's distance to the origin. .. _class_Plane_center: -- :ref:`Vector3` **center** **(** **)** +- :ref:`Vector3` **center** **(** **)** Returns the center of the plane. .. _class_Plane_distance_to: -- :ref:`float` **distance_to** **(** :ref:`Vector3` point **)** +- :ref:`float` **distance_to** **(** :ref:`Vector3` point **)** Returns the shortest distance from the plane to the position "point". .. _class_Plane_get_any_point: -- :ref:`Vector3` **get_any_point** **(** **)** +- :ref:`Vector3` **get_any_point** **(** **)** Returns a point on the plane. .. _class_Plane_has_point: -- :ref:`bool` **has_point** **(** :ref:`Vector3` point, :ref:`float` epsilon=0.00001 **)** +- :ref:`bool` **has_point** **(** :ref:`Vector3` point, :ref:`float` epsilon=0.00001 **)** Returns true if "point" is inside the plane (by a very minimum threshold). .. _class_Plane_intersect_3: -- :ref:`Vector3` **intersect_3** **(** :ref:`Plane` b, :ref:`Plane` c **)** +- :ref:`Vector3` **intersect_3** **(** :ref:`Plane` b, :ref:`Plane` c **)** Returns the intersection point of the three planes "b", "c" and this plane. If no intersection is found null is returned. .. _class_Plane_intersects_ray: -- :ref:`Vector3` **intersects_ray** **(** :ref:`Vector3` from, :ref:`Vector3` dir **)** +- :ref:`Vector3` **intersects_ray** **(** :ref:`Vector3` from, :ref:`Vector3` dir **)** Returns the intersection point of a ray consisting of the position "from" and the direction normal "dir" with this plane. If no intersection is found null is returned. .. _class_Plane_intersects_segment: -- :ref:`Vector3` **intersects_segment** **(** :ref:`Vector3` begin, :ref:`Vector3` end **)** +- :ref:`Vector3` **intersects_segment** **(** :ref:`Vector3` begin, :ref:`Vector3` end **)** Returns the intersection point of a segment from position "begin" to position "end" with this plane. If no intersection is found null is returned. .. _class_Plane_is_point_over: -- :ref:`bool` **is_point_over** **(** :ref:`Vector3` point **)** +- :ref:`bool` **is_point_over** **(** :ref:`Vector3` point **)** Returns true if "point" is located above the plane. .. _class_Plane_normalized: -- :ref:`Plane` **normalized** **(** **)** +- :ref:`Plane` **normalized** **(** **)** Returns a copy of the plane, normalized. .. _class_Plane_project: -- :ref:`Vector3` **project** **(** :ref:`Vector3` point **)** +- :ref:`Vector3` **project** **(** :ref:`Vector3` point **)** Returns the orthogonal projection of point "p" into a point in the plane. diff --git a/classes/class_planemesh.rst b/classes/class_planemesh.rst index 00172a460..134787cdf 100644 --- a/classes/class_planemesh.rst +++ b/classes/class_planemesh.rst @@ -19,19 +19,19 @@ Class representing a planar :ref:`PrimitiveMesh`. Member Functions ---------------- -+--------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_size` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_subdivide_depth` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_subdivide_width` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_size` **(** :ref:`Vector2` size **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_subdivide_depth` **(** :ref:`int` subdivide **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_subdivide_width` **(** :ref:`int` subdivide **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------+ ++--------------------------------+-------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_size` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_subdivide_depth` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_subdivide_width` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_size` **(** :ref:`Vector2` size **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_subdivide_depth` **(** :ref:`int` subdivide **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_subdivide_width` **(** :ref:`int` subdivide **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -59,26 +59,26 @@ Member Function Description .. _class_PlaneMesh_get_size: -- :ref:`Vector2` **get_size** **(** **)** const +- :ref:`Vector2` **get_size** **(** **)** const .. _class_PlaneMesh_get_subdivide_depth: -- :ref:`int` **get_subdivide_depth** **(** **)** const +- :ref:`int` **get_subdivide_depth** **(** **)** const .. _class_PlaneMesh_get_subdivide_width: -- :ref:`int` **get_subdivide_width** **(** **)** const +- :ref:`int` **get_subdivide_width** **(** **)** const .. _class_PlaneMesh_set_size: -- void **set_size** **(** :ref:`Vector2` size **)** +- void **set_size** **(** :ref:`Vector2` size **)** .. _class_PlaneMesh_set_subdivide_depth: -- void **set_subdivide_depth** **(** :ref:`int` subdivide **)** +- void **set_subdivide_depth** **(** :ref:`int` subdivide **)** .. _class_PlaneMesh_set_subdivide_width: -- void **set_subdivide_width** **(** :ref:`int` subdivide **)** +- void **set_subdivide_width** **(** :ref:`int` subdivide **)** diff --git a/classes/class_planeshape.rst b/classes/class_planeshape.rst index b58e1b286..ac4233c23 100644 --- a/classes/class_planeshape.rst +++ b/classes/class_planeshape.rst @@ -19,11 +19,11 @@ Brief Description Member Functions ---------------- -+----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`Plane` | :ref:`get_plane` **(** **)** const | -+----------------------------+--------------------------------------------------------------------------------------------+ -| void | :ref:`set_plane` **(** :ref:`Plane` plane **)** | -+----------------------------+--------------------------------------------------------------------------------------------+ ++----------------------------+------------------------------------------------------------------------------------------+ +| :ref:`Plane` | :ref:`get_plane` **(** **)** const | ++----------------------------+------------------------------------------------------------------------------------------+ +| void | :ref:`set_plane` **(** :ref:`Plane` plane **)** | ++----------------------------+------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -38,10 +38,10 @@ Member Function Description .. _class_PlaneShape_get_plane: -- :ref:`Plane` **get_plane** **(** **)** const +- :ref:`Plane` **get_plane** **(** **)** const .. _class_PlaneShape_set_plane: -- void **set_plane** **(** :ref:`Plane` plane **)** +- void **set_plane** **(** :ref:`Plane` plane **)** diff --git a/classes/class_polygon2d.rst b/classes/class_polygon2d.rst index e01e5c180..f7a6c9c4c 100644 --- a/classes/class_polygon2d.rst +++ b/classes/class_polygon2d.rst @@ -19,55 +19,55 @@ A 2D polygon. Member Functions ---------------- -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_antialiased` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_color` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_invert` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_invert_border` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_offset` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_polygon` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_texture` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_texture_offset` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_texture_rotation` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_texture_scale` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_uv` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolColorArray` | :ref:`get_vertex_colors` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_antialiased` **(** :ref:`bool` antialiased **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_color` **(** :ref:`Color` color **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_invert` **(** :ref:`bool` invert **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_invert_border` **(** :ref:`float` invert_border **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_offset` **(** :ref:`Vector2` offset **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_polygon` **(** :ref:`PoolVector2Array` polygon **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture` **(** :ref:`Texture` texture **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture_offset` **(** :ref:`Vector2` texture_offset **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture_rotation` **(** :ref:`float` texture_rotation **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture_scale` **(** :ref:`Vector2` texture_scale **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_uv` **(** :ref:`PoolVector2Array` uv **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertex_colors` **(** :ref:`PoolColorArray` vertex_colors **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_antialiased` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_color` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_invert` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_invert_border` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_offset` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`get_polygon` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_texture` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_texture_offset` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_texture_rotation` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_texture_scale` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`get_uv` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolColorArray` | :ref:`get_vertex_colors` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_antialiased` **(** :ref:`bool` antialiased **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_color` **(** :ref:`Color` color **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_invert` **(** :ref:`bool` invert **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_invert_border` **(** :ref:`float` invert_border **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_offset` **(** :ref:`Vector2` offset **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_polygon` **(** :ref:`PoolVector2Array` polygon **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_texture` **(** :ref:`Texture` texture **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_texture_offset` **(** :ref:`Vector2` texture_offset **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_texture_rotation` **(** :ref:`float` texture_rotation **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_texture_scale` **(** :ref:`Vector2` texture_scale **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_uv` **(** :ref:`PoolVector2Array` uv **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vertex_colors` **(** :ref:`PoolColorArray` vertex_colors **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -131,139 +131,139 @@ Member Function Description .. _class_Polygon2D_get_antialiased: -- :ref:`bool` **get_antialiased** **(** **)** const +- :ref:`bool` **get_antialiased** **(** **)** const .. _class_Polygon2D_get_color: -- :ref:`Color` **get_color** **(** **)** const +- :ref:`Color` **get_color** **(** **)** const Return the polygon fill color. .. _class_Polygon2D_get_invert: -- :ref:`bool` **get_invert** **(** **)** const +- :ref:`bool` **get_invert** **(** **)** const Return whether this polygon is inverted or not. .. _class_Polygon2D_get_invert_border: -- :ref:`float` **get_invert_border** **(** **)** const +- :ref:`float` **get_invert_border** **(** **)** const Return the added padding around the bounding box. .. _class_Polygon2D_get_offset: -- :ref:`Vector2` **get_offset** **(** **)** const +- :ref:`Vector2` **get_offset** **(** **)** const Return the offset for the polygon vertices. .. _class_Polygon2D_get_polygon: -- :ref:`PoolVector2Array` **get_polygon** **(** **)** const +- :ref:`PoolVector2Array` **get_polygon** **(** **)** const Return the set of vertices that defines this polygon. .. _class_Polygon2D_get_texture: -- :ref:`Texture` **get_texture** **(** **)** const +- :ref:`Texture` **get_texture** **(** **)** const Return the polygon texture .. _class_Polygon2D_get_texture_offset: -- :ref:`Vector2` **get_texture_offset** **(** **)** const +- :ref:`Vector2` **get_texture_offset** **(** **)** const Return the polygon texture offset. .. _class_Polygon2D_get_texture_rotation: -- :ref:`float` **get_texture_rotation** **(** **)** const +- :ref:`float` **get_texture_rotation** **(** **)** const Return the rotation in radians of the texture polygon. .. _class_Polygon2D_get_texture_scale: -- :ref:`Vector2` **get_texture_scale** **(** **)** const +- :ref:`Vector2` **get_texture_scale** **(** **)** const Return the uv coordinate multiplier. .. _class_Polygon2D_get_uv: -- :ref:`PoolVector2Array` **get_uv** **(** **)** const +- :ref:`PoolVector2Array` **get_uv** **(** **)** const Return the texture coordinates associated with every vertex of the polygon. .. _class_Polygon2D_get_vertex_colors: -- :ref:`PoolColorArray` **get_vertex_colors** **(** **)** const +- :ref:`PoolColorArray` **get_vertex_colors** **(** **)** const Return the list of vertex colors. .. _class_Polygon2D_set_antialiased: -- void **set_antialiased** **(** :ref:`bool` antialiased **)** +- void **set_antialiased** **(** :ref:`bool` antialiased **)** .. _class_Polygon2D_set_color: -- void **set_color** **(** :ref:`Color` color **)** +- void **set_color** **(** :ref:`Color` color **)** Set the polygon fill color. If the polygon has a texture defined, the defined texture will be multiplied by the polygon fill color. This, also, is the default color for those vertices that are not defined by :ref:`get_vertex_colors`. .. _class_Polygon2D_set_invert: -- void **set_invert** **(** :ref:`bool` invert **)** +- void **set_invert** **(** :ref:`bool` invert **)** Set the polygon as the defined polygon bounding box minus the defined polygon (the defined polygon will appear as a hole on the square that contains the defined polygon). .. _class_Polygon2D_set_invert_border: -- void **set_invert_border** **(** :ref:`float` invert_border **)** +- void **set_invert_border** **(** :ref:`float` invert_border **)** Add extra padding around the bounding box, making it bigger. Too small a value can make the polygon triangulate strangely, due to numerical imprecision. .. _class_Polygon2D_set_offset: -- void **set_offset** **(** :ref:`Vector2` offset **)** +- void **set_offset** **(** :ref:`Vector2` offset **)** Set the an offset that will be added to the vertices' position. E.g. if the offset is set to (10,10) then all the polygon points will move 10 units to the right and 10 units to the bottom. .. _class_Polygon2D_set_polygon: -- void **set_polygon** **(** :ref:`PoolVector2Array` polygon **)** +- void **set_polygon** **(** :ref:`PoolVector2Array` polygon **)** Define the set of vertices that will represent the polygon. .. _class_Polygon2D_set_texture: -- void **set_texture** **(** :ref:`Texture` texture **)** +- void **set_texture** **(** :ref:`Texture` texture **)** .. _class_Polygon2D_set_texture_offset: -- void **set_texture_offset** **(** :ref:`Vector2` texture_offset **)** +- void **set_texture_offset** **(** :ref:`Vector2` texture_offset **)** Set the offset of the polygon texture. Initially the texture will appear anchored to the polygon position, the offset is used to move the texture location away from that point (notice that the texture origin is set to its top left corner, so when offset is 0,0 the top left corner of the texture is at the polygon position), for example setting the offset to 10, 10 will move the texture 10 units to the left and 10 units to the top. .. _class_Polygon2D_set_texture_rotation: -- void **set_texture_rotation** **(** :ref:`float` texture_rotation **)** +- void **set_texture_rotation** **(** :ref:`float` texture_rotation **)** Set the amount of rotation of the polygon texture, ``texture_rotation`` is specified in radians and clockwise rotation. .. _class_Polygon2D_set_texture_scale: -- void **set_texture_scale** **(** :ref:`Vector2` texture_scale **)** +- void **set_texture_scale** **(** :ref:`Vector2` texture_scale **)** Set the value that will multiply the uv coordinates (:ref:`get_uv`) when applying the texture. Larger values make the texture smaller, and vice versa. .. _class_Polygon2D_set_uv: -- void **set_uv** **(** :ref:`PoolVector2Array` uv **)** +- void **set_uv** **(** :ref:`PoolVector2Array` uv **)** Set the texture coordinates for every vertex of the polygon. There should be one uv vertex for every vertex in the polygon. If there are less, the undefined ones will be assumed to be (0,0). Extra uv vertices are ignored. .. _class_Polygon2D_set_vertex_colors: -- void **set_vertex_colors** **(** :ref:`PoolColorArray` vertex_colors **)** +- void **set_vertex_colors** **(** :ref:`PoolColorArray` vertex_colors **)** Set the color for each vertex of the polygon. There should be one color for every vertex in the polygon. If there are less, the undefined ones will be assumed to be :ref:`get_color`. Extra color entries are ignored. diff --git a/classes/class_polygonpathfinder.rst b/classes/class_polygonpathfinder.rst index 7000442b6..013a1b148 100644 --- a/classes/class_polygonpathfinder.rst +++ b/classes/class_polygonpathfinder.rst @@ -19,23 +19,23 @@ Brief Description Member Functions ---------------- -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`find_path` **(** :ref:`Vector2` from, :ref:`Vector2` to **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_bounds` **(** **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_closest_point` **(** :ref:`Vector2` point **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_intersections` **(** :ref:`Vector2` from, :ref:`Vector2` to **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_point_penalty` **(** :ref:`int` idx **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_point_inside` **(** :ref:`Vector2` point **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_penalty` **(** :ref:`int` idx, :ref:`float` penalty **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`setup` **(** :ref:`PoolVector2Array` points, :ref:`PoolIntArray` connections **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`find_path` **(** :ref:`Vector2` from, :ref:`Vector2` to **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_bounds` **(** **)** const | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_closest_point` **(** :ref:`Vector2` point **)** const | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`get_intersections` **(** :ref:`Vector2` from, :ref:`Vector2` to **)** const | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_point_penalty` **(** :ref:`int` idx **)** const | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_point_inside` **(** :ref:`Vector2` point **)** const | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_penalty` **(** :ref:`int` idx, :ref:`float` penalty **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`setup` **(** :ref:`PoolVector2Array` points, :ref:`PoolIntArray` connections **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -50,34 +50,34 @@ Member Function Description .. _class_PolygonPathFinder_find_path: -- :ref:`PoolVector2Array` **find_path** **(** :ref:`Vector2` from, :ref:`Vector2` to **)** +- :ref:`PoolVector2Array` **find_path** **(** :ref:`Vector2` from, :ref:`Vector2` to **)** .. _class_PolygonPathFinder_get_bounds: -- :ref:`Rect2` **get_bounds** **(** **)** const +- :ref:`Rect2` **get_bounds** **(** **)** const .. _class_PolygonPathFinder_get_closest_point: -- :ref:`Vector2` **get_closest_point** **(** :ref:`Vector2` point **)** const +- :ref:`Vector2` **get_closest_point** **(** :ref:`Vector2` point **)** const .. _class_PolygonPathFinder_get_intersections: -- :ref:`PoolVector2Array` **get_intersections** **(** :ref:`Vector2` from, :ref:`Vector2` to **)** const +- :ref:`PoolVector2Array` **get_intersections** **(** :ref:`Vector2` from, :ref:`Vector2` to **)** const .. _class_PolygonPathFinder_get_point_penalty: -- :ref:`float` **get_point_penalty** **(** :ref:`int` idx **)** const +- :ref:`float` **get_point_penalty** **(** :ref:`int` idx **)** const .. _class_PolygonPathFinder_is_point_inside: -- :ref:`bool` **is_point_inside** **(** :ref:`Vector2` point **)** const +- :ref:`bool` **is_point_inside** **(** :ref:`Vector2` point **)** const .. _class_PolygonPathFinder_set_point_penalty: -- void **set_point_penalty** **(** :ref:`int` idx, :ref:`float` penalty **)** +- void **set_point_penalty** **(** :ref:`int` idx, :ref:`float` penalty **)** .. _class_PolygonPathFinder_setup: -- void **setup** **(** :ref:`PoolVector2Array` points, :ref:`PoolIntArray` connections **)** +- void **setup** **(** :ref:`PoolVector2Array` points, :ref:`PoolIntArray` connections **)** diff --git a/classes/class_poolbytearray.rst b/classes/class_poolbytearray.rst index b14b826fb..7294c0887 100644 --- a/classes/class_poolbytearray.rst +++ b/classes/class_poolbytearray.rst @@ -17,37 +17,37 @@ Raw byte array. Member Functions ---------------- -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`PoolByteArray` **(** :ref:`Array` from **)** | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append` **(** :ref:`int` byte **)** | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append_array` **(** :ref:`PoolByteArray` array **)** | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`compress` **(** :ref:`int` compression_mode=0 **)** | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`decompress` **(** :ref:`int` buffer_size, :ref:`int` compression_mode=0 **)** | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_string_from_ascii` **(** **)** | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_string_from_utf8` **(** **)** | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`int` byte **)** | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`invert` **(** **)** | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_back` **(** :ref:`int` byte **)** | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove` **(** :ref:`int` idx **)** | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resize` **(** :ref:`int` idx **)** | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set` **(** :ref:`int` idx, :ref:`int` byte **)** | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` **(** **)** | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`subarray` **(** :ref:`int` from, :ref:`int` to **)** | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`PoolByteArray` **(** :ref:`Array` from **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append` **(** :ref:`int` byte **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append_array` **(** :ref:`PoolByteArray` array **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`compress` **(** :ref:`int` compression_mode=0 **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`decompress` **(** :ref:`int` buffer_size, :ref:`int` compression_mode=0 **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_string_from_ascii` **(** **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_string_from_utf8` **(** **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`int` byte **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`invert` **(** **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_back` **(** :ref:`int` byte **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove` **(** :ref:`int` idx **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resize` **(** :ref:`int` idx **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set` **(** :ref:`int` idx, :ref:`int` byte **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` **(** **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`subarray` **(** :ref:`int` from, :ref:`int` to **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -59,91 +59,91 @@ Member Function Description .. _class_PoolByteArray_PoolByteArray: -- :ref:`PoolByteArray` **PoolByteArray** **(** :ref:`Array` from **)** +- :ref:`PoolByteArray` **PoolByteArray** **(** :ref:`Array` from **)** Create from a generic array. .. _class_PoolByteArray_append: -- void **append** **(** :ref:`int` byte **)** +- void **append** **(** :ref:`int` byte **)** Append an element at the end of the array (alias of :ref:`push_back`). .. _class_PoolByteArray_append_array: -- void **append_array** **(** :ref:`PoolByteArray` array **)** +- void **append_array** **(** :ref:`PoolByteArray` array **)** Append a :ref:`PoolByteArray` at the end of this array. .. _class_PoolByteArray_compress: -- :ref:`PoolByteArray` **compress** **(** :ref:`int` compression_mode=0 **)** +- :ref:`PoolByteArray` **compress** **(** :ref:`int` compression_mode=0 **)** Returns a new :ref:`PoolByteArray` with the data compressed. Set the compression mode using one of :ref:`File`'s COMPRESS\_\* constants. .. _class_PoolByteArray_decompress: -- :ref:`PoolByteArray` **decompress** **(** :ref:`int` buffer_size, :ref:`int` compression_mode=0 **)** +- :ref:`PoolByteArray` **decompress** **(** :ref:`int` buffer_size, :ref:`int` compression_mode=0 **)** Returns a new :ref:`PoolByteArray` with the data decompressed. Set buffer_size to the size of the uncompressed data. Set the compression mode using one of :ref:`File`'s COMPRESS\_\* constants. .. _class_PoolByteArray_get_string_from_ascii: -- :ref:`String` **get_string_from_ascii** **(** **)** +- :ref:`String` **get_string_from_ascii** **(** **)** Returns a copy of the array's contents as :ref:`String`. Fast alternative to :ref:`PoolByteArray.get_string_from_utf8` if the content is ASCII-only. Unlike the UTF-8 function this function maps every byte to a character in the array. Multibyte sequences will not be interpreted correctly. For parsing user input always use :ref:`PoolByteArray.get_string_from_utf8`. .. _class_PoolByteArray_get_string_from_utf8: -- :ref:`String` **get_string_from_utf8** **(** **)** +- :ref:`String` **get_string_from_utf8** **(** **)** Returns a copy of the array's contents as :ref:`String`. Slower than :ref:`PoolByteArray.get_string_from_ascii` but supports UTF-8 encoded data. Use this function if you are unsure about the source of the data. For user input this function should always be preferred. .. _class_PoolByteArray_insert: -- :ref:`int` **insert** **(** :ref:`int` idx, :ref:`int` byte **)** +- :ref:`int` **insert** **(** :ref:`int` idx, :ref:`int` byte **)** Insert a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()). .. _class_PoolByteArray_invert: -- void **invert** **(** **)** +- void **invert** **(** **)** Reverse the order of the elements in the array (so first element will now be the last). .. _class_PoolByteArray_push_back: -- void **push_back** **(** :ref:`int` byte **)** +- void **push_back** **(** :ref:`int` byte **)** Append an element at the end of the array. .. _class_PoolByteArray_remove: -- void **remove** **(** :ref:`int` idx **)** +- void **remove** **(** :ref:`int` idx **)** Remove an element from the array by index. .. _class_PoolByteArray_resize: -- void **resize** **(** :ref:`int` idx **)** +- void **resize** **(** :ref:`int` idx **)** Set the size of the array. If the array is grown reserve elements at the end of the array. If the array is shrunk truncate the array to the new size. .. _class_PoolByteArray_set: -- void **set** **(** :ref:`int` idx, :ref:`int` byte **)** +- void **set** **(** :ref:`int` idx, :ref:`int` byte **)** Change the byte at the given index. .. _class_PoolByteArray_size: -- :ref:`int` **size** **(** **)** +- :ref:`int` **size** **(** **)** Return the size of the array. .. _class_PoolByteArray_subarray: -- :ref:`PoolByteArray` **subarray** **(** :ref:`int` from, :ref:`int` to **)** +- :ref:`PoolByteArray` **subarray** **(** :ref:`int` from, :ref:`int` to **)** Returns the slice of the :ref:`PoolByteArray` between indices (inclusive) as a new :ref:`PoolByteArray`. Any negative index is considered to be from the end of the array. diff --git a/classes/class_poolcolorarray.rst b/classes/class_poolcolorarray.rst index 636855318..4f91e1d84 100644 --- a/classes/class_poolcolorarray.rst +++ b/classes/class_poolcolorarray.rst @@ -17,27 +17,27 @@ Array of Colors Member Functions ---------------- -+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolColorArray` | :ref:`PoolColorArray` **(** :ref:`Array` from **)** | -+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append` **(** :ref:`Color` color **)** | -+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append_array` **(** :ref:`PoolColorArray` array **)** | -+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`Color` color **)** | -+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`invert` **(** **)** | -+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_back` **(** :ref:`Color` color **)** | -+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove` **(** :ref:`int` idx **)** | -+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resize` **(** :ref:`int` idx **)** | -+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set` **(** :ref:`int` idx, :ref:`Color` color **)** | -+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` **(** **)** | -+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolColorArray` | :ref:`PoolColorArray` **(** :ref:`Array` from **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append` **(** :ref:`Color` color **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append_array` **(** :ref:`PoolColorArray` array **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`Color` color **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`invert` **(** **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_back` **(** :ref:`Color` color **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove` **(** :ref:`int` idx **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resize` **(** :ref:`int` idx **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set` **(** :ref:`int` idx, :ref:`Color` color **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` **(** **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -49,61 +49,61 @@ Member Function Description .. _class_PoolColorArray_PoolColorArray: -- :ref:`PoolColorArray` **PoolColorArray** **(** :ref:`Array` from **)** +- :ref:`PoolColorArray` **PoolColorArray** **(** :ref:`Array` from **)** Create from a generic array. .. _class_PoolColorArray_append: -- void **append** **(** :ref:`Color` color **)** +- void **append** **(** :ref:`Color` color **)** Append an element at the end of the array (alias of :ref:`push_back`). .. _class_PoolColorArray_append_array: -- void **append_array** **(** :ref:`PoolColorArray` array **)** +- void **append_array** **(** :ref:`PoolColorArray` array **)** Append a :ref:`PoolColorArray` at the end of this array. .. _class_PoolColorArray_insert: -- :ref:`int` **insert** **(** :ref:`int` idx, :ref:`Color` color **)** +- :ref:`int` **insert** **(** :ref:`int` idx, :ref:`Color` color **)** Insert a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()). .. _class_PoolColorArray_invert: -- void **invert** **(** **)** +- void **invert** **(** **)** Reverse the order of the elements in the array (so first element will now be the last). .. _class_PoolColorArray_push_back: -- void **push_back** **(** :ref:`Color` color **)** +- void **push_back** **(** :ref:`Color` color **)** Append a value to the array. .. _class_PoolColorArray_remove: -- void **remove** **(** :ref:`int` idx **)** +- void **remove** **(** :ref:`int` idx **)** Remove an element from the array by index. .. _class_PoolColorArray_resize: -- void **resize** **(** :ref:`int` idx **)** +- void **resize** **(** :ref:`int` idx **)** Set the size of the array. If the array is grown reserve elements at the end of the array. If the array is shrunk truncate the array to the new size. .. _class_PoolColorArray_set: -- void **set** **(** :ref:`int` idx, :ref:`Color` color **)** +- void **set** **(** :ref:`int` idx, :ref:`Color` color **)** Change the :ref:`Color` at the given index. .. _class_PoolColorArray_size: -- :ref:`int` **size** **(** **)** +- :ref:`int` **size** **(** **)** Return the size of the array. diff --git a/classes/class_poolintarray.rst b/classes/class_poolintarray.rst index 5b9f7caec..2ee6477a5 100644 --- a/classes/class_poolintarray.rst +++ b/classes/class_poolintarray.rst @@ -17,27 +17,27 @@ Integer Array. Member Functions ---------------- -+------------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`PoolIntArray` **(** :ref:`Array` from **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append` **(** :ref:`int` integer **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append_array` **(** :ref:`PoolIntArray` array **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`int` integer **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`invert` **(** **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_back` **(** :ref:`int` integer **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove` **(** :ref:`int` idx **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resize` **(** :ref:`int` idx **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set` **(** :ref:`int` idx, :ref:`int` integer **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` **(** **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`PoolIntArray` **(** :ref:`Array` from **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append` **(** :ref:`int` integer **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append_array` **(** :ref:`PoolIntArray` array **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`int` integer **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`invert` **(** **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_back` **(** :ref:`int` integer **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove` **(** :ref:`int` idx **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resize` **(** :ref:`int` idx **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set` **(** :ref:`int` idx, :ref:`int` integer **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` **(** **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -49,61 +49,61 @@ Member Function Description .. _class_PoolIntArray_PoolIntArray: -- :ref:`PoolIntArray` **PoolIntArray** **(** :ref:`Array` from **)** +- :ref:`PoolIntArray` **PoolIntArray** **(** :ref:`Array` from **)** Create from a generic array. .. _class_PoolIntArray_append: -- void **append** **(** :ref:`int` integer **)** +- void **append** **(** :ref:`int` integer **)** Append an element at the end of the array (alias of :ref:`push_back`). .. _class_PoolIntArray_append_array: -- void **append_array** **(** :ref:`PoolIntArray` array **)** +- void **append_array** **(** :ref:`PoolIntArray` array **)** Append an :ref:`PoolIntArray` at the end of this array. .. _class_PoolIntArray_insert: -- :ref:`int` **insert** **(** :ref:`int` idx, :ref:`int` integer **)** +- :ref:`int` **insert** **(** :ref:`int` idx, :ref:`int` integer **)** Insert a new int at a given position in the array. The position must be valid, or at the end of the array (pos==size()). .. _class_PoolIntArray_invert: -- void **invert** **(** **)** +- void **invert** **(** **)** Reverse the order of the elements in the array (so first element will now be the last). .. _class_PoolIntArray_push_back: -- void **push_back** **(** :ref:`int` integer **)** +- void **push_back** **(** :ref:`int` integer **)** Append a value to the array. .. _class_PoolIntArray_remove: -- void **remove** **(** :ref:`int` idx **)** +- void **remove** **(** :ref:`int` idx **)** Remove an element from the array by index. .. _class_PoolIntArray_resize: -- void **resize** **(** :ref:`int` idx **)** +- void **resize** **(** :ref:`int` idx **)** Set the size of the array. If the array is grown reserve elements at the end of the array. If the array is shrunk truncate the array to the new size. .. _class_PoolIntArray_set: -- void **set** **(** :ref:`int` idx, :ref:`int` integer **)** +- void **set** **(** :ref:`int` idx, :ref:`int` integer **)** Change the int at the given index. .. _class_PoolIntArray_size: -- :ref:`int` **size** **(** **)** +- :ref:`int` **size** **(** **)** Return the array size. diff --git a/classes/class_poolrealarray.rst b/classes/class_poolrealarray.rst index 4991e1f75..dad7adb95 100644 --- a/classes/class_poolrealarray.rst +++ b/classes/class_poolrealarray.rst @@ -17,27 +17,27 @@ Real Array. Member Functions ---------------- -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolRealArray` | :ref:`PoolRealArray` **(** :ref:`Array` from **)** | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append` **(** :ref:`float` value **)** | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append_array` **(** :ref:`PoolRealArray` array **)** | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`float` value **)** | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`invert` **(** **)** | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_back` **(** :ref:`float` value **)** | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove` **(** :ref:`int` idx **)** | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resize` **(** :ref:`int` idx **)** | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set` **(** :ref:`int` idx, :ref:`float` value **)** | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` **(** **)** | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolRealArray` | :ref:`PoolRealArray` **(** :ref:`Array` from **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append` **(** :ref:`float` value **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append_array` **(** :ref:`PoolRealArray` array **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`float` value **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`invert` **(** **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_back` **(** :ref:`float` value **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove` **(** :ref:`int` idx **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resize` **(** :ref:`int` idx **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set` **(** :ref:`int` idx, :ref:`float` value **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` **(** **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -49,61 +49,61 @@ Member Function Description .. _class_PoolRealArray_PoolRealArray: -- :ref:`PoolRealArray` **PoolRealArray** **(** :ref:`Array` from **)** +- :ref:`PoolRealArray` **PoolRealArray** **(** :ref:`Array` from **)** Create from a generic array. .. _class_PoolRealArray_append: -- void **append** **(** :ref:`float` value **)** +- void **append** **(** :ref:`float` value **)** Append an element at the end of the array (alias of :ref:`push_back`). .. _class_PoolRealArray_append_array: -- void **append_array** **(** :ref:`PoolRealArray` array **)** +- void **append_array** **(** :ref:`PoolRealArray` array **)** Append an RealArray at the end of this array. .. _class_PoolRealArray_insert: -- :ref:`int` **insert** **(** :ref:`int` idx, :ref:`float` value **)** +- :ref:`int` **insert** **(** :ref:`int` idx, :ref:`float` value **)** Insert a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()). .. _class_PoolRealArray_invert: -- void **invert** **(** **)** +- void **invert** **(** **)** Reverse the order of the elements in the array (so first element will now be the last). .. _class_PoolRealArray_push_back: -- void **push_back** **(** :ref:`float` value **)** +- void **push_back** **(** :ref:`float` value **)** Append an element at the end of the array. .. _class_PoolRealArray_remove: -- void **remove** **(** :ref:`int` idx **)** +- void **remove** **(** :ref:`int` idx **)** Remove an element from the array by index. .. _class_PoolRealArray_resize: -- void **resize** **(** :ref:`int` idx **)** +- void **resize** **(** :ref:`int` idx **)** Set the size of the array. If the array is grown reserve elements at the end of the array. If the array is shrunk truncate the array to the new size. .. _class_PoolRealArray_set: -- void **set** **(** :ref:`int` idx, :ref:`float` value **)** +- void **set** **(** :ref:`int` idx, :ref:`float` value **)** Change the float at the given index. .. _class_PoolRealArray_size: -- :ref:`int` **size** **(** **)** +- :ref:`int` **size** **(** **)** Return the size of the array. diff --git a/classes/class_poolstringarray.rst b/classes/class_poolstringarray.rst index da5363893..495bbef95 100644 --- a/classes/class_poolstringarray.rst +++ b/classes/class_poolstringarray.rst @@ -17,29 +17,29 @@ String Array. Member Functions ---------------- -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`PoolStringArray` **(** :ref:`Array` from **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append` **(** :ref:`String` string **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append_array` **(** :ref:`PoolStringArray` array **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`String` string **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`invert` **(** **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`join` **(** :ref:`String` delimiter **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_back` **(** :ref:`String` string **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove` **(** :ref:`int` idx **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resize` **(** :ref:`int` idx **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set` **(** :ref:`int` idx, :ref:`String` string **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` **(** **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`PoolStringArray` **(** :ref:`Array` from **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append` **(** :ref:`String` string **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append_array` **(** :ref:`PoolStringArray` array **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`String` string **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`invert` **(** **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`join` **(** :ref:`String` delimiter **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_back` **(** :ref:`String` string **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove` **(** :ref:`int` idx **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resize` **(** :ref:`int` idx **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set` **(** :ref:`int` idx, :ref:`String` string **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` **(** **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -51,67 +51,67 @@ Member Function Description .. _class_PoolStringArray_PoolStringArray: -- :ref:`PoolStringArray` **PoolStringArray** **(** :ref:`Array` from **)** +- :ref:`PoolStringArray` **PoolStringArray** **(** :ref:`Array` from **)** Create from a generic array. .. _class_PoolStringArray_append: -- void **append** **(** :ref:`String` string **)** +- void **append** **(** :ref:`String` string **)** Append an element at the end of the array (alias of :ref:`push_back`). .. _class_PoolStringArray_append_array: -- void **append_array** **(** :ref:`PoolStringArray` array **)** +- void **append_array** **(** :ref:`PoolStringArray` array **)** Append an StringArray at the end of this array. .. _class_PoolStringArray_insert: -- :ref:`int` **insert** **(** :ref:`int` idx, :ref:`String` string **)** +- :ref:`int` **insert** **(** :ref:`int` idx, :ref:`String` string **)** Insert a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()). .. _class_PoolStringArray_invert: -- void **invert** **(** **)** +- void **invert** **(** **)** Reverse the order of the elements in the array (so first element will now be the last). .. _class_PoolStringArray_join: -- :ref:`String` **join** **(** :ref:`String` delimiter **)** +- :ref:`String` **join** **(** :ref:`String` delimiter **)** Returns a :ref:`String` with each element of the array joined with the delimiter. .. _class_PoolStringArray_push_back: -- void **push_back** **(** :ref:`String` string **)** +- void **push_back** **(** :ref:`String` string **)** Append a string element at end of the array. .. _class_PoolStringArray_remove: -- void **remove** **(** :ref:`int` idx **)** +- void **remove** **(** :ref:`int` idx **)** Remove an element from the array by index. .. _class_PoolStringArray_resize: -- void **resize** **(** :ref:`int` idx **)** +- void **resize** **(** :ref:`int` idx **)** Set the size of the array. If the array is grown reserve elements at the end of the array. If the array is shrunk truncate the array to the new size. .. _class_PoolStringArray_set: -- void **set** **(** :ref:`int` idx, :ref:`String` string **)** +- void **set** **(** :ref:`int` idx, :ref:`String` string **)** Change the :ref:`String` at the given index. .. _class_PoolStringArray_size: -- :ref:`int` **size** **(** **)** +- :ref:`int` **size** **(** **)** Return the size of the array. diff --git a/classes/class_poolvector2array.rst b/classes/class_poolvector2array.rst index 8158fb778..20c9fe0d2 100644 --- a/classes/class_poolvector2array.rst +++ b/classes/class_poolvector2array.rst @@ -17,27 +17,27 @@ An Array of Vector2. Member Functions ---------------- -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`PoolVector2Array` **(** :ref:`Array` from **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append` **(** :ref:`Vector2` vector2 **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append_array` **(** :ref:`PoolVector2Array` array **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`Vector2` vector2 **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`invert` **(** **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_back` **(** :ref:`Vector2` vector2 **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove` **(** :ref:`int` idx **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resize` **(** :ref:`int` idx **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set` **(** :ref:`int` idx, :ref:`Vector2` vector2 **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` **(** **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`PoolVector2Array` **(** :ref:`Array` from **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append` **(** :ref:`Vector2` vector2 **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append_array` **(** :ref:`PoolVector2Array` array **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`Vector2` vector2 **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`invert` **(** **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_back` **(** :ref:`Vector2` vector2 **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove` **(** :ref:`int` idx **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resize` **(** :ref:`int` idx **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set` **(** :ref:`int` idx, :ref:`Vector2` vector2 **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` **(** **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -49,61 +49,61 @@ Member Function Description .. _class_PoolVector2Array_PoolVector2Array: -- :ref:`PoolVector2Array` **PoolVector2Array** **(** :ref:`Array` from **)** +- :ref:`PoolVector2Array` **PoolVector2Array** **(** :ref:`Array` from **)** Construct a new :ref:`PoolVector2Array`. Optionally, you can pass in an Array that will be converted. .. _class_PoolVector2Array_append: -- void **append** **(** :ref:`Vector2` vector2 **)** +- void **append** **(** :ref:`Vector2` vector2 **)** Append an element at the end of the array (alias of :ref:`push_back`). .. _class_PoolVector2Array_append_array: -- void **append_array** **(** :ref:`PoolVector2Array` array **)** +- void **append_array** **(** :ref:`PoolVector2Array` array **)** Append an :ref:`PoolVector2Array` at the end of this array. .. _class_PoolVector2Array_insert: -- :ref:`int` **insert** **(** :ref:`int` idx, :ref:`Vector2` vector2 **)** +- :ref:`int` **insert** **(** :ref:`int` idx, :ref:`Vector2` vector2 **)** Insert a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()). .. _class_PoolVector2Array_invert: -- void **invert** **(** **)** +- void **invert** **(** **)** Reverse the order of the elements in the array (so first element will now be the last). .. _class_PoolVector2Array_push_back: -- void **push_back** **(** :ref:`Vector2` vector2 **)** +- void **push_back** **(** :ref:`Vector2` vector2 **)** Insert a :ref:`Vector2` at the end. .. _class_PoolVector2Array_remove: -- void **remove** **(** :ref:`int` idx **)** +- void **remove** **(** :ref:`int` idx **)** Remove an element from the array by index. .. _class_PoolVector2Array_resize: -- void **resize** **(** :ref:`int` idx **)** +- void **resize** **(** :ref:`int` idx **)** Set the size of the array. If the array is grown reserve elements at the end of the array. If the array is shrunk truncate the array to the new size. .. _class_PoolVector2Array_set: -- void **set** **(** :ref:`int` idx, :ref:`Vector2` vector2 **)** +- void **set** **(** :ref:`int` idx, :ref:`Vector2` vector2 **)** Change the :ref:`Vector2` at the given index. .. _class_PoolVector2Array_size: -- :ref:`int` **size** **(** **)** +- :ref:`int` **size** **(** **)** Return the size of the array. diff --git a/classes/class_poolvector3array.rst b/classes/class_poolvector3array.rst index 359577d33..b9e57e0dc 100644 --- a/classes/class_poolvector3array.rst +++ b/classes/class_poolvector3array.rst @@ -17,27 +17,27 @@ An Array of Vector3. Member Functions ---------------- -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`PoolVector3Array` **(** :ref:`Array` from **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append` **(** :ref:`Vector3` vector3 **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append_array` **(** :ref:`PoolVector3Array` array **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`Vector3` vector3 **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`invert` **(** **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_back` **(** :ref:`Vector3` vector3 **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove` **(** :ref:`int` idx **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resize` **(** :ref:`int` idx **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set` **(** :ref:`int` idx, :ref:`Vector3` vector3 **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` **(** **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`PoolVector3Array` **(** :ref:`Array` from **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append` **(** :ref:`Vector3` vector3 **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append_array` **(** :ref:`PoolVector3Array` array **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`Vector3` vector3 **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`invert` **(** **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_back` **(** :ref:`Vector3` vector3 **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove` **(** :ref:`int` idx **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resize` **(** :ref:`int` idx **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set` **(** :ref:`int` idx, :ref:`Vector3` vector3 **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` **(** **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -49,61 +49,61 @@ Member Function Description .. _class_PoolVector3Array_PoolVector3Array: -- :ref:`PoolVector3Array` **PoolVector3Array** **(** :ref:`Array` from **)** +- :ref:`PoolVector3Array` **PoolVector3Array** **(** :ref:`Array` from **)** Construct a new PoolVector3Array. Optionally, you can pass in an Array that will be converted. .. _class_PoolVector3Array_append: -- void **append** **(** :ref:`Vector3` vector3 **)** +- void **append** **(** :ref:`Vector3` vector3 **)** Append an element at the end of the array (alias of :ref:`push_back`). .. _class_PoolVector3Array_append_array: -- void **append_array** **(** :ref:`PoolVector3Array` array **)** +- void **append_array** **(** :ref:`PoolVector3Array` array **)** Append an :ref:`PoolVector3Array` at the end of this array. .. _class_PoolVector3Array_insert: -- :ref:`int` **insert** **(** :ref:`int` idx, :ref:`Vector3` vector3 **)** +- :ref:`int` **insert** **(** :ref:`int` idx, :ref:`Vector3` vector3 **)** Insert a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()). .. _class_PoolVector3Array_invert: -- void **invert** **(** **)** +- void **invert** **(** **)** Reverse the order of the elements in the array (so first element will now be the last). .. _class_PoolVector3Array_push_back: -- void **push_back** **(** :ref:`Vector3` vector3 **)** +- void **push_back** **(** :ref:`Vector3` vector3 **)** Insert a :ref:`Vector3` at the end. .. _class_PoolVector3Array_remove: -- void **remove** **(** :ref:`int` idx **)** +- void **remove** **(** :ref:`int` idx **)** Remove an element from the array by index. .. _class_PoolVector3Array_resize: -- void **resize** **(** :ref:`int` idx **)** +- void **resize** **(** :ref:`int` idx **)** Set the size of the array. If the array is grown reserve elements at the end of the array. If the array is shrunk truncate the array to the new size. .. _class_PoolVector3Array_set: -- void **set** **(** :ref:`int` idx, :ref:`Vector3` vector3 **)** +- void **set** **(** :ref:`int` idx, :ref:`Vector3` vector3 **)** Change the :ref:`Vector3` at the given index. .. _class_PoolVector3Array_size: -- :ref:`int` **size** **(** **)** +- :ref:`int` **size** **(** **)** Return the size of the array. diff --git a/classes/class_popup.rst b/classes/class_popup.rst index ad38997fa..72e37f240 100644 --- a/classes/class_popup.rst +++ b/classes/class_popup.rst @@ -21,32 +21,32 @@ Base container control for popups and dialogs. Member Functions ---------------- -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_exclusive` **(** **)** const | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`popup` **(** :ref:`Rect2` bounds=Rect2( 0, 0, 0, 0 ) **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`popup_centered` **(** :ref:`Vector2` size=Vector2( 0, 0 ) **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`popup_centered_minsize` **(** :ref:`Vector2` minsize=Vector2( 0, 0 ) **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`popup_centered_ratio` **(** :ref:`float` ratio=0.75 **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_exclusive` **(** :ref:`bool` enable **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_exclusive` **(** **)** const | ++--------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`popup` **(** :ref:`Rect2` bounds=Rect2( 0, 0, 0, 0 ) **)** | ++--------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`popup_centered` **(** :ref:`Vector2` size=Vector2( 0, 0 ) **)** | ++--------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`popup_centered_minsize` **(** :ref:`Vector2` minsize=Vector2( 0, 0 ) **)** | ++--------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`popup_centered_ratio` **(** :ref:`float` ratio=0.75 **)** | ++--------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_exclusive` **(** :ref:`bool` enable **)** | ++--------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_Popup_about_to_show: -- **about_to_show** **(** **)** +- **about_to_show** **(** **)** This signal is emitted when a popup is about to be shown. (often used in :ref:`PopupMenu` for clearing the list of options and creating a new one according to the current context). .. _class_Popup_popup_hide: -- **popup_hide** **(** **)** +- **popup_hide** **(** **)** This signal is emitted when a popup is hidden. @@ -75,37 +75,37 @@ Member Function Description .. _class_Popup_is_exclusive: -- :ref:`bool` **is_exclusive** **(** **)** const +- :ref:`bool` **is_exclusive** **(** **)** const Returns whether the popup will hide other popups when shown on the screen. .. _class_Popup_popup: -- void **popup** **(** :ref:`Rect2` bounds=Rect2( 0, 0, 0, 0 ) **)** +- void **popup** **(** :ref:`Rect2` bounds=Rect2( 0, 0, 0, 0 ) **)** Popup (show the control in modal form). .. _class_Popup_popup_centered: -- void **popup_centered** **(** :ref:`Vector2` size=Vector2( 0, 0 ) **)** +- void **popup_centered** **(** :ref:`Vector2` size=Vector2( 0, 0 ) **)** Popup (show the control in modal form) in the center of the screen, at the current size, or at a size determined by "size". .. _class_Popup_popup_centered_minsize: -- void **popup_centered_minsize** **(** :ref:`Vector2` minsize=Vector2( 0, 0 ) **)** +- void **popup_centered_minsize** **(** :ref:`Vector2` minsize=Vector2( 0, 0 ) **)** Popup (show the control in modal form) in the center of the screen, ensuring the size is never smaller than ``minsize``. .. _class_Popup_popup_centered_ratio: -- void **popup_centered_ratio** **(** :ref:`float` ratio=0.75 **)** +- void **popup_centered_ratio** **(** :ref:`float` ratio=0.75 **)** Popup (show the control in modal form) in the center of the screen, scaled at a ratio of size of the screen. .. _class_Popup_set_exclusive: -- void **set_exclusive** **(** :ref:`bool` enable **)** +- void **set_exclusive** **(** :ref:`bool` enable **)** Make the popup hide other popups when shown on the screen. diff --git a/classes/class_popupmenu.rst b/classes/class_popupmenu.rst index 915ccf124..5ca7f3b06 100644 --- a/classes/class_popupmenu.rst +++ b/classes/class_popupmenu.rst @@ -19,106 +19,106 @@ PopupMenu displays a list of options. Member Functions ---------------- -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_check_item` **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_check_shortcut` **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_icon_check_item` **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_icon_check_shortcut` **(** :ref:`Texture` texture, :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_icon_item` **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_icon_shortcut` **(** :ref:`Texture` texture, :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_item` **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_separator` **(** **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_shortcut` **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_submenu_item` **(** :ref:`String` label, :ref:`String` submenu, :ref:`int` id=-1 **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_accelerator` **(** :ref:`int` idx **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_count` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_item_icon` **(** :ref:`int` idx **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_id` **(** :ref:`int` idx **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_index` **(** :ref:`int` id **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_item_metadata` **(** :ref:`int` idx **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ShortCut` | :ref:`get_item_shortcut` **(** :ref:`int` idx **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_item_submenu` **(** :ref:`int` idx **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_item_text` **(** :ref:`int` idx **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_item_tooltip` **(** :ref:`int` idx **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_hide_on_checkable_item_selection` **(** **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_hide_on_item_selection` **(** **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_item_checkable` **(** :ref:`int` idx **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_item_checked` **(** :ref:`int` idx **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_item_disabled` **(** :ref:`int` idx **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_item_separator` **(** :ref:`int` idx **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_item` **(** :ref:`int` idx **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_hide_on_checkable_item_selection` **(** :ref:`bool` enable **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_hide_on_item_selection` **(** :ref:`bool` enable **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_accelerator` **(** :ref:`int` idx, :ref:`int` accel **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_as_checkable` **(** :ref:`int` idx, :ref:`bool` enable **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_as_separator` **(** :ref:`int` idx, :ref:`bool` enable **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_checked` **(** :ref:`int` idx, :ref:`bool` checked **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_disabled` **(** :ref:`int` idx, :ref:`bool` disabled **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_icon` **(** :ref:`int` idx, :ref:`Texture` icon **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_id` **(** :ref:`int` idx, :ref:`int` id **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_metadata` **(** :ref:`int` idx, :ref:`Variant` metadata **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_shortcut` **(** :ref:`int` idx, :ref:`ShortCut` shortcut, :ref:`bool` global=false **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_submenu` **(** :ref:`int` idx, :ref:`String` submenu **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_text` **(** :ref:`int` idx, :ref:`String` text **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_tooltip` **(** :ref:`int` idx, :ref:`String` tooltip **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`toggle_item_checked` **(** :ref:`int` idx **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_check_item` **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_check_shortcut` **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_icon_check_item` **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_icon_check_shortcut` **(** :ref:`Texture` texture, :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_icon_item` **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_icon_shortcut` **(** :ref:`Texture` texture, :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_item` **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_separator` **(** **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_shortcut` **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_submenu_item` **(** :ref:`String` label, :ref:`String` submenu, :ref:`int` id=-1 **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_item_accelerator` **(** :ref:`int` idx **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_item_count` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_item_icon` **(** :ref:`int` idx **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_item_id` **(** :ref:`int` idx **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_item_index` **(** :ref:`int` id **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_item_metadata` **(** :ref:`int` idx **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ShortCut` | :ref:`get_item_shortcut` **(** :ref:`int` idx **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_item_submenu` **(** :ref:`int` idx **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_item_text` **(** :ref:`int` idx **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_item_tooltip` **(** :ref:`int` idx **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_hide_on_checkable_item_selection` **(** **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_hide_on_item_selection` **(** **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_item_checkable` **(** :ref:`int` idx **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_item_checked` **(** :ref:`int` idx **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_item_disabled` **(** :ref:`int` idx **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_item_separator` **(** :ref:`int` idx **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_item` **(** :ref:`int` idx **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_hide_on_checkable_item_selection` **(** :ref:`bool` enable **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_hide_on_item_selection` **(** :ref:`bool` enable **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_accelerator` **(** :ref:`int` idx, :ref:`int` accel **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_as_checkable` **(** :ref:`int` idx, :ref:`bool` enable **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_as_separator` **(** :ref:`int` idx, :ref:`bool` enable **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_checked` **(** :ref:`int` idx, :ref:`bool` checked **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_disabled` **(** :ref:`int` idx, :ref:`bool` disabled **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_icon` **(** :ref:`int` idx, :ref:`Texture` icon **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_id` **(** :ref:`int` idx, :ref:`int` id **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_metadata` **(** :ref:`int` idx, :ref:`Variant` metadata **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_shortcut` **(** :ref:`int` idx, :ref:`ShortCut` shortcut, :ref:`bool` global=false **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_submenu` **(** :ref:`int` idx, :ref:`String` submenu **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_text` **(** :ref:`int` idx, :ref:`String` text **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_tooltip` **(** :ref:`int` idx, :ref:`String` tooltip **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`toggle_item_checked` **(** :ref:`int` idx **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_PopupMenu_id_pressed: -- **id_pressed** **(** :ref:`int` ID **)** +- **id_pressed** **(** :ref:`int` ID **)** This event is emitted when an item of some id is pressed or its accelerator is activated. .. _class_PopupMenu_index_pressed: -- **index_pressed** **(** :ref:`int` index **)** +- **index_pressed** **(** :ref:`int` index **)** This event is emitted when an item of some index is pressed or its accelerator is activated. @@ -149,17 +149,17 @@ Member Function Description .. _class_PopupMenu_add_check_item: -- void **add_check_item** **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** +- void **add_check_item** **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** Add a new checkable item with text "label". An id can optionally be provided, as well as an accelerator. If no id is provided, one will be created from the index. Note that checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. .. _class_PopupMenu_add_check_shortcut: -- void **add_check_shortcut** **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** +- void **add_check_shortcut** **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** .. _class_PopupMenu_add_icon_check_item: -- void **add_icon_check_item** **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** +- void **add_icon_check_item** **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** Add a new checkable item with text "label" and icon "texture". An id can optionally be provided, as well as an accelerator. If no id is provided, one will be @@ -167,224 +167,224 @@ created from the index. Note that checkable items just display a checkmark, but .. _class_PopupMenu_add_icon_check_shortcut: -- void **add_icon_check_shortcut** **(** :ref:`Texture` texture, :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** +- void **add_icon_check_shortcut** **(** :ref:`Texture` texture, :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** .. _class_PopupMenu_add_icon_item: -- void **add_icon_item** **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** +- void **add_icon_item** **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** Add a new item with text "label" and icon "texture". An id can optionally be provided, as well as an accelerator keybinding. If no id is provided, one will be created from the index. .. _class_PopupMenu_add_icon_shortcut: -- void **add_icon_shortcut** **(** :ref:`Texture` texture, :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** +- void **add_icon_shortcut** **(** :ref:`Texture` texture, :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** .. _class_PopupMenu_add_item: -- void **add_item** **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** +- void **add_item** **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** Add a new item with text "label". An id can optionally be provided, as well as an accelerator keybinding. If no id is provided, one will be created from the index. .. _class_PopupMenu_add_separator: -- void **add_separator** **(** **)** +- void **add_separator** **(** **)** Add a separator between items. Separators also occupy an index. .. _class_PopupMenu_add_shortcut: -- void **add_shortcut** **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** +- void **add_shortcut** **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** .. _class_PopupMenu_add_submenu_item: -- void **add_submenu_item** **(** :ref:`String` label, :ref:`String` submenu, :ref:`int` id=-1 **)** +- void **add_submenu_item** **(** :ref:`String` label, :ref:`String` submenu, :ref:`int` id=-1 **)** Adds an item with a submenu. The submenu is the name of a child PopupMenu node that would be shown when the item is clicked. An id can optionally be provided, but if is isn't provided, one will be created from the index. .. _class_PopupMenu_clear: -- void **clear** **(** **)** +- void **clear** **(** **)** Clear the popup menu, in effect removing all items. .. _class_PopupMenu_get_item_accelerator: -- :ref:`int` **get_item_accelerator** **(** :ref:`int` idx **)** const +- :ref:`int` **get_item_accelerator** **(** :ref:`int` idx **)** const Return the accelerator of the item at index "idx". Accelerators are special combinations of keys that activate the item, no matter which control is focused. .. _class_PopupMenu_get_item_count: -- :ref:`int` **get_item_count** **(** **)** const +- :ref:`int` **get_item_count** **(** **)** const Return the amount of items. .. _class_PopupMenu_get_item_icon: -- :ref:`Texture` **get_item_icon** **(** :ref:`int` idx **)** const +- :ref:`Texture` **get_item_icon** **(** :ref:`int` idx **)** const Return the icon of the item at index "idx". .. _class_PopupMenu_get_item_id: -- :ref:`int` **get_item_id** **(** :ref:`int` idx **)** const +- :ref:`int` **get_item_id** **(** :ref:`int` idx **)** const Return the id of the item at index "idx". .. _class_PopupMenu_get_item_index: -- :ref:`int` **get_item_index** **(** :ref:`int` id **)** const +- :ref:`int` **get_item_index** **(** :ref:`int` id **)** const Find and return the index of the item containing a given id. .. _class_PopupMenu_get_item_metadata: -- :ref:`Variant` **get_item_metadata** **(** :ref:`int` idx **)** const +- :ref:`Variant` **get_item_metadata** **(** :ref:`int` idx **)** const Return the metadata of an item, which might be of any type. You can set it with :ref:`set_item_metadata`, which provides a simple way of assigning context data to items. .. _class_PopupMenu_get_item_shortcut: -- :ref:`ShortCut` **get_item_shortcut** **(** :ref:`int` idx **)** const +- :ref:`ShortCut` **get_item_shortcut** **(** :ref:`int` idx **)** const .. _class_PopupMenu_get_item_submenu: -- :ref:`String` **get_item_submenu** **(** :ref:`int` idx **)** const +- :ref:`String` **get_item_submenu** **(** :ref:`int` idx **)** const Return the submenu name of the item at index "idx". .. _class_PopupMenu_get_item_text: -- :ref:`String` **get_item_text** **(** :ref:`int` idx **)** const +- :ref:`String` **get_item_text** **(** :ref:`int` idx **)** const Return the text of the item at index "idx". .. _class_PopupMenu_get_item_tooltip: -- :ref:`String` **get_item_tooltip** **(** :ref:`int` idx **)** const +- :ref:`String` **get_item_tooltip** **(** :ref:`int` idx **)** const .. _class_PopupMenu_is_hide_on_checkable_item_selection: -- :ref:`bool` **is_hide_on_checkable_item_selection** **(** **)** +- :ref:`bool` **is_hide_on_checkable_item_selection** **(** **)** Returns a boolean that indicates whether or not the PopupMenu will hide on checkable item selection. .. _class_PopupMenu_is_hide_on_item_selection: -- :ref:`bool` **is_hide_on_item_selection** **(** **)** +- :ref:`bool` **is_hide_on_item_selection** **(** **)** Returns a boolean that indicates whether or not the PopupMenu will hide on item selection. .. _class_PopupMenu_is_item_checkable: -- :ref:`bool` **is_item_checkable** **(** :ref:`int` idx **)** const +- :ref:`bool` **is_item_checkable** **(** :ref:`int` idx **)** const Return whether the item at index "idx" has a checkbox. Note that checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. .. _class_PopupMenu_is_item_checked: -- :ref:`bool` **is_item_checked** **(** :ref:`int` idx **)** const +- :ref:`bool` **is_item_checked** **(** :ref:`int` idx **)** const Return the checkstate status of the item at index "idx". .. _class_PopupMenu_is_item_disabled: -- :ref:`bool` **is_item_disabled** **(** :ref:`int` idx **)** const +- :ref:`bool` **is_item_disabled** **(** :ref:`int` idx **)** const Return whether the item at index "idx" is disabled. When it is disabled it can't be selected, or its action invoked. .. _class_PopupMenu_is_item_separator: -- :ref:`bool` **is_item_separator** **(** :ref:`int` idx **)** const +- :ref:`bool` **is_item_separator** **(** :ref:`int` idx **)** const Return whether the item is a seperator. If it is, it would be displayed as a line. .. _class_PopupMenu_remove_item: -- void **remove_item** **(** :ref:`int` idx **)** +- void **remove_item** **(** :ref:`int` idx **)** Removes the item at index "idx" from the menu. Note that the indexes of items after the removed item are going to be shifted by one. .. _class_PopupMenu_set_hide_on_checkable_item_selection: -- void **set_hide_on_checkable_item_selection** **(** :ref:`bool` enable **)** +- void **set_hide_on_checkable_item_selection** **(** :ref:`bool` enable **)** Sets whether or not the PopupMenu will hide on checkable item selection. .. _class_PopupMenu_set_hide_on_item_selection: -- void **set_hide_on_item_selection** **(** :ref:`bool` enable **)** +- void **set_hide_on_item_selection** **(** :ref:`bool` enable **)** Sets whether or not the PopupMenu will hide on item selection. .. _class_PopupMenu_set_item_accelerator: -- void **set_item_accelerator** **(** :ref:`int` idx, :ref:`int` accel **)** +- void **set_item_accelerator** **(** :ref:`int` idx, :ref:`int` accel **)** Set the accelerator of the item at index "idx". Accelerators are special combinations of keys that activate the item, no matter which control is focused. .. _class_PopupMenu_set_item_as_checkable: -- void **set_item_as_checkable** **(** :ref:`int` idx, :ref:`bool` enable **)** +- void **set_item_as_checkable** **(** :ref:`int` idx, :ref:`bool` enable **)** Set whether the item at index "idx" has a checkbox. Note that checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. .. _class_PopupMenu_set_item_as_separator: -- void **set_item_as_separator** **(** :ref:`int` idx, :ref:`bool` enable **)** +- void **set_item_as_separator** **(** :ref:`int` idx, :ref:`bool` enable **)** Mark the item at index "idx" as a seperator, which means that it would be displayed as a mere line. .. _class_PopupMenu_set_item_checked: -- void **set_item_checked** **(** :ref:`int` idx, :ref:`bool` checked **)** +- void **set_item_checked** **(** :ref:`int` idx, :ref:`bool` checked **)** Set the checkstate status of the item at index "idx". .. _class_PopupMenu_set_item_disabled: -- void **set_item_disabled** **(** :ref:`int` idx, :ref:`bool` disabled **)** +- void **set_item_disabled** **(** :ref:`int` idx, :ref:`bool` disabled **)** Sets whether the item at index "idx" is disabled or not. When it is disabled it can't be selected, or its action invoked. .. _class_PopupMenu_set_item_icon: -- void **set_item_icon** **(** :ref:`int` idx, :ref:`Texture` icon **)** +- void **set_item_icon** **(** :ref:`int` idx, :ref:`Texture` icon **)** .. _class_PopupMenu_set_item_id: -- void **set_item_id** **(** :ref:`int` idx, :ref:`int` id **)** +- void **set_item_id** **(** :ref:`int` idx, :ref:`int` id **)** Set the id of the item at index "idx". .. _class_PopupMenu_set_item_metadata: -- void **set_item_metadata** **(** :ref:`int` idx, :ref:`Variant` metadata **)** +- void **set_item_metadata** **(** :ref:`int` idx, :ref:`Variant` metadata **)** Sets the metadata of an item, which might be of any type. You can later get it with :ref:`get_item_metadata`, which provides a simple way of assigning context data to items. .. _class_PopupMenu_set_item_shortcut: -- void **set_item_shortcut** **(** :ref:`int` idx, :ref:`ShortCut` shortcut, :ref:`bool` global=false **)** +- void **set_item_shortcut** **(** :ref:`int` idx, :ref:`ShortCut` shortcut, :ref:`bool` global=false **)** .. _class_PopupMenu_set_item_submenu: -- void **set_item_submenu** **(** :ref:`int` idx, :ref:`String` submenu **)** +- void **set_item_submenu** **(** :ref:`int` idx, :ref:`String` submenu **)** Sets the submenu of the item at index "idx". The submenu is the name of a child PopupMenu node that would be shown when the item is clicked. .. _class_PopupMenu_set_item_text: -- void **set_item_text** **(** :ref:`int` idx, :ref:`String` text **)** +- void **set_item_text** **(** :ref:`int` idx, :ref:`String` text **)** Set the text of the item at index "idx". .. _class_PopupMenu_set_item_tooltip: -- void **set_item_tooltip** **(** :ref:`int` idx, :ref:`String` tooltip **)** +- void **set_item_tooltip** **(** :ref:`int` idx, :ref:`String` tooltip **)** .. _class_PopupMenu_toggle_item_checked: -- void **toggle_item_checked** **(** :ref:`int` idx **)** +- void **toggle_item_checked** **(** :ref:`int` idx **)** diff --git a/classes/class_primitivemesh.rst b/classes/class_primitivemesh.rst index 271abdaf8..2f3251b8f 100644 --- a/classes/class_primitivemesh.rst +++ b/classes/class_primitivemesh.rst @@ -21,13 +21,13 @@ Base class for all primitive meshes. Handles applying a :ref:`Material` | :ref:`get_material` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_mesh_arrays` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_material` **(** :ref:`Material` material **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------+ ++----------------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`Material` | :ref:`get_material` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_mesh_arrays` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_material` **(** :ref:`Material` material **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -47,14 +47,14 @@ Member Function Description .. _class_PrimitiveMesh_get_material: -- :ref:`Material` **get_material** **(** **)** const +- :ref:`Material` **get_material** **(** **)** const .. _class_PrimitiveMesh_get_mesh_arrays: -- :ref:`Array` **get_mesh_arrays** **(** **)** const +- :ref:`Array` **get_mesh_arrays** **(** **)** const .. _class_PrimitiveMesh_set_material: -- void **set_material** **(** :ref:`Material` material **)** +- void **set_material** **(** :ref:`Material` material **)** diff --git a/classes/class_prismmesh.rst b/classes/class_prismmesh.rst index 359dda432..46ce130b2 100644 --- a/classes/class_prismmesh.rst +++ b/classes/class_prismmesh.rst @@ -19,27 +19,27 @@ Class representing a prism-shaped :ref:`PrimitiveMesh`. Member Functions ---------------- -+--------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_left_to_right` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_size` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_subdivide_depth` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_subdivide_height` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_subdivide_width` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_left_to_right` **(** :ref:`float` left_to_right **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_size` **(** :ref:`Vector3` size **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_subdivide_depth` **(** :ref:`int` segments **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_subdivide_height` **(** :ref:`int` segments **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_subdivide_width` **(** :ref:`int` segments **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_left_to_right` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_size` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_subdivide_depth` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_subdivide_height` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_subdivide_width` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_left_to_right` **(** :ref:`float` left_to_right **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_size` **(** :ref:`Vector3` size **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_subdivide_depth` **(** :ref:`int` segments **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_subdivide_height` **(** :ref:`int` segments **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_subdivide_width` **(** :ref:`int` segments **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -75,42 +75,42 @@ Member Function Description .. _class_PrismMesh_get_left_to_right: -- :ref:`float` **get_left_to_right** **(** **)** const +- :ref:`float` **get_left_to_right** **(** **)** const .. _class_PrismMesh_get_size: -- :ref:`Vector3` **get_size** **(** **)** const +- :ref:`Vector3` **get_size** **(** **)** const .. _class_PrismMesh_get_subdivide_depth: -- :ref:`int` **get_subdivide_depth** **(** **)** const +- :ref:`int` **get_subdivide_depth** **(** **)** const .. _class_PrismMesh_get_subdivide_height: -- :ref:`int` **get_subdivide_height** **(** **)** const +- :ref:`int` **get_subdivide_height** **(** **)** const .. _class_PrismMesh_get_subdivide_width: -- :ref:`int` **get_subdivide_width** **(** **)** const +- :ref:`int` **get_subdivide_width** **(** **)** const .. _class_PrismMesh_set_left_to_right: -- void **set_left_to_right** **(** :ref:`float` left_to_right **)** +- void **set_left_to_right** **(** :ref:`float` left_to_right **)** .. _class_PrismMesh_set_size: -- void **set_size** **(** :ref:`Vector3` size **)** +- void **set_size** **(** :ref:`Vector3` size **)** .. _class_PrismMesh_set_subdivide_depth: -- void **set_subdivide_depth** **(** :ref:`int` segments **)** +- void **set_subdivide_depth** **(** :ref:`int` segments **)** .. _class_PrismMesh_set_subdivide_height: -- void **set_subdivide_height** **(** :ref:`int` segments **)** +- void **set_subdivide_height** **(** :ref:`int` segments **)** .. _class_PrismMesh_set_subdivide_width: -- void **set_subdivide_width** **(** :ref:`int` segments **)** +- void **set_subdivide_width** **(** :ref:`int` segments **)** diff --git a/classes/class_proceduralsky.rst b/classes/class_proceduralsky.rst index b9513a4f4..7030b163f 100644 --- a/classes/class_proceduralsky.rst +++ b/classes/class_proceduralsky.rst @@ -19,71 +19,71 @@ Brief Description Member Functions ---------------- -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_ground_bottom_color` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ground_curve` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ground_energy` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_ground_horizon_color` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_sky_curve` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_sky_energy` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_sky_horizon_color` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_sky_top_color` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_sun_angle_max` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_sun_angle_min` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_sun_color` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_sun_curve` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_sun_energy` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_sun_latitude` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_sun_longitude` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_texture_size` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ground_bottom_color` **(** :ref:`Color` color **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ground_curve` **(** :ref:`float` curve **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ground_energy` **(** :ref:`float` energy **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ground_horizon_color` **(** :ref:`Color` color **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sky_curve` **(** :ref:`float` curve **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sky_energy` **(** :ref:`float` energy **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sky_horizon_color` **(** :ref:`Color` color **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sky_top_color` **(** :ref:`Color` color **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sun_angle_max` **(** :ref:`float` degrees **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sun_angle_min` **(** :ref:`float` degrees **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sun_color` **(** :ref:`Color` color **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sun_curve` **(** :ref:`float` curve **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sun_energy` **(** :ref:`float` energy **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sun_latitude` **(** :ref:`float` degrees **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sun_longitude` **(** :ref:`float` degrees **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture_size` **(** :ref:`int` size **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_ground_bottom_color` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_ground_curve` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_ground_energy` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_ground_horizon_color` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_sky_curve` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_sky_energy` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_sky_horizon_color` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_sky_top_color` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_sun_angle_max` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_sun_angle_min` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_sun_color` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_sun_curve` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_sun_energy` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_sun_latitude` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_sun_longitude` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_texture_size` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ground_bottom_color` **(** :ref:`Color` color **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ground_curve` **(** :ref:`float` curve **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ground_energy` **(** :ref:`float` energy **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ground_horizon_color` **(** :ref:`Color` color **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_sky_curve` **(** :ref:`float` curve **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_sky_energy` **(** :ref:`float` energy **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_sky_horizon_color` **(** :ref:`Color` color **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_sky_top_color` **(** :ref:`Color` color **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_sun_angle_max` **(** :ref:`float` degrees **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_sun_angle_min` **(** :ref:`float` degrees **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_sun_color` **(** :ref:`Color` color **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_sun_curve` **(** :ref:`float` curve **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_sun_energy` **(** :ref:`float` energy **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_sun_latitude` **(** :ref:`float` degrees **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_sun_longitude` **(** :ref:`float` degrees **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_texture_size` **(** :ref:`int` size **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -168,130 +168,130 @@ Member Function Description .. _class_ProceduralSky_get_ground_bottom_color: -- :ref:`Color` **get_ground_bottom_color** **(** **)** const +- :ref:`Color` **get_ground_bottom_color** **(** **)** const .. _class_ProceduralSky_get_ground_curve: -- :ref:`float` **get_ground_curve** **(** **)** const +- :ref:`float` **get_ground_curve** **(** **)** const .. _class_ProceduralSky_get_ground_energy: -- :ref:`float` **get_ground_energy** **(** **)** const +- :ref:`float` **get_ground_energy** **(** **)** const .. _class_ProceduralSky_get_ground_horizon_color: -- :ref:`Color` **get_ground_horizon_color** **(** **)** const +- :ref:`Color` **get_ground_horizon_color** **(** **)** const .. _class_ProceduralSky_get_sky_curve: -- :ref:`float` **get_sky_curve** **(** **)** const +- :ref:`float` **get_sky_curve** **(** **)** const .. _class_ProceduralSky_get_sky_energy: -- :ref:`float` **get_sky_energy** **(** **)** const +- :ref:`float` **get_sky_energy** **(** **)** const .. _class_ProceduralSky_get_sky_horizon_color: -- :ref:`Color` **get_sky_horizon_color** **(** **)** const +- :ref:`Color` **get_sky_horizon_color** **(** **)** const .. _class_ProceduralSky_get_sky_top_color: -- :ref:`Color` **get_sky_top_color** **(** **)** const +- :ref:`Color` **get_sky_top_color** **(** **)** const .. _class_ProceduralSky_get_sun_angle_max: -- :ref:`float` **get_sun_angle_max** **(** **)** const +- :ref:`float` **get_sun_angle_max** **(** **)** const .. _class_ProceduralSky_get_sun_angle_min: -- :ref:`float` **get_sun_angle_min** **(** **)** const +- :ref:`float` **get_sun_angle_min** **(** **)** const .. _class_ProceduralSky_get_sun_color: -- :ref:`Color` **get_sun_color** **(** **)** const +- :ref:`Color` **get_sun_color** **(** **)** const .. _class_ProceduralSky_get_sun_curve: -- :ref:`float` **get_sun_curve** **(** **)** const +- :ref:`float` **get_sun_curve** **(** **)** const .. _class_ProceduralSky_get_sun_energy: -- :ref:`float` **get_sun_energy** **(** **)** const +- :ref:`float` **get_sun_energy** **(** **)** const .. _class_ProceduralSky_get_sun_latitude: -- :ref:`float` **get_sun_latitude** **(** **)** const +- :ref:`float` **get_sun_latitude** **(** **)** const .. _class_ProceduralSky_get_sun_longitude: -- :ref:`float` **get_sun_longitude** **(** **)** const +- :ref:`float` **get_sun_longitude** **(** **)** const .. _class_ProceduralSky_get_texture_size: -- :ref:`int` **get_texture_size** **(** **)** const +- :ref:`int` **get_texture_size** **(** **)** const .. _class_ProceduralSky_set_ground_bottom_color: -- void **set_ground_bottom_color** **(** :ref:`Color` color **)** +- void **set_ground_bottom_color** **(** :ref:`Color` color **)** .. _class_ProceduralSky_set_ground_curve: -- void **set_ground_curve** **(** :ref:`float` curve **)** +- void **set_ground_curve** **(** :ref:`float` curve **)** .. _class_ProceduralSky_set_ground_energy: -- void **set_ground_energy** **(** :ref:`float` energy **)** +- void **set_ground_energy** **(** :ref:`float` energy **)** .. _class_ProceduralSky_set_ground_horizon_color: -- void **set_ground_horizon_color** **(** :ref:`Color` color **)** +- void **set_ground_horizon_color** **(** :ref:`Color` color **)** .. _class_ProceduralSky_set_sky_curve: -- void **set_sky_curve** **(** :ref:`float` curve **)** +- void **set_sky_curve** **(** :ref:`float` curve **)** .. _class_ProceduralSky_set_sky_energy: -- void **set_sky_energy** **(** :ref:`float` energy **)** +- void **set_sky_energy** **(** :ref:`float` energy **)** .. _class_ProceduralSky_set_sky_horizon_color: -- void **set_sky_horizon_color** **(** :ref:`Color` color **)** +- void **set_sky_horizon_color** **(** :ref:`Color` color **)** .. _class_ProceduralSky_set_sky_top_color: -- void **set_sky_top_color** **(** :ref:`Color` color **)** +- void **set_sky_top_color** **(** :ref:`Color` color **)** .. _class_ProceduralSky_set_sun_angle_max: -- void **set_sun_angle_max** **(** :ref:`float` degrees **)** +- void **set_sun_angle_max** **(** :ref:`float` degrees **)** .. _class_ProceduralSky_set_sun_angle_min: -- void **set_sun_angle_min** **(** :ref:`float` degrees **)** +- void **set_sun_angle_min** **(** :ref:`float` degrees **)** .. _class_ProceduralSky_set_sun_color: -- void **set_sun_color** **(** :ref:`Color` color **)** +- void **set_sun_color** **(** :ref:`Color` color **)** .. _class_ProceduralSky_set_sun_curve: -- void **set_sun_curve** **(** :ref:`float` curve **)** +- void **set_sun_curve** **(** :ref:`float` curve **)** .. _class_ProceduralSky_set_sun_energy: -- void **set_sun_energy** **(** :ref:`float` energy **)** +- void **set_sun_energy** **(** :ref:`float` energy **)** .. _class_ProceduralSky_set_sun_latitude: -- void **set_sun_latitude** **(** :ref:`float` degrees **)** +- void **set_sun_latitude** **(** :ref:`float` degrees **)** .. _class_ProceduralSky_set_sun_longitude: -- void **set_sun_longitude** **(** :ref:`float` degrees **)** +- void **set_sun_longitude** **(** :ref:`float` degrees **)** .. _class_ProceduralSky_set_texture_size: -- void **set_texture_size** **(** :ref:`int` size **)** +- void **set_texture_size** **(** :ref:`int` size **)** diff --git a/classes/class_progressbar.rst b/classes/class_progressbar.rst index dfa128735..8ae82d871 100644 --- a/classes/class_progressbar.rst +++ b/classes/class_progressbar.rst @@ -19,11 +19,11 @@ General purpose progress bar. Member Functions ---------------- -+--------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_percent_visible` **(** **)** const | -+--------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_percent_visible` **(** :ref:`bool` visible **)** | -+--------------------------+-----------------------------------------------------------------------------------------------------------------+ ++--------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_percent_visible` **(** **)** const | ++--------------------------+---------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_percent_visible` **(** :ref:`bool` visible **)** | ++--------------------------+---------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -43,10 +43,10 @@ Member Function Description .. _class_ProgressBar_is_percent_visible: -- :ref:`bool` **is_percent_visible** **(** **)** const +- :ref:`bool` **is_percent_visible** **(** **)** const .. _class_ProgressBar_set_percent_visible: -- void **set_percent_visible** **(** :ref:`bool` visible **)** +- void **set_percent_visible** **(** :ref:`bool` visible **)** diff --git a/classes/class_projectsettings.rst b/classes/class_projectsettings.rst index 64646d2fe..ff4a486c2 100644 --- a/classes/class_projectsettings.rst +++ b/classes/class_projectsettings.rst @@ -19,41 +19,41 @@ Contains global variables accessible from everywhere. Member Functions ---------------- -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_property_info` **(** :ref:`Dictionary` hint **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** :ref:`String` name **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_order` **(** :ref:`String` name **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_setting` **(** :ref:`String` name **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_singleton` **(** :ref:`String` name **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`globalize_path` **(** :ref:`String` path **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_setting` **(** :ref:`String` name **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_singleton` **(** :ref:`String` name **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`load_resource_pack` **(** :ref:`String` pack **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`localize_path` **(** :ref:`String` path **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`property_can_revert` **(** :ref:`String` name **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`property_get_revert` **(** :ref:`String` name **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`save` **(** **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`save_custom` **(** :ref:`String` file **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_initial_value` **(** :ref:`String` name, :ref:`Variant` value **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_order` **(** :ref:`String` name, :ref:`int` position **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_setting` **(** :ref:`String` name, :ref:`Variant` value **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_property_info` **(** :ref:`Dictionary` hint **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** :ref:`String` name **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_order` **(** :ref:`String` name **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_setting` **(** :ref:`String` name **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_singleton` **(** :ref:`String` name **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`globalize_path` **(** :ref:`String` path **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_setting` **(** :ref:`String` name **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_singleton` **(** :ref:`String` name **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`load_resource_pack` **(** :ref:`String` pack **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`localize_path` **(** :ref:`String` path **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`property_can_revert` **(** :ref:`String` name **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`property_get_revert` **(** :ref:`String` name **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`save` **(** **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`save_custom` **(** :ref:`String` file **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_initial_value` **(** :ref:`String` name, :ref:`Variant` value **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_order` **(** :ref:`String` name, :ref:`int` position **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_setting` **(** :ref:`String` name, :ref:`Variant` value **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -65,7 +65,7 @@ Member Function Description .. _class_ProjectSettings_add_property_info: -- void **add_property_info** **(** :ref:`Dictionary` hint **)** +- void **add_property_info** **(** :ref:`Dictionary` hint **)** Add a custom property info to a property. The dictionary must contain: name::ref:`String`(the name of the property) and type::ref:`int`(see TYPE\_\* in :ref:`@Global Scope`), and optionally hint::ref:`int`(see PROPERTY_HINT\_\* in :ref:`@Global Scope`), hint_string::ref:`String`. @@ -86,78 +86,78 @@ Example: .. _class_ProjectSettings_clear: -- void **clear** **(** :ref:`String` name **)** +- void **clear** **(** :ref:`String` name **)** Clear the whole configuration (not recommended, may break things). .. _class_ProjectSettings_get_order: -- :ref:`int` **get_order** **(** :ref:`String` name **)** const +- :ref:`int` **get_order** **(** :ref:`String` name **)** const Return the order of a configuration value (influences when saved to the config file). .. _class_ProjectSettings_get_setting: -- :ref:`Variant` **get_setting** **(** :ref:`String` name **)** const +- :ref:`Variant` **get_setting** **(** :ref:`String` name **)** const .. _class_ProjectSettings_get_singleton: -- :ref:`Object` **get_singleton** **(** :ref:`String` name **)** const +- :ref:`Object` **get_singleton** **(** :ref:`String` name **)** const .. _class_ProjectSettings_globalize_path: -- :ref:`String` **globalize_path** **(** :ref:`String` path **)** const +- :ref:`String` **globalize_path** **(** :ref:`String` path **)** const Convert a localized path (res://) to a full native OS path. .. _class_ProjectSettings_has_setting: -- :ref:`bool` **has_setting** **(** :ref:`String` name **)** const +- :ref:`bool` **has_setting** **(** :ref:`String` name **)** const Return true if a configuration value is present. .. _class_ProjectSettings_has_singleton: -- :ref:`bool` **has_singleton** **(** :ref:`String` name **)** const +- :ref:`bool` **has_singleton** **(** :ref:`String` name **)** const .. _class_ProjectSettings_load_resource_pack: -- :ref:`bool` **load_resource_pack** **(** :ref:`String` pack **)** +- :ref:`bool` **load_resource_pack** **(** :ref:`String` pack **)** .. _class_ProjectSettings_localize_path: -- :ref:`String` **localize_path** **(** :ref:`String` path **)** const +- :ref:`String` **localize_path** **(** :ref:`String` path **)** const Convert a path to a localized path (res:// path). .. _class_ProjectSettings_property_can_revert: -- :ref:`bool` **property_can_revert** **(** :ref:`String` name **)** +- :ref:`bool` **property_can_revert** **(** :ref:`String` name **)** .. _class_ProjectSettings_property_get_revert: -- :ref:`Variant` **property_get_revert** **(** :ref:`String` name **)** +- :ref:`Variant` **property_get_revert** **(** :ref:`String` name **)** .. _class_ProjectSettings_save: -- :ref:`int` **save** **(** **)** +- :ref:`int` **save** **(** **)** .. _class_ProjectSettings_save_custom: -- :ref:`int` **save_custom** **(** :ref:`String` file **)** +- :ref:`int` **save_custom** **(** :ref:`String` file **)** .. _class_ProjectSettings_set_initial_value: -- void **set_initial_value** **(** :ref:`String` name, :ref:`Variant` value **)** +- void **set_initial_value** **(** :ref:`String` name, :ref:`Variant` value **)** .. _class_ProjectSettings_set_order: -- void **set_order** **(** :ref:`String` name, :ref:`int` position **)** +- void **set_order** **(** :ref:`String` name, :ref:`int` position **)** Set the order of a configuration value (influences when saved to the config file). .. _class_ProjectSettings_set_setting: -- void **set_setting** **(** :ref:`String` name, :ref:`Variant` value **)** +- void **set_setting** **(** :ref:`String` name, :ref:`Variant` value **)** diff --git a/classes/class_proximitygroup.rst b/classes/class_proximitygroup.rst index de8962b0f..98d7f46d7 100644 --- a/classes/class_proximitygroup.rst +++ b/classes/class_proximitygroup.rst @@ -19,24 +19,24 @@ General purpose proximity-detection node. Member Functions ---------------- -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`broadcast` **(** :ref:`String` name, :ref:`Variant` parameters **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_grid_radius` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_dispatch_mode` **(** :ref:`int` mode **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_grid_radius` **(** :ref:`Vector3` radius **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_group_name` **(** :ref:`String` name **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`broadcast` **(** :ref:`String` name, :ref:`Variant` parameters **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_grid_radius` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_dispatch_mode` **(** :ref:`int` mode **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_grid_radius` **(** :ref:`Vector3` radius **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_group_name` **(** :ref:`String` name **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_ProximityGroup_broadcast: -- **broadcast** **(** :ref:`String` name, :ref:`Array` parameters **)** +- **broadcast** **(** :ref:`String` name, :ref:`Array` parameters **)** Member Variables @@ -57,22 +57,22 @@ Member Function Description .. _class_ProximityGroup_broadcast: -- void **broadcast** **(** :ref:`String` name, :ref:`Variant` parameters **)** +- void **broadcast** **(** :ref:`String` name, :ref:`Variant` parameters **)** .. _class_ProximityGroup_get_grid_radius: -- :ref:`Vector3` **get_grid_radius** **(** **)** const +- :ref:`Vector3` **get_grid_radius** **(** **)** const .. _class_ProximityGroup_set_dispatch_mode: -- void **set_dispatch_mode** **(** :ref:`int` mode **)** +- void **set_dispatch_mode** **(** :ref:`int` mode **)** .. _class_ProximityGroup_set_grid_radius: -- void **set_grid_radius** **(** :ref:`Vector3` radius **)** +- void **set_grid_radius** **(** :ref:`Vector3` radius **)** .. _class_ProximityGroup_set_group_name: -- void **set_group_name** **(** :ref:`String` name **)** +- void **set_group_name** **(** :ref:`String` name **)** diff --git a/classes/class_quat.rst b/classes/class_quat.rst index c8d2ea20f..d11536081 100644 --- a/classes/class_quat.rst +++ b/classes/class_quat.rst @@ -17,33 +17,33 @@ Quaternion. Member Functions ---------------- -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Quat` | :ref:`Quat` **(** :ref:`float` x, :ref:`float` y, :ref:`float` z, :ref:`float` w **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Quat` | :ref:`Quat` **(** :ref:`Vector3` axis, :ref:`float` angle **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Quat` | :ref:`Quat` **(** :ref:`Basis` from **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Quat` | :ref:`cubic_slerp` **(** :ref:`Quat` b, :ref:`Quat` pre_a, :ref:`Quat` post_b, :ref:`float` t **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`dot` **(** :ref:`Quat` b **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Quat` | :ref:`inverse` **(** **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_normalized` **(** **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`length` **(** **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`length_squared` **(** **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Quat` | :ref:`normalized` **(** **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Quat` | :ref:`slerp` **(** :ref:`Quat` b, :ref:`float` t **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Quat` | :ref:`slerpni` **(** :ref:`Quat` b, :ref:`float` t **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`xform` **(** :ref:`Vector3` v **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Quat` | :ref:`Quat` **(** :ref:`float` x, :ref:`float` y, :ref:`float` z, :ref:`float` w **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Quat` | :ref:`Quat` **(** :ref:`Vector3` axis, :ref:`float` angle **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Quat` | :ref:`Quat` **(** :ref:`Basis` from **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Quat` | :ref:`cubic_slerp` **(** :ref:`Quat` b, :ref:`Quat` pre_a, :ref:`Quat` post_b, :ref:`float` t **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`dot` **(** :ref:`Quat` b **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Quat` | :ref:`inverse` **(** **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_normalized` **(** **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`length` **(** **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`length_squared` **(** **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Quat` | :ref:`normalized` **(** **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Quat` | :ref:`slerp` **(** :ref:`Quat` b, :ref:`float` t **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Quat` | :ref:`slerpni` **(** :ref:`Quat` b, :ref:`float` t **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`xform` **(** :ref:`Vector3` v **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -75,72 +75,72 @@ Member Function Description .. _class_Quat_Quat: -- :ref:`Quat` **Quat** **(** :ref:`float` x, :ref:`float` y, :ref:`float` z, :ref:`float` w **)** +- :ref:`Quat` **Quat** **(** :ref:`float` x, :ref:`float` y, :ref:`float` z, :ref:`float` w **)** .. _class_Quat_Quat: -- :ref:`Quat` **Quat** **(** :ref:`Vector3` axis, :ref:`float` angle **)** +- :ref:`Quat` **Quat** **(** :ref:`Vector3` axis, :ref:`float` angle **)** Returns a quaternion that will rotate around the given axis by the specified angle. The axis must be a normalized vector. .. _class_Quat_Quat: -- :ref:`Quat` **Quat** **(** :ref:`Basis` from **)** +- :ref:`Quat` **Quat** **(** :ref:`Basis` from **)** Returns the rotation matrix corresponding to the given quaternion. .. _class_Quat_cubic_slerp: -- :ref:`Quat` **cubic_slerp** **(** :ref:`Quat` b, :ref:`Quat` pre_a, :ref:`Quat` post_b, :ref:`float` t **)** +- :ref:`Quat` **cubic_slerp** **(** :ref:`Quat` b, :ref:`Quat` pre_a, :ref:`Quat` post_b, :ref:`float` t **)** .. _class_Quat_dot: -- :ref:`float` **dot** **(** :ref:`Quat` b **)** +- :ref:`float` **dot** **(** :ref:`Quat` b **)** Returns the dot product of two quaternions. .. _class_Quat_inverse: -- :ref:`Quat` **inverse** **(** **)** +- :ref:`Quat` **inverse** **(** **)** Returns the inverse of the quaternion. .. _class_Quat_is_normalized: -- :ref:`bool` **is_normalized** **(** **)** +- :ref:`bool` **is_normalized** **(** **)** Returns whether the quaternion is normalized or not. .. _class_Quat_length: -- :ref:`float` **length** **(** **)** +- :ref:`float` **length** **(** **)** Returns the length of the quaternion. .. _class_Quat_length_squared: -- :ref:`float` **length_squared** **(** **)** +- :ref:`float` **length_squared** **(** **)** Returns the length of the quaternion, squared. .. _class_Quat_normalized: -- :ref:`Quat` **normalized** **(** **)** +- :ref:`Quat` **normalized** **(** **)** Returns a copy of the quaternion, normalized to unit length. .. _class_Quat_slerp: -- :ref:`Quat` **slerp** **(** :ref:`Quat` b, :ref:`float` t **)** +- :ref:`Quat` **slerp** **(** :ref:`Quat` b, :ref:`float` t **)** Perform a spherical-linear interpolation with another quaternion. .. _class_Quat_slerpni: -- :ref:`Quat` **slerpni** **(** :ref:`Quat` b, :ref:`float` t **)** +- :ref:`Quat` **slerpni** **(** :ref:`Quat` b, :ref:`float` t **)** .. _class_Quat_xform: -- :ref:`Vector3` **xform** **(** :ref:`Vector3` v **)** +- :ref:`Vector3` **xform** **(** :ref:`Vector3` v **)** diff --git a/classes/class_range.rst b/classes/class_range.rst index 647cd9793..818bcaed5 100644 --- a/classes/class_range.rst +++ b/classes/class_range.rst @@ -21,56 +21,56 @@ Abstract base class for range-based controls. Member Functions ---------------- -+----------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_as_ratio` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_max` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_min` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_page` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_step` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_value` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_ratio_exp` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_using_rounded_values` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_as_ratio` **(** :ref:`float` value **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_exp_ratio` **(** :ref:`bool` enabled **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_max` **(** :ref:`float` maximum **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_min` **(** :ref:`float` minimum **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_page` **(** :ref:`float` pagesize **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_step` **(** :ref:`float` step **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_rounded_values` **(** :ref:`bool` enabled **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_value` **(** :ref:`float` value **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`share` **(** :ref:`Node` with **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`unshare` **(** **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------+ ++----------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_as_ratio` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_max` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_min` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_page` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_step` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_value` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_ratio_exp` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_using_rounded_values` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_as_ratio` **(** :ref:`float` value **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_exp_ratio` **(** :ref:`bool` enabled **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_max` **(** :ref:`float` maximum **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_min` **(** :ref:`float` minimum **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_page` **(** :ref:`float` pagesize **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_step` **(** :ref:`float` step **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_rounded_values` **(** :ref:`bool` enabled **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_value` **(** :ref:`float` value **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------+ +| void | :ref:`share` **(** :ref:`Node` with **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------+ +| void | :ref:`unshare` **(** **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_Range_changed: -- **changed** **(** **)** +- **changed** **(** **)** This signal is emitted when min, max, range or step change. .. _class_Range_value_changed: -- **value_changed** **(** :ref:`float` value **)** +- **value_changed** **(** :ref:`float` value **)** This signal is emitted when value changes. @@ -117,95 +117,95 @@ Member Function Description .. _class_Range_get_as_ratio: -- :ref:`float` **get_as_ratio** **(** **)** const +- :ref:`float` **get_as_ratio** **(** **)** const Return value mapped to 0 to 1 range. .. _class_Range_get_max: -- :ref:`float` **get_max** **(** **)** const +- :ref:`float` **get_max** **(** **)** const Return the maximum value. .. _class_Range_get_min: -- :ref:`float` **get_min** **(** **)** const +- :ref:`float` **get_min** **(** **)** const Return the minimum value. .. _class_Range_get_page: -- :ref:`float` **get_page** **(** **)** const +- :ref:`float` **get_page** **(** **)** const Return the page size, if page is 0, paging is disabled. .. _class_Range_get_step: -- :ref:`float` **get_step** **(** **)** const +- :ref:`float` **get_step** **(** **)** const Return the stepping, if step is 0, stepping is disabled. .. _class_Range_get_value: -- :ref:`float` **get_value** **(** **)** const +- :ref:`float` **get_value** **(** **)** const .. _class_Range_is_ratio_exp: -- :ref:`bool` **is_ratio_exp** **(** **)** const +- :ref:`bool` **is_ratio_exp** **(** **)** const .. _class_Range_is_using_rounded_values: -- :ref:`bool` **is_using_rounded_values** **(** **)** const +- :ref:`bool` **is_using_rounded_values** **(** **)** const .. _class_Range_set_as_ratio: -- void **set_as_ratio** **(** :ref:`float` value **)** +- void **set_as_ratio** **(** :ref:`float` value **)** Set value mapped to 0 to 1 (unit) range, it will then be converted to the actual value within min and max. .. _class_Range_set_exp_ratio: -- void **set_exp_ratio** **(** :ref:`bool` enabled **)** +- void **set_exp_ratio** **(** :ref:`bool` enabled **)** .. _class_Range_set_max: -- void **set_max** **(** :ref:`float` maximum **)** +- void **set_max** **(** :ref:`float` maximum **)** .. _class_Range_set_min: -- void **set_min** **(** :ref:`float` minimum **)** +- void **set_min** **(** :ref:`float` minimum **)** Set minimum value, clamped range value to it if it's less. .. _class_Range_set_page: -- void **set_page** **(** :ref:`float` pagesize **)** +- void **set_page** **(** :ref:`float` pagesize **)** Set page size. Page is mainly used for scrollbars or anything that controls text scrolling. .. _class_Range_set_step: -- void **set_step** **(** :ref:`float` step **)** +- void **set_step** **(** :ref:`float` step **)** Set step value. If step is 0, stepping will be disabled. .. _class_Range_set_use_rounded_values: -- void **set_use_rounded_values** **(** :ref:`bool` enabled **)** +- void **set_use_rounded_values** **(** :ref:`bool` enabled **)** .. _class_Range_set_value: -- void **set_value** **(** :ref:`float` value **)** +- void **set_value** **(** :ref:`float` value **)** .. _class_Range_share: -- void **share** **(** :ref:`Node` with **)** +- void **share** **(** :ref:`Node` with **)** Binds two Ranges together along with any Ranges previously grouped with either of them. When any of Range's member variables change, it will share the new value with all other Ranges in its group. .. _class_Range_unshare: -- void **unshare** **(** **)** +- void **unshare** **(** **)** Stop Range from sharing its member variables with any other Range. diff --git a/classes/class_raycast.rst b/classes/class_raycast.rst index 45c78c618..839c033dc 100644 --- a/classes/class_raycast.rst +++ b/classes/class_raycast.rst @@ -19,45 +19,45 @@ Query the closest object intersecting a ray. Member Functions ---------------- -+--------------------------------+---------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_exception` **(** :ref:`Object` node **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_exception_rid` **(** :ref:`RID` rid **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_exceptions` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------+ -| void | :ref:`force_raycast_update` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_cast_to` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_collider` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collider_shape` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_layer` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_collision_normal` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_collision_point` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_type_mask` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_colliding` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_enabled` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_exception` **(** :ref:`Object` node **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_exception_rid` **(** :ref:`RID` rid **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cast_to` **(** :ref:`Vector3` local_point **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_layer` **(** :ref:`int` layer **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_enabled` **(** :ref:`bool` enabled **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_type_mask` **(** :ref:`int` mask **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------+ ++--------------------------------+-------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_exception` **(** :ref:`Object` node **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_exception_rid` **(** :ref:`RID` rid **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_exceptions` **(** **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------+ +| void | :ref:`force_raycast_update` **(** **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_cast_to` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_collider` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collider_shape` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_layer` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_collision_normal` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_collision_point` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_type_mask` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_colliding` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_enabled` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_exception` **(** :ref:`Object` node **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_exception_rid` **(** :ref:`RID` rid **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cast_to` **(** :ref:`Vector3` local_point **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_layer` **(** :ref:`int` layer **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_enabled` **(** :ref:`bool` enabled **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_type_mask` **(** :ref:`int` mask **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -101,25 +101,25 @@ Member Function Description .. _class_RayCast_add_exception: -- void **add_exception** **(** :ref:`Object` node **)** +- void **add_exception** **(** :ref:`Object` node **)** Adds a collision exception so the ray does not report collisions with the specified node. .. _class_RayCast_add_exception_rid: -- void **add_exception_rid** **(** :ref:`RID` rid **)** +- void **add_exception_rid** **(** :ref:`RID` rid **)** Adds a collision exception so the ray does not report collisions with the specified :ref:`RID`. .. _class_RayCast_clear_exceptions: -- void **clear_exceptions** **(** **)** +- void **clear_exceptions** **(** **)** Removes all collision exceptions for this ray. .. _class_RayCast_force_raycast_update: -- void **force_raycast_update** **(** **)** +- void **force_raycast_update** **(** **)** Updates the collision information for the ray. @@ -127,13 +127,13 @@ Use this method to update the collision information immediately instead of waiti .. _class_RayCast_get_cast_to: -- :ref:`Vector3` **get_cast_to** **(** **)** const +- :ref:`Vector3` **get_cast_to** **(** **)** const Return the destination point of this ray object. .. _class_RayCast_get_collider: -- :ref:`Object` **get_collider** **(** **)** const +- :ref:`Object` **get_collider** **(** **)** const Return the closest object the ray is pointing to. Note that this does not consider the length of the ray, so you must also use :ref:`is_colliding` to check if the object returned is actually colliding with the ray. @@ -146,7 +146,7 @@ Example: .. _class_RayCast_get_collider_shape: -- :ref:`int` **get_collider_shape** **(** **)** const +- :ref:`int` **get_collider_shape** **(** **)** const Returns the collision shape of the closest object the ray is pointing to. Note that this does not consider the length of the ray, so you must also use :ref:`is_colliding` to check if the object returned is actually colliding with the ray. @@ -159,73 +159,73 @@ Example: .. _class_RayCast_get_collision_layer: -- :ref:`int` **get_collision_layer** **(** **)** const +- :ref:`int` **get_collision_layer** **(** **)** const Returns the collision layer for this ray. .. _class_RayCast_get_collision_normal: -- :ref:`Vector3` **get_collision_normal** **(** **)** const +- :ref:`Vector3` **get_collision_normal** **(** **)** const Returns the normal of the intersecting object's shape at the collision point. .. _class_RayCast_get_collision_point: -- :ref:`Vector3` **get_collision_point** **(** **)** const +- :ref:`Vector3` **get_collision_point** **(** **)** const Returns the collision point at which the ray intersects the closest object. Note: this point is in the **global** coordinate system. .. _class_RayCast_get_type_mask: -- :ref:`int` **get_type_mask** **(** **)** const +- :ref:`int` **get_type_mask** **(** **)** const Returns the type mask (types of objects to detect) for this ray. The value is a sum (bitwise OR'd) of constants available for :ref:`PhysicsDirectSpaceState`. .. _class_RayCast_is_colliding: -- :ref:`bool` **is_colliding** **(** **)** const +- :ref:`bool` **is_colliding** **(** **)** const Return whether the closest object the ray is pointing to is colliding with the vector (considering the vector length). .. _class_RayCast_is_enabled: -- :ref:`bool` **is_enabled** **(** **)** const +- :ref:`bool` **is_enabled** **(** **)** const Returns whether the ray is enabled or not. .. _class_RayCast_remove_exception: -- void **remove_exception** **(** :ref:`Object` node **)** +- void **remove_exception** **(** :ref:`Object` node **)** Removes a collision exception so the ray does report collisions with the specified node. .. _class_RayCast_remove_exception_rid: -- void **remove_exception_rid** **(** :ref:`RID` rid **)** +- void **remove_exception_rid** **(** :ref:`RID` rid **)** Removes a collision exception so the ray does report collisions with the specified :ref:`RID`. .. _class_RayCast_set_cast_to: -- void **set_cast_to** **(** :ref:`Vector3` local_point **)** +- void **set_cast_to** **(** :ref:`Vector3` local_point **)** Sets the ray destination point, so that the ray will test from the ray's origin to ``local_point``. .. _class_RayCast_set_collision_layer: -- void **set_collision_layer** **(** :ref:`int` layer **)** +- void **set_collision_layer** **(** :ref:`int` layer **)** Set the mask to filter objects. Only objects with at least the same mask element set will be detected. .. _class_RayCast_set_enabled: -- void **set_enabled** **(** :ref:`bool` enabled **)** +- void **set_enabled** **(** :ref:`bool` enabled **)** Enables the RayCast2D. Only enabled raycasts will be able to query the space and report collisions. .. _class_RayCast_set_type_mask: -- void **set_type_mask** **(** :ref:`int` mask **)** +- void **set_type_mask** **(** :ref:`int` mask **)** Set the types of objects to detect. For ``mask`` use a logic sum (OR operation) of constants defined in :ref:`PhysicsDirectSpaceState`, eg. ``PhysicsDirectSpaceState.TYPE_MASK_STATIC_BODY | PhysicsDirectSpaceState.TYPE_MASK_KINEMATIC_BODY`` to detect only those two types. diff --git a/classes/class_raycast2d.rst b/classes/class_raycast2d.rst index 604c62443..3e573ef89 100644 --- a/classes/class_raycast2d.rst +++ b/classes/class_raycast2d.rst @@ -19,49 +19,49 @@ Query the closest object intersecting a ray. Member Functions ---------------- -+--------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_exception` **(** :ref:`Object` node **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_exception_rid` **(** :ref:`RID` rid **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_exceptions` **(** **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`force_raycast_update` **(** **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_cast_to` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_collider` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collider_shape` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_layer` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_collision_normal` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_collision_point` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_exclude_parent_body` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_type_mask` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_colliding` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_enabled` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_exception` **(** :ref:`Object` node **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_exception_rid` **(** :ref:`RID` rid **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cast_to` **(** :ref:`Vector2` local_point **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_layer` **(** :ref:`int` layer **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_enabled` **(** :ref:`bool` enabled **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_exclude_parent_body` **(** :ref:`bool` mask **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_type_mask` **(** :ref:`int` mask **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_exception` **(** :ref:`Object` node **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_exception_rid` **(** :ref:`RID` rid **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_exceptions` **(** **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`force_raycast_update` **(** **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_cast_to` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_collider` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collider_shape` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_layer` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_collision_normal` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_collision_point` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_exclude_parent_body` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_type_mask` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_colliding` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_enabled` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_exception` **(** :ref:`Object` node **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_exception_rid` **(** :ref:`RID` rid **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cast_to` **(** :ref:`Vector2` local_point **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_layer` **(** :ref:`int` layer **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_enabled` **(** :ref:`bool` enabled **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_exclude_parent_body` **(** :ref:`bool` mask **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_type_mask` **(** :ref:`int` mask **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -109,37 +109,37 @@ Member Function Description .. _class_RayCast2D_add_exception: -- void **add_exception** **(** :ref:`Object` node **)** +- void **add_exception** **(** :ref:`Object` node **)** Adds a collision exception so the ray does not report collisions with the specified node. .. _class_RayCast2D_add_exception_rid: -- void **add_exception_rid** **(** :ref:`RID` rid **)** +- void **add_exception_rid** **(** :ref:`RID` rid **)** Adds a collision exception so the ray does not report collisions with the specified :ref:`RID`. .. _class_RayCast2D_clear_exceptions: -- void **clear_exceptions** **(** **)** +- void **clear_exceptions** **(** **)** Removes all collision exceptions for this ray. .. _class_RayCast2D_force_raycast_update: -- void **force_raycast_update** **(** **)** +- void **force_raycast_update** **(** **)** Updates the collision information for the ray. Use this method to update the collision information immediately instead of waiting for the next ``_physics_process`` call, for example if the ray or its parent has changed state. Note: ``enabled == true`` is not required for this to work. .. _class_RayCast2D_get_cast_to: -- :ref:`Vector2` **get_cast_to** **(** **)** const +- :ref:`Vector2` **get_cast_to** **(** **)** const Return the destination point of this ray object. .. _class_RayCast2D_get_collider: -- :ref:`Object` **get_collider** **(** **)** const +- :ref:`Object` **get_collider** **(** **)** const Returns the closest object the ray is pointing to. Note that this does not consider the length of the ray, so you must also use :ref:`is_colliding` to check if the object returned is actually colliding with the ray. @@ -152,7 +152,7 @@ Example: .. _class_RayCast2D_get_collider_shape: -- :ref:`int` **get_collider_shape** **(** **)** const +- :ref:`int` **get_collider_shape** **(** **)** const Returns the collision shape of the closest object the ray is pointing to. Note that this does not consider the length of the ray, so you must also use :ref:`is_colliding` to check if the object returned is actually colliding with the ray. @@ -165,85 +165,85 @@ Example: .. _class_RayCast2D_get_collision_layer: -- :ref:`int` **get_collision_layer** **(** **)** const +- :ref:`int` **get_collision_layer** **(** **)** const Returns the collision layer for this ray. .. _class_RayCast2D_get_collision_normal: -- :ref:`Vector2` **get_collision_normal** **(** **)** const +- :ref:`Vector2` **get_collision_normal** **(** **)** const Returns the normal of the intersecting object's shape at the collision point. .. _class_RayCast2D_get_collision_point: -- :ref:`Vector2` **get_collision_point** **(** **)** const +- :ref:`Vector2` **get_collision_point** **(** **)** const Returns the collision point at which the ray intersects the closest object. Note: this point is in the **global** coordinate system. .. _class_RayCast2D_get_exclude_parent_body: -- :ref:`bool` **get_exclude_parent_body** **(** **)** const +- :ref:`bool` **get_exclude_parent_body** **(** **)** const Returns whether this ray should hit your parent node, if it's a body. .. _class_RayCast2D_get_type_mask: -- :ref:`int` **get_type_mask** **(** **)** const +- :ref:`int` **get_type_mask** **(** **)** const Returns the type mask (types of objects to detect) for this ray. The value is a sum (bitwise OR'd) of constants available for :ref:`Physics2DDirectSpaceState`. .. _class_RayCast2D_is_colliding: -- :ref:`bool` **is_colliding** **(** **)** const +- :ref:`bool` **is_colliding** **(** **)** const Return whether the closest object the ray is pointing to is colliding with the vector (considering the vector length). .. _class_RayCast2D_is_enabled: -- :ref:`bool` **is_enabled** **(** **)** const +- :ref:`bool` **is_enabled** **(** **)** const Returns whether this raycast is enabled or not. .. _class_RayCast2D_remove_exception: -- void **remove_exception** **(** :ref:`Object` node **)** +- void **remove_exception** **(** :ref:`Object` node **)** Removes a collision exception so the ray does report collisions with the specified node. .. _class_RayCast2D_remove_exception_rid: -- void **remove_exception_rid** **(** :ref:`RID` rid **)** +- void **remove_exception_rid** **(** :ref:`RID` rid **)** Removes a collision exception so the ray does report collisions with the specified :ref:`RID`. .. _class_RayCast2D_set_cast_to: -- void **set_cast_to** **(** :ref:`Vector2` local_point **)** +- void **set_cast_to** **(** :ref:`Vector2` local_point **)** Sets the ray destination point, so that the ray will test from the ray's origin to ``local_point`` .. _class_RayCast2D_set_collision_layer: -- void **set_collision_layer** **(** :ref:`int` layer **)** +- void **set_collision_layer** **(** :ref:`int` layer **)** Set the mask to filter objects. Only objects with at least the same mask element set will be detected. .. _class_RayCast2D_set_enabled: -- void **set_enabled** **(** :ref:`bool` enabled **)** +- void **set_enabled** **(** :ref:`bool` enabled **)** Enables the RayCast2D. Only enabled raycasts will be able to query the space and report collisions. .. _class_RayCast2D_set_exclude_parent_body: -- void **set_exclude_parent_body** **(** :ref:`bool` mask **)** +- void **set_exclude_parent_body** **(** :ref:`bool` mask **)** Toggle whether this ray should hit your parent node, if it's a body. .. _class_RayCast2D_set_type_mask: -- void **set_type_mask** **(** :ref:`int` mask **)** +- void **set_type_mask** **(** :ref:`int` mask **)** Set the types of objects to detect. For ``mask`` use a logic sum (OR operation) of constants defined in :ref:`Physics2DDirectSpaceState`, eg. ``Physics2DDirectSpaceState.TYPE_MASK_STATIC_BODY | Physics2DDirectSpaceState.TYPE_MASK_KINEMATIC_BODY`` to detect only those two types. diff --git a/classes/class_rayshape.rst b/classes/class_rayshape.rst index 850fea39f..935093016 100644 --- a/classes/class_rayshape.rst +++ b/classes/class_rayshape.rst @@ -19,11 +19,11 @@ Ray shape for 3D collisions. Member Functions ---------------- -+----------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_length` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------+ -| void | :ref:`set_length` **(** :ref:`float` length **)** | -+----------------------------+---------------------------------------------------------------------------------------------+ ++----------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_length` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------+ +| void | :ref:`set_length` **(** :ref:`float` length **)** | ++----------------------------+-------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -43,10 +43,10 @@ Member Function Description .. _class_RayShape_get_length: -- :ref:`float` **get_length** **(** **)** const +- :ref:`float` **get_length** **(** **)** const .. _class_RayShape_set_length: -- void **set_length** **(** :ref:`float` length **)** +- void **set_length** **(** :ref:`float` length **)** diff --git a/classes/class_rayshape2d.rst b/classes/class_rayshape2d.rst index d89c356f7..ad7a3417d 100644 --- a/classes/class_rayshape2d.rst +++ b/classes/class_rayshape2d.rst @@ -19,11 +19,11 @@ Ray shape for 2D collisions. Member Functions ---------------- -+----------------------------+-----------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_length` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------+ -| void | :ref:`set_length` **(** :ref:`float` length **)** | -+----------------------------+-----------------------------------------------------------------------------------------------+ ++----------------------------+---------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_length` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------+ +| void | :ref:`set_length` **(** :ref:`float` length **)** | ++----------------------------+---------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -43,13 +43,13 @@ Member Function Description .. _class_RayShape2D_get_length: -- :ref:`float` **get_length** **(** **)** const +- :ref:`float` **get_length** **(** **)** const Return the length of the ray. .. _class_RayShape2D_set_length: -- void **set_length** **(** :ref:`float` length **)** +- void **set_length** **(** :ref:`float` length **)** Set the length of the ray. diff --git a/classes/class_rect2.rst b/classes/class_rect2.rst index ce22442f3..86c7b9618 100644 --- a/classes/class_rect2.rst +++ b/classes/class_rect2.rst @@ -17,33 +17,33 @@ Brief Description Member Functions ---------------- -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`Rect2` **(** :ref:`Vector2` position, :ref:`Vector2` size **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`Rect2` **(** :ref:`float` x, :ref:`float` y, :ref:`float` width, :ref:`float` height **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`clip` **(** :ref:`Rect2` b **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`encloses` **(** :ref:`Rect2` b **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`expand` **(** :ref:`Vector2` to **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_area` **(** **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`grow` **(** :ref:`float` by **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`grow_individual` **(** :ref:`float` left, :ref:`float` top, :ref:`float` right, :ref:`float` bottom **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`grow_margin` **(** :ref:`int` margin, :ref:`float` by **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_no_area` **(** **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_point` **(** :ref:`Vector2` point **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`intersects` **(** :ref:`Rect2` b **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`merge` **(** :ref:`Rect2` b **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`Rect2` **(** :ref:`Vector2` position, :ref:`Vector2` size **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`Rect2` **(** :ref:`float` x, :ref:`float` y, :ref:`float` width, :ref:`float` height **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`clip` **(** :ref:`Rect2` b **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`encloses` **(** :ref:`Rect2` b **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`expand` **(** :ref:`Vector2` to **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_area` **(** **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`grow` **(** :ref:`float` by **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`grow_individual` **(** :ref:`float` left, :ref:`float` top, :ref:`float` right, :ref:`float` bottom **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`grow_margin` **(** :ref:`int` margin, :ref:`float` by **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_no_area` **(** **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_point` **(** :ref:`Vector2` point **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`intersects` **(** :ref:`Rect2` b **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`merge` **(** :ref:`Rect2` b **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -71,75 +71,75 @@ Member Function Description .. _class_Rect2_Rect2: -- :ref:`Rect2` **Rect2** **(** :ref:`Vector2` position, :ref:`Vector2` size **)** +- :ref:`Rect2` **Rect2** **(** :ref:`Vector2` position, :ref:`Vector2` size **)** Construct a :ref:`Rect2` by position and size. .. _class_Rect2_Rect2: -- :ref:`Rect2` **Rect2** **(** :ref:`float` x, :ref:`float` y, :ref:`float` width, :ref:`float` height **)** +- :ref:`Rect2` **Rect2** **(** :ref:`float` x, :ref:`float` y, :ref:`float` width, :ref:`float` height **)** Construct a :ref:`Rect2` by x, y, width and height. .. _class_Rect2_clip: -- :ref:`Rect2` **clip** **(** :ref:`Rect2` b **)** +- :ref:`Rect2` **clip** **(** :ref:`Rect2` b **)** Returns the intersection of this :ref:`Rect2` and b. .. _class_Rect2_encloses: -- :ref:`bool` **encloses** **(** :ref:`Rect2` b **)** +- :ref:`bool` **encloses** **(** :ref:`Rect2` b **)** Returns true if this :ref:`Rect2` completely encloses another one. .. _class_Rect2_expand: -- :ref:`Rect2` **expand** **(** :ref:`Vector2` to **)** +- :ref:`Rect2` **expand** **(** :ref:`Vector2` to **)** Return this :ref:`Rect2` expanded to include a given point. .. _class_Rect2_get_area: -- :ref:`float` **get_area** **(** **)** +- :ref:`float` **get_area** **(** **)** Get the area of the :ref:`Rect2`. .. _class_Rect2_grow: -- :ref:`Rect2` **grow** **(** :ref:`float` by **)** +- :ref:`Rect2` **grow** **(** :ref:`float` by **)** Return a copy of the :ref:`Rect2` grown a given amount of units towards all the sides. .. _class_Rect2_grow_individual: -- :ref:`Rect2` **grow_individual** **(** :ref:`float` left, :ref:`float` top, :ref:`float` right, :ref:`float` bottom **)** +- :ref:`Rect2` **grow_individual** **(** :ref:`float` left, :ref:`float` top, :ref:`float` right, :ref:`float` bottom **)** .. _class_Rect2_grow_margin: -- :ref:`Rect2` **grow_margin** **(** :ref:`int` margin, :ref:`float` by **)** +- :ref:`Rect2` **grow_margin** **(** :ref:`int` margin, :ref:`float` by **)** .. _class_Rect2_has_no_area: -- :ref:`bool` **has_no_area** **(** **)** +- :ref:`bool` **has_no_area** **(** **)** Return true if the :ref:`Rect2` is flat or empty. .. _class_Rect2_has_point: -- :ref:`bool` **has_point** **(** :ref:`Vector2` point **)** +- :ref:`bool` **has_point** **(** :ref:`Vector2` point **)** Return true if the :ref:`Rect2` contains a point. .. _class_Rect2_intersects: -- :ref:`bool` **intersects** **(** :ref:`Rect2` b **)** +- :ref:`bool` **intersects** **(** :ref:`Rect2` b **)** Return true if the :ref:`Rect2` overlaps with another. .. _class_Rect2_merge: -- :ref:`Rect2` **merge** **(** :ref:`Rect2` b **)** +- :ref:`Rect2` **merge** **(** :ref:`Rect2` b **)** Combine this :ref:`Rect2` with another, a larger one is returned that contains both. diff --git a/classes/class_rect3.rst b/classes/class_rect3.rst index 81158c0ed..903b50c20 100644 --- a/classes/class_rect3.rst +++ b/classes/class_rect3.rst @@ -17,49 +17,49 @@ Axis-Aligned Bounding Box. Member Functions ---------------- -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect3` | :ref:`Rect3` **(** :ref:`Vector3` position, :ref:`Vector3` size **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`encloses` **(** :ref:`Rect3` with **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect3` | :ref:`expand` **(** :ref:`Vector3` to_point **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_area` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_endpoint` **(** :ref:`int` idx **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_longest_axis` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_longest_axis_index` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_longest_axis_size` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_shortest_axis` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_shortest_axis_index` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_shortest_axis_size` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_support` **(** :ref:`Vector3` dir **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect3` | :ref:`grow` **(** :ref:`float` by **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_no_area` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_no_surface` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_point` **(** :ref:`Vector3` point **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect3` | :ref:`intersection` **(** :ref:`Rect3` with **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`intersects` **(** :ref:`Rect3` with **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`intersects_plane` **(** :ref:`Plane` plane **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`intersects_segment` **(** :ref:`Vector3` from, :ref:`Vector3` to **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect3` | :ref:`merge` **(** :ref:`Rect3` with **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect3` | :ref:`Rect3` **(** :ref:`Vector3` position, :ref:`Vector3` size **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`encloses` **(** :ref:`Rect3` with **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect3` | :ref:`expand` **(** :ref:`Vector3` to_point **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_area` **(** **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_endpoint` **(** :ref:`int` idx **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_longest_axis` **(** **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_longest_axis_index` **(** **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_longest_axis_size` **(** **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_shortest_axis` **(** **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_shortest_axis_index` **(** **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_shortest_axis_size` **(** **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_support` **(** :ref:`Vector3` dir **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect3` | :ref:`grow` **(** :ref:`float` by **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_no_area` **(** **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_no_surface` **(** **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_point` **(** :ref:`Vector3` point **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect3` | :ref:`intersection` **(** :ref:`Rect3` with **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`intersects` **(** :ref:`Rect3` with **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`intersects_plane` **(** :ref:`Plane` plane **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`intersects_segment` **(** :ref:`Vector3` from, :ref:`Vector3` to **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect3` | :ref:`merge` **(** :ref:`Rect3` with **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -87,127 +87,127 @@ Member Function Description .. _class_Rect3_Rect3: -- :ref:`Rect3` **Rect3** **(** :ref:`Vector3` position, :ref:`Vector3` size **)** +- :ref:`Rect3` **Rect3** **(** :ref:`Vector3` position, :ref:`Vector3` size **)** Optional constructor, accepts position and size. .. _class_Rect3_encloses: -- :ref:`bool` **encloses** **(** :ref:`Rect3` with **)** +- :ref:`bool` **encloses** **(** :ref:`Rect3` with **)** Return true if this :ref:`Rect3` completely encloses another one. .. _class_Rect3_expand: -- :ref:`Rect3` **expand** **(** :ref:`Vector3` to_point **)** +- :ref:`Rect3` **expand** **(** :ref:`Vector3` to_point **)** Return this :ref:`Rect3` expanded to include a given point. .. _class_Rect3_get_area: -- :ref:`float` **get_area** **(** **)** +- :ref:`float` **get_area** **(** **)** Get the area of the :ref:`Rect3`. .. _class_Rect3_get_endpoint: -- :ref:`Vector3` **get_endpoint** **(** :ref:`int` idx **)** +- :ref:`Vector3` **get_endpoint** **(** :ref:`int` idx **)** Get the position of the 8 endpoints of the :ref:`Rect3` in space. .. _class_Rect3_get_longest_axis: -- :ref:`Vector3` **get_longest_axis** **(** **)** +- :ref:`Vector3` **get_longest_axis** **(** **)** Return the normalized longest axis of the :ref:`Rect3`. .. _class_Rect3_get_longest_axis_index: -- :ref:`int` **get_longest_axis_index** **(** **)** +- :ref:`int` **get_longest_axis_index** **(** **)** Return the index of the longest axis of the :ref:`Rect3` (according to :ref:`Vector3`::AXIS\* enum). .. _class_Rect3_get_longest_axis_size: -- :ref:`float` **get_longest_axis_size** **(** **)** +- :ref:`float` **get_longest_axis_size** **(** **)** Return the scalar length of the longest axis of the :ref:`Rect3`. .. _class_Rect3_get_shortest_axis: -- :ref:`Vector3` **get_shortest_axis** **(** **)** +- :ref:`Vector3` **get_shortest_axis** **(** **)** Return the normalized shortest axis of the :ref:`Rect3`. .. _class_Rect3_get_shortest_axis_index: -- :ref:`int` **get_shortest_axis_index** **(** **)** +- :ref:`int` **get_shortest_axis_index** **(** **)** Return the index of the shortest axis of the :ref:`Rect3` (according to :ref:`Vector3`::AXIS\* enum). .. _class_Rect3_get_shortest_axis_size: -- :ref:`float` **get_shortest_axis_size** **(** **)** +- :ref:`float` **get_shortest_axis_size** **(** **)** Return the scalar length of the shortest axis of the :ref:`Rect3`. .. _class_Rect3_get_support: -- :ref:`Vector3` **get_support** **(** :ref:`Vector3` dir **)** +- :ref:`Vector3` **get_support** **(** :ref:`Vector3` dir **)** Return the support point in a given direction. This is useful for collision detection algorithms. .. _class_Rect3_grow: -- :ref:`Rect3` **grow** **(** :ref:`float` by **)** +- :ref:`Rect3` **grow** **(** :ref:`float` by **)** Return a copy of the :ref:`Rect3` grown a given amount of units towards all the sides. .. _class_Rect3_has_no_area: -- :ref:`bool` **has_no_area** **(** **)** +- :ref:`bool` **has_no_area** **(** **)** Return true if the :ref:`Rect3` is flat or empty. .. _class_Rect3_has_no_surface: -- :ref:`bool` **has_no_surface** **(** **)** +- :ref:`bool` **has_no_surface** **(** **)** Return true if the :ref:`Rect3` is empty. .. _class_Rect3_has_point: -- :ref:`bool` **has_point** **(** :ref:`Vector3` point **)** +- :ref:`bool` **has_point** **(** :ref:`Vector3` point **)** Return true if the :ref:`Rect3` contains a point. .. _class_Rect3_intersection: -- :ref:`Rect3` **intersection** **(** :ref:`Rect3` with **)** +- :ref:`Rect3` **intersection** **(** :ref:`Rect3` with **)** Return the intersection between two :ref:`Rect3`. An empty Rect3 (size 0,0,0) is returned on failure. .. _class_Rect3_intersects: -- :ref:`bool` **intersects** **(** :ref:`Rect3` with **)** +- :ref:`bool` **intersects** **(** :ref:`Rect3` with **)** Return true if the :ref:`Rect3` overlaps with another. .. _class_Rect3_intersects_plane: -- :ref:`bool` **intersects_plane** **(** :ref:`Plane` plane **)** +- :ref:`bool` **intersects_plane** **(** :ref:`Plane` plane **)** Return true if the :ref:`Rect3` is at both sides of a plane. .. _class_Rect3_intersects_segment: -- :ref:`bool` **intersects_segment** **(** :ref:`Vector3` from, :ref:`Vector3` to **)** +- :ref:`bool` **intersects_segment** **(** :ref:`Vector3` from, :ref:`Vector3` to **)** Return true if the :ref:`Rect3` intersects the line segment between from and to .. _class_Rect3_merge: -- :ref:`Rect3` **merge** **(** :ref:`Rect3` with **)** +- :ref:`Rect3` **merge** **(** :ref:`Rect3` with **)** Combine this :ref:`Rect3` with another, a larger one is returned that contains both. diff --git a/classes/class_rectangleshape2d.rst b/classes/class_rectangleshape2d.rst index fd45152d0..de22c759a 100644 --- a/classes/class_rectangleshape2d.rst +++ b/classes/class_rectangleshape2d.rst @@ -19,11 +19,11 @@ Rectangle shape for 2D collisions. Member Functions ---------------- -+--------------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_extents` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_extents` **(** :ref:`Vector2` extents **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------+ ++--------------------------------+----------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_extents` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_extents` **(** :ref:`Vector2` extents **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -43,13 +43,13 @@ Member Function Description .. _class_RectangleShape2D_get_extents: -- :ref:`Vector2` **get_extents** **(** **)** const +- :ref:`Vector2` **get_extents** **(** **)** const Return the half extents, the actual width and height of this shape is twice the half extents. .. _class_RectangleShape2D_set_extents: -- void **set_extents** **(** :ref:`Vector2` extents **)** +- void **set_extents** **(** :ref:`Vector2` extents **)** Set the half extents, the actual width and height of this shape is twice the half extents. diff --git a/classes/class_reference.rst b/classes/class_reference.rst index 7aca05367..5fa359152 100644 --- a/classes/class_reference.rst +++ b/classes/class_reference.rst @@ -21,13 +21,13 @@ Base class for anything that keeps a reference count. Member Functions ---------------- -+--------------------------+--------------------------------------------------------------+ -| :ref:`bool` | :ref:`init_ref` **(** **)** | -+--------------------------+--------------------------------------------------------------+ -| :ref:`bool` | :ref:`reference` **(** **)** | -+--------------------------+--------------------------------------------------------------+ -| :ref:`bool` | :ref:`unreference` **(** **)** | -+--------------------------+--------------------------------------------------------------+ ++--------------------------+-------------------------------------------------------------+ +| :ref:`bool` | :ref:`init_ref` **(** **)** | ++--------------------------+-------------------------------------------------------------+ +| :ref:`bool` | :ref:`reference` **(** **)** | ++--------------------------+-------------------------------------------------------------+ +| :ref:`bool` | :ref:`unreference` **(** **)** | ++--------------------------+-------------------------------------------------------------+ Description ----------- @@ -39,17 +39,17 @@ Member Function Description .. _class_Reference_init_ref: -- :ref:`bool` **init_ref** **(** **)** +- :ref:`bool` **init_ref** **(** **)** .. _class_Reference_reference: -- :ref:`bool` **reference** **(** **)** +- :ref:`bool` **reference** **(** **)** Increase the internal reference counter. Use this only if you really know what you are doing. .. _class_Reference_unreference: -- :ref:`bool` **unreference** **(** **)** +- :ref:`bool` **unreference** **(** **)** Decrease the internal reference counter. Use this only if you really know what you are doing. diff --git a/classes/class_reflectionprobe.rst b/classes/class_reflectionprobe.rst index 6f3fb9843..317febcb8 100644 --- a/classes/class_reflectionprobe.rst +++ b/classes/class_reflectionprobe.rst @@ -19,55 +19,55 @@ Brief Description Member Functions ---------------- -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`are_shadows_enabled` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_cull_mask` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_extents` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_intensity` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_interior_ambient` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_interior_ambient_energy` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_interior_ambient_probe_contribution` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_max_distance` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_origin_offset` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_update_mode` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_box_projection_enabled` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_set_as_interior` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_as_interior` **(** :ref:`bool` enable **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cull_mask` **(** :ref:`int` layers **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_enable_box_projection` **(** :ref:`bool` enable **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_enable_shadows` **(** :ref:`bool` enable **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_extents` **(** :ref:`Vector3` extents **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_intensity` **(** :ref:`float` intensity **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_interior_ambient` **(** :ref:`Color` ambient **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_interior_ambient_energy` **(** :ref:`float` ambient_energy **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_interior_ambient_probe_contribution` **(** :ref:`float` ambient_probe_contribution **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_max_distance` **(** :ref:`float` max_distance **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_origin_offset` **(** :ref:`Vector3` origin_offset **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_update_mode` **(** :ref:`int` mode **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`are_shadows_enabled` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_cull_mask` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_extents` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_intensity` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_interior_ambient` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_interior_ambient_energy` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_interior_ambient_probe_contribution` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_max_distance` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_origin_offset` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_update_mode` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_box_projection_enabled` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_set_as_interior` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_as_interior` **(** :ref:`bool` enable **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cull_mask` **(** :ref:`int` layers **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_enable_box_projection` **(** :ref:`bool` enable **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_enable_shadows` **(** :ref:`bool` enable **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_extents` **(** :ref:`Vector3` extents **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_intensity` **(** :ref:`float` intensity **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_interior_ambient` **(** :ref:`Color` ambient **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_interior_ambient_energy` **(** :ref:`float` ambient_energy **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_interior_ambient_probe_contribution` **(** :ref:`float` ambient_probe_contribution **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_max_distance` **(** :ref:`float` max_distance **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_origin_offset` **(** :ref:`Vector3` origin_offset **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_update_mode` **(** :ref:`int` mode **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -132,98 +132,98 @@ Member Function Description .. _class_ReflectionProbe_are_shadows_enabled: -- :ref:`bool` **are_shadows_enabled** **(** **)** const +- :ref:`bool` **are_shadows_enabled** **(** **)** const .. _class_ReflectionProbe_get_cull_mask: -- :ref:`int` **get_cull_mask** **(** **)** const +- :ref:`int` **get_cull_mask** **(** **)** const .. _class_ReflectionProbe_get_extents: -- :ref:`Vector3` **get_extents** **(** **)** const +- :ref:`Vector3` **get_extents** **(** **)** const .. _class_ReflectionProbe_get_intensity: -- :ref:`float` **get_intensity** **(** **)** const +- :ref:`float` **get_intensity** **(** **)** const .. _class_ReflectionProbe_get_interior_ambient: -- :ref:`Color` **get_interior_ambient** **(** **)** const +- :ref:`Color` **get_interior_ambient** **(** **)** const .. _class_ReflectionProbe_get_interior_ambient_energy: -- :ref:`float` **get_interior_ambient_energy** **(** **)** const +- :ref:`float` **get_interior_ambient_energy** **(** **)** const .. _class_ReflectionProbe_get_interior_ambient_probe_contribution: -- :ref:`float` **get_interior_ambient_probe_contribution** **(** **)** const +- :ref:`float` **get_interior_ambient_probe_contribution** **(** **)** const .. _class_ReflectionProbe_get_max_distance: -- :ref:`float` **get_max_distance** **(** **)** const +- :ref:`float` **get_max_distance** **(** **)** const .. _class_ReflectionProbe_get_origin_offset: -- :ref:`Vector3` **get_origin_offset** **(** **)** const +- :ref:`Vector3` **get_origin_offset** **(** **)** const .. _class_ReflectionProbe_get_update_mode: -- :ref:`int` **get_update_mode** **(** **)** const +- :ref:`int` **get_update_mode** **(** **)** const .. _class_ReflectionProbe_is_box_projection_enabled: -- :ref:`bool` **is_box_projection_enabled** **(** **)** const +- :ref:`bool` **is_box_projection_enabled** **(** **)** const .. _class_ReflectionProbe_is_set_as_interior: -- :ref:`bool` **is_set_as_interior** **(** **)** const +- :ref:`bool` **is_set_as_interior** **(** **)** const .. _class_ReflectionProbe_set_as_interior: -- void **set_as_interior** **(** :ref:`bool` enable **)** +- void **set_as_interior** **(** :ref:`bool` enable **)** .. _class_ReflectionProbe_set_cull_mask: -- void **set_cull_mask** **(** :ref:`int` layers **)** +- void **set_cull_mask** **(** :ref:`int` layers **)** .. _class_ReflectionProbe_set_enable_box_projection: -- void **set_enable_box_projection** **(** :ref:`bool` enable **)** +- void **set_enable_box_projection** **(** :ref:`bool` enable **)** .. _class_ReflectionProbe_set_enable_shadows: -- void **set_enable_shadows** **(** :ref:`bool` enable **)** +- void **set_enable_shadows** **(** :ref:`bool` enable **)** .. _class_ReflectionProbe_set_extents: -- void **set_extents** **(** :ref:`Vector3` extents **)** +- void **set_extents** **(** :ref:`Vector3` extents **)** .. _class_ReflectionProbe_set_intensity: -- void **set_intensity** **(** :ref:`float` intensity **)** +- void **set_intensity** **(** :ref:`float` intensity **)** .. _class_ReflectionProbe_set_interior_ambient: -- void **set_interior_ambient** **(** :ref:`Color` ambient **)** +- void **set_interior_ambient** **(** :ref:`Color` ambient **)** .. _class_ReflectionProbe_set_interior_ambient_energy: -- void **set_interior_ambient_energy** **(** :ref:`float` ambient_energy **)** +- void **set_interior_ambient_energy** **(** :ref:`float` ambient_energy **)** .. _class_ReflectionProbe_set_interior_ambient_probe_contribution: -- void **set_interior_ambient_probe_contribution** **(** :ref:`float` ambient_probe_contribution **)** +- void **set_interior_ambient_probe_contribution** **(** :ref:`float` ambient_probe_contribution **)** .. _class_ReflectionProbe_set_max_distance: -- void **set_max_distance** **(** :ref:`float` max_distance **)** +- void **set_max_distance** **(** :ref:`float` max_distance **)** .. _class_ReflectionProbe_set_origin_offset: -- void **set_origin_offset** **(** :ref:`Vector3` origin_offset **)** +- void **set_origin_offset** **(** :ref:`Vector3` origin_offset **)** .. _class_ReflectionProbe_set_update_mode: -- void **set_update_mode** **(** :ref:`int` mode **)** +- void **set_update_mode** **(** :ref:`int` mode **)** diff --git a/classes/class_regex.rst b/classes/class_regex.rst index a56af0f70..258d362d5 100644 --- a/classes/class_regex.rst +++ b/classes/class_regex.rst @@ -19,23 +19,23 @@ Simple regular expression matcher. Member Functions ---------------- -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`compile` **(** :ref:`String` pattern **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_group_count` **(** **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_names` **(** **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_pattern` **(** **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_valid` **(** **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RegExMatch` | :ref:`search` **(** :ref:`String` subject, :ref:`int` offset=0, :ref:`int` end=-1 **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`sub` **(** :ref:`String` subject, :ref:`String` replacement, :ref:`bool` all=false, :ref:`int` offset=0, :ref:`int` end=-1 **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`compile` **(** :ref:`String` pattern **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_group_count` **(** **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_names` **(** **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_pattern` **(** **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_valid` **(** **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RegExMatch` | :ref:`search` **(** :ref:`String` subject, :ref:`int` offset=0, :ref:`int` end=-1 **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`sub` **(** :ref:`String` subject, :ref:`String` replacement, :ref:`bool` all=false, :ref:`int` offset=0, :ref:`int` end=-1 **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -93,49 +93,49 @@ Member Function Description .. _class_RegEx_clear: -- void **clear** **(** **)** +- void **clear** **(** **)** This method resets the state of the object, as it was freshly created. Namely, it unassigns the regular expression of this object. .. _class_RegEx_compile: -- :ref:`int` **compile** **(** :ref:`String` pattern **)** +- :ref:`int` **compile** **(** :ref:`String` pattern **)** Compiles and assign the search pattern to use. .. _class_RegEx_get_group_count: -- :ref:`int` **get_group_count** **(** **)** const +- :ref:`int` **get_group_count** **(** **)** const Returns the number of numeric capturing groups. .. _class_RegEx_get_names: -- :ref:`Array` **get_names** **(** **)** const +- :ref:`Array` **get_names** **(** **)** const Returns an array of names of named capturing groups. .. _class_RegEx_get_pattern: -- :ref:`String` **get_pattern** **(** **)** const +- :ref:`String` **get_pattern** **(** **)** const Returns the search pattern used to compile the code. .. _class_RegEx_is_valid: -- :ref:`bool` **is_valid** **(** **)** const +- :ref:`bool` **is_valid** **(** **)** const Returns whether this object has a valid search pattern assigned. .. _class_RegEx_search: -- :ref:`RegExMatch` **search** **(** :ref:`String` subject, :ref:`int` offset=0, :ref:`int` end=-1 **)** const +- :ref:`RegExMatch` **search** **(** :ref:`String` subject, :ref:`int` offset=0, :ref:`int` end=-1 **)** const Searches the text for the compiled pattern. Returns a :ref:`RegExMatch` container of the first matching result if found, otherwise null. The region to search within can be specified without modifying where the start and end anchor would be. .. _class_RegEx_sub: -- :ref:`String` **sub** **(** :ref:`String` subject, :ref:`String` replacement, :ref:`bool` all=false, :ref:`int` offset=0, :ref:`int` end=-1 **)** const +- :ref:`String` **sub** **(** :ref:`String` subject, :ref:`String` replacement, :ref:`bool` all=false, :ref:`int` offset=0, :ref:`int` end=-1 **)** const Searches the text for the compiled pattern and replaces it with the specified string. Escapes and backreferences such as ``\1`` and ``\g`` expanded and resolved. By default only the first instance is replaced but it can be changed for all instances (global replacement). The region to search within can be specified without modifying where the start and end anchor would be. diff --git a/classes/class_regexmatch.rst b/classes/class_regexmatch.rst index 0b858b63e..4ec080395 100644 --- a/classes/class_regexmatch.rst +++ b/classes/class_regexmatch.rst @@ -19,21 +19,21 @@ Contains the results of a regex search. Member Functions ---------------- -+--------------------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_end` **(** :ref:`Variant` name=0 **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_group_count` **(** **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_names` **(** **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_start` **(** :ref:`Variant` name=0 **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_string` **(** :ref:`Variant` name=0 **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_strings` **(** **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_subject` **(** **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------+ ++--------------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_end` **(** :ref:`Variant` name=0 **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_group_count` **(** **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_names` **(** **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_start` **(** :ref:`Variant` name=0 **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_string` **(** :ref:`Variant` name=0 **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_strings` **(** **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_subject` **(** **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------+ Description ----------- @@ -45,43 +45,43 @@ Member Function Description .. _class_RegExMatch_get_end: -- :ref:`int` **get_end** **(** :ref:`Variant` name=0 **)** const +- :ref:`int` **get_end** **(** :ref:`Variant` name=0 **)** const Returns the end position of the match in the source string. An integer can be specified for numeric groups or a string for named groups. Returns -1 if that group wasn't found or doesn't exist. Defaults to 0 (whole pattern). .. _class_RegExMatch_get_group_count: -- :ref:`int` **get_group_count** **(** **)** const +- :ref:`int` **get_group_count** **(** **)** const Returns the number of numeric capturing groups. .. _class_RegExMatch_get_names: -- :ref:`Dictionary` **get_names** **(** **)** const +- :ref:`Dictionary` **get_names** **(** **)** const Returns an array of names of named capturing groups. .. _class_RegExMatch_get_start: -- :ref:`int` **get_start** **(** :ref:`Variant` name=0 **)** const +- :ref:`int` **get_start** **(** :ref:`Variant` name=0 **)** const Returns the starting position of the match in the source string. An integer can be specified for numeric groups or a string for named groups. Returns -1 if that group wasn't found or doesn't exist. Defaults to 0 (whole pattern). .. _class_RegExMatch_get_string: -- :ref:`String` **get_string** **(** :ref:`Variant` name=0 **)** const +- :ref:`String` **get_string** **(** :ref:`Variant` name=0 **)** const Returns the result of the match in the source string. An integer can be specified for numeric groups or a string for named groups. Returns -1 if that group wasn't found or doesn't exist. Defaults to 0 (whole pattern). .. _class_RegExMatch_get_strings: -- :ref:`Array` **get_strings** **(** **)** const +- :ref:`Array` **get_strings** **(** **)** const Returns an :ref:`Array` of the matches in the source string. .. _class_RegExMatch_get_subject: -- :ref:`String` **get_subject** **(** **)** const +- :ref:`String` **get_subject** **(** **)** const Returns the source string used with the search pattern to find this matching result. diff --git a/classes/class_remotetransform.rst b/classes/class_remotetransform.rst index dd0540676..4b5cdc241 100644 --- a/classes/class_remotetransform.rst +++ b/classes/class_remotetransform.rst @@ -19,27 +19,27 @@ Brief Description Member Functions ---------------- -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_remote_node` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_update_position` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_update_rotation` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_update_scale` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_use_global_coordinates` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_remote_node` **(** :ref:`NodePath` path **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_update_position` **(** :ref:`bool` update_remote_position **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_update_rotation` **(** :ref:`bool` update_remote_rotation **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_update_scale` **(** :ref:`bool` update_remote_scale **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_global_coordinates` **(** :ref:`bool` use_global_coordinates **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_remote_node` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_update_position` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_update_rotation` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_update_scale` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_use_global_coordinates` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_remote_node` **(** :ref:`NodePath` path **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_update_position` **(** :ref:`bool` update_remote_position **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_update_rotation` **(** :ref:`bool` update_remote_rotation **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_update_scale` **(** :ref:`bool` update_remote_scale **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_global_coordinates` **(** :ref:`bool` use_global_coordinates **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -70,42 +70,42 @@ Member Function Description .. _class_RemoteTransform_get_remote_node: -- :ref:`NodePath` **get_remote_node** **(** **)** const +- :ref:`NodePath` **get_remote_node** **(** **)** const .. _class_RemoteTransform_get_update_position: -- :ref:`bool` **get_update_position** **(** **)** const +- :ref:`bool` **get_update_position** **(** **)** const .. _class_RemoteTransform_get_update_rotation: -- :ref:`bool` **get_update_rotation** **(** **)** const +- :ref:`bool` **get_update_rotation** **(** **)** const .. _class_RemoteTransform_get_update_scale: -- :ref:`bool` **get_update_scale** **(** **)** const +- :ref:`bool` **get_update_scale** **(** **)** const .. _class_RemoteTransform_get_use_global_coordinates: -- :ref:`bool` **get_use_global_coordinates** **(** **)** const +- :ref:`bool` **get_use_global_coordinates** **(** **)** const .. _class_RemoteTransform_set_remote_node: -- void **set_remote_node** **(** :ref:`NodePath` path **)** +- void **set_remote_node** **(** :ref:`NodePath` path **)** .. _class_RemoteTransform_set_update_position: -- void **set_update_position** **(** :ref:`bool` update_remote_position **)** +- void **set_update_position** **(** :ref:`bool` update_remote_position **)** .. _class_RemoteTransform_set_update_rotation: -- void **set_update_rotation** **(** :ref:`bool` update_remote_rotation **)** +- void **set_update_rotation** **(** :ref:`bool` update_remote_rotation **)** .. _class_RemoteTransform_set_update_scale: -- void **set_update_scale** **(** :ref:`bool` update_remote_scale **)** +- void **set_update_scale** **(** :ref:`bool` update_remote_scale **)** .. _class_RemoteTransform_set_use_global_coordinates: -- void **set_use_global_coordinates** **(** :ref:`bool` use_global_coordinates **)** +- void **set_use_global_coordinates** **(** :ref:`bool` use_global_coordinates **)** diff --git a/classes/class_remotetransform2d.rst b/classes/class_remotetransform2d.rst index 60e8b5954..1bcdcacb7 100644 --- a/classes/class_remotetransform2d.rst +++ b/classes/class_remotetransform2d.rst @@ -19,27 +19,27 @@ Brief Description Member Functions ---------------- -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_remote_node` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_update_position` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_update_rotation` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_update_scale` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_use_global_coordinates` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_remote_node` **(** :ref:`NodePath` path **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_update_position` **(** :ref:`bool` update_remote_position **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_update_rotation` **(** :ref:`bool` update_remote_rotation **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_update_scale` **(** :ref:`bool` update_remote_scale **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_global_coordinates` **(** :ref:`bool` use_global_coordinates **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_remote_node` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_update_position` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_update_rotation` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_update_scale` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_use_global_coordinates` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_remote_node` **(** :ref:`NodePath` path **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_update_position` **(** :ref:`bool` update_remote_position **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_update_rotation` **(** :ref:`bool` update_remote_rotation **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_update_scale` **(** :ref:`bool` update_remote_scale **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_global_coordinates` **(** :ref:`bool` use_global_coordinates **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -70,42 +70,42 @@ Member Function Description .. _class_RemoteTransform2D_get_remote_node: -- :ref:`NodePath` **get_remote_node** **(** **)** const +- :ref:`NodePath` **get_remote_node** **(** **)** const .. _class_RemoteTransform2D_get_update_position: -- :ref:`bool` **get_update_position** **(** **)** const +- :ref:`bool` **get_update_position** **(** **)** const .. _class_RemoteTransform2D_get_update_rotation: -- :ref:`bool` **get_update_rotation** **(** **)** const +- :ref:`bool` **get_update_rotation** **(** **)** const .. _class_RemoteTransform2D_get_update_scale: -- :ref:`bool` **get_update_scale** **(** **)** const +- :ref:`bool` **get_update_scale** **(** **)** const .. _class_RemoteTransform2D_get_use_global_coordinates: -- :ref:`bool` **get_use_global_coordinates** **(** **)** const +- :ref:`bool` **get_use_global_coordinates** **(** **)** const .. _class_RemoteTransform2D_set_remote_node: -- void **set_remote_node** **(** :ref:`NodePath` path **)** +- void **set_remote_node** **(** :ref:`NodePath` path **)** .. _class_RemoteTransform2D_set_update_position: -- void **set_update_position** **(** :ref:`bool` update_remote_position **)** +- void **set_update_position** **(** :ref:`bool` update_remote_position **)** .. _class_RemoteTransform2D_set_update_rotation: -- void **set_update_rotation** **(** :ref:`bool` update_remote_rotation **)** +- void **set_update_rotation** **(** :ref:`bool` update_remote_rotation **)** .. _class_RemoteTransform2D_set_update_scale: -- void **set_update_scale** **(** :ref:`bool` update_remote_scale **)** +- void **set_update_scale** **(** :ref:`bool` update_remote_scale **)** .. _class_RemoteTransform2D_set_use_global_coordinates: -- void **set_use_global_coordinates** **(** :ref:`bool` use_global_coordinates **)** +- void **set_use_global_coordinates** **(** :ref:`bool` use_global_coordinates **)** diff --git a/classes/class_resource.rst b/classes/class_resource.rst index 3585d6d5c..f11cb80a4 100644 --- a/classes/class_resource.rst +++ b/classes/class_resource.rst @@ -21,38 +21,38 @@ Base class for all resources. Member Functions ---------------- -+----------------------------------+-----------------------------------------------------------------------------------------------------------+ -| void | :ref:`_setup_local_to_scene` **(** **)** virtual | -+----------------------------------+-----------------------------------------------------------------------------------------------------------+ -| :ref:`Resource` | :ref:`duplicate` **(** :ref:`bool` subresources=false **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_local_scene` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_name` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_path` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_rid` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_local_to_scene` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_local_to_scene` **(** :ref:`bool` enable **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_name` **(** :ref:`String` name **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_path` **(** :ref:`String` path **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------+ -| void | :ref:`setup_local_to_scene` **(** **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------+ -| void | :ref:`take_over_path` **(** :ref:`String` path **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------+ ++----------------------------------+---------------------------------------------------------------------------------------------------------+ +| void | :ref:`_setup_local_to_scene` **(** **)** virtual | ++----------------------------------+---------------------------------------------------------------------------------------------------------+ +| :ref:`Resource` | :ref:`duplicate` **(** :ref:`bool` subresources=false **)** const | ++----------------------------------+---------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`get_local_scene` **(** **)** const | ++----------------------------------+---------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_name` **(** **)** const | ++----------------------------------+---------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_path` **(** **)** const | ++----------------------------------+---------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_rid` **(** **)** const | ++----------------------------------+---------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_local_to_scene` **(** **)** const | ++----------------------------------+---------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_local_to_scene` **(** :ref:`bool` enable **)** | ++----------------------------------+---------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_name` **(** :ref:`String` name **)** | ++----------------------------------+---------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_path` **(** :ref:`String` path **)** | ++----------------------------------+---------------------------------------------------------------------------------------------------------+ +| void | :ref:`setup_local_to_scene` **(** **)** | ++----------------------------------+---------------------------------------------------------------------------------------------------------+ +| void | :ref:`take_over_path` **(** :ref:`String` path **)** | ++----------------------------------+---------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_Resource_changed: -- **changed** **(** **)** +- **changed** **(** **)** Member Variables @@ -81,61 +81,61 @@ Member Function Description .. _class_Resource__setup_local_to_scene: -- void **_setup_local_to_scene** **(** **)** virtual +- void **_setup_local_to_scene** **(** **)** virtual .. _class_Resource_duplicate: -- :ref:`Resource` **duplicate** **(** :ref:`bool` subresources=false **)** const +- :ref:`Resource` **duplicate** **(** :ref:`bool` subresources=false **)** const .. _class_Resource_get_local_scene: -- :ref:`Node` **get_local_scene** **(** **)** const +- :ref:`Node` **get_local_scene** **(** **)** const .. _class_Resource_get_name: -- :ref:`String` **get_name** **(** **)** const +- :ref:`String` **get_name** **(** **)** const Return the name of the resources, any name is valid (it doesn't have to be unique). Name is for descriptive purposes only. .. _class_Resource_get_path: -- :ref:`String` **get_path** **(** **)** const +- :ref:`String` **get_path** **(** **)** const Return the path of the resource. This is useful mainly for editors when saving/loading, and shouldn't be changed by anything else. .. _class_Resource_get_rid: -- :ref:`RID` **get_rid** **(** **)** const +- :ref:`RID` **get_rid** **(** **)** const Return the RID of the resource (or an empty RID). Many resources (such as :ref:`Texture`, :ref:`Mesh`, etc) are high level abstractions of resources stored in a server, so this function will return the original RID. .. _class_Resource_is_local_to_scene: -- :ref:`bool` **is_local_to_scene** **(** **)** const +- :ref:`bool` **is_local_to_scene** **(** **)** const .. _class_Resource_set_local_to_scene: -- void **set_local_to_scene** **(** :ref:`bool` enable **)** +- void **set_local_to_scene** **(** :ref:`bool` enable **)** .. _class_Resource_set_name: -- void **set_name** **(** :ref:`String` name **)** +- void **set_name** **(** :ref:`String` name **)** Set the name of the resources, any name is valid (it doesn't have to be unique). Name is for descriptive purposes only. .. _class_Resource_set_path: -- void **set_path** **(** :ref:`String` path **)** +- void **set_path** **(** :ref:`String` path **)** Set the path of the resource. This is useful mainly for editors when saving/loading, and shouldn't be changed by anything else. Fails if another :ref:`Resource` already has path "path". .. _class_Resource_setup_local_to_scene: -- void **setup_local_to_scene** **(** **)** +- void **setup_local_to_scene** **(** **)** .. _class_Resource_take_over_path: -- void **take_over_path** **(** :ref:`String` path **)** +- void **take_over_path** **(** :ref:`String` path **)** Set the path of the resource. Differs from set_path(), if another :ref:`Resource` exists with "path" it over-takes it, instead of failing. diff --git a/classes/class_resourceinteractiveloader.rst b/classes/class_resourceinteractiveloader.rst index b17a5d136..ac5ce1277 100644 --- a/classes/class_resourceinteractiveloader.rst +++ b/classes/class_resourceinteractiveloader.rst @@ -19,17 +19,17 @@ Interactive Resource Loader. Member Functions ---------------- -+----------------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`Resource` | :ref:`get_resource` **(** **)** | -+----------------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_stage` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_stage_count` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`poll` **(** **)** | -+----------------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`wait` **(** **)** | -+----------------------------------+--------------------------------------------------------------------------------------------+ ++----------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`Resource` | :ref:`get_resource` **(** **)** | ++----------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_stage` **(** **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_stage_count` **(** **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`poll` **(** **)** | ++----------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`wait` **(** **)** | ++----------------------------------+-------------------------------------------------------------------------------------------+ Description ----------- @@ -41,30 +41,30 @@ Member Function Description .. _class_ResourceInteractiveLoader_get_resource: -- :ref:`Resource` **get_resource** **(** **)** +- :ref:`Resource` **get_resource** **(** **)** Return the loaded resource (only if loaded). Otherwise, returns null. .. _class_ResourceInteractiveLoader_get_stage: -- :ref:`int` **get_stage** **(** **)** const +- :ref:`int` **get_stage** **(** **)** const Return the load stage. The total amount of stages can be queried with :ref:`get_stage_count` .. _class_ResourceInteractiveLoader_get_stage_count: -- :ref:`int` **get_stage_count** **(** **)** const +- :ref:`int` **get_stage_count** **(** **)** const Return the total amount of stages (calls to :ref:`poll`) needed to completely load this resource. .. _class_ResourceInteractiveLoader_poll: -- :ref:`int` **poll** **(** **)** +- :ref:`int` **poll** **(** **)** Poll the load. If OK is returned, this means poll will have to be called again. If ERR_FILE_EOF is returned, them the load has finished and the resource can be obtained by calling :ref:`get_resource`. .. _class_ResourceInteractiveLoader_wait: -- :ref:`int` **wait** **(** **)** +- :ref:`int` **wait** **(** **)** diff --git a/classes/class_resourceloader.rst b/classes/class_resourceloader.rst index 674106848..7f5f35149 100644 --- a/classes/class_resourceloader.rst +++ b/classes/class_resourceloader.rst @@ -19,19 +19,19 @@ Resource Loader. Member Functions ---------------- -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_dependencies` **(** :ref:`String` path **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_recognized_extensions_for_type` **(** :ref:`String` type **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has` **(** :ref:`String` path **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Resource` | :ref:`load` **(** :ref:`String` path, :ref:`String` type_hint="", :ref:`bool` p_no_cache=false **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ResourceInteractiveLoader` | :ref:`load_interactive` **(** :ref:`String` path, :ref:`String` type_hint="" **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_abort_on_missing_resources` **(** :ref:`bool` abort **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_dependencies` **(** :ref:`String` path **)** | ++--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_recognized_extensions_for_type` **(** :ref:`String` type **)** | ++--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has` **(** :ref:`String` path **)** | ++--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Resource` | :ref:`load` **(** :ref:`String` path, :ref:`String` type_hint="", :ref:`bool` p_no_cache=false **)** | ++--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ResourceInteractiveLoader` | :ref:`load_interactive` **(** :ref:`String` path, :ref:`String` type_hint="" **)** | ++--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_abort_on_missing_resources` **(** :ref:`bool` abort **)** | ++--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -43,31 +43,31 @@ Member Function Description .. _class_ResourceLoader_get_dependencies: -- :ref:`PoolStringArray` **get_dependencies** **(** :ref:`String` path **)** +- :ref:`PoolStringArray` **get_dependencies** **(** :ref:`String` path **)** .. _class_ResourceLoader_get_recognized_extensions_for_type: -- :ref:`PoolStringArray` **get_recognized_extensions_for_type** **(** :ref:`String` type **)** +- :ref:`PoolStringArray` **get_recognized_extensions_for_type** **(** :ref:`String` type **)** Return the list of recognized extensions for a resource type. .. _class_ResourceLoader_has: -- :ref:`bool` **has** **(** :ref:`String` path **)** +- :ref:`bool` **has** **(** :ref:`String` path **)** .. _class_ResourceLoader_load: -- :ref:`Resource` **load** **(** :ref:`String` path, :ref:`String` type_hint="", :ref:`bool` p_no_cache=false **)** +- :ref:`Resource` **load** **(** :ref:`String` path, :ref:`String` type_hint="", :ref:`bool` p_no_cache=false **)** .. _class_ResourceLoader_load_interactive: -- :ref:`ResourceInteractiveLoader` **load_interactive** **(** :ref:`String` path, :ref:`String` type_hint="" **)** +- :ref:`ResourceInteractiveLoader` **load_interactive** **(** :ref:`String` path, :ref:`String` type_hint="" **)** Load a resource interactively, the returned object allows to load with high granularity. .. _class_ResourceLoader_set_abort_on_missing_resources: -- void **set_abort_on_missing_resources** **(** :ref:`bool` abort **)** +- void **set_abort_on_missing_resources** **(** :ref:`bool` abort **)** Change the behavior on missing sub-resources. Default is to abort load. diff --git a/classes/class_resourcepreloader.rst b/classes/class_resourcepreloader.rst index 644c0910c..eafb8c0c0 100644 --- a/classes/class_resourcepreloader.rst +++ b/classes/class_resourcepreloader.rst @@ -19,19 +19,19 @@ Resource Preloader Node. Member Functions ---------------- -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_resource` **(** :ref:`String` name, :ref:`Resource` resource **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Resource` | :ref:`get_resource` **(** :ref:`String` name **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_resource_list` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_resource` **(** :ref:`String` name **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_resource` **(** :ref:`String` name **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rename_resource` **(** :ref:`String` name, :ref:`String` newname **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_resource` **(** :ref:`String` name, :ref:`Resource` resource **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Resource` | :ref:`get_resource` **(** :ref:`String` name **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_resource_list` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_resource` **(** :ref:`String` name **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_resource` **(** :ref:`String` name **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rename_resource` **(** :ref:`String` name, :ref:`String` newname **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -51,35 +51,35 @@ Member Function Description .. _class_ResourcePreloader_add_resource: -- void **add_resource** **(** :ref:`String` name, :ref:`Resource` resource **)** +- void **add_resource** **(** :ref:`String` name, :ref:`Resource` resource **)** .. _class_ResourcePreloader_get_resource: -- :ref:`Resource` **get_resource** **(** :ref:`String` name **)** const +- :ref:`Resource` **get_resource** **(** :ref:`String` name **)** const Return the resource given a text-id. .. _class_ResourcePreloader_get_resource_list: -- :ref:`PoolStringArray` **get_resource_list** **(** **)** const +- :ref:`PoolStringArray` **get_resource_list** **(** **)** const Return the list of resources inside the preloader. .. _class_ResourcePreloader_has_resource: -- :ref:`bool` **has_resource** **(** :ref:`String` name **)** const +- :ref:`bool` **has_resource** **(** :ref:`String` name **)** const Return true if the preloader has a given resource. .. _class_ResourcePreloader_remove_resource: -- void **remove_resource** **(** :ref:`String` name **)** +- void **remove_resource** **(** :ref:`String` name **)** Remove a resource from the preloader by text id. .. _class_ResourcePreloader_rename_resource: -- void **rename_resource** **(** :ref:`String` name, :ref:`String` newname **)** +- void **rename_resource** **(** :ref:`String` name, :ref:`String` newname **)** Rename a resource inside the preloader, from a text-id to a new text-id. diff --git a/classes/class_resourcesaver.rst b/classes/class_resourcesaver.rst index d0f3ec7a4..4e4f66f69 100644 --- a/classes/class_resourcesaver.rst +++ b/classes/class_resourcesaver.rst @@ -19,11 +19,11 @@ Resource Saving Interface. Member Functions ---------------- -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_recognized_extensions` **(** :ref:`Resource` type **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`save` **(** :ref:`String` path, :ref:`Resource` resource, :ref:`int` flags=0 **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_recognized_extensions` **(** :ref:`Resource` type **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`save` **(** :ref:`String` path, :ref:`Resource` resource, :ref:`int` flags=0 **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -45,13 +45,13 @@ Member Function Description .. _class_ResourceSaver_get_recognized_extensions: -- :ref:`PoolStringArray` **get_recognized_extensions** **(** :ref:`Resource` type **)** +- :ref:`PoolStringArray` **get_recognized_extensions** **(** :ref:`Resource` type **)** Return the list of extensions available for saving a resource of a given type. .. _class_ResourceSaver_save: -- :ref:`int` **save** **(** :ref:`String` path, :ref:`Resource` resource, :ref:`int` flags=0 **)** +- :ref:`int` **save** **(** :ref:`String` path, :ref:`Resource` resource, :ref:`int` flags=0 **)** Save a resource to disk, to a given path. diff --git a/classes/class_richtextlabel.rst b/classes/class_richtextlabel.rst index 2b90563a1..4f62a22cb 100644 --- a/classes/class_richtextlabel.rst +++ b/classes/class_richtextlabel.rst @@ -19,104 +19,104 @@ Label that displays rich text. Member Functions ---------------- -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_image` **(** :ref:`Texture` image **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_text` **(** :ref:`String` text **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`append_bbcode` **(** :ref:`String` bbcode **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_bbcode` **(** **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_line_count` **(** **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_percent_visible` **(** **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_tab_size` **(** **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_text` **(** **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_total_character_count` **(** **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`VScrollBar` | :ref:`get_v_scroll` **(** **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_visible_characters` **(** **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_visible_line_count` **(** **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_meta_underlined` **(** **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_overriding_selected_font_color` **(** **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_scroll_active` **(** **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_scroll_following` **(** **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_selection_enabled` **(** **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_using_bbcode` **(** **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`newline` **(** **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`parse_bbcode` **(** :ref:`String` bbcode **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`pop` **(** **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_align` **(** :ref:`int` align **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_cell` **(** **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_color` **(** :ref:`Color` color **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_font` **(** :ref:`Font` font **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_indent` **(** :ref:`int` level **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_list` **(** :ref:`int` type **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_meta` **(** :ref:`Variant` data **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_table` **(** :ref:`int` columns **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_underline` **(** **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`remove_line` **(** :ref:`int` line **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`scroll_to_line` **(** :ref:`int` line **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bbcode` **(** :ref:`String` text **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_meta_underline` **(** :ref:`bool` enable **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_override_selected_font_color` **(** :ref:`bool` override **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_percent_visible` **(** :ref:`float` percent_visible **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_scroll_active` **(** :ref:`bool` active **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_scroll_follow` **(** :ref:`bool` follow **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_selection_enabled` **(** :ref:`bool` enabled **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tab_size` **(** :ref:`int` spaces **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_table_column_expand` **(** :ref:`int` column, :ref:`bool` expand, :ref:`int` ratio **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_text` **(** :ref:`String` text **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_bbcode` **(** :ref:`bool` enable **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_visible_characters` **(** :ref:`int` amount **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_image` **(** :ref:`Texture` image **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_text` **(** :ref:`String` text **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`append_bbcode` **(** :ref:`String` bbcode **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_bbcode` **(** **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_line_count` **(** **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_percent_visible` **(** **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_tab_size` **(** **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_text` **(** **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_total_character_count` **(** **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`VScrollBar` | :ref:`get_v_scroll` **(** **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_visible_characters` **(** **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_visible_line_count` **(** **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_meta_underlined` **(** **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_overriding_selected_font_color` **(** **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_scroll_active` **(** **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_scroll_following` **(** **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_selection_enabled` **(** **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_using_bbcode` **(** **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`newline` **(** **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`parse_bbcode` **(** :ref:`String` bbcode **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`pop` **(** **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_align` **(** :ref:`int` align **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_cell` **(** **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_color` **(** :ref:`Color` color **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_font` **(** :ref:`Font` font **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_indent` **(** :ref:`int` level **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_list` **(** :ref:`int` type **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_meta` **(** :ref:`Variant` data **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_table` **(** :ref:`int` columns **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_underline` **(** **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`remove_line` **(** :ref:`int` line **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`scroll_to_line` **(** :ref:`int` line **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bbcode` **(** :ref:`String` text **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_meta_underline` **(** :ref:`bool` enable **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_override_selected_font_color` **(** :ref:`bool` override **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_percent_visible` **(** :ref:`float` percent_visible **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_scroll_active` **(** :ref:`bool` active **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_scroll_follow` **(** :ref:`bool` follow **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_selection_enabled` **(** :ref:`bool` enabled **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tab_size` **(** :ref:`int` spaces **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_table_column_expand` **(** :ref:`int` column, :ref:`bool` expand, :ref:`int` ratio **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_text` **(** :ref:`String` text **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_bbcode` **(** :ref:`bool` enable **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_visible_characters` **(** :ref:`int` amount **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_RichTextLabel_meta_clicked: -- **meta_clicked** **(** :ref:`Nil` meta **)** +- **meta_clicked** **(** :ref:`Nil` meta **)** Member Variables @@ -175,188 +175,188 @@ Member Function Description .. _class_RichTextLabel_add_image: -- void **add_image** **(** :ref:`Texture` image **)** +- void **add_image** **(** :ref:`Texture` image **)** .. _class_RichTextLabel_add_text: -- void **add_text** **(** :ref:`String` text **)** +- void **add_text** **(** :ref:`String` text **)** .. _class_RichTextLabel_append_bbcode: -- :ref:`int` **append_bbcode** **(** :ref:`String` bbcode **)** +- :ref:`int` **append_bbcode** **(** :ref:`String` bbcode **)** .. _class_RichTextLabel_clear: -- void **clear** **(** **)** +- void **clear** **(** **)** .. _class_RichTextLabel_get_bbcode: -- :ref:`String` **get_bbcode** **(** **)** const +- :ref:`String` **get_bbcode** **(** **)** const .. _class_RichTextLabel_get_line_count: -- :ref:`int` **get_line_count** **(** **)** const +- :ref:`int` **get_line_count** **(** **)** const .. _class_RichTextLabel_get_percent_visible: -- :ref:`float` **get_percent_visible** **(** **)** const +- :ref:`float` **get_percent_visible** **(** **)** const .. _class_RichTextLabel_get_tab_size: -- :ref:`int` **get_tab_size** **(** **)** const +- :ref:`int` **get_tab_size** **(** **)** const .. _class_RichTextLabel_get_text: -- :ref:`String` **get_text** **(** **)** +- :ref:`String` **get_text** **(** **)** Returns the raw text, stripping out the formatting information. .. _class_RichTextLabel_get_total_character_count: -- :ref:`int` **get_total_character_count** **(** **)** const +- :ref:`int` **get_total_character_count** **(** **)** const .. _class_RichTextLabel_get_v_scroll: -- :ref:`VScrollBar` **get_v_scroll** **(** **)** +- :ref:`VScrollBar` **get_v_scroll** **(** **)** .. _class_RichTextLabel_get_visible_characters: -- :ref:`int` **get_visible_characters** **(** **)** const +- :ref:`int` **get_visible_characters** **(** **)** const .. _class_RichTextLabel_get_visible_line_count: -- :ref:`int` **get_visible_line_count** **(** **)** const +- :ref:`int` **get_visible_line_count** **(** **)** const .. _class_RichTextLabel_is_meta_underlined: -- :ref:`bool` **is_meta_underlined** **(** **)** const +- :ref:`bool` **is_meta_underlined** **(** **)** const .. _class_RichTextLabel_is_overriding_selected_font_color: -- :ref:`bool` **is_overriding_selected_font_color** **(** **)** const +- :ref:`bool` **is_overriding_selected_font_color** **(** **)** const .. _class_RichTextLabel_is_scroll_active: -- :ref:`bool` **is_scroll_active** **(** **)** const +- :ref:`bool` **is_scroll_active** **(** **)** const .. _class_RichTextLabel_is_scroll_following: -- :ref:`bool` **is_scroll_following** **(** **)** const +- :ref:`bool` **is_scroll_following** **(** **)** const .. _class_RichTextLabel_is_selection_enabled: -- :ref:`bool` **is_selection_enabled** **(** **)** const +- :ref:`bool` **is_selection_enabled** **(** **)** const Return true if selecting the text inside this richtext is allowed. .. _class_RichTextLabel_is_using_bbcode: -- :ref:`bool` **is_using_bbcode** **(** **)** const +- :ref:`bool` **is_using_bbcode** **(** **)** const .. _class_RichTextLabel_newline: -- void **newline** **(** **)** +- void **newline** **(** **)** .. _class_RichTextLabel_parse_bbcode: -- :ref:`int` **parse_bbcode** **(** :ref:`String` bbcode **)** +- :ref:`int` **parse_bbcode** **(** :ref:`String` bbcode **)** .. _class_RichTextLabel_pop: -- void **pop** **(** **)** +- void **pop** **(** **)** .. _class_RichTextLabel_push_align: -- void **push_align** **(** :ref:`int` align **)** +- void **push_align** **(** :ref:`int` align **)** .. _class_RichTextLabel_push_cell: -- void **push_cell** **(** **)** +- void **push_cell** **(** **)** .. _class_RichTextLabel_push_color: -- void **push_color** **(** :ref:`Color` color **)** +- void **push_color** **(** :ref:`Color` color **)** .. _class_RichTextLabel_push_font: -- void **push_font** **(** :ref:`Font` font **)** +- void **push_font** **(** :ref:`Font` font **)** .. _class_RichTextLabel_push_indent: -- void **push_indent** **(** :ref:`int` level **)** +- void **push_indent** **(** :ref:`int` level **)** .. _class_RichTextLabel_push_list: -- void **push_list** **(** :ref:`int` type **)** +- void **push_list** **(** :ref:`int` type **)** .. _class_RichTextLabel_push_meta: -- void **push_meta** **(** :ref:`Variant` data **)** +- void **push_meta** **(** :ref:`Variant` data **)** .. _class_RichTextLabel_push_table: -- void **push_table** **(** :ref:`int` columns **)** +- void **push_table** **(** :ref:`int` columns **)** .. _class_RichTextLabel_push_underline: -- void **push_underline** **(** **)** +- void **push_underline** **(** **)** .. _class_RichTextLabel_remove_line: -- :ref:`bool` **remove_line** **(** :ref:`int` line **)** +- :ref:`bool` **remove_line** **(** :ref:`int` line **)** .. _class_RichTextLabel_scroll_to_line: -- void **scroll_to_line** **(** :ref:`int` line **)** +- void **scroll_to_line** **(** :ref:`int` line **)** .. _class_RichTextLabel_set_bbcode: -- void **set_bbcode** **(** :ref:`String` text **)** +- void **set_bbcode** **(** :ref:`String` text **)** .. _class_RichTextLabel_set_meta_underline: -- void **set_meta_underline** **(** :ref:`bool` enable **)** +- void **set_meta_underline** **(** :ref:`bool` enable **)** .. _class_RichTextLabel_set_override_selected_font_color: -- void **set_override_selected_font_color** **(** :ref:`bool` override **)** +- void **set_override_selected_font_color** **(** :ref:`bool` override **)** .. _class_RichTextLabel_set_percent_visible: -- void **set_percent_visible** **(** :ref:`float` percent_visible **)** +- void **set_percent_visible** **(** :ref:`float` percent_visible **)** .. _class_RichTextLabel_set_scroll_active: -- void **set_scroll_active** **(** :ref:`bool` active **)** +- void **set_scroll_active** **(** :ref:`bool` active **)** .. _class_RichTextLabel_set_scroll_follow: -- void **set_scroll_follow** **(** :ref:`bool` follow **)** +- void **set_scroll_follow** **(** :ref:`bool` follow **)** .. _class_RichTextLabel_set_selection_enabled: -- void **set_selection_enabled** **(** :ref:`bool` enabled **)** +- void **set_selection_enabled** **(** :ref:`bool` enabled **)** Set to true if selecting the text inside this richtext is allowed. .. _class_RichTextLabel_set_tab_size: -- void **set_tab_size** **(** :ref:`int` spaces **)** +- void **set_tab_size** **(** :ref:`int` spaces **)** .. _class_RichTextLabel_set_table_column_expand: -- void **set_table_column_expand** **(** :ref:`int` column, :ref:`bool` expand, :ref:`int` ratio **)** +- void **set_table_column_expand** **(** :ref:`int` column, :ref:`bool` expand, :ref:`int` ratio **)** .. _class_RichTextLabel_set_text: -- void **set_text** **(** :ref:`String` text **)** +- void **set_text** **(** :ref:`String` text **)** .. _class_RichTextLabel_set_use_bbcode: -- void **set_use_bbcode** **(** :ref:`bool` enable **)** +- void **set_use_bbcode** **(** :ref:`bool` enable **)** .. _class_RichTextLabel_set_visible_characters: -- void **set_visible_characters** **(** :ref:`int` amount **)** +- void **set_visible_characters** **(** :ref:`int` amount **)** diff --git a/classes/class_rid.rst b/classes/class_rid.rst index 50bebdea9..e79d795da 100644 --- a/classes/class_rid.rst +++ b/classes/class_rid.rst @@ -17,11 +17,11 @@ Handle for a :ref:`Resource`'s unique ID. Member Functions ---------------- -+------------------------+--------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`RID` **(** :ref:`Object` from **)** | -+------------------------+--------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_id` **(** **)** | -+------------------------+--------------------------------------------------------------------------+ ++------------------------+------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`RID` **(** :ref:`Object` from **)** | ++------------------------+------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_id` **(** **)** | ++------------------------+------------------------------------------------------------------------+ Description ----------- @@ -33,13 +33,13 @@ Member Function Description .. _class_RID_RID: -- :ref:`RID` **RID** **(** :ref:`Object` from **)** +- :ref:`RID` **RID** **(** :ref:`Object` from **)** Create a new RID instance with the ID of a given resource. When not handed a valid resource, silently stores the unused ID 0. .. _class_RID_get_id: -- :ref:`int` **get_id** **(** **)** +- :ref:`int` **get_id** **(** **)** Retrieve the ID of the referenced resource. diff --git a/classes/class_rigidbody.rst b/classes/class_rigidbody.rst index 9ef60c781..231a67c42 100644 --- a/classes/class_rigidbody.rst +++ b/classes/class_rigidbody.rst @@ -19,102 +19,102 @@ Physics Body whose position is determined through physics simulation in 3D space Member Functions ---------------- -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_integrate_forces` **(** :ref:`PhysicsDirectBodyState` state **)** virtual | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`apply_impulse` **(** :ref:`Vector3` position, :ref:`Vector3` impulse **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_angular_damp` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_angular_velocity` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_axis_lock` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_bounce` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_colliding_bodies` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_friction` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_gravity_scale` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_linear_damp` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_linear_velocity` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_mass` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_max_contacts_reported` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_mode` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_weight` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_able_to_sleep` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_contact_monitor_enabled` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_sleeping` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_using_continuous_collision_detection` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_using_custom_integrator` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_angular_damp` **(** :ref:`float` angular_damp **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_angular_velocity` **(** :ref:`Vector3` angular_velocity **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_axis_lock` **(** :ref:`int` axis_lock **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_axis_velocity` **(** :ref:`Vector3` axis_velocity **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bounce` **(** :ref:`float` bounce **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_can_sleep` **(** :ref:`bool` able_to_sleep **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_contact_monitor` **(** :ref:`bool` enabled **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_friction` **(** :ref:`float` friction **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_gravity_scale` **(** :ref:`float` gravity_scale **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_linear_damp` **(** :ref:`float` linear_damp **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_linear_velocity` **(** :ref:`Vector3` linear_velocity **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mass` **(** :ref:`float` mass **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_max_contacts_reported` **(** :ref:`int` amount **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mode` **(** :ref:`int` mode **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sleeping` **(** :ref:`bool` sleeping **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_continuous_collision_detection` **(** :ref:`bool` enable **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_custom_integrator` **(** :ref:`bool` enable **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_weight` **(** :ref:`float` weight **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_integrate_forces` **(** :ref:`PhysicsDirectBodyState` state **)** virtual | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`apply_impulse` **(** :ref:`Vector3` position, :ref:`Vector3` impulse **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_angular_damp` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_angular_velocity` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_axis_lock` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_bounce` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_colliding_bodies` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_friction` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_gravity_scale` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_linear_damp` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_linear_velocity` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_mass` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_max_contacts_reported` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_mode` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_weight` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_able_to_sleep` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_contact_monitor_enabled` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_sleeping` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_using_continuous_collision_detection` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_using_custom_integrator` **(** **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_angular_damp` **(** :ref:`float` angular_damp **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_angular_velocity` **(** :ref:`Vector3` angular_velocity **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_axis_lock` **(** :ref:`int` axis_lock **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_axis_velocity` **(** :ref:`Vector3` axis_velocity **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bounce` **(** :ref:`float` bounce **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_can_sleep` **(** :ref:`bool` able_to_sleep **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_contact_monitor` **(** :ref:`bool` enabled **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_friction` **(** :ref:`float` friction **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_gravity_scale` **(** :ref:`float` gravity_scale **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_linear_damp` **(** :ref:`float` linear_damp **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_linear_velocity` **(** :ref:`Vector3` linear_velocity **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_mass` **(** :ref:`float` mass **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_max_contacts_reported` **(** :ref:`int` amount **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_mode` **(** :ref:`int` mode **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_sleeping` **(** :ref:`bool` sleeping **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_continuous_collision_detection` **(** :ref:`bool` enable **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_custom_integrator` **(** :ref:`bool` enable **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_weight` **(** :ref:`float` weight **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_RigidBody_body_entered: -- **body_entered** **(** :ref:`Object` body **)** +- **body_entered** **(** :ref:`Object` body **)** Emitted when a body enters into contact with this one. Contact monitor and contacts reported must be enabled for this to work. .. _class_RigidBody_body_exited: -- **body_exited** **(** :ref:`Object` body **)** +- **body_exited** **(** :ref:`Object` body **)** Emitted when a body shape exits contact with this one. Contact monitor and contacts reported must be enabled for this to work. .. _class_RigidBody_body_shape_entered: -- **body_shape_entered** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` local_shape **)** +- **body_shape_entered** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` local_shape **)** Emitted when a body enters into contact with this one. Contact monitor and contacts reported must be enabled for this to work. @@ -122,7 +122,7 @@ This signal not only receives the body that collided with this one, but also its .. _class_RigidBody_body_shape_exited: -- **body_shape_exited** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` local_shape **)** +- **body_shape_exited** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` local_shape **)** Emitted when a body shape exits contact with this one. Contact monitor and contacts reported must be enabled for this to work. @@ -130,7 +130,7 @@ This signal not only receives the body that stopped colliding with this one, but .. _class_RigidBody_sleeping_state_changed: -- **sleeping_state_changed** **(** **)** +- **sleeping_state_changed** **(** **)** Emitted when the body changes its sleeping state. Either by sleeping or waking up. @@ -239,157 +239,157 @@ Member Function Description .. _class_RigidBody__integrate_forces: -- void **_integrate_forces** **(** :ref:`PhysicsDirectBodyState` state **)** virtual +- void **_integrate_forces** **(** :ref:`PhysicsDirectBodyState` state **)** virtual Called during physics processing, allowing you to read and safely modify the simulation state for the object. By default it works in addition to the usual physics behavior, but :ref:`set_use_custom_integrator` allows you to disable the default behavior and do fully custom force integration for a body. .. _class_RigidBody_apply_impulse: -- void **apply_impulse** **(** :ref:`Vector3` position, :ref:`Vector3` impulse **)** +- void **apply_impulse** **(** :ref:`Vector3` position, :ref:`Vector3` impulse **)** Apply a positioned impulse (which will be affected by the body mass and shape). This is the equivalent of hitting a billiard ball with a cue: a force that is applied once, and only once. Both the impulse and the offset from the body origin are in global coordinates. .. _class_RigidBody_get_angular_damp: -- :ref:`float` **get_angular_damp** **(** **)** const +- :ref:`float` **get_angular_damp** **(** **)** const Return the current body angular damp. Default is -1. .. _class_RigidBody_get_angular_velocity: -- :ref:`Vector3` **get_angular_velocity** **(** **)** const +- :ref:`Vector3` **get_angular_velocity** **(** **)** const Return the current body angular velocity. .. _class_RigidBody_get_axis_lock: -- :ref:`int` **get_axis_lock** **(** **)** const +- :ref:`int` **get_axis_lock** **(** **)** const Return the current axis lock of the body. One of AXIS_LOCK\_\* enum. .. _class_RigidBody_get_bounce: -- :ref:`float` **get_bounce** **(** **)** const +- :ref:`float` **get_bounce** **(** **)** const Return the current body bounciness. .. _class_RigidBody_get_colliding_bodies: -- :ref:`Array` **get_colliding_bodies** **(** **)** const +- :ref:`Array` **get_colliding_bodies** **(** **)** const Return a list of the bodies colliding with this one. By default, number of max contacts reported is at 0 , see :ref:`set_max_contacts_reported` to increase it. .. _class_RigidBody_get_friction: -- :ref:`float` **get_friction** **(** **)** const +- :ref:`float` **get_friction** **(** **)** const Return the current body friction, from 0 (frictionless) to 1 (max friction). .. _class_RigidBody_get_gravity_scale: -- :ref:`float` **get_gravity_scale** **(** **)** const +- :ref:`float` **get_gravity_scale** **(** **)** const Return the current body gravity scale. .. _class_RigidBody_get_linear_damp: -- :ref:`float` **get_linear_damp** **(** **)** const +- :ref:`float` **get_linear_damp** **(** **)** const Return the current body linear damp. Default is -1. .. _class_RigidBody_get_linear_velocity: -- :ref:`Vector3` **get_linear_velocity** **(** **)** const +- :ref:`Vector3` **get_linear_velocity** **(** **)** const Return the current body linear velocity. .. _class_RigidBody_get_mass: -- :ref:`float` **get_mass** **(** **)** const +- :ref:`float` **get_mass** **(** **)** const Return the current body mass. .. _class_RigidBody_get_max_contacts_reported: -- :ref:`int` **get_max_contacts_reported** **(** **)** const +- :ref:`int` **get_max_contacts_reported** **(** **)** const Return the maximum contacts that can be reported. See :ref:`set_max_contacts_reported`. .. _class_RigidBody_get_mode: -- :ref:`int` **get_mode** **(** **)** const +- :ref:`int` **get_mode** **(** **)** const Return the current body mode, see :ref:`set_mode`. .. _class_RigidBody_get_weight: -- :ref:`float` **get_weight** **(** **)** const +- :ref:`float` **get_weight** **(** **)** const Return the current body weight, given standard earth-weight (gravity 9.8). .. _class_RigidBody_is_able_to_sleep: -- :ref:`bool` **is_able_to_sleep** **(** **)** const +- :ref:`bool` **is_able_to_sleep** **(** **)** const Return whether the body has the ability to fall asleep when not moving. See :ref:`set_can_sleep`. .. _class_RigidBody_is_contact_monitor_enabled: -- :ref:`bool` **is_contact_monitor_enabled** **(** **)** const +- :ref:`bool` **is_contact_monitor_enabled** **(** **)** const Return whether contact monitoring is enabled. .. _class_RigidBody_is_sleeping: -- :ref:`bool` **is_sleeping** **(** **)** const +- :ref:`bool` **is_sleeping** **(** **)** const Return whether the body is sleeping. .. _class_RigidBody_is_using_continuous_collision_detection: -- :ref:`bool` **is_using_continuous_collision_detection** **(** **)** const +- :ref:`bool` **is_using_continuous_collision_detection** **(** **)** const Return whether this body is using continuous collision detection. .. _class_RigidBody_is_using_custom_integrator: -- :ref:`bool` **is_using_custom_integrator** **(** **)** +- :ref:`bool` **is_using_custom_integrator** **(** **)** Return whether the body is using a custom integrator. .. _class_RigidBody_set_angular_damp: -- void **set_angular_damp** **(** :ref:`float` angular_damp **)** +- void **set_angular_damp** **(** :ref:`float` angular_damp **)** Set the angular damp for this body. Default of -1, cannot be less than -1. If this value is different from -1, any angular damp derived from the world or areas will be overridden. .. _class_RigidBody_set_angular_velocity: -- void **set_angular_velocity** **(** :ref:`Vector3` angular_velocity **)** +- void **set_angular_velocity** **(** :ref:`Vector3` angular_velocity **)** Set the body angular velocity. Can be used sporadically, but **DON'T SET THIS IN EVERY FRAME**, because physics may be running in another thread and definitely runs at a different granularity. Use :ref:`_integrate_forces` as your process loop if you want to have precise control of the body state. .. _class_RigidBody_set_axis_lock: -- void **set_axis_lock** **(** :ref:`int` axis_lock **)** +- void **set_axis_lock** **(** :ref:`int` axis_lock **)** Set the axis lock of the body, from the AXIS_LOCK\_\* enum. Axis lock stops the body from moving along the specified axis(X/Y/Z) and rotating along the other two axes. .. _class_RigidBody_set_axis_velocity: -- void **set_axis_velocity** **(** :ref:`Vector3` axis_velocity **)** +- void **set_axis_velocity** **(** :ref:`Vector3` axis_velocity **)** Set an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior. .. _class_RigidBody_set_bounce: -- void **set_bounce** **(** :ref:`float` bounce **)** +- void **set_bounce** **(** :ref:`float` bounce **)** Set the body bounciness, from 0 (no bounciness) to 1 (max bounciness). .. _class_RigidBody_set_can_sleep: -- void **set_can_sleep** **(** :ref:`bool` able_to_sleep **)** +- void **set_can_sleep** **(** :ref:`bool` able_to_sleep **)** Set the body ability to fall asleep when not moving. This saves an enormous amount of processor time when there are plenty of rigid bodies (non static) in a scene. @@ -397,61 +397,61 @@ Sleeping bodies are not affected by forces until a collision or an :ref:`apply_i .. _class_RigidBody_set_contact_monitor: -- void **set_contact_monitor** **(** :ref:`bool` enabled **)** +- void **set_contact_monitor** **(** :ref:`bool` enabled **)** Enable contact monitoring. This allows the body to emit signals when it collides with another. .. _class_RigidBody_set_friction: -- void **set_friction** **(** :ref:`float` friction **)** +- void **set_friction** **(** :ref:`float` friction **)** Set the body friction, from 0 (frictionless) to 1 (max friction). .. _class_RigidBody_set_gravity_scale: -- void **set_gravity_scale** **(** :ref:`float` gravity_scale **)** +- void **set_gravity_scale** **(** :ref:`float` gravity_scale **)** Set the gravity factor. This factor multiplies gravity intensity just for this body. .. _class_RigidBody_set_linear_damp: -- void **set_linear_damp** **(** :ref:`float` linear_damp **)** +- void **set_linear_damp** **(** :ref:`float` linear_damp **)** Set the linear damp for this body. Default of -1, cannot be less than -1. If this value is different from -1, any linear damp derived from the world or areas will be overridden. .. _class_RigidBody_set_linear_velocity: -- void **set_linear_velocity** **(** :ref:`Vector3` linear_velocity **)** +- void **set_linear_velocity** **(** :ref:`Vector3` linear_velocity **)** Set the body linear velocity. Can be used sporadically, but **DON'T SET THIS IN EVERY FRAME**, because physics may be running in another thread and definitely runs at a different granularity. Use :ref:`_integrate_forces` as your process loop if you want to have precise control of the body state. .. _class_RigidBody_set_mass: -- void **set_mass** **(** :ref:`float` mass **)** +- void **set_mass** **(** :ref:`float` mass **)** Set the body mass. .. _class_RigidBody_set_max_contacts_reported: -- void **set_max_contacts_reported** **(** :ref:`int` amount **)** +- void **set_max_contacts_reported** **(** :ref:`int` amount **)** Set the maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0. .. _class_RigidBody_set_mode: -- void **set_mode** **(** :ref:`int` mode **)** +- void **set_mode** **(** :ref:`int` mode **)** Set the body mode, from the MODE\_\* enum. This allows to change to a static body or a character body. .. _class_RigidBody_set_sleeping: -- void **set_sleeping** **(** :ref:`bool` sleeping **)** +- void **set_sleeping** **(** :ref:`bool` sleeping **)** Set whether a body is sleeping or not. Sleeping bodies are not affected by forces until a collision or an :ref:`apply_impulse` wakes them up. Until then, they behave like a static body. .. _class_RigidBody_set_use_continuous_collision_detection: -- void **set_use_continuous_collision_detection** **(** :ref:`bool` enable **)** +- void **set_use_continuous_collision_detection** **(** :ref:`bool` enable **)** Set the continuous collision detection mode from the enum CCD_MODE\_\*. @@ -459,13 +459,13 @@ Continuous collision detection tries to predict where a moving body will collide .. _class_RigidBody_set_use_custom_integrator: -- void **set_use_custom_integrator** **(** :ref:`bool` enable **)** +- void **set_use_custom_integrator** **(** :ref:`bool` enable **)** Pass true to disable the internal force integration (like gravity or air friction) for this body. Other than collision response, the body will only move as determined by the :ref:`_integrate_forces` function, if defined. .. _class_RigidBody_set_weight: -- void **set_weight** **(** :ref:`float` weight **)** +- void **set_weight** **(** :ref:`float` weight **)** Set the body weight given standard earth-weight (gravity 9.8). diff --git a/classes/class_rigidbody2d.rst b/classes/class_rigidbody2d.rst index 7b1c914e5..f4f445f46 100644 --- a/classes/class_rigidbody2d.rst +++ b/classes/class_rigidbody2d.rst @@ -19,126 +19,126 @@ A body that is controlled by the 2D physics engine. Member Functions ---------------- -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_integrate_forces` **(** :ref:`Physics2DDirectBodyState` state **)** virtual | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_force` **(** :ref:`Vector2` offset, :ref:`Vector2` force **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`apply_impulse` **(** :ref:`Vector2` offset, :ref:`Vector2` impulse **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_angular_damp` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_angular_velocity` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_applied_force` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_applied_torque` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_bounce` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_colliding_bodies` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_continuous_collision_detection_mode` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_friction` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_gravity_scale` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_inertia` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_linear_damp` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_linear_velocity` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_mass` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_max_contacts_reported` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_mode` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_weight` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_able_to_sleep` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_contact_monitor_enabled` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_sleeping` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_using_custom_integrator` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_angular_damp` **(** :ref:`float` angular_damp **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_angular_velocity` **(** :ref:`float` angular_velocity **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_applied_force` **(** :ref:`Vector2` force **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_applied_torque` **(** :ref:`float` torque **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_axis_velocity` **(** :ref:`Vector2` axis_velocity **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bounce` **(** :ref:`float` bounce **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_can_sleep` **(** :ref:`bool` able_to_sleep **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_contact_monitor` **(** :ref:`bool` enabled **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_continuous_collision_detection_mode` **(** :ref:`int` mode **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_friction` **(** :ref:`float` friction **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_gravity_scale` **(** :ref:`float` gravity_scale **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_inertia` **(** :ref:`float` inertia **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_linear_damp` **(** :ref:`float` linear_damp **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_linear_velocity` **(** :ref:`Vector2` linear_velocity **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mass` **(** :ref:`float` mass **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_max_contacts_reported` **(** :ref:`int` amount **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mode` **(** :ref:`int` mode **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sleeping` **(** :ref:`bool` sleeping **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_custom_integrator` **(** :ref:`bool` enable **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_weight` **(** :ref:`float` weight **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`test_motion` **(** :ref:`Vector2` motion, :ref:`float` margin=0.08, :ref:`Physics2DTestMotionResult` result=null **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_integrate_forces` **(** :ref:`Physics2DDirectBodyState` state **)** virtual | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_force` **(** :ref:`Vector2` offset, :ref:`Vector2` force **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`apply_impulse` **(** :ref:`Vector2` offset, :ref:`Vector2` impulse **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_angular_damp` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_angular_velocity` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_applied_force` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_applied_torque` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_bounce` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_colliding_bodies` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_continuous_collision_detection_mode` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_friction` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_gravity_scale` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_inertia` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_linear_damp` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_linear_velocity` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_mass` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_max_contacts_reported` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_mode` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_weight` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_able_to_sleep` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_contact_monitor_enabled` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_sleeping` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_using_custom_integrator` **(** **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_angular_damp` **(** :ref:`float` angular_damp **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_angular_velocity` **(** :ref:`float` angular_velocity **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_applied_force` **(** :ref:`Vector2` force **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_applied_torque` **(** :ref:`float` torque **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_axis_velocity` **(** :ref:`Vector2` axis_velocity **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bounce` **(** :ref:`float` bounce **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_can_sleep` **(** :ref:`bool` able_to_sleep **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_contact_monitor` **(** :ref:`bool` enabled **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_continuous_collision_detection_mode` **(** :ref:`int` mode **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_friction` **(** :ref:`float` friction **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_gravity_scale` **(** :ref:`float` gravity_scale **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_inertia` **(** :ref:`float` inertia **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_linear_damp` **(** :ref:`float` linear_damp **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_linear_velocity` **(** :ref:`Vector2` linear_velocity **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_mass` **(** :ref:`float` mass **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_max_contacts_reported` **(** :ref:`int` amount **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_mode` **(** :ref:`int` mode **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_sleeping` **(** :ref:`bool` sleeping **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_custom_integrator` **(** :ref:`bool` enable **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_weight` **(** :ref:`float` weight **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`test_motion` **(** :ref:`Vector2` motion, :ref:`float` margin=0.08, :ref:`Physics2DTestMotionResult` result=null **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_RigidBody2D_body_entered: -- **body_entered** **(** :ref:`Object` body **)** +- **body_entered** **(** :ref:`Object` body **)** Emitted when a body enters into contact with this one. :ref:`contact_monitor` must be ``true`` and :ref:`contacts_reported` greater than ``0``. .. _class_RigidBody2D_body_exited: -- **body_exited** **(** :ref:`Object` body **)** +- **body_exited** **(** :ref:`Object` body **)** Emitted when a body exits contact with this one. :ref:`contact_monitor` must be ``true`` and :ref:`contacts_reported` greater than ``0``. .. _class_RigidBody2D_body_shape_entered: -- **body_shape_entered** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` local_shape **)** +- **body_shape_entered** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` local_shape **)** Emitted when a body enters into contact with this one. Reports colliding shape information. See :ref:`CollisionObject2D` for shape index information. :ref:`contact_monitor` must be ``true`` and :ref:`contacts_reported` greater than ``0``. .. _class_RigidBody2D_body_shape_exited: -- **body_shape_exited** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` local_shape **)** +- **body_shape_exited** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` local_shape **)** Emitted when a body shape exits contact with this one. Reports colliding shape information. See :ref:`CollisionObject2D` for shape index information. :ref:`contact_monitor` must be ``true`` and :ref:`contacts_reported` greater than ``0``. .. _class_RigidBody2D_sleeping_state_changed: -- **sleeping_state_changed** **(** **)** +- **sleeping_state_changed** **(** **)** Emitted when :ref:`sleeping` changes. @@ -248,181 +248,181 @@ Member Function Description .. _class_RigidBody2D__integrate_forces: -- void **_integrate_forces** **(** :ref:`Physics2DDirectBodyState` state **)** virtual +- void **_integrate_forces** **(** :ref:`Physics2DDirectBodyState` state **)** virtual Allows you to read and safely modify the simulation state for the object. Use this instead of Node._physics_process if you need to directly change the body's ``position`` or other physics properties. By default it works in addition to the usual physics behavior, but :ref:`custom_integrator` allows you to disable the default behavior and write custom force integration for a body. .. _class_RigidBody2D_add_force: -- void **add_force** **(** :ref:`Vector2` offset, :ref:`Vector2` force **)** +- void **add_force** **(** :ref:`Vector2` offset, :ref:`Vector2` force **)** Adds a positioned force to the body. Both the force and the offset from the body origin are in global coordinates. .. _class_RigidBody2D_apply_impulse: -- void **apply_impulse** **(** :ref:`Vector2` offset, :ref:`Vector2` impulse **)** +- void **apply_impulse** **(** :ref:`Vector2` offset, :ref:`Vector2` impulse **)** Applies a positioned impulse to the body (which will be affected by the body mass and shape). This is the equivalent of hitting a billiard ball with a cue: a force that is applied instantaneously. Both the impulse and the offset from the body origin are in global coordinates. .. _class_RigidBody2D_get_angular_damp: -- :ref:`float` **get_angular_damp** **(** **)** const +- :ref:`float` **get_angular_damp** **(** **)** const Return the angular damp for this body. .. _class_RigidBody2D_get_angular_velocity: -- :ref:`float` **get_angular_velocity** **(** **)** const +- :ref:`float` **get_angular_velocity** **(** **)** const Return the body angular velocity. This changes by physics granularity. See :ref:`set_angular_velocity`. .. _class_RigidBody2D_get_applied_force: -- :ref:`Vector2` **get_applied_force** **(** **)** const +- :ref:`Vector2` **get_applied_force** **(** **)** const Returns the body's total applied force. .. _class_RigidBody2D_get_applied_torque: -- :ref:`float` **get_applied_torque** **(** **)** const +- :ref:`float` **get_applied_torque** **(** **)** const Returns the body's total applied torque. .. _class_RigidBody2D_get_bounce: -- :ref:`float` **get_bounce** **(** **)** const +- :ref:`float` **get_bounce** **(** **)** const Return the body bounciness. .. _class_RigidBody2D_get_colliding_bodies: -- :ref:`Array` **get_colliding_bodies** **(** **)** const +- :ref:`Array` **get_colliding_bodies** **(** **)** const Returns a list of the bodies colliding with this one. Use :ref:`contacts_reported` to set the maximum number reported. You must also set :ref:`contact_monitor` to ``true``. .. _class_RigidBody2D_get_continuous_collision_detection_mode: -- :ref:`int` **get_continuous_collision_detection_mode** **(** **)** const +- :ref:`int` **get_continuous_collision_detection_mode** **(** **)** const Return whether this body is using continuous collision detection. .. _class_RigidBody2D_get_friction: -- :ref:`float` **get_friction** **(** **)** const +- :ref:`float` **get_friction** **(** **)** const Return the body friction. .. _class_RigidBody2D_get_gravity_scale: -- :ref:`float` **get_gravity_scale** **(** **)** const +- :ref:`float` **get_gravity_scale** **(** **)** const Return the gravity factor. .. _class_RigidBody2D_get_inertia: -- :ref:`float` **get_inertia** **(** **)** const +- :ref:`float` **get_inertia** **(** **)** const Returns the body's moment of inertia, which is computed automatically from the body's mass and assigned :ref:`Shape2D`\ s during the physics frame. Note that it will not yet have a value in the ``_ready()`` function. .. _class_RigidBody2D_get_linear_damp: -- :ref:`float` **get_linear_damp** **(** **)** const +- :ref:`float` **get_linear_damp** **(** **)** const Return the linear damp for this body. .. _class_RigidBody2D_get_linear_velocity: -- :ref:`Vector2` **get_linear_velocity** **(** **)** const +- :ref:`Vector2` **get_linear_velocity** **(** **)** const Returns the body's linear velocity. This changes when a physics frame has passed, not during a normal update. See :ref:`set_linear_velocity`. .. _class_RigidBody2D_get_mass: -- :ref:`float` **get_mass** **(** **)** const +- :ref:`float` **get_mass** **(** **)** const Return the body mass. .. _class_RigidBody2D_get_max_contacts_reported: -- :ref:`int` **get_max_contacts_reported** **(** **)** const +- :ref:`int` **get_max_contacts_reported** **(** **)** const Return the maximum contacts that can be reported. See :ref:`set_max_contacts_reported`. .. _class_RigidBody2D_get_mode: -- :ref:`int` **get_mode** **(** **)** const +- :ref:`int` **get_mode** **(** **)** const Return the current body mode, see :ref:`set_mode`. .. _class_RigidBody2D_get_weight: -- :ref:`float` **get_weight** **(** **)** const +- :ref:`float` **get_weight** **(** **)** const Return the body weight given standard earth-weight (gravity 9.8). .. _class_RigidBody2D_is_able_to_sleep: -- :ref:`bool` **is_able_to_sleep** **(** **)** const +- :ref:`bool` **is_able_to_sleep** **(** **)** const Return true if the body has the ability to fall asleep when not moving. See :ref:`set_can_sleep`. .. _class_RigidBody2D_is_contact_monitor_enabled: -- :ref:`bool` **is_contact_monitor_enabled** **(** **)** const +- :ref:`bool` **is_contact_monitor_enabled** **(** **)** const Return whether contact monitoring is enabled. .. _class_RigidBody2D_is_sleeping: -- :ref:`bool` **is_sleeping** **(** **)** const +- :ref:`bool` **is_sleeping** **(** **)** const Return whether the body is sleeping. .. _class_RigidBody2D_is_using_custom_integrator: -- :ref:`bool` **is_using_custom_integrator** **(** **)** +- :ref:`bool` **is_using_custom_integrator** **(** **)** Return true if the body is not doing any built-in force integration. .. _class_RigidBody2D_set_angular_damp: -- void **set_angular_damp** **(** :ref:`float` angular_damp **)** +- void **set_angular_damp** **(** :ref:`float` angular_damp **)** Set the angular damp for this body. If this value is different from -1, any angular damp derived from the world or areas will be overridden. .. _class_RigidBody2D_set_angular_velocity: -- void **set_angular_velocity** **(** :ref:`float` angular_velocity **)** +- void **set_angular_velocity** **(** :ref:`float` angular_velocity **)** Set the body angular velocity. Can be used sporadically, but **DON'T SET THIS IN EVERY FRAME**, because physics may be running in another thread and definitely runs at a different granularity. Use :ref:`_integrate_forces` as your process loop if you want to have precise control of the body state. .. _class_RigidBody2D_set_applied_force: -- void **set_applied_force** **(** :ref:`Vector2` force **)** +- void **set_applied_force** **(** :ref:`Vector2` force **)** Sets the applied force vector. This is the equivalent of firing a rocket: the force is applied constantly. .. _class_RigidBody2D_set_applied_torque: -- void **set_applied_torque** **(** :ref:`float` torque **)** +- void **set_applied_torque** **(** :ref:`float` torque **)** Sets the applied torque. .. _class_RigidBody2D_set_axis_velocity: -- void **set_axis_velocity** **(** :ref:`Vector2` axis_velocity **)** +- void **set_axis_velocity** **(** :ref:`Vector2` axis_velocity **)** Sets the body's velocity on the given axis. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior. .. _class_RigidBody2D_set_bounce: -- void **set_bounce** **(** :ref:`float` bounce **)** +- void **set_bounce** **(** :ref:`float` bounce **)** Set the body bounciness, from 0 (no bounce) to 1 (full bounce). .. _class_RigidBody2D_set_can_sleep: -- void **set_can_sleep** **(** :ref:`bool` able_to_sleep **)** +- void **set_can_sleep** **(** :ref:`bool` able_to_sleep **)** Set the body ability to fall asleep when not moving. This saves an enormous amount of processor time when there are plenty of rigid bodies (non static) in a scene. @@ -430,13 +430,13 @@ Sleeping bodies are not affected by forces until a collision or an :ref:`apply_i .. _class_RigidBody2D_set_contact_monitor: -- void **set_contact_monitor** **(** :ref:`bool` enabled **)** +- void **set_contact_monitor** **(** :ref:`bool` enabled **)** Enable contact monitoring. This allows the body to emit signals when it collides with another. .. _class_RigidBody2D_set_continuous_collision_detection_mode: -- void **set_continuous_collision_detection_mode** **(** :ref:`int` mode **)** +- void **set_continuous_collision_detection_mode** **(** :ref:`int` mode **)** Set the continuous collision detection mode from the enum CCD_MODE\_\*. @@ -444,73 +444,73 @@ Continuous collision detection tries to predict where a moving body will collide .. _class_RigidBody2D_set_friction: -- void **set_friction** **(** :ref:`float` friction **)** +- void **set_friction** **(** :ref:`float` friction **)** Set the body friction, from 0 (frictionless) to 1 (full friction). .. _class_RigidBody2D_set_gravity_scale: -- void **set_gravity_scale** **(** :ref:`float` gravity_scale **)** +- void **set_gravity_scale** **(** :ref:`float` gravity_scale **)** Set the gravity factor. This factor multiplies gravity intensity just for this body. .. _class_RigidBody2D_set_inertia: -- void **set_inertia** **(** :ref:`float` inertia **)** +- void **set_inertia** **(** :ref:`float` inertia **)** Set the body's moment of inertia. This is like mass, but for rotation: it determines how much torque it takes to rotate the body. The moment of inertia is usually computed automatically from the mass and the shapes, but this function allows you to set a custom value. Set 0 (or negative) inertia to return to automatically computing it. .. _class_RigidBody2D_set_linear_damp: -- void **set_linear_damp** **(** :ref:`float` linear_damp **)** +- void **set_linear_damp** **(** :ref:`float` linear_damp **)** Set the linear damp for this body. If this value is different from -1, any linear damp derived from the world or areas will be overridden. .. _class_RigidBody2D_set_linear_velocity: -- void **set_linear_velocity** **(** :ref:`Vector2` linear_velocity **)** +- void **set_linear_velocity** **(** :ref:`Vector2` linear_velocity **)** Set the body linear velocity. Can be used sporadically, but **DON'T SET THIS IN EVERY FRAME**, because physics may be running in another thread and definitely runs at a different granularity. Use :ref:`_integrate_forces` as your process loop if you want to have precise control of the body state. .. _class_RigidBody2D_set_mass: -- void **set_mass** **(** :ref:`float` mass **)** +- void **set_mass** **(** :ref:`float` mass **)** Set the body mass. .. _class_RigidBody2D_set_max_contacts_reported: -- void **set_max_contacts_reported** **(** :ref:`int` amount **)** +- void **set_max_contacts_reported** **(** :ref:`int` amount **)** Set the maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0. .. _class_RigidBody2D_set_mode: -- void **set_mode** **(** :ref:`int` mode **)** +- void **set_mode** **(** :ref:`int` mode **)** Set the body mode, from the MODE\_\* enum. This allows to change to a static body or a character body. .. _class_RigidBody2D_set_sleeping: -- void **set_sleeping** **(** :ref:`bool` sleeping **)** +- void **set_sleeping** **(** :ref:`bool` sleeping **)** Set whether a body is sleeping or not. Sleeping bodies are not affected by forces until a collision or an :ref:`apply_impulse` / :ref:`set_applied_force` wakes them up. Until then, they behave like a static body. .. _class_RigidBody2D_set_use_custom_integrator: -- void **set_use_custom_integrator** **(** :ref:`bool` enable **)** +- void **set_use_custom_integrator** **(** :ref:`bool` enable **)** Pass true to disable the internal force integration (like gravity or air friction) for this body. Other than collision response, the body will only move as determined by the :ref:`_integrate_forces` function, if defined. .. _class_RigidBody2D_set_weight: -- void **set_weight** **(** :ref:`float` weight **)** +- void **set_weight** **(** :ref:`float` weight **)** Set the body weight given standard earth-weight (gravity 9.8). Not really useful for 2D since most measures for this node are in pixels. .. _class_RigidBody2D_test_motion: -- :ref:`bool` **test_motion** **(** :ref:`Vector2` motion, :ref:`float` margin=0.08, :ref:`Physics2DTestMotionResult` result=null **)** +- :ref:`bool` **test_motion** **(** :ref:`Vector2` motion, :ref:`float` margin=0.08, :ref:`Physics2DTestMotionResult` result=null **)** Returns ``true`` if a collision would result from moving in the given vector. ``margin`` increases the size of the shapes involved in the collision detection, and ``result`` is an object of type :ref:`Physics2DTestMotionResult`, which contains additional information about the collision (should there be one). diff --git a/classes/class_scenestate.rst b/classes/class_scenestate.rst index a3507f0b6..2bf45ccea 100644 --- a/classes/class_scenestate.rst +++ b/classes/class_scenestate.rst @@ -19,45 +19,45 @@ Brief Description Member Functions ---------------- -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_connection_binds` **(** :ref:`int` idx **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_connection_count` **(** **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_connection_flags` **(** :ref:`int` idx **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_connection_method` **(** :ref:`int` idx **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_connection_signal` **(** :ref:`int` idx **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_connection_source` **(** :ref:`int` idx **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_connection_target` **(** :ref:`int` idx **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_node_count` **(** **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_node_groups` **(** :ref:`int` idx **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedScene` | :ref:`get_node_instance` **(** :ref:`int` idx **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_node_instance_placeholder` **(** :ref:`int` idx **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_node_name` **(** :ref:`int` idx **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_node_owner_path` **(** :ref:`int` idx **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_node_path` **(** :ref:`int` idx, :ref:`bool` for_parent=false **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_node_property_count` **(** :ref:`int` idx **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_node_property_name` **(** :ref:`int` idx, :ref:`int` prop_idx **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_node_property_value` **(** :ref:`int` idx, :ref:`int` prop_idx **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_node_type` **(** :ref:`int` idx **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_node_instance_placeholder` **(** :ref:`int` idx **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_connection_binds` **(** :ref:`int` idx **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_connection_count` **(** **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_connection_flags` **(** :ref:`int` idx **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_connection_method` **(** :ref:`int` idx **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_connection_signal` **(** :ref:`int` idx **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_connection_source` **(** :ref:`int` idx **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_connection_target` **(** :ref:`int` idx **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_node_count` **(** **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_node_groups` **(** :ref:`int` idx **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedScene` | :ref:`get_node_instance` **(** :ref:`int` idx **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_node_instance_placeholder` **(** :ref:`int` idx **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_node_name` **(** :ref:`int` idx **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_node_owner_path` **(** :ref:`int` idx **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_node_path` **(** :ref:`int` idx, :ref:`bool` for_parent=false **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_node_property_count` **(** :ref:`int` idx **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_node_property_name` **(** :ref:`int` idx, :ref:`int` prop_idx **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_node_property_value` **(** :ref:`int` idx, :ref:`int` prop_idx **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_node_type` **(** :ref:`int` idx **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_node_instance_placeholder` **(** :ref:`int` idx **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -71,78 +71,78 @@ Member Function Description .. _class_SceneState_get_connection_binds: -- :ref:`Array` **get_connection_binds** **(** :ref:`int` idx **)** const +- :ref:`Array` **get_connection_binds** **(** :ref:`int` idx **)** const .. _class_SceneState_get_connection_count: -- :ref:`int` **get_connection_count** **(** **)** const +- :ref:`int` **get_connection_count** **(** **)** const .. _class_SceneState_get_connection_flags: -- :ref:`int` **get_connection_flags** **(** :ref:`int` idx **)** const +- :ref:`int` **get_connection_flags** **(** :ref:`int` idx **)** const .. _class_SceneState_get_connection_method: -- :ref:`String` **get_connection_method** **(** :ref:`int` idx **)** const +- :ref:`String` **get_connection_method** **(** :ref:`int` idx **)** const .. _class_SceneState_get_connection_signal: -- :ref:`String` **get_connection_signal** **(** :ref:`int` idx **)** const +- :ref:`String` **get_connection_signal** **(** :ref:`int` idx **)** const .. _class_SceneState_get_connection_source: -- :ref:`NodePath` **get_connection_source** **(** :ref:`int` idx **)** const +- :ref:`NodePath` **get_connection_source** **(** :ref:`int` idx **)** const .. _class_SceneState_get_connection_target: -- :ref:`NodePath` **get_connection_target** **(** :ref:`int` idx **)** const +- :ref:`NodePath` **get_connection_target** **(** :ref:`int` idx **)** const .. _class_SceneState_get_node_count: -- :ref:`int` **get_node_count** **(** **)** const +- :ref:`int` **get_node_count** **(** **)** const .. _class_SceneState_get_node_groups: -- :ref:`PoolStringArray` **get_node_groups** **(** :ref:`int` idx **)** const +- :ref:`PoolStringArray` **get_node_groups** **(** :ref:`int` idx **)** const .. _class_SceneState_get_node_instance: -- :ref:`PackedScene` **get_node_instance** **(** :ref:`int` idx **)** const +- :ref:`PackedScene` **get_node_instance** **(** :ref:`int` idx **)** const .. _class_SceneState_get_node_instance_placeholder: -- :ref:`String` **get_node_instance_placeholder** **(** :ref:`int` idx **)** const +- :ref:`String` **get_node_instance_placeholder** **(** :ref:`int` idx **)** const .. _class_SceneState_get_node_name: -- :ref:`String` **get_node_name** **(** :ref:`int` idx **)** const +- :ref:`String` **get_node_name** **(** :ref:`int` idx **)** const .. _class_SceneState_get_node_owner_path: -- :ref:`NodePath` **get_node_owner_path** **(** :ref:`int` idx **)** const +- :ref:`NodePath` **get_node_owner_path** **(** :ref:`int` idx **)** const .. _class_SceneState_get_node_path: -- :ref:`NodePath` **get_node_path** **(** :ref:`int` idx, :ref:`bool` for_parent=false **)** const +- :ref:`NodePath` **get_node_path** **(** :ref:`int` idx, :ref:`bool` for_parent=false **)** const .. _class_SceneState_get_node_property_count: -- :ref:`int` **get_node_property_count** **(** :ref:`int` idx **)** const +- :ref:`int` **get_node_property_count** **(** :ref:`int` idx **)** const .. _class_SceneState_get_node_property_name: -- :ref:`String` **get_node_property_name** **(** :ref:`int` idx, :ref:`int` prop_idx **)** const +- :ref:`String` **get_node_property_name** **(** :ref:`int` idx, :ref:`int` prop_idx **)** const .. _class_SceneState_get_node_property_value: -- :ref:`Variant` **get_node_property_value** **(** :ref:`int` idx, :ref:`int` prop_idx **)** const +- :ref:`Variant` **get_node_property_value** **(** :ref:`int` idx, :ref:`int` prop_idx **)** const .. _class_SceneState_get_node_type: -- :ref:`String` **get_node_type** **(** :ref:`int` idx **)** const +- :ref:`String` **get_node_type** **(** :ref:`int` idx **)** const .. _class_SceneState_is_node_instance_placeholder: -- :ref:`bool` **is_node_instance_placeholder** **(** :ref:`int` idx **)** const +- :ref:`bool` **is_node_instance_placeholder** **(** :ref:`int` idx **)** const diff --git a/classes/class_scenetree.rst b/classes/class_scenetree.rst index 334a624d5..37f4ffb07 100644 --- a/classes/class_scenetree.rst +++ b/classes/class_scenetree.rst @@ -19,140 +19,140 @@ Brief Description Member Functions ---------------- -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`call_group` **(** :ref:`String` group, :ref:`String` method **)** vararg | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`call_group_flags` **(** :ref:`int` flags, :ref:`String` group, :ref:`String` method **)** vararg | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`change_scene` **(** :ref:`String` path **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`change_scene_to` **(** :ref:`PackedScene` packed_scene **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`SceneTreeTimer` | :ref:`create_timer` **(** :ref:`float` time_sec, :ref:`bool` pause_mode_process=true **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_current_scene` **(** **)** const | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_edited_scene_root` **(** **)** const | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_frame` **(** **)** const | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_network_connected_peers` **(** **)** const | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_network_unique_id` **(** **)** const | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_node_count` **(** **)** const | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_nodes_in_group` **(** :ref:`String` group **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Viewport` | :ref:`get_root` **(** **)** const | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_rpc_sender_id` **(** **)** const | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_group` **(** :ref:`String` name **)** const | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_network_peer` **(** **)** const | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_debugging_collisions_hint` **(** **)** const | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_debugging_navigation_hint` **(** **)** const | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_input_handled` **(** **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_network_server` **(** **)** const | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_paused` **(** **)** const | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_refusing_new_network_connections` **(** **)** const | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`notify_group` **(** :ref:`String` group, :ref:`int` notification **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`notify_group_flags` **(** :ref:`int` call_flags, :ref:`String` group, :ref:`int` notification **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`queue_delete` **(** :ref:`Object` obj **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`quit` **(** **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`reload_current_scene` **(** **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_auto_accept_quit` **(** :ref:`bool` enabled **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_current_scene` **(** :ref:`Node` child_node **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_debug_collisions_hint` **(** :ref:`bool` enable **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_debug_navigation_hint` **(** :ref:`bool` enable **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_edited_scene_root` **(** :ref:`Node` scene **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_group` **(** :ref:`String` group, :ref:`String` property, :ref:`Variant` value **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_group_flags` **(** :ref:`int` call_flags, :ref:`String` group, :ref:`String` property, :ref:`Variant` value **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_input_as_handled` **(** **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_network_peer` **(** :ref:`NetworkedMultiplayerPeer` peer **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pause` **(** :ref:`bool` enable **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_refuse_new_network_connections` **(** :ref:`bool` refuse **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_screen_stretch` **(** :ref:`int` mode, :ref:`int` aspect, :ref:`Vector2` minsize, :ref:`float` shrink=1 **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`call_group` **(** :ref:`String` group, :ref:`String` method **)** vararg | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`call_group_flags` **(** :ref:`int` flags, :ref:`String` group, :ref:`String` method **)** vararg | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`change_scene` **(** :ref:`String` path **)** | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`change_scene_to` **(** :ref:`PackedScene` packed_scene **)** | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`SceneTreeTimer` | :ref:`create_timer` **(** :ref:`float` time_sec, :ref:`bool` pause_mode_process=true **)** | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`get_current_scene` **(** **)** const | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`get_edited_scene_root` **(** **)** const | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_frame` **(** **)** const | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`get_network_connected_peers` **(** **)** const | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_network_unique_id` **(** **)** const | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_node_count` **(** **)** const | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_nodes_in_group` **(** :ref:`String` group **)** | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Viewport` | :ref:`get_root` **(** **)** const | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_rpc_sender_id` **(** **)** const | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_group` **(** :ref:`String` name **)** const | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_network_peer` **(** **)** const | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_debugging_collisions_hint` **(** **)** const | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_debugging_navigation_hint` **(** **)** const | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_input_handled` **(** **)** | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_network_server` **(** **)** const | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_paused` **(** **)** const | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_refusing_new_network_connections` **(** **)** const | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`notify_group` **(** :ref:`String` group, :ref:`int` notification **)** | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`notify_group_flags` **(** :ref:`int` call_flags, :ref:`String` group, :ref:`int` notification **)** | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`queue_delete` **(** :ref:`Object` obj **)** | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`quit` **(** **)** | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`reload_current_scene` **(** **)** | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_auto_accept_quit` **(** :ref:`bool` enabled **)** | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_current_scene` **(** :ref:`Node` child_node **)** | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_debug_collisions_hint` **(** :ref:`bool` enable **)** | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_debug_navigation_hint` **(** :ref:`bool` enable **)** | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_edited_scene_root` **(** :ref:`Node` scene **)** | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_group` **(** :ref:`String` group, :ref:`String` property, :ref:`Variant` value **)** | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_group_flags` **(** :ref:`int` call_flags, :ref:`String` group, :ref:`String` property, :ref:`Variant` value **)** | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_input_as_handled` **(** **)** | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_network_peer` **(** :ref:`NetworkedMultiplayerPeer` peer **)** | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pause` **(** :ref:`bool` enable **)** | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_refuse_new_network_connections` **(** :ref:`bool` refuse **)** | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_screen_stretch` **(** :ref:`int` mode, :ref:`int` aspect, :ref:`Vector2` minsize, :ref:`float` shrink=1 **)** | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_SceneTree_connected_to_server: -- **connected_to_server** **(** **)** +- **connected_to_server** **(** **)** .. _class_SceneTree_connection_failed: -- **connection_failed** **(** **)** +- **connection_failed** **(** **)** .. _class_SceneTree_files_dropped: -- **files_dropped** **(** :ref:`PoolStringArray` files, :ref:`int` screen **)** +- **files_dropped** **(** :ref:`PoolStringArray` files, :ref:`int` screen **)** .. _class_SceneTree_idle_frame: -- **idle_frame** **(** **)** +- **idle_frame** **(** **)** .. _class_SceneTree_network_peer_connected: -- **network_peer_connected** **(** :ref:`int` id **)** +- **network_peer_connected** **(** :ref:`int` id **)** .. _class_SceneTree_network_peer_disconnected: -- **network_peer_disconnected** **(** :ref:`int` id **)** +- **network_peer_disconnected** **(** :ref:`int` id **)** .. _class_SceneTree_node_added: -- **node_added** **(** :ref:`Object` node **)** +- **node_added** **(** :ref:`Object` node **)** .. _class_SceneTree_node_configuration_warning_changed: -- **node_configuration_warning_changed** **(** :ref:`Object` node **)** +- **node_configuration_warning_changed** **(** :ref:`Object` node **)** .. _class_SceneTree_node_removed: -- **node_removed** **(** :ref:`Object` node **)** +- **node_removed** **(** :ref:`Object` node **)** .. _class_SceneTree_physics_frame: -- **physics_frame** **(** **)** +- **physics_frame** **(** **)** .. _class_SceneTree_screen_resized: -- **screen_resized** **(** **)** +- **screen_resized** **(** **)** .. _class_SceneTree_server_disconnected: -- **server_disconnected** **(** **)** +- **server_disconnected** **(** **)** .. _class_SceneTree_tree_changed: -- **tree_changed** **(** **)** +- **tree_changed** **(** **)** Numeric Constants @@ -176,164 +176,164 @@ Member Function Description .. _class_SceneTree_call_group: -- :ref:`Variant` **call_group** **(** :ref:`String` group, :ref:`String` method **)** vararg +- :ref:`Variant` **call_group** **(** :ref:`String` group, :ref:`String` method **)** vararg .. _class_SceneTree_call_group_flags: -- :ref:`Variant` **call_group_flags** **(** :ref:`int` flags, :ref:`String` group, :ref:`String` method **)** vararg +- :ref:`Variant` **call_group_flags** **(** :ref:`int` flags, :ref:`String` group, :ref:`String` method **)** vararg .. _class_SceneTree_change_scene: -- :ref:`int` **change_scene** **(** :ref:`String` path **)** +- :ref:`int` **change_scene** **(** :ref:`String` path **)** .. _class_SceneTree_change_scene_to: -- :ref:`int` **change_scene_to** **(** :ref:`PackedScene` packed_scene **)** +- :ref:`int` **change_scene_to** **(** :ref:`PackedScene` packed_scene **)** .. _class_SceneTree_create_timer: -- :ref:`SceneTreeTimer` **create_timer** **(** :ref:`float` time_sec, :ref:`bool` pause_mode_process=true **)** +- :ref:`SceneTreeTimer` **create_timer** **(** :ref:`float` time_sec, :ref:`bool` pause_mode_process=true **)** .. _class_SceneTree_get_current_scene: -- :ref:`Node` **get_current_scene** **(** **)** const +- :ref:`Node` **get_current_scene** **(** **)** const .. _class_SceneTree_get_edited_scene_root: -- :ref:`Node` **get_edited_scene_root** **(** **)** const +- :ref:`Node` **get_edited_scene_root** **(** **)** const .. _class_SceneTree_get_frame: -- :ref:`int` **get_frame** **(** **)** const +- :ref:`int` **get_frame** **(** **)** const .. _class_SceneTree_get_network_connected_peers: -- :ref:`PoolIntArray` **get_network_connected_peers** **(** **)** const +- :ref:`PoolIntArray` **get_network_connected_peers** **(** **)** const .. _class_SceneTree_get_network_unique_id: -- :ref:`int` **get_network_unique_id** **(** **)** const +- :ref:`int` **get_network_unique_id** **(** **)** const .. _class_SceneTree_get_node_count: -- :ref:`int` **get_node_count** **(** **)** const +- :ref:`int` **get_node_count** **(** **)** const .. _class_SceneTree_get_nodes_in_group: -- :ref:`Array` **get_nodes_in_group** **(** :ref:`String` group **)** +- :ref:`Array` **get_nodes_in_group** **(** :ref:`String` group **)** .. _class_SceneTree_get_root: -- :ref:`Viewport` **get_root** **(** **)** const +- :ref:`Viewport` **get_root** **(** **)** const .. _class_SceneTree_get_rpc_sender_id: -- :ref:`int` **get_rpc_sender_id** **(** **)** const +- :ref:`int` **get_rpc_sender_id** **(** **)** const .. _class_SceneTree_has_group: -- :ref:`bool` **has_group** **(** :ref:`String` name **)** const +- :ref:`bool` **has_group** **(** :ref:`String` name **)** const .. _class_SceneTree_has_network_peer: -- :ref:`bool` **has_network_peer** **(** **)** const +- :ref:`bool` **has_network_peer** **(** **)** const Returns true if there is a :ref:`NetworkedMultiplayerPeer` set (with :ref:`SceneTree.set_network_peer`). .. _class_SceneTree_is_debugging_collisions_hint: -- :ref:`bool` **is_debugging_collisions_hint** **(** **)** const +- :ref:`bool` **is_debugging_collisions_hint** **(** **)** const .. _class_SceneTree_is_debugging_navigation_hint: -- :ref:`bool` **is_debugging_navigation_hint** **(** **)** const +- :ref:`bool` **is_debugging_navigation_hint** **(** **)** const .. _class_SceneTree_is_input_handled: -- :ref:`bool` **is_input_handled** **(** **)** +- :ref:`bool` **is_input_handled** **(** **)** .. _class_SceneTree_is_network_server: -- :ref:`bool` **is_network_server** **(** **)** const +- :ref:`bool` **is_network_server** **(** **)** const Returns true if this SceneTree's :ref:`NetworkedMultiplayerPeer` is in server mode (listening for connections). .. _class_SceneTree_is_paused: -- :ref:`bool` **is_paused** **(** **)** const +- :ref:`bool` **is_paused** **(** **)** const .. _class_SceneTree_is_refusing_new_network_connections: -- :ref:`bool` **is_refusing_new_network_connections** **(** **)** const +- :ref:`bool` **is_refusing_new_network_connections** **(** **)** const .. _class_SceneTree_notify_group: -- void **notify_group** **(** :ref:`String` group, :ref:`int` notification **)** +- void **notify_group** **(** :ref:`String` group, :ref:`int` notification **)** .. _class_SceneTree_notify_group_flags: -- void **notify_group_flags** **(** :ref:`int` call_flags, :ref:`String` group, :ref:`int` notification **)** +- void **notify_group_flags** **(** :ref:`int` call_flags, :ref:`String` group, :ref:`int` notification **)** .. _class_SceneTree_queue_delete: -- void **queue_delete** **(** :ref:`Object` obj **)** +- void **queue_delete** **(** :ref:`Object` obj **)** .. _class_SceneTree_quit: -- void **quit** **(** **)** +- void **quit** **(** **)** .. _class_SceneTree_reload_current_scene: -- :ref:`int` **reload_current_scene** **(** **)** +- :ref:`int` **reload_current_scene** **(** **)** .. _class_SceneTree_set_auto_accept_quit: -- void **set_auto_accept_quit** **(** :ref:`bool` enabled **)** +- void **set_auto_accept_quit** **(** :ref:`bool` enabled **)** .. _class_SceneTree_set_current_scene: -- void **set_current_scene** **(** :ref:`Node` child_node **)** +- void **set_current_scene** **(** :ref:`Node` child_node **)** .. _class_SceneTree_set_debug_collisions_hint: -- void **set_debug_collisions_hint** **(** :ref:`bool` enable **)** +- void **set_debug_collisions_hint** **(** :ref:`bool` enable **)** .. _class_SceneTree_set_debug_navigation_hint: -- void **set_debug_navigation_hint** **(** :ref:`bool` enable **)** +- void **set_debug_navigation_hint** **(** :ref:`bool` enable **)** .. _class_SceneTree_set_edited_scene_root: -- void **set_edited_scene_root** **(** :ref:`Node` scene **)** +- void **set_edited_scene_root** **(** :ref:`Node` scene **)** .. _class_SceneTree_set_group: -- void **set_group** **(** :ref:`String` group, :ref:`String` property, :ref:`Variant` value **)** +- void **set_group** **(** :ref:`String` group, :ref:`String` property, :ref:`Variant` value **)** .. _class_SceneTree_set_group_flags: -- void **set_group_flags** **(** :ref:`int` call_flags, :ref:`String` group, :ref:`String` property, :ref:`Variant` value **)** +- void **set_group_flags** **(** :ref:`int` call_flags, :ref:`String` group, :ref:`String` property, :ref:`Variant` value **)** .. _class_SceneTree_set_input_as_handled: -- void **set_input_as_handled** **(** **)** +- void **set_input_as_handled** **(** **)** .. _class_SceneTree_set_network_peer: -- void **set_network_peer** **(** :ref:`NetworkedMultiplayerPeer` peer **)** +- void **set_network_peer** **(** :ref:`NetworkedMultiplayerPeer` peer **)** Set the peer object to handle the RPC system (effectively enabling networking). Depending on the peer itself, the SceneTree will become a network server (check with :ref:`is_network_server()`) and will set root node's network mode to master (see NETWORK_MODE\_\* constants in :ref:`Node`), or it will become a regular peer with root node set to slave. All child nodes are set to inherit the network mode by default. Handling of networking-related events (connection, disconnection, new clients) is done by connecting to SceneTree's signals. .. _class_SceneTree_set_pause: -- void **set_pause** **(** :ref:`bool` enable **)** +- void **set_pause** **(** :ref:`bool` enable **)** .. _class_SceneTree_set_refuse_new_network_connections: -- void **set_refuse_new_network_connections** **(** :ref:`bool` refuse **)** +- void **set_refuse_new_network_connections** **(** :ref:`bool` refuse **)** .. _class_SceneTree_set_screen_stretch: -- void **set_screen_stretch** **(** :ref:`int` mode, :ref:`int` aspect, :ref:`Vector2` minsize, :ref:`float` shrink=1 **)** +- void **set_screen_stretch** **(** :ref:`int` mode, :ref:`int` aspect, :ref:`Vector2` minsize, :ref:`float` shrink=1 **)** diff --git a/classes/class_scenetreetimer.rst b/classes/class_scenetreetimer.rst index 01bf1e270..82dc1eb10 100644 --- a/classes/class_scenetreetimer.rst +++ b/classes/class_scenetreetimer.rst @@ -19,18 +19,18 @@ Brief Description Member Functions ---------------- -+----------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_time_left` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_time_left` **(** :ref:`float` time **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------+ ++----------------------------+-----------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_time_left` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------+ +| void | :ref:`set_time_left` **(** :ref:`float` time **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------+ Signals ------- .. _class_SceneTreeTimer_timeout: -- **timeout** **(** **)** +- **timeout** **(** **)** Member Function Description @@ -38,10 +38,10 @@ Member Function Description .. _class_SceneTreeTimer_get_time_left: -- :ref:`float` **get_time_left** **(** **)** const +- :ref:`float` **get_time_left** **(** **)** const .. _class_SceneTreeTimer_set_time_left: -- void **set_time_left** **(** :ref:`float` time **)** +- void **set_time_left** **(** :ref:`float` time **)** diff --git a/classes/class_script.rst b/classes/class_script.rst index d9dc9303d..72c4bd040 100644 --- a/classes/class_script.rst +++ b/classes/class_script.rst @@ -21,25 +21,25 @@ A class stored as a resource. Member Functions ---------------- -+------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_instance` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_node_type` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_source_code` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_script_signal` **(** :ref:`String` signal_name **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_source_code` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`instance_has` **(** :ref:`Object` base_object **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_tool` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`reload` **(** :ref:`bool` keep_state=false **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_source_code` **(** :ref:`String` source **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------+ ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_instance` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_node_type` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_source_code` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_script_signal` **(** :ref:`String` signal_name **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_source_code` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`instance_has` **(** :ref:`Object` base_object **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_tool` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`reload` **(** :ref:`bool` keep_state=false **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_source_code` **(** :ref:`String` source **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -53,53 +53,53 @@ Member Function Description .. _class_Script_can_instance: -- :ref:`bool` **can_instance** **(** **)** const +- :ref:`bool` **can_instance** **(** **)** const Returns true if the script can be instanced. .. _class_Script_get_node_type: -- :ref:`String` **get_node_type** **(** **)** const +- :ref:`String` **get_node_type** **(** **)** const .. _class_Script_get_source_code: -- :ref:`String` **get_source_code** **(** **)** const +- :ref:`String` **get_source_code** **(** **)** const Returns the script source code, or an empty string if source code is not available. .. _class_Script_has_script_signal: -- :ref:`bool` **has_script_signal** **(** :ref:`String` signal_name **)** const +- :ref:`bool` **has_script_signal** **(** :ref:`String` signal_name **)** const Returns true if the script, or a base class, defines a signal with the given name. .. _class_Script_has_source_code: -- :ref:`bool` **has_source_code** **(** **)** const +- :ref:`bool` **has_source_code** **(** **)** const Returns true if the script contains non-empty source code. .. _class_Script_instance_has: -- :ref:`bool` **instance_has** **(** :ref:`Object` base_object **)** const +- :ref:`bool` **instance_has** **(** :ref:`Object` base_object **)** const Returns true if 'base_object' is an instance of this script. .. _class_Script_is_tool: -- :ref:`bool` **is_tool** **(** **)** const +- :ref:`bool` **is_tool** **(** **)** const Returns true if the script is a tool script. A tool script can run in the editor. .. _class_Script_reload: -- :ref:`int` **reload** **(** :ref:`bool` keep_state=false **)** +- :ref:`int` **reload** **(** :ref:`bool` keep_state=false **)** Reloads the script's class implementation. Returns an error code. .. _class_Script_set_source_code: -- void **set_source_code** **(** :ref:`String` source **)** +- void **set_source_code** **(** :ref:`String` source **)** Sets the script source code. Does not reload the class implementation. diff --git a/classes/class_scripteditor.rst b/classes/class_scripteditor.rst index d3ad88be5..04717d49d 100644 --- a/classes/class_scripteditor.rst +++ b/classes/class_scripteditor.rst @@ -19,24 +19,24 @@ Brief Description Member Functions ---------------- -+------------------------------+---------------------------------------------------------------------------------+ -| :ref:`Script` | :ref:`get_current_script` **(** **)** | -+------------------------------+---------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_open_scripts` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------+ ++------------------------------+--------------------------------------------------------------------------------+ +| :ref:`Script` | :ref:`get_current_script` **(** **)** | ++------------------------------+--------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_open_scripts` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------+ Signals ------- .. _class_ScriptEditor_editor_script_changed: -- **editor_script_changed** **(** :ref:`Object` script **)** +- **editor_script_changed** **(** :ref:`Object` script **)** Emitted when user changed active script. Argument is a freshly activated :ref:`Script`. .. _class_ScriptEditor_script_close: -- **script_close** **(** :ref:`Object` script **)** +- **script_close** **(** :ref:`Object` script **)** Emitted when editor is about to close the active script. Argument is a :ref:`Script` that is going to be closed. @@ -46,13 +46,13 @@ Member Function Description .. _class_ScriptEditor_get_current_script: -- :ref:`Script` **get_current_script** **(** **)** +- :ref:`Script` **get_current_script** **(** **)** Returns a :ref:`Script` that is currently active in editor. .. _class_ScriptEditor_get_open_scripts: -- :ref:`Array` **get_open_scripts** **(** **)** const +- :ref:`Array` **get_open_scripts** **(** **)** const Returns an array with all :ref:`Script` objects which are currently open in editor. diff --git a/classes/class_scrollbar.rst b/classes/class_scrollbar.rst index d2901f188..ab613f888 100644 --- a/classes/class_scrollbar.rst +++ b/classes/class_scrollbar.rst @@ -21,18 +21,18 @@ Base class for scroll bars. Member Functions ---------------- -+----------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_custom_step` **(** **)** const | -+----------------------------+------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_step` **(** :ref:`float` step **)** | -+----------------------------+------------------------------------------------------------------------------------------------------+ ++----------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_custom_step` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_step` **(** :ref:`float` step **)** | ++----------------------------+----------------------------------------------------------------------------------------------------+ Signals ------- .. _class_ScrollBar_scrolling: -- **scrolling** **(** **)** +- **scrolling** **(** **)** Member Variables @@ -53,10 +53,10 @@ Member Function Description .. _class_ScrollBar_get_custom_step: -- :ref:`float` **get_custom_step** **(** **)** const +- :ref:`float` **get_custom_step** **(** **)** const .. _class_ScrollBar_set_custom_step: -- void **set_custom_step** **(** :ref:`float` step **)** +- void **set_custom_step** **(** :ref:`float` step **)** diff --git a/classes/class_scrollcontainer.rst b/classes/class_scrollcontainer.rst index 5c36ae8f6..547a55789 100644 --- a/classes/class_scrollcontainer.rst +++ b/classes/class_scrollcontainer.rst @@ -19,23 +19,23 @@ A helper node for displaying scrollable elements (e.g. lists). Member Functions ---------------- -+--------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_h_scroll` **(** **)** const | -+--------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_v_scroll` **(** **)** const | -+--------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_h_scroll_enabled` **(** **)** const | -+--------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_v_scroll_enabled` **(** **)** const | -+--------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_enable_h_scroll` **(** :ref:`bool` enable **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_enable_v_scroll` **(** :ref:`bool` enable **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_h_scroll` **(** :ref:`int` val **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_v_scroll` **(** :ref:`int` val **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------+ ++--------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_h_scroll` **(** **)** const | ++--------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_v_scroll` **(** **)** const | ++--------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_h_scroll_enabled` **(** **)** const | ++--------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_v_scroll_enabled` **(** **)** const | ++--------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_enable_h_scroll` **(** :ref:`bool` enable **)** | ++--------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_enable_v_scroll` **(** :ref:`bool` enable **)** | ++--------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_h_scroll` **(** :ref:`int` val **)** | ++--------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_v_scroll` **(** :ref:`int` val **)** | ++--------------------------+------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -59,49 +59,49 @@ Member Function Description .. _class_ScrollContainer_get_h_scroll: -- :ref:`int` **get_h_scroll** **(** **)** const +- :ref:`int` **get_h_scroll** **(** **)** const Return current horizontal scroll value. .. _class_ScrollContainer_get_v_scroll: -- :ref:`int` **get_v_scroll** **(** **)** const +- :ref:`int` **get_v_scroll** **(** **)** const Return current vertical scroll value. .. _class_ScrollContainer_is_h_scroll_enabled: -- :ref:`bool` **is_h_scroll_enabled** **(** **)** const +- :ref:`bool` **is_h_scroll_enabled** **(** **)** const Return true if horizontal scroll is allowed. .. _class_ScrollContainer_is_v_scroll_enabled: -- :ref:`bool` **is_v_scroll_enabled** **(** **)** const +- :ref:`bool` **is_v_scroll_enabled** **(** **)** const Return true if vertical scroll is allowed. .. _class_ScrollContainer_set_enable_h_scroll: -- void **set_enable_h_scroll** **(** :ref:`bool` enable **)** +- void **set_enable_h_scroll** **(** :ref:`bool` enable **)** Set allows horizontal scroll. .. _class_ScrollContainer_set_enable_v_scroll: -- void **set_enable_v_scroll** **(** :ref:`bool` enable **)** +- void **set_enable_v_scroll** **(** :ref:`bool` enable **)** Set allows vertical scroll. .. _class_ScrollContainer_set_h_scroll: -- void **set_h_scroll** **(** :ref:`int` val **)** +- void **set_h_scroll** **(** :ref:`int` val **)** Set horizontal scroll value. .. _class_ScrollContainer_set_v_scroll: -- void **set_v_scroll** **(** :ref:`int` val **)** +- void **set_v_scroll** **(** :ref:`int` val **)** Set vertical scroll value. diff --git a/classes/class_segmentshape2d.rst b/classes/class_segmentshape2d.rst index 0aeafe6fb..043fbabf5 100644 --- a/classes/class_segmentshape2d.rst +++ b/classes/class_segmentshape2d.rst @@ -19,15 +19,15 @@ Segment shape for 2D collisions. Member Functions ---------------- -+--------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_a` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_b` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------+ -| void | :ref:`set_a` **(** :ref:`Vector2` a **)** | -+--------------------------------+----------------------------------------------------------------------------------------+ -| void | :ref:`set_b` **(** :ref:`Vector2` b **)** | -+--------------------------------+----------------------------------------------------------------------------------------+ ++--------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_a` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_b` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------+ +| void | :ref:`set_a` **(** :ref:`Vector2` a **)** | ++--------------------------------+--------------------------------------------------------------------------------------+ +| void | :ref:`set_b` **(** :ref:`Vector2` b **)** | ++--------------------------------+--------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -51,25 +51,25 @@ Member Function Description .. _class_SegmentShape2D_get_a: -- :ref:`Vector2` **get_a** **(** **)** const +- :ref:`Vector2` **get_a** **(** **)** const Return the first point's position. .. _class_SegmentShape2D_get_b: -- :ref:`Vector2` **get_b** **(** **)** const +- :ref:`Vector2` **get_b** **(** **)** const Return the second point's position. .. _class_SegmentShape2D_set_a: -- void **set_a** **(** :ref:`Vector2` a **)** +- void **set_a** **(** :ref:`Vector2` a **)** Set the first point's position. .. _class_SegmentShape2D_set_b: -- void **set_b** **(** :ref:`Vector2` b **)** +- void **set_b** **(** :ref:`Vector2` b **)** Set the second point's position. diff --git a/classes/class_semaphore.rst b/classes/class_semaphore.rst index 73ef15f44..2a601584b 100644 --- a/classes/class_semaphore.rst +++ b/classes/class_semaphore.rst @@ -19,11 +19,11 @@ A synchronization Semaphore. Member Functions ---------------- -+------------------------+------------------------------------------------+ -| :ref:`int` | :ref:`post` **(** **)** | -+------------------------+------------------------------------------------+ -| :ref:`int` | :ref:`wait` **(** **)** | -+------------------------+------------------------------------------------+ ++------------------------+-----------------------------------------------+ +| :ref:`int` | :ref:`post` **(** **)** | ++------------------------+-----------------------------------------------+ +| :ref:`int` | :ref:`wait` **(** **)** | ++------------------------+-----------------------------------------------+ Description ----------- @@ -35,13 +35,13 @@ Member Function Description .. _class_Semaphore_post: -- :ref:`int` **post** **(** **)** +- :ref:`int` **post** **(** **)** Lowers the :ref:`Semaphore`, allowing one more thread in. .. _class_Semaphore_wait: -- :ref:`int` **wait** **(** **)** +- :ref:`int` **wait** **(** **)** Tries to wait for the :ref:`Semaphore`, if its value is zero, blocks until non-zero. diff --git a/classes/class_shader.rst b/classes/class_shader.rst index 65b9c9dcd..5e91a219d 100644 --- a/classes/class_shader.rst +++ b/classes/class_shader.rst @@ -19,19 +19,19 @@ To be changed, ignore. Member Functions ---------------- -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_code` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_default_texture_param` **(** :ref:`String` param **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_mode` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_param` **(** :ref:`String` name **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_code` **(** :ref:`String` code **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_default_texture_param` **(** :ref:`String` param, :ref:`Texture` texture **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_code` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_default_texture_param` **(** :ref:`String` param **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_mode` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_param` **(** :ref:`String` name **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_code` **(** :ref:`String` code **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_default_texture_param` **(** :ref:`String` param, :ref:`Texture` texture **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -58,26 +58,26 @@ Member Function Description .. _class_Shader_get_code: -- :ref:`String` **get_code** **(** **)** const +- :ref:`String` **get_code** **(** **)** const .. _class_Shader_get_default_texture_param: -- :ref:`Texture` **get_default_texture_param** **(** :ref:`String` param **)** const +- :ref:`Texture` **get_default_texture_param** **(** :ref:`String` param **)** const .. _class_Shader_get_mode: -- :ref:`int` **get_mode** **(** **)** const +- :ref:`int` **get_mode** **(** **)** const .. _class_Shader_has_param: -- :ref:`bool` **has_param** **(** :ref:`String` name **)** const +- :ref:`bool` **has_param** **(** :ref:`String` name **)** const .. _class_Shader_set_code: -- void **set_code** **(** :ref:`String` code **)** +- void **set_code** **(** :ref:`String` code **)** .. _class_Shader_set_default_texture_param: -- void **set_default_texture_param** **(** :ref:`String` param, :ref:`Texture` texture **)** +- void **set_default_texture_param** **(** :ref:`String` param, :ref:`Texture` texture **)** diff --git a/classes/class_shadermaterial.rst b/classes/class_shadermaterial.rst index ad2c56967..307a3033f 100644 --- a/classes/class_shadermaterial.rst +++ b/classes/class_shadermaterial.rst @@ -19,33 +19,33 @@ Brief Description Member Functions ---------------- -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Shader` | :ref:`get_shader` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_shader_param` **(** :ref:`String` param **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shader` **(** :ref:`Shader` shader **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shader_param` **(** :ref:`String` param, :ref:`Variant` value **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Shader` | :ref:`get_shader` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_shader_param` **(** :ref:`String` param **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shader` **(** :ref:`Shader` shader **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shader_param` **(** :ref:`String` param, :ref:`Variant` value **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ Member Function Description --------------------------- .. _class_ShaderMaterial_get_shader: -- :ref:`Shader` **get_shader** **(** **)** const +- :ref:`Shader` **get_shader** **(** **)** const .. _class_ShaderMaterial_get_shader_param: -- :ref:`Variant` **get_shader_param** **(** :ref:`String` param **)** const +- :ref:`Variant` **get_shader_param** **(** :ref:`String` param **)** const .. _class_ShaderMaterial_set_shader: -- void **set_shader** **(** :ref:`Shader` shader **)** +- void **set_shader** **(** :ref:`Shader` shader **)** .. _class_ShaderMaterial_set_shader_param: -- void **set_shader_param** **(** :ref:`String` param, :ref:`Variant` value **)** +- void **set_shader_param** **(** :ref:`String` param, :ref:`Variant` value **)** diff --git a/classes/class_shape2d.rst b/classes/class_shape2d.rst index 7ae0adc67..38752dd09 100644 --- a/classes/class_shape2d.rst +++ b/classes/class_shape2d.rst @@ -21,19 +21,19 @@ Base class for all 2D Shapes. Member Functions ---------------- -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`collide` **(** :ref:`Transform2D` local_xform, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`collide_and_get_contacts` **(** :ref:`Transform2D` local_xform, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`collide_with_motion` **(** :ref:`Transform2D` local_xform, :ref:`Vector2` local_motion, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform, :ref:`Vector2` shape_motion **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`collide_with_motion_and_get_contacts` **(** :ref:`Transform2D` local_xform, :ref:`Vector2` local_motion, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform, :ref:`Vector2` shape_motion **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_custom_solver_bias` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_solver_bias` **(** :ref:`float` bias **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`collide` **(** :ref:`Transform2D` local_xform, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`collide_and_get_contacts` **(** :ref:`Transform2D` local_xform, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`collide_with_motion` **(** :ref:`Transform2D` local_xform, :ref:`Vector2` local_motion, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform, :ref:`Vector2` shape_motion **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`collide_with_motion_and_get_contacts` **(** :ref:`Transform2D` local_xform, :ref:`Vector2` local_motion, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform, :ref:`Vector2` shape_motion **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_custom_solver_bias` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_solver_bias` **(** :ref:`float` bias **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -53,7 +53,7 @@ Member Function Description .. _class_Shape2D_collide: -- :ref:`bool` **collide** **(** :ref:`Transform2D` local_xform, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform **)** +- :ref:`bool` **collide** **(** :ref:`Transform2D` local_xform, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform **)** Return whether this shape is colliding with another. @@ -61,7 +61,7 @@ This method needs the transformation matrix for this shape (``local_xform``), th .. _class_Shape2D_collide_and_get_contacts: -- :ref:`Variant` **collide_and_get_contacts** **(** :ref:`Transform2D` local_xform, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform **)** +- :ref:`Variant` **collide_and_get_contacts** **(** :ref:`Transform2D` local_xform, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform **)** Return a list of the points where this shape touches another. If there are no collisions, the list is empty. @@ -69,7 +69,7 @@ This method needs the transformation matrix for this shape (``local_xform``), th .. _class_Shape2D_collide_with_motion: -- :ref:`bool` **collide_with_motion** **(** :ref:`Transform2D` local_xform, :ref:`Vector2` local_motion, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform, :ref:`Vector2` shape_motion **)** +- :ref:`bool` **collide_with_motion** **(** :ref:`Transform2D` local_xform, :ref:`Vector2` local_motion, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform, :ref:`Vector2` shape_motion **)** Return whether this shape would collide with another, if a given movement was applied. @@ -77,7 +77,7 @@ This method needs the transformation matrix for this shape (``local_xform``), th .. _class_Shape2D_collide_with_motion_and_get_contacts: -- :ref:`Variant` **collide_with_motion_and_get_contacts** **(** :ref:`Transform2D` local_xform, :ref:`Vector2` local_motion, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform, :ref:`Vector2` shape_motion **)** +- :ref:`Variant` **collide_with_motion_and_get_contacts** **(** :ref:`Transform2D` local_xform, :ref:`Vector2` local_motion, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform, :ref:`Vector2` shape_motion **)** Return a list of the points where this shape would touch another, if a given movement was applied. If there are no collisions, the list is empty. @@ -85,13 +85,13 @@ This method needs the transformation matrix for this shape (``local_xform``), th .. _class_Shape2D_get_custom_solver_bias: -- :ref:`float` **get_custom_solver_bias** **(** **)** const +- :ref:`float` **get_custom_solver_bias** **(** **)** const Return the custom solver bias. .. _class_Shape2D_set_custom_solver_bias: -- void **set_custom_solver_bias** **(** :ref:`float` bias **)** +- void **set_custom_solver_bias** **(** :ref:`float` bias **)** Use a custom solver bias. No need to change this unless you really know what you are doing. diff --git a/classes/class_shortcut.rst b/classes/class_shortcut.rst index 07a00b814..675c8dfd2 100644 --- a/classes/class_shortcut.rst +++ b/classes/class_shortcut.rst @@ -19,17 +19,17 @@ Brief Description Member Functions ---------------- -+--------------------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_as_text` **(** **)** const | -+--------------------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`InputEvent` | :ref:`get_shortcut` **(** **)** const | -+--------------------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_shortcut` **(** :ref:`InputEvent` event **)** const | -+--------------------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_valid` **(** **)** const | -+--------------------------------------+--------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shortcut` **(** :ref:`InputEvent` event **)** | -+--------------------------------------+--------------------------------------------------------------------------------------------------------------+ ++--------------------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_as_text` **(** **)** const | ++--------------------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`InputEvent` | :ref:`get_shortcut` **(** **)** const | ++--------------------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_shortcut` **(** :ref:`InputEvent` event **)** const | ++--------------------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_valid` **(** **)** const | ++--------------------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shortcut` **(** :ref:`InputEvent` event **)** | ++--------------------------------------+------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -44,22 +44,22 @@ Member Function Description .. _class_ShortCut_get_as_text: -- :ref:`String` **get_as_text** **(** **)** const +- :ref:`String` **get_as_text** **(** **)** const .. _class_ShortCut_get_shortcut: -- :ref:`InputEvent` **get_shortcut** **(** **)** const +- :ref:`InputEvent` **get_shortcut** **(** **)** const .. _class_ShortCut_is_shortcut: -- :ref:`bool` **is_shortcut** **(** :ref:`InputEvent` event **)** const +- :ref:`bool` **is_shortcut** **(** :ref:`InputEvent` event **)** const .. _class_ShortCut_is_valid: -- :ref:`bool` **is_valid** **(** **)** const +- :ref:`bool` **is_valid** **(** **)** const .. _class_ShortCut_set_shortcut: -- void **set_shortcut** **(** :ref:`InputEvent` event **)** +- void **set_shortcut** **(** :ref:`InputEvent` event **)** diff --git a/classes/class_skeleton.rst b/classes/class_skeleton.rst index be9ab41b5..e4785203c 100644 --- a/classes/class_skeleton.rst +++ b/classes/class_skeleton.rst @@ -19,51 +19,51 @@ Skeleton for characters and animated objects. Member Functions ---------------- -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_bone` **(** :ref:`String` name **)** | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`bind_child_node_to_bone` **(** :ref:`int` bone_idx, :ref:`Node` node **)** | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_bones` **(** **)** | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_bone` **(** :ref:`String` name **)** const | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_bone_count` **(** **)** const | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_bone_custom_pose` **(** :ref:`int` bone_idx **)** const | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_bone_global_pose` **(** :ref:`int` bone_idx **)** const | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_bone_name` **(** :ref:`int` bone_idx **)** const | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_bone_parent` **(** :ref:`int` bone_idx **)** const | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_bone_pose` **(** :ref:`int` bone_idx **)** const | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_bone_rest` **(** :ref:`int` bone_idx **)** const | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_bone_transform` **(** :ref:`int` bone_idx **)** const | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_bound_child_nodes_to_bone` **(** :ref:`int` bone_idx **)** const | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_bone_rest_disabled` **(** :ref:`int` bone_idx **)** const | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bone_custom_pose` **(** :ref:`int` bone_idx, :ref:`Transform` custom_pose **)** | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bone_disable_rest` **(** :ref:`int` bone_idx, :ref:`bool` disable **)** | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bone_global_pose` **(** :ref:`int` bone_idx, :ref:`Transform` pose **)** | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bone_parent` **(** :ref:`int` bone_idx, :ref:`int` parent_idx **)** | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bone_pose` **(** :ref:`int` bone_idx, :ref:`Transform` pose **)** | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bone_rest` **(** :ref:`int` bone_idx, :ref:`Transform` rest **)** | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`unbind_child_node_from_bone` **(** :ref:`int` bone_idx, :ref:`Node` node **)** | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`unparent_bone_and_rest` **(** :ref:`int` bone_idx **)** | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_bone` **(** :ref:`String` name **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`bind_child_node_to_bone` **(** :ref:`int` bone_idx, :ref:`Node` node **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_bones` **(** **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find_bone` **(** :ref:`String` name **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_bone_count` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`get_bone_custom_pose` **(** :ref:`int` bone_idx **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`get_bone_global_pose` **(** :ref:`int` bone_idx **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_bone_name` **(** :ref:`int` bone_idx **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_bone_parent` **(** :ref:`int` bone_idx **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`get_bone_pose` **(** :ref:`int` bone_idx **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`get_bone_rest` **(** :ref:`int` bone_idx **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`get_bone_transform` **(** :ref:`int` bone_idx **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_bound_child_nodes_to_bone` **(** :ref:`int` bone_idx **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_bone_rest_disabled` **(** :ref:`int` bone_idx **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bone_custom_pose` **(** :ref:`int` bone_idx, :ref:`Transform` custom_pose **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bone_disable_rest` **(** :ref:`int` bone_idx, :ref:`bool` disable **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bone_global_pose` **(** :ref:`int` bone_idx, :ref:`Transform` pose **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bone_parent` **(** :ref:`int` bone_idx, :ref:`int` parent_idx **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bone_pose` **(** :ref:`int` bone_idx, :ref:`Transform` pose **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bone_rest` **(** :ref:`int` bone_idx, :ref:`Transform` rest **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`unbind_child_node_from_bone` **(** :ref:`int` bone_idx, :ref:`Node` node **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`unparent_bone_and_rest` **(** :ref:`int` bone_idx **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -80,118 +80,118 @@ Member Function Description .. _class_Skeleton_add_bone: -- void **add_bone** **(** :ref:`String` name **)** +- void **add_bone** **(** :ref:`String` name **)** Add a bone, with name "name". :ref:`get_bone_count` will become the bone index. .. _class_Skeleton_bind_child_node_to_bone: -- void **bind_child_node_to_bone** **(** :ref:`int` bone_idx, :ref:`Node` node **)** +- void **bind_child_node_to_bone** **(** :ref:`int` bone_idx, :ref:`Node` node **)** Deprecated soon. .. _class_Skeleton_clear_bones: -- void **clear_bones** **(** **)** +- void **clear_bones** **(** **)** Clear all the bones in this skeleton. .. _class_Skeleton_find_bone: -- :ref:`int` **find_bone** **(** :ref:`String` name **)** const +- :ref:`int` **find_bone** **(** :ref:`String` name **)** const Return the bone index that matches "name" as its name. .. _class_Skeleton_get_bone_count: -- :ref:`int` **get_bone_count** **(** **)** const +- :ref:`int` **get_bone_count** **(** **)** const Return the amount of bones in the skeleton. .. _class_Skeleton_get_bone_custom_pose: -- :ref:`Transform` **get_bone_custom_pose** **(** :ref:`int` bone_idx **)** const +- :ref:`Transform` **get_bone_custom_pose** **(** :ref:`int` bone_idx **)** const .. _class_Skeleton_get_bone_global_pose: -- :ref:`Transform` **get_bone_global_pose** **(** :ref:`int` bone_idx **)** const +- :ref:`Transform` **get_bone_global_pose** **(** :ref:`int` bone_idx **)** const .. _class_Skeleton_get_bone_name: -- :ref:`String` **get_bone_name** **(** :ref:`int` bone_idx **)** const +- :ref:`String` **get_bone_name** **(** :ref:`int` bone_idx **)** const Return the name of the bone at index "index" .. _class_Skeleton_get_bone_parent: -- :ref:`int` **get_bone_parent** **(** :ref:`int` bone_idx **)** const +- :ref:`int` **get_bone_parent** **(** :ref:`int` bone_idx **)** const Return the bone index which is the parent of the bone at "bone_idx". If -1, then bone has no parent. Note that the parent bone returned will always be less than "bone_idx". .. _class_Skeleton_get_bone_pose: -- :ref:`Transform` **get_bone_pose** **(** :ref:`int` bone_idx **)** const +- :ref:`Transform` **get_bone_pose** **(** :ref:`int` bone_idx **)** const Return the pose transform for bone "bone_idx". .. _class_Skeleton_get_bone_rest: -- :ref:`Transform` **get_bone_rest** **(** :ref:`int` bone_idx **)** const +- :ref:`Transform` **get_bone_rest** **(** :ref:`int` bone_idx **)** const Return the rest transform for a bone "bone_idx". .. _class_Skeleton_get_bone_transform: -- :ref:`Transform` **get_bone_transform** **(** :ref:`int` bone_idx **)** const +- :ref:`Transform` **get_bone_transform** **(** :ref:`int` bone_idx **)** const .. _class_Skeleton_get_bound_child_nodes_to_bone: -- :ref:`Array` **get_bound_child_nodes_to_bone** **(** :ref:`int` bone_idx **)** const +- :ref:`Array` **get_bound_child_nodes_to_bone** **(** :ref:`int` bone_idx **)** const Deprecated soon. .. _class_Skeleton_is_bone_rest_disabled: -- :ref:`bool` **is_bone_rest_disabled** **(** :ref:`int` bone_idx **)** const +- :ref:`bool` **is_bone_rest_disabled** **(** :ref:`int` bone_idx **)** const .. _class_Skeleton_set_bone_custom_pose: -- void **set_bone_custom_pose** **(** :ref:`int` bone_idx, :ref:`Transform` custom_pose **)** +- void **set_bone_custom_pose** **(** :ref:`int` bone_idx, :ref:`Transform` custom_pose **)** .. _class_Skeleton_set_bone_disable_rest: -- void **set_bone_disable_rest** **(** :ref:`int` bone_idx, :ref:`bool` disable **)** +- void **set_bone_disable_rest** **(** :ref:`int` bone_idx, :ref:`bool` disable **)** .. _class_Skeleton_set_bone_global_pose: -- void **set_bone_global_pose** **(** :ref:`int` bone_idx, :ref:`Transform` pose **)** +- void **set_bone_global_pose** **(** :ref:`int` bone_idx, :ref:`Transform` pose **)** .. _class_Skeleton_set_bone_parent: -- void **set_bone_parent** **(** :ref:`int` bone_idx, :ref:`int` parent_idx **)** +- void **set_bone_parent** **(** :ref:`int` bone_idx, :ref:`int` parent_idx **)** Set the bone index "parent_idx" as the parent of the bone at "bone_idx". If -1, then bone has no parent. Note: "parent_idx" must be less than "bone_idx". .. _class_Skeleton_set_bone_pose: -- void **set_bone_pose** **(** :ref:`int` bone_idx, :ref:`Transform` pose **)** +- void **set_bone_pose** **(** :ref:`int` bone_idx, :ref:`Transform` pose **)** Return the pose transform for bone "bone_idx". .. _class_Skeleton_set_bone_rest: -- void **set_bone_rest** **(** :ref:`int` bone_idx, :ref:`Transform` rest **)** +- void **set_bone_rest** **(** :ref:`int` bone_idx, :ref:`Transform` rest **)** Set the rest transform for bone "bone_idx" .. _class_Skeleton_unbind_child_node_from_bone: -- void **unbind_child_node_from_bone** **(** :ref:`int` bone_idx, :ref:`Node` node **)** +- void **unbind_child_node_from_bone** **(** :ref:`int` bone_idx, :ref:`Node` node **)** Deprecated soon. .. _class_Skeleton_unparent_bone_and_rest: -- void **unparent_bone_and_rest** **(** :ref:`int` bone_idx **)** +- void **unparent_bone_and_rest** **(** :ref:`int` bone_idx **)** diff --git a/classes/class_sky.rst b/classes/class_sky.rst index 8f62f76ad..2eaaa07b2 100644 --- a/classes/class_sky.rst +++ b/classes/class_sky.rst @@ -21,11 +21,11 @@ Brief Description Member Functions ---------------- -+------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_radiance_size` **(** **)** const | -+------------------------+------------------------------------------------------------------------------------------------+ -| void | :ref:`set_radiance_size` **(** :ref:`int` size **)** | -+------------------------+------------------------------------------------------------------------------------------------+ ++------------------------+----------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_radiance_size` **(** **)** const | ++------------------------+----------------------------------------------------------------------------------------------+ +| void | :ref:`set_radiance_size` **(** :ref:`int` size **)** | ++------------------------+----------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -52,10 +52,10 @@ Member Function Description .. _class_Sky_get_radiance_size: -- :ref:`int` **get_radiance_size** **(** **)** const +- :ref:`int` **get_radiance_size** **(** **)** const .. _class_Sky_set_radiance_size: -- void **set_radiance_size** **(** :ref:`int` size **)** +- void **set_radiance_size** **(** :ref:`int` size **)** diff --git a/classes/class_slider.rst b/classes/class_slider.rst index 4527aebb0..93a8bf3b4 100644 --- a/classes/class_slider.rst +++ b/classes/class_slider.rst @@ -21,19 +21,19 @@ Base class for GUI Sliders. Member Functions ---------------- -+--------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_ticks` **(** **)** const | -+--------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_ticks_on_borders` **(** **)** const | -+--------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_editable` **(** **)** const | -+--------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_editable` **(** :ref:`bool` editable **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ticks` **(** :ref:`int` count **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ticks_on_borders` **(** :ref:`bool` ticks_on_border **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------------+ ++--------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_ticks` **(** **)** const | ++--------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_ticks_on_borders` **(** **)** const | ++--------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_editable` **(** **)** const | ++--------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_editable` **(** :ref:`bool` editable **)** | ++--------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ticks` **(** :ref:`int` count **)** | ++--------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ticks_on_borders` **(** :ref:`bool` ticks_on_border **)** | ++--------------------------+--------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -65,33 +65,33 @@ Member Function Description .. _class_Slider_get_ticks: -- :ref:`int` **get_ticks** **(** **)** const +- :ref:`int` **get_ticks** **(** **)** const Return amounts of ticks to display on slider. .. _class_Slider_get_ticks_on_borders: -- :ref:`bool` **get_ticks_on_borders** **(** **)** const +- :ref:`bool` **get_ticks_on_borders** **(** **)** const Return true if ticks are visible on borders. .. _class_Slider_is_editable: -- :ref:`bool` **is_editable** **(** **)** const +- :ref:`bool` **is_editable** **(** **)** const .. _class_Slider_set_editable: -- void **set_editable** **(** :ref:`bool` editable **)** +- void **set_editable** **(** :ref:`bool` editable **)** .. _class_Slider_set_ticks: -- void **set_ticks** **(** :ref:`int` count **)** +- void **set_ticks** **(** :ref:`int` count **)** Set amount of ticks to display in slider. .. _class_Slider_set_ticks_on_borders: -- void **set_ticks_on_borders** **(** :ref:`bool` ticks_on_border **)** +- void **set_ticks_on_borders** **(** :ref:`bool` ticks_on_border **)** Set true if ticks are visible on borders. diff --git a/classes/class_sliderjoint.rst b/classes/class_sliderjoint.rst index 88cddd961..d0cdeb3a5 100644 --- a/classes/class_sliderjoint.rst +++ b/classes/class_sliderjoint.rst @@ -19,11 +19,11 @@ Piston kind of slider between two bodies in 3D. Member Functions ---------------- -+----------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_param` **(** :ref:`int` param **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_param` **(** :ref:`int` param, :ref:`float` value **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------+ ++----------------------------+------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_param` **(** :ref:`int` param **)** const | ++----------------------------+------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_param` **(** :ref:`int` param, :ref:`float` value **)** | ++----------------------------+------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -160,10 +160,10 @@ Member Function Description .. _class_SliderJoint_get_param: -- :ref:`float` **get_param** **(** :ref:`int` param **)** const +- :ref:`float` **get_param** **(** :ref:`int` param **)** const .. _class_SliderJoint_set_param: -- void **set_param** **(** :ref:`int` param, :ref:`float` value **)** +- void **set_param** **(** :ref:`int` param, :ref:`float` value **)** diff --git a/classes/class_spatial.rst b/classes/class_spatial.rst index 835f8cc76..aacb81848 100644 --- a/classes/class_spatial.rst +++ b/classes/class_spatial.rst @@ -21,98 +21,98 @@ Most basic 3D game object, parent of all 3D related nodes. Member Functions ---------------- -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`SpatialGizmo` | :ref:`get_gizmo` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_global_transform` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Spatial` | :ref:`get_parent_spatial` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_rotation` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_rotation_deg` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_scale` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_transform` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_translation` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`World` | :ref:`get_world` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`global_rotate` **(** :ref:`Vector3` normal, :ref:`float` radians **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`global_translate` **(** :ref:`Vector3` offset **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`hide` **(** **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_local_transform_notification_enabled` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_set_as_toplevel` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_transform_notification_enabled` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_visible` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_visible_in_tree` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`look_at` **(** :ref:`Vector3` target, :ref:`Vector3` up **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`look_at_from_position` **(** :ref:`Vector3` position, :ref:`Vector3` target, :ref:`Vector3` up **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`orthonormalize` **(** **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rotate` **(** :ref:`Vector3` normal, :ref:`float` radians **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rotate_x` **(** :ref:`float` radians **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rotate_y` **(** :ref:`float` radians **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rotate_z` **(** :ref:`float` radians **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_as_toplevel` **(** :ref:`bool` enable **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_gizmo` **(** :ref:`SpatialGizmo` gizmo **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_global_transform` **(** :ref:`Transform` global **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_identity` **(** **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ignore_transform_notification` **(** :ref:`bool` enabled **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_notify_local_transform` **(** :ref:`bool` enable **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_notify_transform` **(** :ref:`bool` enable **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rotation` **(** :ref:`Vector3` rotation_rad **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rotation_deg` **(** :ref:`Vector3` rotation_deg **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_scale` **(** :ref:`Vector3` scale **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_transform` **(** :ref:`Transform` local **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_translation` **(** :ref:`Vector3` translation **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_visible` **(** :ref:`bool` visible **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`show` **(** **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`to_global` **(** :ref:`Vector3` local_point **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`to_local` **(** :ref:`Vector3` global_point **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`translate` **(** :ref:`Vector3` offset **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`update_gizmo` **(** **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`SpatialGizmo` | :ref:`get_gizmo` **(** **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`get_global_transform` **(** **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Spatial` | :ref:`get_parent_spatial` **(** **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_rotation` **(** **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_rotation_deg` **(** **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_scale` **(** **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`get_transform` **(** **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_translation` **(** **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`World` | :ref:`get_world` **(** **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`global_rotate` **(** :ref:`Vector3` normal, :ref:`float` radians **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`global_translate` **(** :ref:`Vector3` offset **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`hide` **(** **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_local_transform_notification_enabled` **(** **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_set_as_toplevel` **(** **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_transform_notification_enabled` **(** **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_visible` **(** **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_visible_in_tree` **(** **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`look_at` **(** :ref:`Vector3` target, :ref:`Vector3` up **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`look_at_from_position` **(** :ref:`Vector3` position, :ref:`Vector3` target, :ref:`Vector3` up **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`orthonormalize` **(** **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rotate` **(** :ref:`Vector3` normal, :ref:`float` radians **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rotate_x` **(** :ref:`float` radians **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rotate_y` **(** :ref:`float` radians **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rotate_z` **(** :ref:`float` radians **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_as_toplevel` **(** :ref:`bool` enable **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_gizmo` **(** :ref:`SpatialGizmo` gizmo **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_global_transform` **(** :ref:`Transform` global **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_identity` **(** **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ignore_transform_notification` **(** :ref:`bool` enabled **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_notify_local_transform` **(** :ref:`bool` enable **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_notify_transform` **(** :ref:`bool` enable **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rotation` **(** :ref:`Vector3` rotation_rad **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rotation_deg` **(** :ref:`Vector3` rotation_deg **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_scale` **(** :ref:`Vector3` scale **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_transform` **(** :ref:`Transform` local **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_translation` **(** :ref:`Vector3` translation **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_visible` **(** :ref:`bool` visible **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`show` **(** **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`to_global` **(** :ref:`Vector3` local_point **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`to_local` **(** :ref:`Vector3` global_point **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`translate` **(** :ref:`Vector3` offset **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`update_gizmo` **(** **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_Spatial_visibility_changed: -- **visibility_changed** **(** **)** +- **visibility_changed** **(** **)** Emitted when node visibility changes. @@ -169,245 +169,245 @@ Member Function Description .. _class_Spatial_get_gizmo: -- :ref:`SpatialGizmo` **get_gizmo** **(** **)** const +- :ref:`SpatialGizmo` **get_gizmo** **(** **)** const Returns the SpatialGizmo for this node. Used for example in :ref:`EditorSpatialGizmo` as custom visualization and editing handles in Editor. .. _class_Spatial_get_global_transform: -- :ref:`Transform` **get_global_transform** **(** **)** const +- :ref:`Transform` **get_global_transform** **(** **)** const Returns the global transform, relative to worldspace. .. _class_Spatial_get_parent_spatial: -- :ref:`Spatial` **get_parent_spatial** **(** **)** const +- :ref:`Spatial` **get_parent_spatial** **(** **)** const Returns the parent :ref:`Spatial`, or an empty :ref:`Object` if no parent exists or parent is not of type :ref:`Spatial`. .. _class_Spatial_get_rotation: -- :ref:`Vector3` **get_rotation** **(** **)** const +- :ref:`Vector3` **get_rotation** **(** **)** const Returns the rotation (in radians). .. _class_Spatial_get_rotation_deg: -- :ref:`Vector3` **get_rotation_deg** **(** **)** const +- :ref:`Vector3` **get_rotation_deg** **(** **)** const Returns the rotation (in degrees). .. _class_Spatial_get_scale: -- :ref:`Vector3` **get_scale** **(** **)** const +- :ref:`Vector3` **get_scale** **(** **)** const .. _class_Spatial_get_transform: -- :ref:`Transform` **get_transform** **(** **)** const +- :ref:`Transform` **get_transform** **(** **)** const Returns the local transform, relative to the bone parent. .. _class_Spatial_get_translation: -- :ref:`Vector3` **get_translation** **(** **)** const +- :ref:`Vector3` **get_translation** **(** **)** const .. _class_Spatial_get_world: -- :ref:`World` **get_world** **(** **)** const +- :ref:`World` **get_world** **(** **)** const Returns the current :ref:`World` resource this Spatial node is registered to. .. _class_Spatial_global_rotate: -- void **global_rotate** **(** :ref:`Vector3` normal, :ref:`float` radians **)** +- void **global_rotate** **(** :ref:`Vector3` normal, :ref:`float` radians **)** Rotates the current node along normal :ref:`Vector3` by angle in radians in Global space. .. _class_Spatial_global_translate: -- void **global_translate** **(** :ref:`Vector3` offset **)** +- void **global_translate** **(** :ref:`Vector3` offset **)** Moves the node by :ref:`Vector3` offset in Global space. .. _class_Spatial_hide: -- void **hide** **(** **)** +- void **hide** **(** **)** Disables rendering of this node. Change Spatial Visible property to false. .. _class_Spatial_is_local_transform_notification_enabled: -- :ref:`bool` **is_local_transform_notification_enabled** **(** **)** const +- :ref:`bool` **is_local_transform_notification_enabled** **(** **)** const Returns whether node notifies about its local transformation changes. Spatial will not propagate this by default. .. _class_Spatial_is_set_as_toplevel: -- :ref:`bool` **is_set_as_toplevel** **(** **)** const +- :ref:`bool` **is_set_as_toplevel** **(** **)** const Returns whether this node is set as Toplevel, that is whether it ignores its parent nodes transformations. .. _class_Spatial_is_transform_notification_enabled: -- :ref:`bool` **is_transform_notification_enabled** **(** **)** const +- :ref:`bool` **is_transform_notification_enabled** **(** **)** const Returns whether the node notifies about its global and local transformation changes. Spatial will not propagate this by default. .. _class_Spatial_is_visible: -- :ref:`bool` **is_visible** **(** **)** const +- :ref:`bool` **is_visible** **(** **)** const Returns whether the node is set to be visible. .. _class_Spatial_is_visible_in_tree: -- :ref:`bool` **is_visible_in_tree** **(** **)** const +- :ref:`bool` **is_visible_in_tree** **(** **)** const Returns whether the node is visible, taking into consideration that its parents visibility. .. _class_Spatial_look_at: -- void **look_at** **(** :ref:`Vector3` target, :ref:`Vector3` up **)** +- void **look_at** **(** :ref:`Vector3` target, :ref:`Vector3` up **)** Rotates itself to point into direction of target position. Operations take place in global space. .. _class_Spatial_look_at_from_position: -- void **look_at_from_position** **(** :ref:`Vector3` position, :ref:`Vector3` target, :ref:`Vector3` up **)** +- void **look_at_from_position** **(** :ref:`Vector3` position, :ref:`Vector3` target, :ref:`Vector3` up **)** Moves the node to specified position and then rotates itself to point into direction of target position. Operations take place in global space. .. _class_Spatial_orthonormalize: -- void **orthonormalize** **(** **)** +- void **orthonormalize** **(** **)** Resets this node's transformations (like scale, skew and taper) preserving its rotation and translation. Performs orthonormalization on this node Transform3D. .. _class_Spatial_rotate: -- void **rotate** **(** :ref:`Vector3` normal, :ref:`float` radians **)** +- void **rotate** **(** :ref:`Vector3` normal, :ref:`float` radians **)** Rotates the node in local space on given normal :ref:`Vector3` by angle in radians. .. _class_Spatial_rotate_x: -- void **rotate_x** **(** :ref:`float` radians **)** +- void **rotate_x** **(** :ref:`float` radians **)** Rotates the node in local space on X axis by angle in radians. .. _class_Spatial_rotate_y: -- void **rotate_y** **(** :ref:`float` radians **)** +- void **rotate_y** **(** :ref:`float` radians **)** Rotates the node in local space on Y axis by angle in radians. .. _class_Spatial_rotate_z: -- void **rotate_z** **(** :ref:`float` radians **)** +- void **rotate_z** **(** :ref:`float` radians **)** Rotates the node in local space on Z axis by angle in radians. .. _class_Spatial_set_as_toplevel: -- void **set_as_toplevel** **(** :ref:`bool` enable **)** +- void **set_as_toplevel** **(** :ref:`bool` enable **)** Makes the node ignore its parents transformations. Node transformations are only in global space. .. _class_Spatial_set_gizmo: -- void **set_gizmo** **(** :ref:`SpatialGizmo` gizmo **)** +- void **set_gizmo** **(** :ref:`SpatialGizmo` gizmo **)** Set :ref:`SpatialGizmo` for this node. Used for example in :ref:`EditorSpatialGizmo` as custom visualization and editing handles in Editor. .. _class_Spatial_set_global_transform: -- void **set_global_transform** **(** :ref:`Transform` global **)** +- void **set_global_transform** **(** :ref:`Transform` global **)** Set the transform globally, relative to world space. .. _class_Spatial_set_identity: -- void **set_identity** **(** **)** +- void **set_identity** **(** **)** Reset all transformations for this node. Set its Transform3D to identity matrix. .. _class_Spatial_set_ignore_transform_notification: -- void **set_ignore_transform_notification** **(** :ref:`bool` enabled **)** +- void **set_ignore_transform_notification** **(** :ref:`bool` enabled **)** Set whether the node ignores notification that its transformation (global or local) changed. .. _class_Spatial_set_notify_local_transform: -- void **set_notify_local_transform** **(** :ref:`bool` enable **)** +- void **set_notify_local_transform** **(** :ref:`bool` enable **)** Set whether the node notifies about its local transformation changes. Spatial will not propagate this by default. .. _class_Spatial_set_notify_transform: -- void **set_notify_transform** **(** :ref:`bool` enable **)** +- void **set_notify_transform** **(** :ref:`bool` enable **)** Set whether the node notifies about its global and local transformation changes. Spatial will not propagate this by default. .. _class_Spatial_set_rotation: -- void **set_rotation** **(** :ref:`Vector3` rotation_rad **)** +- void **set_rotation** **(** :ref:`Vector3` rotation_rad **)** Set the rotation (in radians). .. _class_Spatial_set_rotation_deg: -- void **set_rotation_deg** **(** :ref:`Vector3` rotation_deg **)** +- void **set_rotation_deg** **(** :ref:`Vector3` rotation_deg **)** Set the rotation (in degrees). .. _class_Spatial_set_scale: -- void **set_scale** **(** :ref:`Vector3` scale **)** +- void **set_scale** **(** :ref:`Vector3` scale **)** Set the scale. .. _class_Spatial_set_transform: -- void **set_transform** **(** :ref:`Transform` local **)** +- void **set_transform** **(** :ref:`Transform` local **)** Set the transform locally, relative to the parent spatial node. .. _class_Spatial_set_translation: -- void **set_translation** **(** :ref:`Vector3` translation **)** +- void **set_translation** **(** :ref:`Vector3` translation **)** .. _class_Spatial_set_visible: -- void **set_visible** **(** :ref:`bool` visible **)** +- void **set_visible** **(** :ref:`bool` visible **)** .. _class_Spatial_show: -- void **show** **(** **)** +- void **show** **(** **)** Enables rendering of this node. Change Spatial Visible property to "True". .. _class_Spatial_to_global: -- :ref:`Vector3` **to_global** **(** :ref:`Vector3` local_point **)** const +- :ref:`Vector3` **to_global** **(** :ref:`Vector3` local_point **)** const Transforms :ref:`Vector3` "local_point" from this node's local space to world space. .. _class_Spatial_to_local: -- :ref:`Vector3` **to_local** **(** :ref:`Vector3` global_point **)** const +- :ref:`Vector3` **to_local** **(** :ref:`Vector3` global_point **)** const Transforms :ref:`Vector3` "global_point" from world space to this node's local space. .. _class_Spatial_translate: -- void **translate** **(** :ref:`Vector3` offset **)** +- void **translate** **(** :ref:`Vector3` offset **)** Changes the node's position by given offset :ref:`Vector3`. .. _class_Spatial_update_gizmo: -- void **update_gizmo** **(** **)** +- void **update_gizmo** **(** **)** Updates the :ref:`SpatialGizmo` of this node. diff --git a/classes/class_spatialmaterial.rst b/classes/class_spatialmaterial.rst index 92fa78075..431f72e50 100644 --- a/classes/class_spatialmaterial.rst +++ b/classes/class_spatialmaterial.rst @@ -19,223 +19,223 @@ Brief Description Member Functions ---------------- -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_albedo` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_alpha_scissor_threshold` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_anisotropy` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ao_light_affect` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_ao_texture_channel` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_billboard_mode` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_blend_mode` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_clearcoat` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_clearcoat_gloss` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_cull_mode` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_depth_deep_parallax_max_layers` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_depth_deep_parallax_min_layers` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_depth_draw_mode` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_depth_scale` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_detail_blend_mode` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_detail_uv` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_diffuse_mode` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_distance_fade_max_distance` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_distance_fade_min_distance` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_emission` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_emission_energy` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_feature` **(** :ref:`int` feature **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_flag` **(** :ref:`int` flag **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_grow` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_line_width` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_metallic` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_metallic_texture_channel` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_normal_scale` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_particles_anim_h_frames` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_particles_anim_loop` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_particles_anim_v_frames` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_point_size` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_proximity_fade_distance` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_refraction` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_refraction_texture_channel` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_rim` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_rim_tint` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_roughness` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_roughness_texture_channel` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_specular` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_specular_mode` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_subsurface_scattering_strength` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_texture` **(** :ref:`int` param **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_transmission` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_uv1_offset` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_uv1_scale` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_uv1_triplanar_blend_sharpness` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_uv2_offset` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_uv2_scale` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_uv2_triplanar_blend_sharpness` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_depth_deep_parallax_enabled` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_distance_fade_enabled` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_grow_enabled` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_proximity_fade_enabled` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_albedo` **(** :ref:`Color` albedo **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_alpha_scissor_threshold` **(** :ref:`float` threshold **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_anisotropy` **(** :ref:`float` anisotropy **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ao_light_affect` **(** :ref:`float` amount **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ao_texture_channel` **(** :ref:`int` channel **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_billboard_mode` **(** :ref:`int` mode **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_blend_mode` **(** :ref:`int` blend_mode **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_clearcoat` **(** :ref:`float` clearcoat **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_clearcoat_gloss` **(** :ref:`float` clearcoat_gloss **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cull_mode` **(** :ref:`int` cull_mode **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_depth_deep_parallax` **(** :ref:`bool` enable **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_depth_deep_parallax_max_layers` **(** :ref:`int` layer **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_depth_deep_parallax_min_layers` **(** :ref:`int` layer **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_depth_draw_mode` **(** :ref:`int` depth_draw_mode **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_depth_scale` **(** :ref:`float` depth_scale **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_detail_blend_mode` **(** :ref:`int` detail_blend_mode **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_detail_uv` **(** :ref:`int` detail_uv **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_diffuse_mode` **(** :ref:`int` diffuse_mode **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_distance_fade` **(** :ref:`bool` enabled **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_distance_fade_max_distance` **(** :ref:`float` distance **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_distance_fade_min_distance` **(** :ref:`float` distance **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_emission` **(** :ref:`Color` emission **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_emission_energy` **(** :ref:`float` emission_energy **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_feature` **(** :ref:`int` feature, :ref:`bool` enable **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_flag` **(** :ref:`int` flag, :ref:`bool` enable **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_grow` **(** :ref:`float` amount **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_grow_enabled` **(** :ref:`bool` enable **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_line_width` **(** :ref:`float` line_width **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_metallic` **(** :ref:`float` metallic **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_metallic_texture_channel` **(** :ref:`int` channel **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_normal_scale` **(** :ref:`float` normal_scale **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_particles_anim_h_frames` **(** :ref:`int` frames **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_particles_anim_loop` **(** :ref:`int` frames **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_particles_anim_v_frames` **(** :ref:`int` frames **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_size` **(** :ref:`float` point_size **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_proximity_fade` **(** :ref:`bool` enabled **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_proximity_fade_distance` **(** :ref:`float` distance **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_refraction` **(** :ref:`float` refraction **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_refraction_texture_channel` **(** :ref:`int` channel **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rim` **(** :ref:`float` rim **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rim_tint` **(** :ref:`float` rim_tint **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_roughness` **(** :ref:`float` roughness **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_roughness_texture_channel` **(** :ref:`int` channel **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_specular` **(** :ref:`float` specular **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_specular_mode` **(** :ref:`int` specular_mode **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_subsurface_scattering_strength` **(** :ref:`float` strength **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture` **(** :ref:`int` param, :ref:`Texture` texture **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_transmission` **(** :ref:`Color` transmission **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_uv1_offset` **(** :ref:`Vector3` offset **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_uv1_scale` **(** :ref:`Vector3` scale **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_uv1_triplanar_blend_sharpness` **(** :ref:`float` sharpness **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_uv2_offset` **(** :ref:`Vector3` offset **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_uv2_scale` **(** :ref:`Vector3` scale **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_uv2_triplanar_blend_sharpness` **(** :ref:`float` sharpness **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_albedo` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_alpha_scissor_threshold` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_anisotropy` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_ao_light_affect` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_ao_texture_channel` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_billboard_mode` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_blend_mode` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_clearcoat` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_clearcoat_gloss` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_cull_mode` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_depth_deep_parallax_max_layers` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_depth_deep_parallax_min_layers` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_depth_draw_mode` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_depth_scale` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_detail_blend_mode` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_detail_uv` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_diffuse_mode` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_distance_fade_max_distance` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_distance_fade_min_distance` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_emission` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_emission_energy` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_feature` **(** :ref:`int` feature **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_flag` **(** :ref:`int` flag **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_grow` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_line_width` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_metallic` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_metallic_texture_channel` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_normal_scale` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_particles_anim_h_frames` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_particles_anim_loop` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_particles_anim_v_frames` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_point_size` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_proximity_fade_distance` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_refraction` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_refraction_texture_channel` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_rim` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_rim_tint` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_roughness` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_roughness_texture_channel` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_specular` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_specular_mode` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_subsurface_scattering_strength` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_texture` **(** :ref:`int` param **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_transmission` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_uv1_offset` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_uv1_scale` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_uv1_triplanar_blend_sharpness` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_uv2_offset` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_uv2_scale` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_uv2_triplanar_blend_sharpness` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_depth_deep_parallax_enabled` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_distance_fade_enabled` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_grow_enabled` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_proximity_fade_enabled` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_albedo` **(** :ref:`Color` albedo **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_alpha_scissor_threshold` **(** :ref:`float` threshold **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_anisotropy` **(** :ref:`float` anisotropy **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ao_light_affect` **(** :ref:`float` amount **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ao_texture_channel` **(** :ref:`int` channel **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_billboard_mode` **(** :ref:`int` mode **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_blend_mode` **(** :ref:`int` blend_mode **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_clearcoat` **(** :ref:`float` clearcoat **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_clearcoat_gloss` **(** :ref:`float` clearcoat_gloss **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cull_mode` **(** :ref:`int` cull_mode **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_depth_deep_parallax` **(** :ref:`bool` enable **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_depth_deep_parallax_max_layers` **(** :ref:`int` layer **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_depth_deep_parallax_min_layers` **(** :ref:`int` layer **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_depth_draw_mode` **(** :ref:`int` depth_draw_mode **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_depth_scale` **(** :ref:`float` depth_scale **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_detail_blend_mode` **(** :ref:`int` detail_blend_mode **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_detail_uv` **(** :ref:`int` detail_uv **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_diffuse_mode` **(** :ref:`int` diffuse_mode **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_distance_fade` **(** :ref:`bool` enabled **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_distance_fade_max_distance` **(** :ref:`float` distance **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_distance_fade_min_distance` **(** :ref:`float` distance **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_emission` **(** :ref:`Color` emission **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_emission_energy` **(** :ref:`float` emission_energy **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_feature` **(** :ref:`int` feature, :ref:`bool` enable **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_flag` **(** :ref:`int` flag, :ref:`bool` enable **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_grow` **(** :ref:`float` amount **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_grow_enabled` **(** :ref:`bool` enable **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_line_width` **(** :ref:`float` line_width **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_metallic` **(** :ref:`float` metallic **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_metallic_texture_channel` **(** :ref:`int` channel **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_normal_scale` **(** :ref:`float` normal_scale **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_particles_anim_h_frames` **(** :ref:`int` frames **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_particles_anim_loop` **(** :ref:`int` frames **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_particles_anim_v_frames` **(** :ref:`int` frames **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_size` **(** :ref:`float` point_size **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_proximity_fade` **(** :ref:`bool` enabled **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_proximity_fade_distance` **(** :ref:`float` distance **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_refraction` **(** :ref:`float` refraction **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_refraction_texture_channel` **(** :ref:`int` channel **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rim` **(** :ref:`float` rim **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rim_tint` **(** :ref:`float` rim_tint **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_roughness` **(** :ref:`float` roughness **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_roughness_texture_channel` **(** :ref:`int` channel **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_specular` **(** :ref:`float` specular **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_specular_mode` **(** :ref:`int` specular_mode **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_subsurface_scattering_strength` **(** :ref:`float` strength **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_texture` **(** :ref:`int` param, :ref:`Texture` texture **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_transmission` **(** :ref:`Color` transmission **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_uv1_offset` **(** :ref:`Vector3` offset **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_uv1_scale` **(** :ref:`Vector3` scale **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_uv1_triplanar_blend_sharpness` **(** :ref:`float` sharpness **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_uv2_offset` **(** :ref:`Vector3` offset **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_uv2_scale` **(** :ref:`Vector3` scale **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_uv2_triplanar_blend_sharpness` **(** :ref:`float` sharpness **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -689,434 +689,434 @@ Member Function Description .. _class_SpatialMaterial_get_albedo: -- :ref:`Color` **get_albedo** **(** **)** const +- :ref:`Color` **get_albedo** **(** **)** const .. _class_SpatialMaterial_get_alpha_scissor_threshold: -- :ref:`float` **get_alpha_scissor_threshold** **(** **)** const +- :ref:`float` **get_alpha_scissor_threshold** **(** **)** const .. _class_SpatialMaterial_get_anisotropy: -- :ref:`float` **get_anisotropy** **(** **)** const +- :ref:`float` **get_anisotropy** **(** **)** const .. _class_SpatialMaterial_get_ao_light_affect: -- :ref:`float` **get_ao_light_affect** **(** **)** const +- :ref:`float` **get_ao_light_affect** **(** **)** const .. _class_SpatialMaterial_get_ao_texture_channel: -- :ref:`int` **get_ao_texture_channel** **(** **)** const +- :ref:`int` **get_ao_texture_channel** **(** **)** const .. _class_SpatialMaterial_get_billboard_mode: -- :ref:`int` **get_billboard_mode** **(** **)** const +- :ref:`int` **get_billboard_mode** **(** **)** const .. _class_SpatialMaterial_get_blend_mode: -- :ref:`int` **get_blend_mode** **(** **)** const +- :ref:`int` **get_blend_mode** **(** **)** const .. _class_SpatialMaterial_get_clearcoat: -- :ref:`float` **get_clearcoat** **(** **)** const +- :ref:`float` **get_clearcoat** **(** **)** const .. _class_SpatialMaterial_get_clearcoat_gloss: -- :ref:`float` **get_clearcoat_gloss** **(** **)** const +- :ref:`float` **get_clearcoat_gloss** **(** **)** const .. _class_SpatialMaterial_get_cull_mode: -- :ref:`int` **get_cull_mode** **(** **)** const +- :ref:`int` **get_cull_mode** **(** **)** const .. _class_SpatialMaterial_get_depth_deep_parallax_max_layers: -- :ref:`int` **get_depth_deep_parallax_max_layers** **(** **)** const +- :ref:`int` **get_depth_deep_parallax_max_layers** **(** **)** const .. _class_SpatialMaterial_get_depth_deep_parallax_min_layers: -- :ref:`int` **get_depth_deep_parallax_min_layers** **(** **)** const +- :ref:`int` **get_depth_deep_parallax_min_layers** **(** **)** const .. _class_SpatialMaterial_get_depth_draw_mode: -- :ref:`int` **get_depth_draw_mode** **(** **)** const +- :ref:`int` **get_depth_draw_mode** **(** **)** const .. _class_SpatialMaterial_get_depth_scale: -- :ref:`float` **get_depth_scale** **(** **)** const +- :ref:`float` **get_depth_scale** **(** **)** const .. _class_SpatialMaterial_get_detail_blend_mode: -- :ref:`int` **get_detail_blend_mode** **(** **)** const +- :ref:`int` **get_detail_blend_mode** **(** **)** const .. _class_SpatialMaterial_get_detail_uv: -- :ref:`int` **get_detail_uv** **(** **)** const +- :ref:`int` **get_detail_uv** **(** **)** const .. _class_SpatialMaterial_get_diffuse_mode: -- :ref:`int` **get_diffuse_mode** **(** **)** const +- :ref:`int` **get_diffuse_mode** **(** **)** const .. _class_SpatialMaterial_get_distance_fade_max_distance: -- :ref:`float` **get_distance_fade_max_distance** **(** **)** const +- :ref:`float` **get_distance_fade_max_distance** **(** **)** const .. _class_SpatialMaterial_get_distance_fade_min_distance: -- :ref:`float` **get_distance_fade_min_distance** **(** **)** const +- :ref:`float` **get_distance_fade_min_distance** **(** **)** const .. _class_SpatialMaterial_get_emission: -- :ref:`Color` **get_emission** **(** **)** const +- :ref:`Color` **get_emission** **(** **)** const .. _class_SpatialMaterial_get_emission_energy: -- :ref:`float` **get_emission_energy** **(** **)** const +- :ref:`float` **get_emission_energy** **(** **)** const .. _class_SpatialMaterial_get_feature: -- :ref:`bool` **get_feature** **(** :ref:`int` feature **)** const +- :ref:`bool` **get_feature** **(** :ref:`int` feature **)** const .. _class_SpatialMaterial_get_flag: -- :ref:`bool` **get_flag** **(** :ref:`int` flag **)** const +- :ref:`bool` **get_flag** **(** :ref:`int` flag **)** const .. _class_SpatialMaterial_get_grow: -- :ref:`float` **get_grow** **(** **)** const +- :ref:`float` **get_grow** **(** **)** const .. _class_SpatialMaterial_get_line_width: -- :ref:`float` **get_line_width** **(** **)** const +- :ref:`float` **get_line_width** **(** **)** const .. _class_SpatialMaterial_get_metallic: -- :ref:`float` **get_metallic** **(** **)** const +- :ref:`float` **get_metallic** **(** **)** const .. _class_SpatialMaterial_get_metallic_texture_channel: -- :ref:`int` **get_metallic_texture_channel** **(** **)** const +- :ref:`int` **get_metallic_texture_channel** **(** **)** const .. _class_SpatialMaterial_get_normal_scale: -- :ref:`float` **get_normal_scale** **(** **)** const +- :ref:`float` **get_normal_scale** **(** **)** const .. _class_SpatialMaterial_get_particles_anim_h_frames: -- :ref:`int` **get_particles_anim_h_frames** **(** **)** const +- :ref:`int` **get_particles_anim_h_frames** **(** **)** const .. _class_SpatialMaterial_get_particles_anim_loop: -- :ref:`int` **get_particles_anim_loop** **(** **)** const +- :ref:`int` **get_particles_anim_loop** **(** **)** const .. _class_SpatialMaterial_get_particles_anim_v_frames: -- :ref:`int` **get_particles_anim_v_frames** **(** **)** const +- :ref:`int` **get_particles_anim_v_frames** **(** **)** const .. _class_SpatialMaterial_get_point_size: -- :ref:`float` **get_point_size** **(** **)** const +- :ref:`float` **get_point_size** **(** **)** const .. _class_SpatialMaterial_get_proximity_fade_distance: -- :ref:`float` **get_proximity_fade_distance** **(** **)** const +- :ref:`float` **get_proximity_fade_distance** **(** **)** const .. _class_SpatialMaterial_get_refraction: -- :ref:`float` **get_refraction** **(** **)** const +- :ref:`float` **get_refraction** **(** **)** const .. _class_SpatialMaterial_get_refraction_texture_channel: -- :ref:`int` **get_refraction_texture_channel** **(** **)** const +- :ref:`int` **get_refraction_texture_channel** **(** **)** const .. _class_SpatialMaterial_get_rim: -- :ref:`float` **get_rim** **(** **)** const +- :ref:`float` **get_rim** **(** **)** const .. _class_SpatialMaterial_get_rim_tint: -- :ref:`float` **get_rim_tint** **(** **)** const +- :ref:`float` **get_rim_tint** **(** **)** const .. _class_SpatialMaterial_get_roughness: -- :ref:`float` **get_roughness** **(** **)** const +- :ref:`float` **get_roughness** **(** **)** const .. _class_SpatialMaterial_get_roughness_texture_channel: -- :ref:`int` **get_roughness_texture_channel** **(** **)** const +- :ref:`int` **get_roughness_texture_channel** **(** **)** const .. _class_SpatialMaterial_get_specular: -- :ref:`float` **get_specular** **(** **)** const +- :ref:`float` **get_specular** **(** **)** const .. _class_SpatialMaterial_get_specular_mode: -- :ref:`int` **get_specular_mode** **(** **)** const +- :ref:`int` **get_specular_mode** **(** **)** const .. _class_SpatialMaterial_get_subsurface_scattering_strength: -- :ref:`float` **get_subsurface_scattering_strength** **(** **)** const +- :ref:`float` **get_subsurface_scattering_strength** **(** **)** const .. _class_SpatialMaterial_get_texture: -- :ref:`Texture` **get_texture** **(** :ref:`int` param **)** const +- :ref:`Texture` **get_texture** **(** :ref:`int` param **)** const .. _class_SpatialMaterial_get_transmission: -- :ref:`Color` **get_transmission** **(** **)** const +- :ref:`Color` **get_transmission** **(** **)** const .. _class_SpatialMaterial_get_uv1_offset: -- :ref:`Vector3` **get_uv1_offset** **(** **)** const +- :ref:`Vector3` **get_uv1_offset** **(** **)** const .. _class_SpatialMaterial_get_uv1_scale: -- :ref:`Vector3` **get_uv1_scale** **(** **)** const +- :ref:`Vector3` **get_uv1_scale** **(** **)** const .. _class_SpatialMaterial_get_uv1_triplanar_blend_sharpness: -- :ref:`float` **get_uv1_triplanar_blend_sharpness** **(** **)** const +- :ref:`float` **get_uv1_triplanar_blend_sharpness** **(** **)** const .. _class_SpatialMaterial_get_uv2_offset: -- :ref:`Vector3` **get_uv2_offset** **(** **)** const +- :ref:`Vector3` **get_uv2_offset** **(** **)** const .. _class_SpatialMaterial_get_uv2_scale: -- :ref:`Vector3` **get_uv2_scale** **(** **)** const +- :ref:`Vector3` **get_uv2_scale** **(** **)** const .. _class_SpatialMaterial_get_uv2_triplanar_blend_sharpness: -- :ref:`float` **get_uv2_triplanar_blend_sharpness** **(** **)** const +- :ref:`float` **get_uv2_triplanar_blend_sharpness** **(** **)** const .. _class_SpatialMaterial_is_depth_deep_parallax_enabled: -- :ref:`bool` **is_depth_deep_parallax_enabled** **(** **)** const +- :ref:`bool` **is_depth_deep_parallax_enabled** **(** **)** const .. _class_SpatialMaterial_is_distance_fade_enabled: -- :ref:`bool` **is_distance_fade_enabled** **(** **)** const +- :ref:`bool` **is_distance_fade_enabled** **(** **)** const .. _class_SpatialMaterial_is_grow_enabled: -- :ref:`bool` **is_grow_enabled** **(** **)** const +- :ref:`bool` **is_grow_enabled** **(** **)** const .. _class_SpatialMaterial_is_proximity_fade_enabled: -- :ref:`bool` **is_proximity_fade_enabled** **(** **)** const +- :ref:`bool` **is_proximity_fade_enabled** **(** **)** const .. _class_SpatialMaterial_set_albedo: -- void **set_albedo** **(** :ref:`Color` albedo **)** +- void **set_albedo** **(** :ref:`Color` albedo **)** .. _class_SpatialMaterial_set_alpha_scissor_threshold: -- void **set_alpha_scissor_threshold** **(** :ref:`float` threshold **)** +- void **set_alpha_scissor_threshold** **(** :ref:`float` threshold **)** .. _class_SpatialMaterial_set_anisotropy: -- void **set_anisotropy** **(** :ref:`float` anisotropy **)** +- void **set_anisotropy** **(** :ref:`float` anisotropy **)** .. _class_SpatialMaterial_set_ao_light_affect: -- void **set_ao_light_affect** **(** :ref:`float` amount **)** +- void **set_ao_light_affect** **(** :ref:`float` amount **)** .. _class_SpatialMaterial_set_ao_texture_channel: -- void **set_ao_texture_channel** **(** :ref:`int` channel **)** +- void **set_ao_texture_channel** **(** :ref:`int` channel **)** .. _class_SpatialMaterial_set_billboard_mode: -- void **set_billboard_mode** **(** :ref:`int` mode **)** +- void **set_billboard_mode** **(** :ref:`int` mode **)** .. _class_SpatialMaterial_set_blend_mode: -- void **set_blend_mode** **(** :ref:`int` blend_mode **)** +- void **set_blend_mode** **(** :ref:`int` blend_mode **)** .. _class_SpatialMaterial_set_clearcoat: -- void **set_clearcoat** **(** :ref:`float` clearcoat **)** +- void **set_clearcoat** **(** :ref:`float` clearcoat **)** .. _class_SpatialMaterial_set_clearcoat_gloss: -- void **set_clearcoat_gloss** **(** :ref:`float` clearcoat_gloss **)** +- void **set_clearcoat_gloss** **(** :ref:`float` clearcoat_gloss **)** .. _class_SpatialMaterial_set_cull_mode: -- void **set_cull_mode** **(** :ref:`int` cull_mode **)** +- void **set_cull_mode** **(** :ref:`int` cull_mode **)** .. _class_SpatialMaterial_set_depth_deep_parallax: -- void **set_depth_deep_parallax** **(** :ref:`bool` enable **)** +- void **set_depth_deep_parallax** **(** :ref:`bool` enable **)** .. _class_SpatialMaterial_set_depth_deep_parallax_max_layers: -- void **set_depth_deep_parallax_max_layers** **(** :ref:`int` layer **)** +- void **set_depth_deep_parallax_max_layers** **(** :ref:`int` layer **)** .. _class_SpatialMaterial_set_depth_deep_parallax_min_layers: -- void **set_depth_deep_parallax_min_layers** **(** :ref:`int` layer **)** +- void **set_depth_deep_parallax_min_layers** **(** :ref:`int` layer **)** .. _class_SpatialMaterial_set_depth_draw_mode: -- void **set_depth_draw_mode** **(** :ref:`int` depth_draw_mode **)** +- void **set_depth_draw_mode** **(** :ref:`int` depth_draw_mode **)** .. _class_SpatialMaterial_set_depth_scale: -- void **set_depth_scale** **(** :ref:`float` depth_scale **)** +- void **set_depth_scale** **(** :ref:`float` depth_scale **)** .. _class_SpatialMaterial_set_detail_blend_mode: -- void **set_detail_blend_mode** **(** :ref:`int` detail_blend_mode **)** +- void **set_detail_blend_mode** **(** :ref:`int` detail_blend_mode **)** .. _class_SpatialMaterial_set_detail_uv: -- void **set_detail_uv** **(** :ref:`int` detail_uv **)** +- void **set_detail_uv** **(** :ref:`int` detail_uv **)** .. _class_SpatialMaterial_set_diffuse_mode: -- void **set_diffuse_mode** **(** :ref:`int` diffuse_mode **)** +- void **set_diffuse_mode** **(** :ref:`int` diffuse_mode **)** .. _class_SpatialMaterial_set_distance_fade: -- void **set_distance_fade** **(** :ref:`bool` enabled **)** +- void **set_distance_fade** **(** :ref:`bool` enabled **)** .. _class_SpatialMaterial_set_distance_fade_max_distance: -- void **set_distance_fade_max_distance** **(** :ref:`float` distance **)** +- void **set_distance_fade_max_distance** **(** :ref:`float` distance **)** .. _class_SpatialMaterial_set_distance_fade_min_distance: -- void **set_distance_fade_min_distance** **(** :ref:`float` distance **)** +- void **set_distance_fade_min_distance** **(** :ref:`float` distance **)** .. _class_SpatialMaterial_set_emission: -- void **set_emission** **(** :ref:`Color` emission **)** +- void **set_emission** **(** :ref:`Color` emission **)** .. _class_SpatialMaterial_set_emission_energy: -- void **set_emission_energy** **(** :ref:`float` emission_energy **)** +- void **set_emission_energy** **(** :ref:`float` emission_energy **)** .. _class_SpatialMaterial_set_feature: -- void **set_feature** **(** :ref:`int` feature, :ref:`bool` enable **)** +- void **set_feature** **(** :ref:`int` feature, :ref:`bool` enable **)** .. _class_SpatialMaterial_set_flag: -- void **set_flag** **(** :ref:`int` flag, :ref:`bool` enable **)** +- void **set_flag** **(** :ref:`int` flag, :ref:`bool` enable **)** .. _class_SpatialMaterial_set_grow: -- void **set_grow** **(** :ref:`float` amount **)** +- void **set_grow** **(** :ref:`float` amount **)** .. _class_SpatialMaterial_set_grow_enabled: -- void **set_grow_enabled** **(** :ref:`bool` enable **)** +- void **set_grow_enabled** **(** :ref:`bool` enable **)** .. _class_SpatialMaterial_set_line_width: -- void **set_line_width** **(** :ref:`float` line_width **)** +- void **set_line_width** **(** :ref:`float` line_width **)** .. _class_SpatialMaterial_set_metallic: -- void **set_metallic** **(** :ref:`float` metallic **)** +- void **set_metallic** **(** :ref:`float` metallic **)** .. _class_SpatialMaterial_set_metallic_texture_channel: -- void **set_metallic_texture_channel** **(** :ref:`int` channel **)** +- void **set_metallic_texture_channel** **(** :ref:`int` channel **)** .. _class_SpatialMaterial_set_normal_scale: -- void **set_normal_scale** **(** :ref:`float` normal_scale **)** +- void **set_normal_scale** **(** :ref:`float` normal_scale **)** .. _class_SpatialMaterial_set_particles_anim_h_frames: -- void **set_particles_anim_h_frames** **(** :ref:`int` frames **)** +- void **set_particles_anim_h_frames** **(** :ref:`int` frames **)** .. _class_SpatialMaterial_set_particles_anim_loop: -- void **set_particles_anim_loop** **(** :ref:`int` frames **)** +- void **set_particles_anim_loop** **(** :ref:`int` frames **)** .. _class_SpatialMaterial_set_particles_anim_v_frames: -- void **set_particles_anim_v_frames** **(** :ref:`int` frames **)** +- void **set_particles_anim_v_frames** **(** :ref:`int` frames **)** .. _class_SpatialMaterial_set_point_size: -- void **set_point_size** **(** :ref:`float` point_size **)** +- void **set_point_size** **(** :ref:`float` point_size **)** .. _class_SpatialMaterial_set_proximity_fade: -- void **set_proximity_fade** **(** :ref:`bool` enabled **)** +- void **set_proximity_fade** **(** :ref:`bool` enabled **)** .. _class_SpatialMaterial_set_proximity_fade_distance: -- void **set_proximity_fade_distance** **(** :ref:`float` distance **)** +- void **set_proximity_fade_distance** **(** :ref:`float` distance **)** .. _class_SpatialMaterial_set_refraction: -- void **set_refraction** **(** :ref:`float` refraction **)** +- void **set_refraction** **(** :ref:`float` refraction **)** .. _class_SpatialMaterial_set_refraction_texture_channel: -- void **set_refraction_texture_channel** **(** :ref:`int` channel **)** +- void **set_refraction_texture_channel** **(** :ref:`int` channel **)** .. _class_SpatialMaterial_set_rim: -- void **set_rim** **(** :ref:`float` rim **)** +- void **set_rim** **(** :ref:`float` rim **)** .. _class_SpatialMaterial_set_rim_tint: -- void **set_rim_tint** **(** :ref:`float` rim_tint **)** +- void **set_rim_tint** **(** :ref:`float` rim_tint **)** .. _class_SpatialMaterial_set_roughness: -- void **set_roughness** **(** :ref:`float` roughness **)** +- void **set_roughness** **(** :ref:`float` roughness **)** .. _class_SpatialMaterial_set_roughness_texture_channel: -- void **set_roughness_texture_channel** **(** :ref:`int` channel **)** +- void **set_roughness_texture_channel** **(** :ref:`int` channel **)** .. _class_SpatialMaterial_set_specular: -- void **set_specular** **(** :ref:`float` specular **)** +- void **set_specular** **(** :ref:`float` specular **)** .. _class_SpatialMaterial_set_specular_mode: -- void **set_specular_mode** **(** :ref:`int` specular_mode **)** +- void **set_specular_mode** **(** :ref:`int` specular_mode **)** .. _class_SpatialMaterial_set_subsurface_scattering_strength: -- void **set_subsurface_scattering_strength** **(** :ref:`float` strength **)** +- void **set_subsurface_scattering_strength** **(** :ref:`float` strength **)** .. _class_SpatialMaterial_set_texture: -- void **set_texture** **(** :ref:`int` param, :ref:`Texture` texture **)** +- void **set_texture** **(** :ref:`int` param, :ref:`Texture` texture **)** .. _class_SpatialMaterial_set_transmission: -- void **set_transmission** **(** :ref:`Color` transmission **)** +- void **set_transmission** **(** :ref:`Color` transmission **)** .. _class_SpatialMaterial_set_uv1_offset: -- void **set_uv1_offset** **(** :ref:`Vector3` offset **)** +- void **set_uv1_offset** **(** :ref:`Vector3` offset **)** .. _class_SpatialMaterial_set_uv1_scale: -- void **set_uv1_scale** **(** :ref:`Vector3` scale **)** +- void **set_uv1_scale** **(** :ref:`Vector3` scale **)** .. _class_SpatialMaterial_set_uv1_triplanar_blend_sharpness: -- void **set_uv1_triplanar_blend_sharpness** **(** :ref:`float` sharpness **)** +- void **set_uv1_triplanar_blend_sharpness** **(** :ref:`float` sharpness **)** .. _class_SpatialMaterial_set_uv2_offset: -- void **set_uv2_offset** **(** :ref:`Vector3` offset **)** +- void **set_uv2_offset** **(** :ref:`Vector3` offset **)** .. _class_SpatialMaterial_set_uv2_scale: -- void **set_uv2_scale** **(** :ref:`Vector3` scale **)** +- void **set_uv2_scale** **(** :ref:`Vector3` scale **)** .. _class_SpatialMaterial_set_uv2_triplanar_blend_sharpness: -- void **set_uv2_triplanar_blend_sharpness** **(** :ref:`float` sharpness **)** +- void **set_uv2_triplanar_blend_sharpness** **(** :ref:`float` sharpness **)** diff --git a/classes/class_spatialvelocitytracker.rst b/classes/class_spatialvelocitytracker.rst index a0c1befff..185e2ab1e 100644 --- a/classes/class_spatialvelocitytracker.rst +++ b/classes/class_spatialvelocitytracker.rst @@ -19,39 +19,39 @@ Brief Description Member Functions ---------------- -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_tracked_linear_velocity` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_tracking_physics_step` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reset` **(** :ref:`Vector3` position **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_track_physics_step` **(** :ref:`bool` enable **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`update_position` **(** :ref:`Vector3` position **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_tracked_linear_velocity` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_tracking_physics_step` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reset` **(** :ref:`Vector3` position **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_track_physics_step` **(** :ref:`bool` enable **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`update_position` **(** :ref:`Vector3` position **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ Member Function Description --------------------------- .. _class_SpatialVelocityTracker_get_tracked_linear_velocity: -- :ref:`Vector3` **get_tracked_linear_velocity** **(** **)** const +- :ref:`Vector3` **get_tracked_linear_velocity** **(** **)** const .. _class_SpatialVelocityTracker_is_tracking_physics_step: -- :ref:`bool` **is_tracking_physics_step** **(** **)** const +- :ref:`bool` **is_tracking_physics_step** **(** **)** const .. _class_SpatialVelocityTracker_reset: -- void **reset** **(** :ref:`Vector3` position **)** +- void **reset** **(** :ref:`Vector3` position **)** .. _class_SpatialVelocityTracker_set_track_physics_step: -- void **set_track_physics_step** **(** :ref:`bool` enable **)** +- void **set_track_physics_step** **(** :ref:`bool` enable **)** .. _class_SpatialVelocityTracker_update_position: -- void **update_position** **(** :ref:`Vector3` position **)** +- void **update_position** **(** :ref:`Vector3` position **)** diff --git a/classes/class_spheremesh.rst b/classes/class_spheremesh.rst index 410797d1e..94082d408 100644 --- a/classes/class_spheremesh.rst +++ b/classes/class_spheremesh.rst @@ -19,27 +19,27 @@ Class representing a spherical :ref:`PrimitiveMesh`. Member Functions ---------------- -+----------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_height` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_is_hemisphere` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_radial_segments` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_radius` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_rings` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_height` **(** :ref:`float` height **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_is_hemisphere` **(** :ref:`bool` is_hemisphere **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_radial_segments` **(** :ref:`int` radial_segments **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_radius` **(** :ref:`float` radius **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rings` **(** :ref:`int` rings **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------------------+ ++----------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_height` **(** **)** const | ++----------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_is_hemisphere` **(** **)** const | ++----------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_radial_segments` **(** **)** const | ++----------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_radius` **(** **)** const | ++----------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_rings` **(** **)** const | ++----------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_height` **(** :ref:`float` height **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_is_hemisphere` **(** :ref:`bool` is_hemisphere **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_radial_segments` **(** :ref:`int` radial_segments **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_radius` **(** :ref:`float` radius **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rings` **(** :ref:`int` rings **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -75,42 +75,42 @@ Member Function Description .. _class_SphereMesh_get_height: -- :ref:`float` **get_height** **(** **)** const +- :ref:`float` **get_height** **(** **)** const .. _class_SphereMesh_get_is_hemisphere: -- :ref:`bool` **get_is_hemisphere** **(** **)** const +- :ref:`bool` **get_is_hemisphere** **(** **)** const .. _class_SphereMesh_get_radial_segments: -- :ref:`int` **get_radial_segments** **(** **)** const +- :ref:`int` **get_radial_segments** **(** **)** const .. _class_SphereMesh_get_radius: -- :ref:`float` **get_radius** **(** **)** const +- :ref:`float` **get_radius** **(** **)** const .. _class_SphereMesh_get_rings: -- :ref:`int` **get_rings** **(** **)** const +- :ref:`int` **get_rings** **(** **)** const .. _class_SphereMesh_set_height: -- void **set_height** **(** :ref:`float` height **)** +- void **set_height** **(** :ref:`float` height **)** .. _class_SphereMesh_set_is_hemisphere: -- void **set_is_hemisphere** **(** :ref:`bool` is_hemisphere **)** +- void **set_is_hemisphere** **(** :ref:`bool` is_hemisphere **)** .. _class_SphereMesh_set_radial_segments: -- void **set_radial_segments** **(** :ref:`int` radial_segments **)** +- void **set_radial_segments** **(** :ref:`int` radial_segments **)** .. _class_SphereMesh_set_radius: -- void **set_radius** **(** :ref:`float` radius **)** +- void **set_radius** **(** :ref:`float` radius **)** .. _class_SphereMesh_set_rings: -- void **set_rings** **(** :ref:`int` rings **)** +- void **set_rings** **(** :ref:`int` rings **)** diff --git a/classes/class_sphereshape.rst b/classes/class_sphereshape.rst index 023bd5375..84d0d19e2 100644 --- a/classes/class_sphereshape.rst +++ b/classes/class_sphereshape.rst @@ -19,11 +19,11 @@ Sphere shape for 3D collisions. Member Functions ---------------- -+----------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_radius` **(** **)** const | -+----------------------------+------------------------------------------------------------------------------------------------+ -| void | :ref:`set_radius` **(** :ref:`float` radius **)** | -+----------------------------+------------------------------------------------------------------------------------------------+ ++----------------------------+----------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_radius` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------+ +| void | :ref:`set_radius` **(** :ref:`float` radius **)** | ++----------------------------+----------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -43,10 +43,10 @@ Member Function Description .. _class_SphereShape_get_radius: -- :ref:`float` **get_radius** **(** **)** const +- :ref:`float` **get_radius** **(** **)** const .. _class_SphereShape_set_radius: -- void **set_radius** **(** :ref:`float` radius **)** +- void **set_radius** **(** :ref:`float` radius **)** diff --git a/classes/class_spinbox.rst b/classes/class_spinbox.rst index 46964b62d..35cc156ce 100644 --- a/classes/class_spinbox.rst +++ b/classes/class_spinbox.rst @@ -19,21 +19,21 @@ Numerical input text field. Member Functions ---------------- -+----------------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`LineEdit` | :ref:`get_line_edit` **(** **)** | -+----------------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_prefix` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_suffix` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_editable` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------+ -| void | :ref:`set_editable` **(** :ref:`bool` editable **)** | -+----------------------------------+------------------------------------------------------------------------------------------------+ -| void | :ref:`set_prefix` **(** :ref:`String` prefix **)** | -+----------------------------------+------------------------------------------------------------------------------------------------+ -| void | :ref:`set_suffix` **(** :ref:`String` suffix **)** | -+----------------------------------+------------------------------------------------------------------------------------------------+ ++----------------------------------+----------------------------------------------------------------------------------------------+ +| :ref:`LineEdit` | :ref:`get_line_edit` **(** **)** | ++----------------------------------+----------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_prefix` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_suffix` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_editable` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------+ +| void | :ref:`set_editable` **(** :ref:`bool` editable **)** | ++----------------------------------+----------------------------------------------------------------------------------------------+ +| void | :ref:`set_prefix` **(** :ref:`String` prefix **)** | ++----------------------------------+----------------------------------------------------------------------------------------------+ +| void | :ref:`set_suffix` **(** :ref:`String` suffix **)** | ++----------------------------------+----------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -61,39 +61,39 @@ Member Function Description .. _class_SpinBox_get_line_edit: -- :ref:`LineEdit` **get_line_edit** **(** **)** +- :ref:`LineEdit` **get_line_edit** **(** **)** .. _class_SpinBox_get_prefix: -- :ref:`String` **get_prefix** **(** **)** const +- :ref:`String` **get_prefix** **(** **)** const .. _class_SpinBox_get_suffix: -- :ref:`String` **get_suffix** **(** **)** const +- :ref:`String` **get_suffix** **(** **)** const Return the specific suffix. .. _class_SpinBox_is_editable: -- :ref:`bool` **is_editable** **(** **)** const +- :ref:`bool` **is_editable** **(** **)** const Return if the spinbox is editable. .. _class_SpinBox_set_editable: -- void **set_editable** **(** :ref:`bool` editable **)** +- void **set_editable** **(** :ref:`bool` editable **)** Set whether the spinbox is editable. .. _class_SpinBox_set_prefix: -- void **set_prefix** **(** :ref:`String` prefix **)** +- void **set_prefix** **(** :ref:`String` prefix **)** Set a prefix. .. _class_SpinBox_set_suffix: -- void **set_suffix** **(** :ref:`String` suffix **)** +- void **set_suffix** **(** :ref:`String` suffix **)** Set a specific suffix. diff --git a/classes/class_splitcontainer.rst b/classes/class_splitcontainer.rst index e57ad2083..707f4fb88 100644 --- a/classes/class_splitcontainer.rst +++ b/classes/class_splitcontainer.rst @@ -21,26 +21,26 @@ Container for splitting and adjusting. Member Functions ---------------- -+--------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_dragger_visibility` **(** **)** const | -+--------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_split_offset` **(** **)** const | -+--------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_collapsed` **(** **)** const | -+--------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collapsed` **(** :ref:`bool` collapsed **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_dragger_visibility` **(** :ref:`int` mode **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_split_offset` **(** :ref:`int` offset **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------+ ++--------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_dragger_visibility` **(** **)** const | ++--------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_split_offset` **(** **)** const | ++--------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_collapsed` **(** **)** const | ++--------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collapsed` **(** :ref:`bool` collapsed **)** | ++--------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_dragger_visibility` **(** :ref:`int` mode **)** | ++--------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_split_offset` **(** :ref:`int` offset **)** | ++--------------------------+-------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_SplitContainer_dragged: -- **dragged** **(** :ref:`int` offset **)** +- **dragged** **(** :ref:`int` offset **)** Emitted when the dragger is dragged by user. @@ -78,37 +78,37 @@ Member Function Description .. _class_SplitContainer_get_dragger_visibility: -- :ref:`int` **get_dragger_visibility** **(** **)** const +- :ref:`int` **get_dragger_visibility** **(** **)** const Return visibility of the split dragger (one of DRAGGER_VISIBLE, DRAGGER_HIDDEN or DRAGGER_HIDDEN_COLLAPSED). .. _class_SplitContainer_get_split_offset: -- :ref:`int` **get_split_offset** **(** **)** const +- :ref:`int` **get_split_offset** **(** **)** const Return the split offset. .. _class_SplitContainer_is_collapsed: -- :ref:`bool` **is_collapsed** **(** **)** const +- :ref:`bool` **is_collapsed** **(** **)** const Return true if the split is collapsed. .. _class_SplitContainer_set_collapsed: -- void **set_collapsed** **(** :ref:`bool` collapsed **)** +- void **set_collapsed** **(** :ref:`bool` collapsed **)** Set if the split must be collapsed. .. _class_SplitContainer_set_dragger_visibility: -- void **set_dragger_visibility** **(** :ref:`int` mode **)** +- void **set_dragger_visibility** **(** :ref:`int` mode **)** Set visibility of the split dragger (*mode* must be one of DRAGGER_VISIBLE, DRAGGER_HIDDEN or DRAGGER_HIDDEN_COLLAPSED). .. _class_SplitContainer_set_split_offset: -- void **set_split_offset** **(** :ref:`int` offset **)** +- void **set_split_offset** **(** :ref:`int` offset **)** Set the split offset. diff --git a/classes/class_sprite.rst b/classes/class_sprite.rst index 05ac0615a..6d1bf58dc 100644 --- a/classes/class_sprite.rst +++ b/classes/class_sprite.rst @@ -19,68 +19,68 @@ General purpose Sprite node. Member Functions ---------------- -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_frame` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_hframes` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_normal_map` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_offset` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_region_rect` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_texture` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_vframes` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_centered` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_flipped_h` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_flipped_v` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_region` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_region_filter_clip_enabled` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_centered` **(** :ref:`bool` centered **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_flip_h` **(** :ref:`bool` flip_h **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_flip_v` **(** :ref:`bool` flip_v **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_frame` **(** :ref:`int` frame **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_hframes` **(** :ref:`int` hframes **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_normal_map` **(** :ref:`Texture` normal_map **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_offset` **(** :ref:`Vector2` offset **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_region` **(** :ref:`bool` enabled **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_region_filter_clip` **(** :ref:`bool` enabled **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_region_rect` **(** :ref:`Rect2` rect **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture` **(** :ref:`Texture` texture **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vframes` **(** :ref:`int` vframes **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_frame` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_hframes` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_normal_map` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_offset` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_region_rect` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_texture` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_vframes` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_centered` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_flipped_h` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_flipped_v` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_region` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_region_filter_clip_enabled` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_centered` **(** :ref:`bool` centered **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_flip_h` **(** :ref:`bool` flip_h **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_flip_v` **(** :ref:`bool` flip_v **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_frame` **(** :ref:`int` frame **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_hframes` **(** :ref:`int` hframes **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_normal_map` **(** :ref:`Texture` normal_map **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_offset` **(** :ref:`Vector2` offset **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_region` **(** :ref:`bool` enabled **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_region_filter_clip` **(** :ref:`bool` enabled **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_region_rect` **(** :ref:`Rect2` rect **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_texture` **(** :ref:`Texture` texture **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vframes` **(** :ref:`int` vframes **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_Sprite_frame_changed: -- **frame_changed** **(** **)** +- **frame_changed** **(** **)** Emitted when the :ref:`frame` changes. .. _class_Sprite_texture_changed: -- **texture_changed** **(** **)** +- **texture_changed** **(** **)** Emitted when the :ref:`texture` changes. @@ -147,137 +147,137 @@ Member Function Description .. _class_Sprite_get_frame: -- :ref:`int` **get_frame** **(** **)** const +- :ref:`int` **get_frame** **(** **)** const Return the texture frame for a sprite-sheet, works when vframes or hframes are greater than 1. .. _class_Sprite_get_hframes: -- :ref:`int` **get_hframes** **(** **)** const +- :ref:`int` **get_hframes** **(** **)** const Return the amount of horizontal frames. See :ref:`set_hframes`. .. _class_Sprite_get_normal_map: -- :ref:`Texture` **get_normal_map** **(** **)** const +- :ref:`Texture` **get_normal_map** **(** **)** const .. _class_Sprite_get_offset: -- :ref:`Vector2` **get_offset** **(** **)** const +- :ref:`Vector2` **get_offset** **(** **)** const Return sprite draw offset. .. _class_Sprite_get_region_rect: -- :ref:`Rect2` **get_region_rect** **(** **)** const +- :ref:`Rect2` **get_region_rect** **(** **)** const Return the region rect to read from. .. _class_Sprite_get_texture: -- :ref:`Texture` **get_texture** **(** **)** const +- :ref:`Texture` **get_texture** **(** **)** const Return the base texture for the sprite. .. _class_Sprite_get_vframes: -- :ref:`int` **get_vframes** **(** **)** const +- :ref:`int` **get_vframes** **(** **)** const Return the amount of vertical frames. See :ref:`set_vframes`. .. _class_Sprite_is_centered: -- :ref:`bool` **is_centered** **(** **)** const +- :ref:`bool` **is_centered** **(** **)** const Return if the sprite is centered at the local origin. .. _class_Sprite_is_flipped_h: -- :ref:`bool` **is_flipped_h** **(** **)** const +- :ref:`bool` **is_flipped_h** **(** **)** const Return true if the sprite is flipped horizontally. .. _class_Sprite_is_flipped_v: -- :ref:`bool` **is_flipped_v** **(** **)** const +- :ref:`bool` **is_flipped_v** **(** **)** const Return true if the sprite is flipped vertically. .. _class_Sprite_is_region: -- :ref:`bool` **is_region** **(** **)** const +- :ref:`bool` **is_region** **(** **)** const Return if the sprite reads from a region. .. _class_Sprite_is_region_filter_clip_enabled: -- :ref:`bool` **is_region_filter_clip_enabled** **(** **)** const +- :ref:`bool` **is_region_filter_clip_enabled** **(** **)** const .. _class_Sprite_set_centered: -- void **set_centered** **(** :ref:`bool` centered **)** +- void **set_centered** **(** :ref:`bool` centered **)** Set whether the sprite should be centered on the origin. .. _class_Sprite_set_flip_h: -- void **set_flip_h** **(** :ref:`bool` flip_h **)** +- void **set_flip_h** **(** :ref:`bool` flip_h **)** Set true to flip the sprite horizontally. .. _class_Sprite_set_flip_v: -- void **set_flip_v** **(** :ref:`bool` flip_v **)** +- void **set_flip_v** **(** :ref:`bool` flip_v **)** Set true to flip the sprite vertically. .. _class_Sprite_set_frame: -- void **set_frame** **(** :ref:`int` frame **)** +- void **set_frame** **(** :ref:`int` frame **)** Set the texture frame for a sprite-sheet, works when vframes or hframes are greater than 1. .. _class_Sprite_set_hframes: -- void **set_hframes** **(** :ref:`int` hframes **)** +- void **set_hframes** **(** :ref:`int` hframes **)** Set the amount of horizontal frames and converts the sprite into a sprite-sheet. This is useful for animation. .. _class_Sprite_set_normal_map: -- void **set_normal_map** **(** :ref:`Texture` normal_map **)** +- void **set_normal_map** **(** :ref:`Texture` normal_map **)** .. _class_Sprite_set_offset: -- void **set_offset** **(** :ref:`Vector2` offset **)** +- void **set_offset** **(** :ref:`Vector2` offset **)** Set the sprite draw offset, useful for setting rotation pivots. .. _class_Sprite_set_region: -- void **set_region** **(** :ref:`bool` enabled **)** +- void **set_region** **(** :ref:`bool` enabled **)** Set the sprite as a sub-region of a bigger texture. Useful for texture-atlases. .. _class_Sprite_set_region_filter_clip: -- void **set_region_filter_clip** **(** :ref:`bool` enabled **)** +- void **set_region_filter_clip** **(** :ref:`bool` enabled **)** .. _class_Sprite_set_region_rect: -- void **set_region_rect** **(** :ref:`Rect2` rect **)** +- void **set_region_rect** **(** :ref:`Rect2` rect **)** Set the region rect to read from. .. _class_Sprite_set_texture: -- void **set_texture** **(** :ref:`Texture` texture **)** +- void **set_texture** **(** :ref:`Texture` texture **)** Set the base texture for the sprite. .. _class_Sprite_set_vframes: -- void **set_vframes** **(** :ref:`int` vframes **)** +- void **set_vframes** **(** :ref:`int` vframes **)** Set the amount of vertical frames and converts the sprite into a sprite-sheet. This is useful for animation. diff --git a/classes/class_sprite3d.rst b/classes/class_sprite3d.rst index 488cbe62f..48e6a724d 100644 --- a/classes/class_sprite3d.rst +++ b/classes/class_sprite3d.rst @@ -19,38 +19,38 @@ Brief Description Member Functions ---------------- -+--------------------------------+-----------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_frame` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_hframes` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_region_rect` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_texture` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_vframes` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_region` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------+ -| void | :ref:`set_frame` **(** :ref:`int` frame **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------+ -| void | :ref:`set_hframes` **(** :ref:`int` hframes **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------+ -| void | :ref:`set_region` **(** :ref:`bool` enabled **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------+ -| void | :ref:`set_region_rect` **(** :ref:`Rect2` rect **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture` **(** :ref:`Texture` texture **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vframes` **(** :ref:`int` vframes **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------+ ++--------------------------------+---------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_frame` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_hframes` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_region_rect` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_texture` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_vframes` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_region` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------+ +| void | :ref:`set_frame` **(** :ref:`int` frame **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------+ +| void | :ref:`set_hframes` **(** :ref:`int` hframes **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------+ +| void | :ref:`set_region` **(** :ref:`bool` enabled **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------+ +| void | :ref:`set_region_rect` **(** :ref:`Rect2` rect **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------+ +| void | :ref:`set_texture` **(** :ref:`Texture` texture **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vframes` **(** :ref:`int` vframes **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------+ Signals ------- .. _class_Sprite3D_frame_changed: -- **frame_changed** **(** **)** +- **frame_changed** **(** **)** Emitted when the :ref:`frame` changes. @@ -93,50 +93,50 @@ Member Function Description .. _class_Sprite3D_get_frame: -- :ref:`int` **get_frame** **(** **)** const +- :ref:`int` **get_frame** **(** **)** const .. _class_Sprite3D_get_hframes: -- :ref:`int` **get_hframes** **(** **)** const +- :ref:`int` **get_hframes** **(** **)** const .. _class_Sprite3D_get_region_rect: -- :ref:`Rect2` **get_region_rect** **(** **)** const +- :ref:`Rect2` **get_region_rect** **(** **)** const .. _class_Sprite3D_get_texture: -- :ref:`Texture` **get_texture** **(** **)** const +- :ref:`Texture` **get_texture** **(** **)** const .. _class_Sprite3D_get_vframes: -- :ref:`int` **get_vframes** **(** **)** const +- :ref:`int` **get_vframes** **(** **)** const .. _class_Sprite3D_is_region: -- :ref:`bool` **is_region** **(** **)** const +- :ref:`bool` **is_region** **(** **)** const .. _class_Sprite3D_set_frame: -- void **set_frame** **(** :ref:`int` frame **)** +- void **set_frame** **(** :ref:`int` frame **)** .. _class_Sprite3D_set_hframes: -- void **set_hframes** **(** :ref:`int` hframes **)** +- void **set_hframes** **(** :ref:`int` hframes **)** .. _class_Sprite3D_set_region: -- void **set_region** **(** :ref:`bool` enabled **)** +- void **set_region** **(** :ref:`bool` enabled **)** .. _class_Sprite3D_set_region_rect: -- void **set_region_rect** **(** :ref:`Rect2` rect **)** +- void **set_region_rect** **(** :ref:`Rect2` rect **)** .. _class_Sprite3D_set_texture: -- void **set_texture** **(** :ref:`Texture` texture **)** +- void **set_texture** **(** :ref:`Texture` texture **)** .. _class_Sprite3D_set_vframes: -- void **set_vframes** **(** :ref:`int` vframes **)** +- void **set_vframes** **(** :ref:`int` vframes **)** diff --git a/classes/class_spritebase3d.rst b/classes/class_spritebase3d.rst index 0d181aa4a..28e3f03f8 100644 --- a/classes/class_spritebase3d.rst +++ b/classes/class_spritebase3d.rst @@ -21,49 +21,49 @@ Brief Description Member Functions ---------------- -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_alpha_cut_mode` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_axis` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_draw_flag` **(** :ref:`int` flag **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_item_rect` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_modulate` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_offset` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_opacity` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_pixel_size` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_centered` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_flipped_h` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_flipped_v` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_alpha_cut_mode` **(** :ref:`int` mode **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_axis` **(** :ref:`int` axis **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_centered` **(** :ref:`bool` centered **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_draw_flag` **(** :ref:`int` flag, :ref:`bool` enabled **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_flip_h` **(** :ref:`bool` flip_h **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_flip_v` **(** :ref:`bool` flip_v **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_modulate` **(** :ref:`Color` modulate **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_offset` **(** :ref:`Vector2` offset **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_opacity` **(** :ref:`float` opacity **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pixel_size` **(** :ref:`float` pixel_size **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_alpha_cut_mode` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_axis` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_draw_flag` **(** :ref:`int` flag **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_item_rect` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_modulate` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_offset` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_opacity` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_pixel_size` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_centered` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_flipped_h` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_flipped_v` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_alpha_cut_mode` **(** :ref:`int` mode **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_axis` **(** :ref:`int` axis **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_centered` **(** :ref:`bool` centered **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_draw_flag` **(** :ref:`int` flag, :ref:`bool` enabled **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_flip_h` **(** :ref:`bool` flip_h **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_flip_v` **(** :ref:`bool` flip_v **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_modulate` **(** :ref:`Color` modulate **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_offset` **(** :ref:`Vector2` offset **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_opacity` **(** :ref:`float` opacity **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pixel_size` **(** :ref:`float` pixel_size **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -138,86 +138,86 @@ Member Function Description .. _class_SpriteBase3D_get_alpha_cut_mode: -- :ref:`int` **get_alpha_cut_mode** **(** **)** const +- :ref:`int` **get_alpha_cut_mode** **(** **)** const .. _class_SpriteBase3D_get_axis: -- :ref:`int` **get_axis** **(** **)** const +- :ref:`int` **get_axis** **(** **)** const .. _class_SpriteBase3D_get_draw_flag: -- :ref:`bool` **get_draw_flag** **(** :ref:`int` flag **)** const +- :ref:`bool` **get_draw_flag** **(** :ref:`int` flag **)** const .. _class_SpriteBase3D_get_item_rect: -- :ref:`Rect2` **get_item_rect** **(** **)** const +- :ref:`Rect2` **get_item_rect** **(** **)** const .. _class_SpriteBase3D_get_modulate: -- :ref:`Color` **get_modulate** **(** **)** const +- :ref:`Color` **get_modulate** **(** **)** const .. _class_SpriteBase3D_get_offset: -- :ref:`Vector2` **get_offset** **(** **)** const +- :ref:`Vector2` **get_offset** **(** **)** const .. _class_SpriteBase3D_get_opacity: -- :ref:`float` **get_opacity** **(** **)** const +- :ref:`float` **get_opacity** **(** **)** const .. _class_SpriteBase3D_get_pixel_size: -- :ref:`float` **get_pixel_size** **(** **)** const +- :ref:`float` **get_pixel_size** **(** **)** const .. _class_SpriteBase3D_is_centered: -- :ref:`bool` **is_centered** **(** **)** const +- :ref:`bool` **is_centered** **(** **)** const .. _class_SpriteBase3D_is_flipped_h: -- :ref:`bool` **is_flipped_h** **(** **)** const +- :ref:`bool` **is_flipped_h** **(** **)** const .. _class_SpriteBase3D_is_flipped_v: -- :ref:`bool` **is_flipped_v** **(** **)** const +- :ref:`bool` **is_flipped_v** **(** **)** const .. _class_SpriteBase3D_set_alpha_cut_mode: -- void **set_alpha_cut_mode** **(** :ref:`int` mode **)** +- void **set_alpha_cut_mode** **(** :ref:`int` mode **)** .. _class_SpriteBase3D_set_axis: -- void **set_axis** **(** :ref:`int` axis **)** +- void **set_axis** **(** :ref:`int` axis **)** .. _class_SpriteBase3D_set_centered: -- void **set_centered** **(** :ref:`bool` centered **)** +- void **set_centered** **(** :ref:`bool` centered **)** .. _class_SpriteBase3D_set_draw_flag: -- void **set_draw_flag** **(** :ref:`int` flag, :ref:`bool` enabled **)** +- void **set_draw_flag** **(** :ref:`int` flag, :ref:`bool` enabled **)** .. _class_SpriteBase3D_set_flip_h: -- void **set_flip_h** **(** :ref:`bool` flip_h **)** +- void **set_flip_h** **(** :ref:`bool` flip_h **)** .. _class_SpriteBase3D_set_flip_v: -- void **set_flip_v** **(** :ref:`bool` flip_v **)** +- void **set_flip_v** **(** :ref:`bool` flip_v **)** .. _class_SpriteBase3D_set_modulate: -- void **set_modulate** **(** :ref:`Color` modulate **)** +- void **set_modulate** **(** :ref:`Color` modulate **)** .. _class_SpriteBase3D_set_offset: -- void **set_offset** **(** :ref:`Vector2` offset **)** +- void **set_offset** **(** :ref:`Vector2` offset **)** .. _class_SpriteBase3D_set_opacity: -- void **set_opacity** **(** :ref:`float` opacity **)** +- void **set_opacity** **(** :ref:`float` opacity **)** .. _class_SpriteBase3D_set_pixel_size: -- void **set_pixel_size** **(** :ref:`float` pixel_size **)** +- void **set_pixel_size** **(** :ref:`float` pixel_size **)** diff --git a/classes/class_spriteframes.rst b/classes/class_spriteframes.rst index 195a8362a..fc285ef5f 100644 --- a/classes/class_spriteframes.rst +++ b/classes/class_spriteframes.rst @@ -19,37 +19,37 @@ Sprite frame library for AnimatedSprite. Member Functions ---------------- -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_animation` **(** :ref:`String` anim **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_frame` **(** :ref:`String` anim, :ref:`Texture` frame, :ref:`int` at_position=-1 **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** :ref:`String` anim **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_all` **(** **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_animation_loop` **(** :ref:`String` anim **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_animation_speed` **(** :ref:`String` anim **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_frame` **(** :ref:`String` anim, :ref:`int` idx **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_frame_count` **(** :ref:`String` anim **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_animation` **(** :ref:`String` anim **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_animation` **(** :ref:`String` anim **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_frame` **(** :ref:`String` anim, :ref:`int` idx **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rename_animation` **(** :ref:`String` anim, :ref:`String` newname **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_animation_loop` **(** :ref:`String` anim, :ref:`bool` loop **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_animation_speed` **(** :ref:`String` anim, :ref:`float` speed **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_frame` **(** :ref:`String` anim, :ref:`int` idx, :ref:`Texture` txt **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_animation` **(** :ref:`String` anim **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_frame` **(** :ref:`String` anim, :ref:`Texture` frame, :ref:`int` at_position=-1 **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** :ref:`String` anim **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_all` **(** **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_animation_loop` **(** :ref:`String` anim **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_animation_speed` **(** :ref:`String` anim **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_frame` **(** :ref:`String` anim, :ref:`int` idx **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_frame_count` **(** :ref:`String` anim **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_animation` **(** :ref:`String` anim **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_animation` **(** :ref:`String` anim **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_frame` **(** :ref:`String` anim, :ref:`int` idx **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rename_animation` **(** :ref:`String` anim, :ref:`String` newname **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_animation_loop` **(** :ref:`String` anim, :ref:`bool` loop **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_animation_speed` **(** :ref:`String` anim, :ref:`float` speed **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_frame` **(** :ref:`String` anim, :ref:`int` idx, :ref:`Texture` txt **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -73,91 +73,91 @@ Member Function Description .. _class_SpriteFrames_add_animation: -- void **add_animation** **(** :ref:`String` anim **)** +- void **add_animation** **(** :ref:`String` anim **)** Adds a new animation to the the library. .. _class_SpriteFrames_add_frame: -- void **add_frame** **(** :ref:`String` anim, :ref:`Texture` frame, :ref:`int` at_position=-1 **)** +- void **add_frame** **(** :ref:`String` anim, :ref:`Texture` frame, :ref:`int` at_position=-1 **)** Adds a frame to the given animation. .. _class_SpriteFrames_clear: -- void **clear** **(** :ref:`String` anim **)** +- void **clear** **(** :ref:`String` anim **)** Removes all frames from the given animation. .. _class_SpriteFrames_clear_all: -- void **clear_all** **(** **)** +- void **clear_all** **(** **)** Removes all animations. A "default" animation will be created. .. _class_SpriteFrames_get_animation_loop: -- :ref:`bool` **get_animation_loop** **(** :ref:`String` anim **)** const +- :ref:`bool` **get_animation_loop** **(** :ref:`String` anim **)** const If ``true`` the given animation will loop. .. _class_SpriteFrames_get_animation_speed: -- :ref:`float` **get_animation_speed** **(** :ref:`String` anim **)** const +- :ref:`float` **get_animation_speed** **(** :ref:`String` anim **)** const The animation's speed in frames per second. .. _class_SpriteFrames_get_frame: -- :ref:`Texture` **get_frame** **(** :ref:`String` anim, :ref:`int` idx **)** const +- :ref:`Texture` **get_frame** **(** :ref:`String` anim, :ref:`int` idx **)** const Returns the animation's selected frame. .. _class_SpriteFrames_get_frame_count: -- :ref:`int` **get_frame_count** **(** :ref:`String` anim **)** const +- :ref:`int` **get_frame_count** **(** :ref:`String` anim **)** const Returns the number of frames in the animation. .. _class_SpriteFrames_has_animation: -- :ref:`bool` **has_animation** **(** :ref:`String` anim **)** const +- :ref:`bool` **has_animation** **(** :ref:`String` anim **)** const If ``true`` the named animation exists. .. _class_SpriteFrames_remove_animation: -- void **remove_animation** **(** :ref:`String` anim **)** +- void **remove_animation** **(** :ref:`String` anim **)** Removes the given animation. .. _class_SpriteFrames_remove_frame: -- void **remove_frame** **(** :ref:`String` anim, :ref:`int` idx **)** +- void **remove_frame** **(** :ref:`String` anim, :ref:`int` idx **)** Removes the animation's selected frame. .. _class_SpriteFrames_rename_animation: -- void **rename_animation** **(** :ref:`String` anim, :ref:`String` newname **)** +- void **rename_animation** **(** :ref:`String` anim, :ref:`String` newname **)** Changes the animation's name to ``newname``. .. _class_SpriteFrames_set_animation_loop: -- void **set_animation_loop** **(** :ref:`String` anim, :ref:`bool` loop **)** +- void **set_animation_loop** **(** :ref:`String` anim, :ref:`bool` loop **)** If ``true`` the animation will loop. .. _class_SpriteFrames_set_animation_speed: -- void **set_animation_speed** **(** :ref:`String` anim, :ref:`float` speed **)** +- void **set_animation_speed** **(** :ref:`String` anim, :ref:`float` speed **)** The animation's speed in frames per second. .. _class_SpriteFrames_set_frame: -- void **set_frame** **(** :ref:`String` anim, :ref:`int` idx, :ref:`Texture` txt **)** +- void **set_frame** **(** :ref:`String` anim, :ref:`int` idx, :ref:`Texture` txt **)** Sets the texture of the given frame. diff --git a/classes/class_staticbody.rst b/classes/class_staticbody.rst index 36ac71d1b..42349ab4a 100644 --- a/classes/class_staticbody.rst +++ b/classes/class_staticbody.rst @@ -19,23 +19,23 @@ Static body for 3D Physics. Member Functions ---------------- -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_bounce` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_constant_angular_velocity` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_constant_linear_velocity` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_friction` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bounce` **(** :ref:`float` bounce **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_constant_angular_velocity` **(** :ref:`Vector3` vel **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_constant_linear_velocity` **(** :ref:`Vector3` vel **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_friction` **(** :ref:`float` friction **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_bounce` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_constant_angular_velocity` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_constant_linear_velocity` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_friction` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bounce` **(** :ref:`float` bounce **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_constant_angular_velocity` **(** :ref:`Vector3` vel **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_constant_linear_velocity` **(** :ref:`Vector3` vel **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_friction` **(** :ref:`float` friction **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -71,49 +71,49 @@ Member Function Description .. _class_StaticBody_get_bounce: -- :ref:`float` **get_bounce** **(** **)** const +- :ref:`float` **get_bounce** **(** **)** const Return the body bounciness. .. _class_StaticBody_get_constant_angular_velocity: -- :ref:`Vector3` **get_constant_angular_velocity** **(** **)** const +- :ref:`Vector3` **get_constant_angular_velocity** **(** **)** const Return the constant angular velocity for the body. .. _class_StaticBody_get_constant_linear_velocity: -- :ref:`Vector3` **get_constant_linear_velocity** **(** **)** const +- :ref:`Vector3` **get_constant_linear_velocity** **(** **)** const Return the constant linear velocity for the body. .. _class_StaticBody_get_friction: -- :ref:`float` **get_friction** **(** **)** const +- :ref:`float` **get_friction** **(** **)** const Return the body friction. .. _class_StaticBody_set_bounce: -- void **set_bounce** **(** :ref:`float` bounce **)** +- void **set_bounce** **(** :ref:`float` bounce **)** Set the body bounciness, from 0 (not bouncy) to 1 (bouncy). .. _class_StaticBody_set_constant_angular_velocity: -- void **set_constant_angular_velocity** **(** :ref:`Vector3` vel **)** +- void **set_constant_angular_velocity** **(** :ref:`Vector3` vel **)** Set a constant angular velocity for the body. This does not rotate the body, but affects other bodies touching it, as if it was rotating. .. _class_StaticBody_set_constant_linear_velocity: -- void **set_constant_linear_velocity** **(** :ref:`Vector3` vel **)** +- void **set_constant_linear_velocity** **(** :ref:`Vector3` vel **)** Set a constant linear velocity for the body. This does not move the body, but affects other bodies touching it, as if it was moving. .. _class_StaticBody_set_friction: -- void **set_friction** **(** :ref:`float` friction **)** +- void **set_friction** **(** :ref:`float` friction **)** Set the body friction, from 0 (frictionless) to 1 (full friction). diff --git a/classes/class_staticbody2d.rst b/classes/class_staticbody2d.rst index da50e918d..e4b976756 100644 --- a/classes/class_staticbody2d.rst +++ b/classes/class_staticbody2d.rst @@ -19,23 +19,23 @@ Static body for 2D Physics. Member Functions ---------------- -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_bounce` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_constant_angular_velocity` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_constant_linear_velocity` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_friction` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bounce` **(** :ref:`float` bounce **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_constant_angular_velocity` **(** :ref:`float` vel **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_constant_linear_velocity` **(** :ref:`Vector2` vel **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_friction` **(** :ref:`float` friction **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_bounce` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_constant_angular_velocity` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_constant_linear_velocity` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_friction` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bounce` **(** :ref:`float` bounce **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_constant_angular_velocity` **(** :ref:`float` vel **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_constant_linear_velocity` **(** :ref:`Vector2` vel **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_friction` **(** :ref:`float` friction **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -69,49 +69,49 @@ Member Function Description .. _class_StaticBody2D_get_bounce: -- :ref:`float` **get_bounce** **(** **)** const +- :ref:`float` **get_bounce** **(** **)** const Return the body bounciness. .. _class_StaticBody2D_get_constant_angular_velocity: -- :ref:`float` **get_constant_angular_velocity** **(** **)** const +- :ref:`float` **get_constant_angular_velocity** **(** **)** const Return the constant angular velocity for the body. .. _class_StaticBody2D_get_constant_linear_velocity: -- :ref:`Vector2` **get_constant_linear_velocity** **(** **)** const +- :ref:`Vector2` **get_constant_linear_velocity** **(** **)** const Return the constant linear velocity for the body. .. _class_StaticBody2D_get_friction: -- :ref:`float` **get_friction** **(** **)** const +- :ref:`float` **get_friction** **(** **)** const Return the body friction. .. _class_StaticBody2D_set_bounce: -- void **set_bounce** **(** :ref:`float` bounce **)** +- void **set_bounce** **(** :ref:`float` bounce **)** Set the body bounciness, from 0 (not bouncy) to 1 (bouncy). .. _class_StaticBody2D_set_constant_angular_velocity: -- void **set_constant_angular_velocity** **(** :ref:`float` vel **)** +- void **set_constant_angular_velocity** **(** :ref:`float` vel **)** Set a constant angular velocity for the body. This does not rotate the body, but affects other bodies touching it, as if it was rotating. .. _class_StaticBody2D_set_constant_linear_velocity: -- void **set_constant_linear_velocity** **(** :ref:`Vector2` vel **)** +- void **set_constant_linear_velocity** **(** :ref:`Vector2` vel **)** Set a constant linear velocity for the body. This does not move the body, but affects other bodies touching it, as if it was moving. .. _class_StaticBody2D_set_friction: -- void **set_friction** **(** :ref:`float` friction **)** +- void **set_friction** **(** :ref:`float` friction **)** Set the body friction, from 0 (frictionless) to 1 (full friction). diff --git a/classes/class_streampeer.rst b/classes/class_streampeer.rst index da20a523b..5bd306eb4 100644 --- a/classes/class_streampeer.rst +++ b/classes/class_streampeer.rst @@ -21,71 +21,71 @@ Abstraction and base class for stream-based protocols. Member Functions ---------------- -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_16` **(** **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_32` **(** **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_64` **(** **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_8` **(** **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_available_bytes` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_data` **(** :ref:`int` bytes **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_double` **(** **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_float` **(** **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_partial_data` **(** :ref:`int` bytes **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_string` **(** :ref:`int` bytes **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_u16` **(** **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_u32` **(** **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_u64` **(** **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_u8` **(** **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_utf8_string` **(** :ref:`int` bytes **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_var` **(** **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_big_endian_enabled` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_16` **(** :ref:`int` val **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_32` **(** :ref:`int` val **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_64` **(** :ref:`int` val **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_8` **(** :ref:`int` val **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`put_data` **(** :ref:`PoolByteArray` data **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_double` **(** :ref:`float` val **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_float` **(** :ref:`float` val **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`put_partial_data` **(** :ref:`PoolByteArray` data **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_u16` **(** :ref:`int` val **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_u32` **(** :ref:`int` val **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_u64` **(** :ref:`int` val **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_u8` **(** :ref:`int` val **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_utf8_string` **(** :ref:`String` val **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_var` **(** :ref:`Variant` val **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_big_endian` **(** :ref:`bool` enable **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_16` **(** **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_32` **(** **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_64` **(** **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_8` **(** **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_available_bytes` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_data` **(** :ref:`int` bytes **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_double` **(** **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_float` **(** **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_partial_data` **(** :ref:`int` bytes **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_string` **(** :ref:`int` bytes **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_u16` **(** **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_u32` **(** **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_u64` **(** **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_u8` **(** **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_utf8_string` **(** :ref:`int` bytes **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_var` **(** **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_big_endian_enabled` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`put_16` **(** :ref:`int` val **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`put_32` **(** :ref:`int` val **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`put_64` **(** :ref:`int` val **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`put_8` **(** :ref:`int` val **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`put_data` **(** :ref:`PoolByteArray` data **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`put_double` **(** :ref:`float` val **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`put_float` **(** :ref:`float` val **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`put_partial_data` **(** :ref:`PoolByteArray` data **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`put_u16` **(** :ref:`int` val **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`put_u32` **(** :ref:`int` val **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`put_u64` **(** :ref:`int` val **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`put_u8` **(** :ref:`int` val **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`put_utf8_string` **(** :ref:`String` val **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`put_var` **(** :ref:`Variant` val **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_big_endian` **(** :ref:`bool` enable **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -97,193 +97,193 @@ Member Function Description .. _class_StreamPeer_get_16: -- :ref:`int` **get_16** **(** **)** +- :ref:`int` **get_16** **(** **)** Get a signed 16 bit value from the stream. .. _class_StreamPeer_get_32: -- :ref:`int` **get_32** **(** **)** +- :ref:`int` **get_32** **(** **)** Get a signed 32 bit value from the stream. .. _class_StreamPeer_get_64: -- :ref:`int` **get_64** **(** **)** +- :ref:`int` **get_64** **(** **)** Get a signed 64 bit value from the stream. .. _class_StreamPeer_get_8: -- :ref:`int` **get_8** **(** **)** +- :ref:`int` **get_8** **(** **)** Get a signed byte from the stream. .. _class_StreamPeer_get_available_bytes: -- :ref:`int` **get_available_bytes** **(** **)** const +- :ref:`int` **get_available_bytes** **(** **)** const Return the amount of bytes this :ref:`StreamPeer` has available. .. _class_StreamPeer_get_data: -- :ref:`Array` **get_data** **(** :ref:`int` bytes **)** +- :ref:`Array` **get_data** **(** :ref:`int` bytes **)** Return a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will block until the desired amount is received. This function returns two values, an Error code and a data array. .. _class_StreamPeer_get_double: -- :ref:`float` **get_double** **(** **)** +- :ref:`float` **get_double** **(** **)** Get a double-precision float from the stream. .. _class_StreamPeer_get_float: -- :ref:`float` **get_float** **(** **)** +- :ref:`float` **get_float** **(** **)** Get a single-precision float from the stream. .. _class_StreamPeer_get_partial_data: -- :ref:`Array` **get_partial_data** **(** :ref:`int` bytes **)** +- :ref:`Array` **get_partial_data** **(** :ref:`int` bytes **)** Return a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will return how many were actually received. This function returns two values, an Error code, and a data array. .. _class_StreamPeer_get_string: -- :ref:`String` **get_string** **(** :ref:`int` bytes **)** +- :ref:`String` **get_string** **(** :ref:`int` bytes **)** Get a string with byte-length "bytes" from the stream. .. _class_StreamPeer_get_u16: -- :ref:`int` **get_u16** **(** **)** +- :ref:`int` **get_u16** **(** **)** Get an unsigned 16 bit value from the stream. .. _class_StreamPeer_get_u32: -- :ref:`int` **get_u32** **(** **)** +- :ref:`int` **get_u32** **(** **)** Get an unsigned 32 bit value from the stream. .. _class_StreamPeer_get_u64: -- :ref:`int` **get_u64** **(** **)** +- :ref:`int` **get_u64** **(** **)** Get an unsigned 16 bit value from the stream. .. _class_StreamPeer_get_u8: -- :ref:`int` **get_u8** **(** **)** +- :ref:`int` **get_u8** **(** **)** Get an unsigned byte from the stream. .. _class_StreamPeer_get_utf8_string: -- :ref:`String` **get_utf8_string** **(** :ref:`int` bytes **)** +- :ref:`String` **get_utf8_string** **(** :ref:`int` bytes **)** Get a utf8 string with byte-length "bytes" from the stream (this decodes the string sent as utf8). .. _class_StreamPeer_get_var: -- :ref:`Variant` **get_var** **(** **)** +- :ref:`Variant` **get_var** **(** **)** Get a Variant from the stream. .. _class_StreamPeer_is_big_endian_enabled: -- :ref:`bool` **is_big_endian_enabled** **(** **)** const +- :ref:`bool` **is_big_endian_enabled** **(** **)** const Return whether this :ref:`StreamPeer` is using big-endian format. .. _class_StreamPeer_put_16: -- void **put_16** **(** :ref:`int` val **)** +- void **put_16** **(** :ref:`int` val **)** Put a signed 16 bit value into the stream. .. _class_StreamPeer_put_32: -- void **put_32** **(** :ref:`int` val **)** +- void **put_32** **(** :ref:`int` val **)** Put a signed 32 bit value into the stream. .. _class_StreamPeer_put_64: -- void **put_64** **(** :ref:`int` val **)** +- void **put_64** **(** :ref:`int` val **)** Put a signed 64 bit value into the stream. .. _class_StreamPeer_put_8: -- void **put_8** **(** :ref:`int` val **)** +- void **put_8** **(** :ref:`int` val **)** Put a signed byte into the stream. .. _class_StreamPeer_put_data: -- :ref:`int` **put_data** **(** :ref:`PoolByteArray` data **)** +- :ref:`int` **put_data** **(** :ref:`PoolByteArray` data **)** Send a chunk of data through the connection, blocking if necessary until the data is done sending. This function returns an Error code. .. _class_StreamPeer_put_double: -- void **put_double** **(** :ref:`float` val **)** +- void **put_double** **(** :ref:`float` val **)** Put a double-precision float into the stream. .. _class_StreamPeer_put_float: -- void **put_float** **(** :ref:`float` val **)** +- void **put_float** **(** :ref:`float` val **)** Put a single-precision float into the stream. .. _class_StreamPeer_put_partial_data: -- :ref:`Array` **put_partial_data** **(** :ref:`PoolByteArray` data **)** +- :ref:`Array` **put_partial_data** **(** :ref:`PoolByteArray` data **)** Send a chunk of data through the connection, if all the data could not be sent at once, only part of it will. This function returns two values, an Error code and an integer, describing how much data was actually sent. .. _class_StreamPeer_put_u16: -- void **put_u16** **(** :ref:`int` val **)** +- void **put_u16** **(** :ref:`int` val **)** Put an unsigned 16 bit value into the stream. .. _class_StreamPeer_put_u32: -- void **put_u32** **(** :ref:`int` val **)** +- void **put_u32** **(** :ref:`int` val **)** Put an unsigned 32 bit value into the stream. .. _class_StreamPeer_put_u64: -- void **put_u64** **(** :ref:`int` val **)** +- void **put_u64** **(** :ref:`int` val **)** Put an unsigned 64 bit value into the stream. .. _class_StreamPeer_put_u8: -- void **put_u8** **(** :ref:`int` val **)** +- void **put_u8** **(** :ref:`int` val **)** Put an unsigned byte into the stream. .. _class_StreamPeer_put_utf8_string: -- void **put_utf8_string** **(** :ref:`String` val **)** +- void **put_utf8_string** **(** :ref:`String` val **)** Put a zero-terminated utf8 string into the stream. .. _class_StreamPeer_put_var: -- void **put_var** **(** :ref:`Variant` val **)** +- void **put_var** **(** :ref:`Variant` val **)** Put a Variant into the stream. .. _class_StreamPeer_set_big_endian: -- void **set_big_endian** **(** :ref:`bool` enable **)** +- void **set_big_endian** **(** :ref:`bool` enable **)** Set this :ref:`StreamPeer` to use big-endian format. Default is false. diff --git a/classes/class_streampeerbuffer.rst b/classes/class_streampeerbuffer.rst index 3b3ab11fe..b1e83cf52 100644 --- a/classes/class_streampeerbuffer.rst +++ b/classes/class_streampeerbuffer.rst @@ -19,57 +19,57 @@ Brief Description Member Functions ---------------- -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StreamPeerBuffer` | :ref:`duplicate` **(** **)** const | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`get_data_array` **(** **)** const | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_position` **(** **)** const | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_size` **(** **)** const | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resize` **(** :ref:`int` size **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`seek` **(** :ref:`int` position **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_data_array` **(** :ref:`PoolByteArray` data **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`StreamPeerBuffer` | :ref:`duplicate` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`get_data_array` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_position` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_size` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resize` **(** :ref:`int` size **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`seek` **(** :ref:`int` position **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_data_array` **(** :ref:`PoolByteArray` data **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ Member Function Description --------------------------- .. _class_StreamPeerBuffer_clear: -- void **clear** **(** **)** +- void **clear** **(** **)** .. _class_StreamPeerBuffer_duplicate: -- :ref:`StreamPeerBuffer` **duplicate** **(** **)** const +- :ref:`StreamPeerBuffer` **duplicate** **(** **)** const .. _class_StreamPeerBuffer_get_data_array: -- :ref:`PoolByteArray` **get_data_array** **(** **)** const +- :ref:`PoolByteArray` **get_data_array** **(** **)** const .. _class_StreamPeerBuffer_get_position: -- :ref:`int` **get_position** **(** **)** const +- :ref:`int` **get_position** **(** **)** const .. _class_StreamPeerBuffer_get_size: -- :ref:`int` **get_size** **(** **)** const +- :ref:`int` **get_size** **(** **)** const .. _class_StreamPeerBuffer_resize: -- void **resize** **(** :ref:`int` size **)** +- void **resize** **(** :ref:`int` size **)** .. _class_StreamPeerBuffer_seek: -- void **seek** **(** :ref:`int` position **)** +- void **seek** **(** :ref:`int` position **)** .. _class_StreamPeerBuffer_set_data_array: -- void **set_data_array** **(** :ref:`PoolByteArray` data **)** +- void **set_data_array** **(** :ref:`PoolByteArray` data **)** diff --git a/classes/class_streampeerssl.rst b/classes/class_streampeerssl.rst index 77d90207b..7e509d696 100644 --- a/classes/class_streampeerssl.rst +++ b/classes/class_streampeerssl.rst @@ -19,15 +19,15 @@ SSL Stream peer. Member Functions ---------------- -+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`accept_stream` **(** :ref:`StreamPeer` stream **)** | -+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`connect_to_stream` **(** :ref:`StreamPeer` stream, :ref:`bool` validate_certs=false, :ref:`String` for_hostname="" **)** | -+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`disconnect_from_stream` **(** **)** | -+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_status` **(** **)** const | -+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`accept_stream` **(** :ref:`StreamPeer` stream **)** | ++------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`connect_to_stream` **(** :ref:`StreamPeer` stream, :ref:`bool` validate_certs=false, :ref:`String` for_hostname="" **)** | ++------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`disconnect_from_stream` **(** **)** | ++------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_status` **(** **)** const | ++------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -47,23 +47,23 @@ Member Function Description .. _class_StreamPeerSSL_accept_stream: -- :ref:`int` **accept_stream** **(** :ref:`StreamPeer` stream **)** +- :ref:`int` **accept_stream** **(** :ref:`StreamPeer` stream **)** .. _class_StreamPeerSSL_connect_to_stream: -- :ref:`int` **connect_to_stream** **(** :ref:`StreamPeer` stream, :ref:`bool` validate_certs=false, :ref:`String` for_hostname="" **)** +- :ref:`int` **connect_to_stream** **(** :ref:`StreamPeer` stream, :ref:`bool` validate_certs=false, :ref:`String` for_hostname="" **)** Connect to a peer using an underlying :ref:`StreamPeer` "stream", when "validate_certs" is true, :ref:`StreamPeerSSL` will validate that the certificate presented by the peer matches the "for_hostname". .. _class_StreamPeerSSL_disconnect_from_stream: -- void **disconnect_from_stream** **(** **)** +- void **disconnect_from_stream** **(** **)** Disconnect from host. .. _class_StreamPeerSSL_get_status: -- :ref:`int` **get_status** **(** **)** const +- :ref:`int` **get_status** **(** **)** const Return the status of the connection, one of STATUS\_\* enum. diff --git a/classes/class_streampeertcp.rst b/classes/class_streampeertcp.rst index 02664fac2..6c49bc7bd 100644 --- a/classes/class_streampeertcp.rst +++ b/classes/class_streampeertcp.rst @@ -19,19 +19,19 @@ TCP Stream peer. Member Functions ---------------- -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`connect_to_host` **(** :ref:`String` host, :ref:`int` port **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`disconnect_from_host` **(** **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_connected_host` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_connected_port` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_status` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_connected_to_host` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`connect_to_host` **(** :ref:`String` host, :ref:`int` port **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`disconnect_from_host` **(** **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_connected_host` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_connected_port` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_status` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_connected_to_host` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -51,36 +51,36 @@ Member Function Description .. _class_StreamPeerTCP_connect_to_host: -- :ref:`int` **connect_to_host** **(** :ref:`String` host, :ref:`int` port **)** +- :ref:`int` **connect_to_host** **(** :ref:`String` host, :ref:`int` port **)** Connect to the specified host:port pair. A hostname will be resolved if valid. Returns OK on success or FAILED on failure. .. _class_StreamPeerTCP_disconnect_from_host: -- void **disconnect_from_host** **(** **)** +- void **disconnect_from_host** **(** **)** Disconnect from host. .. _class_StreamPeerTCP_get_connected_host: -- :ref:`String` **get_connected_host** **(** **)** const +- :ref:`String` **get_connected_host** **(** **)** const Return the IP of this peer. .. _class_StreamPeerTCP_get_connected_port: -- :ref:`int` **get_connected_port** **(** **)** const +- :ref:`int` **get_connected_port** **(** **)** const Return the port of this peer. .. _class_StreamPeerTCP_get_status: -- :ref:`int` **get_status** **(** **)** const +- :ref:`int` **get_status** **(** **)** const Return the status of the connection, one of STATUS\_\* enum. .. _class_StreamPeerTCP_is_connected_to_host: -- :ref:`bool` **is_connected_to_host** **(** **)** const +- :ref:`bool` **is_connected_to_host** **(** **)** const diff --git a/classes/class_streamtexture.rst b/classes/class_streamtexture.rst index 59d2a0234..6ebf91c64 100644 --- a/classes/class_streamtexture.rst +++ b/classes/class_streamtexture.rst @@ -19,11 +19,11 @@ Brief Description Member Functions ---------------- -+------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_load_path` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`load` **(** :ref:`String` path **)** | -+------------------------------+--------------------------------------------------------------------------------------+ ++------------------------------+------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_load_path` **(** **)** const | ++------------------------------+------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`load` **(** :ref:`String` path **)** | ++------------------------------+------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -38,10 +38,10 @@ Member Function Description .. _class_StreamTexture_get_load_path: -- :ref:`String` **get_load_path** **(** **)** const +- :ref:`String` **get_load_path** **(** **)** const .. _class_StreamTexture_load: -- :ref:`int` **load** **(** :ref:`String` path **)** +- :ref:`int` **load** **(** :ref:`String` path **)** diff --git a/classes/class_string.rst b/classes/class_string.rst index ea8768ef1..f5a3e7fde 100644 --- a/classes/class_string.rst +++ b/classes/class_string.rst @@ -17,181 +17,181 @@ Built-in string class. Member Functions ---------------- -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`bool` from **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`int` from **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`float` from **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`Vector2` from **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`Rect2` from **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`Vector3` from **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`Transform2D` from **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`Plane` from **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`Quat` from **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`Rect3` from **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`Basis` from **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`Transform` from **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`Color` from **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`NodePath` from **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`RID` from **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`Dictionary` from **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`Array` from **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`PoolByteArray` from **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`PoolIntArray` from **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`PoolRealArray` from **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`PoolStringArray` from **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`PoolVector2Array` from **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`PoolVector3Array` from **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`PoolColorArray` from **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`begins_with` **(** :ref:`String` text **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`bigrams` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`c_escape` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`c_unescape` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`capitalize` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`casecmp_to` **(** :ref:`String` to **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`empty` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`ends_with` **(** :ref:`String` text **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase` **(** :ref:`int` position, :ref:`int` chars **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find` **(** :ref:`String` what, :ref:`int` from=0 **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_last` **(** :ref:`String` what **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`findn` **(** :ref:`String` what, :ref:`int` from=0 **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`format` **(** var values, :ref:`String` placeholder={_} **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_base_dir` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_basename` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_extension` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_file` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`hash` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`hex_to_int` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`insert` **(** :ref:`int` position, :ref:`String` what **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_abs_path` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_rel_path` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_subsequence_of` **(** :ref:`String` text **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_subsequence_ofi` **(** :ref:`String` text **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_valid_float` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_valid_html_color` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_valid_identifier` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_valid_integer` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_valid_ip_address` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`json_escape` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`left` **(** :ref:`int` position **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`length` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`match` **(** :ref:`String` expr **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`matchn` **(** :ref:`String` expr **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`md5_buffer` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`md5_text` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`nocasecmp_to` **(** :ref:`String` to **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`ord_at` **(** :ref:`int` at **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`pad_decimals` **(** :ref:`int` digits **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`pad_zeros` **(** :ref:`int` digits **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`percent_decode` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`percent_encode` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`plus_file` **(** :ref:`String` file **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`replace` **(** :ref:`String` what, :ref:`String` forwhat **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`replacen` **(** :ref:`String` what, :ref:`String` forwhat **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rfind` **(** :ref:`String` what, :ref:`int` from=-1 **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rfindn` **(** :ref:`String` what, :ref:`int` from=-1 **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`right` **(** :ref:`int` position **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`sha256_buffer` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`sha256_text` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`similarity` **(** :ref:`String` text **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`split` **(** :ref:`String` divisor, :ref:`bool` allow_empty=True **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolRealArray` | :ref:`split_floats` **(** :ref:`String` divisor, :ref:`bool` allow_empty=True **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`strip_edges` **(** :ref:`bool` left=True, :ref:`bool` right=True **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`substr` **(** :ref:`int` from, :ref:`int` len **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`to_ascii` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`to_float` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`to_int` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`to_lower` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`to_upper` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`to_utf8` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`xml_escape` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`xml_unescape` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`bool` from **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`int` from **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`float` from **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`Vector2` from **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`Rect2` from **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`Vector3` from **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`Transform2D` from **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`Plane` from **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`Quat` from **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`Rect3` from **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`Basis` from **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`Transform` from **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`Color` from **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`NodePath` from **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`RID` from **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`Dictionary` from **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`Array` from **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`PoolByteArray` from **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`PoolIntArray` from **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`PoolRealArray` from **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`PoolStringArray` from **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`PoolVector2Array` from **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`PoolVector3Array` from **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`PoolColorArray` from **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`begins_with` **(** :ref:`String` text **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`bigrams` **(** **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`c_escape` **(** **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`c_unescape` **(** **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`capitalize` **(** **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`casecmp_to` **(** :ref:`String` to **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`empty` **(** **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`ends_with` **(** :ref:`String` text **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`erase` **(** :ref:`int` position, :ref:`int` chars **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find` **(** :ref:`String` what, :ref:`int` from=0 **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find_last` **(** :ref:`String` what **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`findn` **(** :ref:`String` what, :ref:`int` from=0 **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`format` **(** var values, :ref:`String` placeholder={_} **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_base_dir` **(** **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_basename` **(** **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_extension` **(** **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_file` **(** **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`hash` **(** **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`hex_to_int` **(** **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`insert` **(** :ref:`int` position, :ref:`String` what **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_abs_path` **(** **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_rel_path` **(** **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_subsequence_of` **(** :ref:`String` text **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_subsequence_ofi` **(** :ref:`String` text **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_valid_float` **(** **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_valid_html_color` **(** **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_valid_identifier` **(** **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_valid_integer` **(** **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_valid_ip_address` **(** **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`json_escape` **(** **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`left` **(** :ref:`int` position **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`length` **(** **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`match` **(** :ref:`String` expr **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`matchn` **(** :ref:`String` expr **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`md5_buffer` **(** **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`md5_text` **(** **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`nocasecmp_to` **(** :ref:`String` to **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`ord_at` **(** :ref:`int` at **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`pad_decimals` **(** :ref:`int` digits **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`pad_zeros` **(** :ref:`int` digits **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`percent_decode` **(** **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`percent_encode` **(** **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`plus_file` **(** :ref:`String` file **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`replace` **(** :ref:`String` what, :ref:`String` forwhat **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`replacen` **(** :ref:`String` what, :ref:`String` forwhat **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rfind` **(** :ref:`String` what, :ref:`int` from=-1 **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rfindn` **(** :ref:`String` what, :ref:`int` from=-1 **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`right` **(** :ref:`int` position **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`sha256_buffer` **(** **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`sha256_text` **(** **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`similarity` **(** :ref:`String` text **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`split` **(** :ref:`String` divisor, :ref:`bool` allow_empty=True **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolRealArray` | :ref:`split_floats` **(** :ref:`String` divisor, :ref:`bool` allow_empty=True **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`strip_edges` **(** :ref:`bool` left=True, :ref:`bool` right=True **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`substr` **(** :ref:`int` from, :ref:`int` len **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`to_ascii` **(** **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`to_float` **(** **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`to_int` **(** **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`to_lower` **(** **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`to_upper` **(** **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`to_utf8` **(** **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`xml_escape` **(** **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`xml_unescape` **(** **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -203,471 +203,471 @@ Member Function Description .. _class_String_String: -- :ref:`String` **String** **(** :ref:`bool` from **)** +- :ref:`String` **String** **(** :ref:`bool` from **)** .. _class_String_String: -- :ref:`String` **String** **(** :ref:`int` from **)** +- :ref:`String` **String** **(** :ref:`int` from **)** .. _class_String_String: -- :ref:`String` **String** **(** :ref:`float` from **)** +- :ref:`String` **String** **(** :ref:`float` from **)** .. _class_String_String: -- :ref:`String` **String** **(** :ref:`Vector2` from **)** +- :ref:`String` **String** **(** :ref:`Vector2` from **)** .. _class_String_String: -- :ref:`String` **String** **(** :ref:`Rect2` from **)** +- :ref:`String` **String** **(** :ref:`Rect2` from **)** .. _class_String_String: -- :ref:`String` **String** **(** :ref:`Vector3` from **)** +- :ref:`String` **String** **(** :ref:`Vector3` from **)** .. _class_String_String: -- :ref:`String` **String** **(** :ref:`Transform2D` from **)** +- :ref:`String` **String** **(** :ref:`Transform2D` from **)** .. _class_String_String: -- :ref:`String` **String** **(** :ref:`Plane` from **)** +- :ref:`String` **String** **(** :ref:`Plane` from **)** .. _class_String_String: -- :ref:`String` **String** **(** :ref:`Quat` from **)** +- :ref:`String` **String** **(** :ref:`Quat` from **)** .. _class_String_String: -- :ref:`String` **String** **(** :ref:`Rect3` from **)** +- :ref:`String` **String** **(** :ref:`Rect3` from **)** .. _class_String_String: -- :ref:`String` **String** **(** :ref:`Basis` from **)** +- :ref:`String` **String** **(** :ref:`Basis` from **)** .. _class_String_String: -- :ref:`String` **String** **(** :ref:`Transform` from **)** +- :ref:`String` **String** **(** :ref:`Transform` from **)** .. _class_String_String: -- :ref:`String` **String** **(** :ref:`Color` from **)** +- :ref:`String` **String** **(** :ref:`Color` from **)** .. _class_String_String: -- :ref:`String` **String** **(** :ref:`NodePath` from **)** +- :ref:`String` **String** **(** :ref:`NodePath` from **)** .. _class_String_String: -- :ref:`String` **String** **(** :ref:`RID` from **)** +- :ref:`String` **String** **(** :ref:`RID` from **)** .. _class_String_String: -- :ref:`String` **String** **(** :ref:`Dictionary` from **)** +- :ref:`String` **String** **(** :ref:`Dictionary` from **)** .. _class_String_String: -- :ref:`String` **String** **(** :ref:`Array` from **)** +- :ref:`String` **String** **(** :ref:`Array` from **)** .. _class_String_String: -- :ref:`String` **String** **(** :ref:`PoolByteArray` from **)** +- :ref:`String` **String** **(** :ref:`PoolByteArray` from **)** .. _class_String_String: -- :ref:`String` **String** **(** :ref:`PoolIntArray` from **)** +- :ref:`String` **String** **(** :ref:`PoolIntArray` from **)** .. _class_String_String: -- :ref:`String` **String** **(** :ref:`PoolRealArray` from **)** +- :ref:`String` **String** **(** :ref:`PoolRealArray` from **)** .. _class_String_String: -- :ref:`String` **String** **(** :ref:`PoolStringArray` from **)** +- :ref:`String` **String** **(** :ref:`PoolStringArray` from **)** .. _class_String_String: -- :ref:`String` **String** **(** :ref:`PoolVector2Array` from **)** +- :ref:`String` **String** **(** :ref:`PoolVector2Array` from **)** .. _class_String_String: -- :ref:`String` **String** **(** :ref:`PoolVector3Array` from **)** +- :ref:`String` **String** **(** :ref:`PoolVector3Array` from **)** .. _class_String_String: -- :ref:`String` **String** **(** :ref:`PoolColorArray` from **)** +- :ref:`String` **String** **(** :ref:`PoolColorArray` from **)** .. _class_String_begins_with: -- :ref:`bool` **begins_with** **(** :ref:`String` text **)** +- :ref:`bool` **begins_with** **(** :ref:`String` text **)** Return true if the strings begins with the given string. .. _class_String_bigrams: -- :ref:`PoolStringArray` **bigrams** **(** **)** +- :ref:`PoolStringArray` **bigrams** **(** **)** Return the bigrams (pairs of consecutive letters) of this string. .. _class_String_c_escape: -- :ref:`String` **c_escape** **(** **)** +- :ref:`String` **c_escape** **(** **)** Return a copy of the string with special characters escaped using the C language standard. .. _class_String_c_unescape: -- :ref:`String` **c_unescape** **(** **)** +- :ref:`String` **c_unescape** **(** **)** Return a copy of the string with escaped characters replaced by their meanings according to the C language standard. .. _class_String_capitalize: -- :ref:`String` **capitalize** **(** **)** +- :ref:`String` **capitalize** **(** **)** Change the case of some letters. Replace underscores with spaces, convert all letters to lowercase then capitalize first and every letter following the space character. For ``capitalize camelCase mixed_with_underscores`` it will return ``Capitalize Camelcase Mixed With Underscores``. .. _class_String_casecmp_to: -- :ref:`int` **casecmp_to** **(** :ref:`String` to **)** +- :ref:`int` **casecmp_to** **(** :ref:`String` to **)** Perform a case-sensitive comparison to another string, return -1 if less, 0 if equal and +1 if greater. .. _class_String_empty: -- :ref:`bool` **empty** **(** **)** +- :ref:`bool` **empty** **(** **)** Return true if the string is empty. .. _class_String_ends_with: -- :ref:`bool` **ends_with** **(** :ref:`String` text **)** +- :ref:`bool` **ends_with** **(** :ref:`String` text **)** Return true if the strings ends with the given string. .. _class_String_erase: -- void **erase** **(** :ref:`int` position, :ref:`int` chars **)** +- void **erase** **(** :ref:`int` position, :ref:`int` chars **)** Erase ``chars`` characters from the string starting from ``position``. .. _class_String_find: -- :ref:`int` **find** **(** :ref:`String` what, :ref:`int` from=0 **)** +- :ref:`int` **find** **(** :ref:`String` what, :ref:`int` from=0 **)** Find the first occurrence of a substring, return the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed. .. _class_String_find_last: -- :ref:`int` **find_last** **(** :ref:`String` what **)** +- :ref:`int` **find_last** **(** :ref:`String` what **)** Find the last occurrence of a substring, return the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed. .. _class_String_findn: -- :ref:`int` **findn** **(** :ref:`String` what, :ref:`int` from=0 **)** +- :ref:`int` **findn** **(** :ref:`String` what, :ref:`int` from=0 **)** Find the first occurrence of a substring but search as case-insensitive, return the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed. .. _class_String_format: -- :ref:`String` **format** **(** var values, :ref:`String` placeholder={_} **)** +- :ref:`String` **format** **(** var values, :ref:`String` placeholder={_} **)** .. _class_String_get_base_dir: -- :ref:`String` **get_base_dir** **(** **)** +- :ref:`String` **get_base_dir** **(** **)** If the string is a path to a file, return the base directory. .. _class_String_get_basename: -- :ref:`String` **get_basename** **(** **)** +- :ref:`String` **get_basename** **(** **)** If the string is a path to a file, return the path to the file without the extension. .. _class_String_get_extension: -- :ref:`String` **get_extension** **(** **)** +- :ref:`String` **get_extension** **(** **)** If the string is a path to a file, return the extension. .. _class_String_get_file: -- :ref:`String` **get_file** **(** **)** +- :ref:`String` **get_file** **(** **)** If the string is a path to a file, return the file and ignore the base directory. .. _class_String_hash: -- :ref:`int` **hash** **(** **)** +- :ref:`int` **hash** **(** **)** Hash the string and return a 32 bits integer. .. _class_String_hex_to_int: -- :ref:`int` **hex_to_int** **(** **)** +- :ref:`int` **hex_to_int** **(** **)** Convert a string containing a hexadecimal number into an int. .. _class_String_insert: -- :ref:`String` **insert** **(** :ref:`int` position, :ref:`String` what **)** +- :ref:`String` **insert** **(** :ref:`int` position, :ref:`String` what **)** Insert a substring at a given position. .. _class_String_is_abs_path: -- :ref:`bool` **is_abs_path** **(** **)** +- :ref:`bool` **is_abs_path** **(** **)** If the string is a path to a file or directory, return true if the path is absolute. .. _class_String_is_rel_path: -- :ref:`bool` **is_rel_path** **(** **)** +- :ref:`bool` **is_rel_path** **(** **)** If the string is a path to a file or directory, return true if the path is relative. .. _class_String_is_subsequence_of: -- :ref:`bool` **is_subsequence_of** **(** :ref:`String` text **)** +- :ref:`bool` **is_subsequence_of** **(** :ref:`String` text **)** Check whether this string is a subsequence of the given string. .. _class_String_is_subsequence_ofi: -- :ref:`bool` **is_subsequence_ofi** **(** :ref:`String` text **)** +- :ref:`bool` **is_subsequence_ofi** **(** :ref:`String` text **)** Check whether this string is a subsequence of the given string, without considering case. .. _class_String_is_valid_float: -- :ref:`bool` **is_valid_float** **(** **)** +- :ref:`bool` **is_valid_float** **(** **)** Check whether the string contains a valid float. .. _class_String_is_valid_html_color: -- :ref:`bool` **is_valid_html_color** **(** **)** +- :ref:`bool` **is_valid_html_color** **(** **)** Check whether the string contains a valid color in HTML notation. .. _class_String_is_valid_identifier: -- :ref:`bool` **is_valid_identifier** **(** **)** +- :ref:`bool` **is_valid_identifier** **(** **)** Check whether the string is a valid identifier. As is common in programming languages, a valid identifier may contain only letters, digits and underscores (\_) and the first character may not be a digit. .. _class_String_is_valid_integer: -- :ref:`bool` **is_valid_integer** **(** **)** +- :ref:`bool` **is_valid_integer** **(** **)** Check whether the string contains a valid integer. .. _class_String_is_valid_ip_address: -- :ref:`bool` **is_valid_ip_address** **(** **)** +- :ref:`bool` **is_valid_ip_address** **(** **)** Check whether the string contains a valid IP address. .. _class_String_json_escape: -- :ref:`String` **json_escape** **(** **)** +- :ref:`String` **json_escape** **(** **)** Return a copy of the string with special characters escaped using the JSON standard. .. _class_String_left: -- :ref:`String` **left** **(** :ref:`int` position **)** +- :ref:`String` **left** **(** :ref:`int` position **)** Return an amount of characters from the left of the string. .. _class_String_length: -- :ref:`int` **length** **(** **)** +- :ref:`int` **length** **(** **)** Return the length of the string in characters. .. _class_String_match: -- :ref:`bool` **match** **(** :ref:`String` expr **)** +- :ref:`bool` **match** **(** :ref:`String` expr **)** Do a simple expression match, where '\*' matches zero or more arbitrary characters and '?' matches any single character except '.'. .. _class_String_matchn: -- :ref:`bool` **matchn** **(** :ref:`String` expr **)** +- :ref:`bool` **matchn** **(** :ref:`String` expr **)** Do a simple case insensitive expression match, using ? and \* wildcards (see :ref:`match`). .. _class_String_md5_buffer: -- :ref:`PoolByteArray` **md5_buffer** **(** **)** +- :ref:`PoolByteArray` **md5_buffer** **(** **)** Return the MD5 hash of the string as an array of bytes. .. _class_String_md5_text: -- :ref:`String` **md5_text** **(** **)** +- :ref:`String` **md5_text** **(** **)** Return the MD5 hash of the string as a string. .. _class_String_nocasecmp_to: -- :ref:`int` **nocasecmp_to** **(** :ref:`String` to **)** +- :ref:`int` **nocasecmp_to** **(** :ref:`String` to **)** Perform a case-insensitive comparison to another string, return -1 if less, 0 if equal and +1 if greater. .. _class_String_ord_at: -- :ref:`int` **ord_at** **(** :ref:`int` at **)** +- :ref:`int` **ord_at** **(** :ref:`int` at **)** Return the character code at position ``at``. .. _class_String_pad_decimals: -- :ref:`String` **pad_decimals** **(** :ref:`int` digits **)** +- :ref:`String` **pad_decimals** **(** :ref:`int` digits **)** Format a number to have an exact number of ``digits`` after the decimal point. .. _class_String_pad_zeros: -- :ref:`String` **pad_zeros** **(** :ref:`int` digits **)** +- :ref:`String` **pad_zeros** **(** :ref:`int` digits **)** Format a number to have an exact number of ``digits`` before the decimal point. .. _class_String_percent_decode: -- :ref:`String` **percent_decode** **(** **)** +- :ref:`String` **percent_decode** **(** **)** Decode a percent-encoded string. See :ref:`percent_encode`. .. _class_String_percent_encode: -- :ref:`String` **percent_encode** **(** **)** +- :ref:`String` **percent_encode** **(** **)** Percent-encode a string. This is meant to encode parameters in a URL when sending a HTTP GET request and bodies of form-urlencoded POST request. .. _class_String_plus_file: -- :ref:`String` **plus_file** **(** :ref:`String` file **)** +- :ref:`String` **plus_file** **(** :ref:`String` file **)** If the string is a path, this concatenates ``file`` at the end of the string as a subpath. E.g. ``"this/is".plus_file("path") == "this/is/path"``. .. _class_String_replace: -- :ref:`String` **replace** **(** :ref:`String` what, :ref:`String` forwhat **)** +- :ref:`String` **replace** **(** :ref:`String` what, :ref:`String` forwhat **)** Replace occurrences of a substring for different ones inside the string. .. _class_String_replacen: -- :ref:`String` **replacen** **(** :ref:`String` what, :ref:`String` forwhat **)** +- :ref:`String` **replacen** **(** :ref:`String` what, :ref:`String` forwhat **)** Replace occurrences of a substring for different ones inside the string, but search case-insensitive. .. _class_String_rfind: -- :ref:`int` **rfind** **(** :ref:`String` what, :ref:`int` from=-1 **)** +- :ref:`int` **rfind** **(** :ref:`String` what, :ref:`int` from=-1 **)** Perform a search for a substring, but start from the end of the string instead of the beginning. .. _class_String_rfindn: -- :ref:`int` **rfindn** **(** :ref:`String` what, :ref:`int` from=-1 **)** +- :ref:`int` **rfindn** **(** :ref:`String` what, :ref:`int` from=-1 **)** Perform a search for a substring, but start from the end of the string instead of the beginning. Also search case-insensitive. .. _class_String_right: -- :ref:`String` **right** **(** :ref:`int` position **)** +- :ref:`String` **right** **(** :ref:`int` position **)** Return the right side of the string from a given position. .. _class_String_sha256_buffer: -- :ref:`PoolByteArray` **sha256_buffer** **(** **)** +- :ref:`PoolByteArray` **sha256_buffer** **(** **)** .. _class_String_sha256_text: -- :ref:`String` **sha256_text** **(** **)** +- :ref:`String` **sha256_text** **(** **)** Return the SHA-256 hash of the string as a string. .. _class_String_similarity: -- :ref:`float` **similarity** **(** :ref:`String` text **)** +- :ref:`float` **similarity** **(** :ref:`String` text **)** Return the similarity index of the text compared to this string. 1 means totally similar and 0 means totally dissimilar. .. _class_String_split: -- :ref:`PoolStringArray` **split** **(** :ref:`String` divisor, :ref:`bool` allow_empty=True **)** +- :ref:`PoolStringArray` **split** **(** :ref:`String` divisor, :ref:`bool` allow_empty=True **)** Split the string by a divisor string, return an array of the substrings. Example "One,Two,Three" will return "One","Two","Three" if split by ",". .. _class_String_split_floats: -- :ref:`PoolRealArray` **split_floats** **(** :ref:`String` divisor, :ref:`bool` allow_empty=True **)** +- :ref:`PoolRealArray` **split_floats** **(** :ref:`String` divisor, :ref:`bool` allow_empty=True **)** Split the string in floats by using a divisor string, return an array of the substrings. Example "1,2.5,3" will return 1,2.5,3 if split by ",". .. _class_String_strip_edges: -- :ref:`String` **strip_edges** **(** :ref:`bool` left=True, :ref:`bool` right=True **)** +- :ref:`String` **strip_edges** **(** :ref:`bool` left=True, :ref:`bool` right=True **)** Return a copy of the string stripped of any non-printable character at the beginning and the end. The optional arguments are used to toggle stripping on the left and right edges respectively. .. _class_String_substr: -- :ref:`String` **substr** **(** :ref:`int` from, :ref:`int` len **)** +- :ref:`String` **substr** **(** :ref:`int` from, :ref:`int` len **)** Return part of the string from the position ``from``, with length ``len``. .. _class_String_to_ascii: -- :ref:`PoolByteArray` **to_ascii** **(** **)** +- :ref:`PoolByteArray` **to_ascii** **(** **)** Convert the String (which is a character array) to PoolByteArray (which is an array of bytes). The conversion is speeded up in comparison to to_utf8() with the assumption that all the characters the String contains are only ASCII characters. .. _class_String_to_float: -- :ref:`float` **to_float** **(** **)** +- :ref:`float` **to_float** **(** **)** Convert a string, containing a decimal number, into a ``float``. .. _class_String_to_int: -- :ref:`int` **to_int** **(** **)** +- :ref:`int` **to_int** **(** **)** Convert a string, containing an integer number, into an ``int``. .. _class_String_to_lower: -- :ref:`String` **to_lower** **(** **)** +- :ref:`String` **to_lower** **(** **)** Return the string converted to lowercase. .. _class_String_to_upper: -- :ref:`String` **to_upper** **(** **)** +- :ref:`String` **to_upper** **(** **)** Return the string converted to uppercase. .. _class_String_to_utf8: -- :ref:`PoolByteArray` **to_utf8** **(** **)** +- :ref:`PoolByteArray` **to_utf8** **(** **)** Convert the String (which is an array of characters) to PoolByteArray (which is an array of bytes). The conversion is a bit slower than to_ascii(), but supports all UTF-8 characters. Therefore, you should prefer this function over to_ascii(). .. _class_String_xml_escape: -- :ref:`String` **xml_escape** **(** **)** +- :ref:`String` **xml_escape** **(** **)** Return a copy of the string with special characters escaped using the XML standard. .. _class_String_xml_unescape: -- :ref:`String` **xml_unescape** **(** **)** +- :ref:`String` **xml_unescape** **(** **)** Return a copy of the string with escaped characters replaced by their meanings according to the XML standard. diff --git a/classes/class_stylebox.rst b/classes/class_stylebox.rst index 11fb1c0c1..a11fe3988 100644 --- a/classes/class_stylebox.rst +++ b/classes/class_stylebox.rst @@ -21,23 +21,23 @@ Base class for drawing stylized boxes for the UI. Member Functions ---------------- -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw` **(** :ref:`RID` canvas_item, :ref:`Rect2` rect **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_center_size` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_default_margin` **(** :ref:`int` margin **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_margin` **(** :ref:`int` margin **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_minimum_size` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_offset` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_default_margin` **(** :ref:`int` margin, :ref:`float` offset **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`test_mask` **(** :ref:`Vector2` point, :ref:`Rect2` rect **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw` **(** :ref:`RID` canvas_item, :ref:`Rect2` rect **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_center_size` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_default_margin` **(** :ref:`int` margin **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_margin` **(** :ref:`int` margin **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_minimum_size` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_offset` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_default_margin` **(** :ref:`int` margin, :ref:`float` offset **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`test_mask` **(** :ref:`Vector2` point, :ref:`Rect2` rect **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -69,45 +69,45 @@ Member Function Description .. _class_StyleBox_draw: -- void **draw** **(** :ref:`RID` canvas_item, :ref:`Rect2` rect **)** const +- void **draw** **(** :ref:`RID` canvas_item, :ref:`Rect2` rect **)** const .. _class_StyleBox_get_center_size: -- :ref:`Vector2` **get_center_size** **(** **)** const +- :ref:`Vector2` **get_center_size** **(** **)** const .. _class_StyleBox_get_default_margin: -- :ref:`float` **get_default_margin** **(** :ref:`int` margin **)** const +- :ref:`float` **get_default_margin** **(** :ref:`int` margin **)** const Return the default offset of the margin "margin" (see MARGIN\_\* enum) of a StyleBox, Controls that draw styleboxes with context inside need to know the margin, so the border of the stylebox is not occluded. .. _class_StyleBox_get_margin: -- :ref:`float` **get_margin** **(** :ref:`int` margin **)** const +- :ref:`float` **get_margin** **(** :ref:`int` margin **)** const Return the offset of margin "margin" (see MARGIN\_\* enum). .. _class_StyleBox_get_minimum_size: -- :ref:`Vector2` **get_minimum_size** **(** **)** const +- :ref:`Vector2` **get_minimum_size** **(** **)** const Return the minimum size that this stylebox can be shrunk to. .. _class_StyleBox_get_offset: -- :ref:`Vector2` **get_offset** **(** **)** const +- :ref:`Vector2` **get_offset** **(** **)** const Return the "offset" of a stylebox, this is a helper function, like writing ``Vector2(style.get_margin(MARGIN_LEFT), style.get_margin(MARGIN_TOP))``. .. _class_StyleBox_set_default_margin: -- void **set_default_margin** **(** :ref:`int` margin, :ref:`float` offset **)** +- void **set_default_margin** **(** :ref:`int` margin, :ref:`float` offset **)** Set the default offset "offset" of the margin "margin" (see MARGIN\_\* enum) for a StyleBox, Controls that draw styleboxes with context inside need to know the margin, so the border of the stylebox is not occluded. .. _class_StyleBox_test_mask: -- :ref:`bool` **test_mask** **(** :ref:`Vector2` point, :ref:`Rect2` rect **)** const +- :ref:`bool` **test_mask** **(** :ref:`Vector2` point, :ref:`Rect2` rect **)** const Test a position in a rectangle, return whether it passes the mask test. diff --git a/classes/class_styleboxflat.rst b/classes/class_styleboxflat.rst index f314e84f1..681505fb8 100644 --- a/classes/class_styleboxflat.rst +++ b/classes/class_styleboxflat.rst @@ -19,67 +19,67 @@ Customizable Stylebox with a given set of parameters. (no texture required) Member Functions ---------------- -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_aa_size` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_bg_color` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_border_blend` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_border_color` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_border_width` **(** :ref:`int` margin **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_border_width_min` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_corner_detail` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_corner_radius` **(** :ref:`int` corner **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_expand_margin` **(** :ref:`int` margin **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_shadow_color` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_shadow_size` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_anti_aliased` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_draw_center_enabled` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_aa_size` **(** :ref:`int` size **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_anti_aliased` **(** :ref:`bool` anti_aliased **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bg_color` **(** :ref:`Color` color **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_border_blend` **(** :ref:`bool` blend **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_border_color` **(** :ref:`Color` color **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_border_width` **(** :ref:`int` margin, :ref:`int` width **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_border_width_all` **(** :ref:`int` width **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_corner_detail` **(** :ref:`int` detail **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_corner_radius` **(** :ref:`int` corner, :ref:`int` radius **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_corner_radius_all` **(** :ref:`int` radius **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_corner_radius_individual` **(** :ref:`int` radius_top_left, :ref:`int` radius_top_right, :ref:`int` radius_bottom_right, :ref:`int` radius_bottom_left **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_draw_center` **(** :ref:`bool` draw_center **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_expand_margin` **(** :ref:`int` margin, :ref:`float` size **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_expand_margin_all` **(** :ref:`float` size **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_expand_margin_individual` **(** :ref:`float` size_left, :ref:`float` size_top, :ref:`float` size_right, :ref:`float` size_bottom **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shadow_color` **(** :ref:`Color` color **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shadow_size` **(** :ref:`int` size **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_aa_size` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_bg_color` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_border_blend` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_border_color` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_border_width` **(** :ref:`int` margin **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_border_width_min` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_corner_detail` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_corner_radius` **(** :ref:`int` corner **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_expand_margin` **(** :ref:`int` margin **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_shadow_color` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_shadow_size` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_anti_aliased` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_draw_center_enabled` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_aa_size` **(** :ref:`int` size **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_anti_aliased` **(** :ref:`bool` anti_aliased **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bg_color` **(** :ref:`Color` color **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_border_blend` **(** :ref:`bool` blend **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_border_color` **(** :ref:`Color` color **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_border_width` **(** :ref:`int` margin, :ref:`int` width **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_border_width_all` **(** :ref:`int` width **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_corner_detail` **(** :ref:`int` detail **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_corner_radius` **(** :ref:`int` corner, :ref:`int` radius **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_corner_radius_all` **(** :ref:`int` radius **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_corner_radius_individual` **(** :ref:`int` radius_top_left, :ref:`int` radius_top_right, :ref:`int` radius_bottom_right, :ref:`int` radius_bottom_left **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_draw_center` **(** :ref:`bool` draw_center **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_expand_margin` **(** :ref:`int` margin, :ref:`float` size **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_expand_margin_all` **(** :ref:`float` size **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_expand_margin_individual` **(** :ref:`float` size_left, :ref:`float` size_top, :ref:`float` size_right, :ref:`float` size_bottom **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shadow_color` **(** :ref:`Color` color **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shadow_size` **(** :ref:`int` size **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -208,122 +208,122 @@ Member Function Description .. _class_StyleBoxFlat_get_aa_size: -- :ref:`int` **get_aa_size** **(** **)** const +- :ref:`int` **get_aa_size** **(** **)** const .. _class_StyleBoxFlat_get_bg_color: -- :ref:`Color` **get_bg_color** **(** **)** const +- :ref:`Color` **get_bg_color** **(** **)** const .. _class_StyleBoxFlat_get_border_blend: -- :ref:`bool` **get_border_blend** **(** **)** const +- :ref:`bool` **get_border_blend** **(** **)** const .. _class_StyleBoxFlat_get_border_color: -- :ref:`Color` **get_border_color** **(** **)** const +- :ref:`Color` **get_border_color** **(** **)** const .. _class_StyleBoxFlat_get_border_width: -- :ref:`int` **get_border_width** **(** :ref:`int` margin **)** const +- :ref:`int` **get_border_width** **(** :ref:`int` margin **)** const .. _class_StyleBoxFlat_get_border_width_min: -- :ref:`int` **get_border_width_min** **(** **)** const +- :ref:`int` **get_border_width_min** **(** **)** const .. _class_StyleBoxFlat_get_corner_detail: -- :ref:`int` **get_corner_detail** **(** **)** const +- :ref:`int` **get_corner_detail** **(** **)** const .. _class_StyleBoxFlat_get_corner_radius: -- :ref:`int` **get_corner_radius** **(** :ref:`int` corner **)** const +- :ref:`int` **get_corner_radius** **(** :ref:`int` corner **)** const .. _class_StyleBoxFlat_get_expand_margin: -- :ref:`float` **get_expand_margin** **(** :ref:`int` margin **)** const +- :ref:`float` **get_expand_margin** **(** :ref:`int` margin **)** const .. _class_StyleBoxFlat_get_shadow_color: -- :ref:`Color` **get_shadow_color** **(** **)** const +- :ref:`Color` **get_shadow_color** **(** **)** const .. _class_StyleBoxFlat_get_shadow_size: -- :ref:`int` **get_shadow_size** **(** **)** const +- :ref:`int` **get_shadow_size** **(** **)** const .. _class_StyleBoxFlat_is_anti_aliased: -- :ref:`bool` **is_anti_aliased** **(** **)** const +- :ref:`bool` **is_anti_aliased** **(** **)** const .. _class_StyleBoxFlat_is_draw_center_enabled: -- :ref:`bool` **is_draw_center_enabled** **(** **)** const +- :ref:`bool` **is_draw_center_enabled** **(** **)** const .. _class_StyleBoxFlat_set_aa_size: -- void **set_aa_size** **(** :ref:`int` size **)** +- void **set_aa_size** **(** :ref:`int` size **)** .. _class_StyleBoxFlat_set_anti_aliased: -- void **set_anti_aliased** **(** :ref:`bool` anti_aliased **)** +- void **set_anti_aliased** **(** :ref:`bool` anti_aliased **)** .. _class_StyleBoxFlat_set_bg_color: -- void **set_bg_color** **(** :ref:`Color` color **)** +- void **set_bg_color** **(** :ref:`Color` color **)** .. _class_StyleBoxFlat_set_border_blend: -- void **set_border_blend** **(** :ref:`bool` blend **)** +- void **set_border_blend** **(** :ref:`bool` blend **)** .. _class_StyleBoxFlat_set_border_color: -- void **set_border_color** **(** :ref:`Color` color **)** +- void **set_border_color** **(** :ref:`Color` color **)** .. _class_StyleBoxFlat_set_border_width: -- void **set_border_width** **(** :ref:`int` margin, :ref:`int` width **)** +- void **set_border_width** **(** :ref:`int` margin, :ref:`int` width **)** .. _class_StyleBoxFlat_set_border_width_all: -- void **set_border_width_all** **(** :ref:`int` width **)** +- void **set_border_width_all** **(** :ref:`int` width **)** .. _class_StyleBoxFlat_set_corner_detail: -- void **set_corner_detail** **(** :ref:`int` detail **)** +- void **set_corner_detail** **(** :ref:`int` detail **)** .. _class_StyleBoxFlat_set_corner_radius: -- void **set_corner_radius** **(** :ref:`int` corner, :ref:`int` radius **)** +- void **set_corner_radius** **(** :ref:`int` corner, :ref:`int` radius **)** .. _class_StyleBoxFlat_set_corner_radius_all: -- void **set_corner_radius_all** **(** :ref:`int` radius **)** +- void **set_corner_radius_all** **(** :ref:`int` radius **)** .. _class_StyleBoxFlat_set_corner_radius_individual: -- void **set_corner_radius_individual** **(** :ref:`int` radius_top_left, :ref:`int` radius_top_right, :ref:`int` radius_bottom_right, :ref:`int` radius_bottom_left **)** +- void **set_corner_radius_individual** **(** :ref:`int` radius_top_left, :ref:`int` radius_top_right, :ref:`int` radius_bottom_right, :ref:`int` radius_bottom_left **)** .. _class_StyleBoxFlat_set_draw_center: -- void **set_draw_center** **(** :ref:`bool` draw_center **)** +- void **set_draw_center** **(** :ref:`bool` draw_center **)** .. _class_StyleBoxFlat_set_expand_margin: -- void **set_expand_margin** **(** :ref:`int` margin, :ref:`float` size **)** +- void **set_expand_margin** **(** :ref:`int` margin, :ref:`float` size **)** .. _class_StyleBoxFlat_set_expand_margin_all: -- void **set_expand_margin_all** **(** :ref:`float` size **)** +- void **set_expand_margin_all** **(** :ref:`float` size **)** .. _class_StyleBoxFlat_set_expand_margin_individual: -- void **set_expand_margin_individual** **(** :ref:`float` size_left, :ref:`float` size_top, :ref:`float` size_right, :ref:`float` size_bottom **)** +- void **set_expand_margin_individual** **(** :ref:`float` size_left, :ref:`float` size_top, :ref:`float` size_right, :ref:`float` size_bottom **)** .. _class_StyleBoxFlat_set_shadow_color: -- void **set_shadow_color** **(** :ref:`Color` color **)** +- void **set_shadow_color** **(** :ref:`Color` color **)** .. _class_StyleBoxFlat_set_shadow_size: -- void **set_shadow_size** **(** :ref:`int` size **)** +- void **set_shadow_size** **(** :ref:`int` size **)** diff --git a/classes/class_styleboxtexture.rst b/classes/class_styleboxtexture.rst index ddc20d796..c6d53bcc2 100644 --- a/classes/class_styleboxtexture.rst +++ b/classes/class_styleboxtexture.rst @@ -19,54 +19,54 @@ Texture Based 3x3 scale style. Member Functions ---------------- -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_expand_margin_size` **(** :ref:`int` margin **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_h_axis_stretch_mode` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_margin_size` **(** :ref:`int` margin **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_modulate` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Resource` | :ref:`get_normal_map` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_region_rect` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Resource` | :ref:`get_texture` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_v_axis_stretch_mode` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_draw_center_enabled` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_draw_center` **(** :ref:`bool` enable **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_expand_margin_all` **(** :ref:`float` size **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_expand_margin_individual` **(** :ref:`float` size_left, :ref:`float` size_top, :ref:`float` size_right, :ref:`float` size_bottom **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_expand_margin_size` **(** :ref:`int` margin, :ref:`float` size **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_h_axis_stretch_mode` **(** :ref:`int` mode **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_margin_size` **(** :ref:`int` margin, :ref:`float` size **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_modulate` **(** :ref:`Color` color **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_normal_map` **(** :ref:`Resource` normal_map **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_region_rect` **(** :ref:`Rect2` region **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture` **(** :ref:`Resource` texture **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_v_axis_stretch_mode` **(** :ref:`int` mode **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_expand_margin_size` **(** :ref:`int` margin **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_h_axis_stretch_mode` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_margin_size` **(** :ref:`int` margin **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_modulate` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Resource` | :ref:`get_normal_map` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_region_rect` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Resource` | :ref:`get_texture` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_v_axis_stretch_mode` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_draw_center_enabled` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_draw_center` **(** :ref:`bool` enable **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_expand_margin_all` **(** :ref:`float` size **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_expand_margin_individual` **(** :ref:`float` size_left, :ref:`float` size_top, :ref:`float` size_right, :ref:`float` size_bottom **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_expand_margin_size` **(** :ref:`int` margin, :ref:`float` size **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_h_axis_stretch_mode` **(** :ref:`int` mode **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_margin_size` **(** :ref:`int` margin, :ref:`float` size **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_modulate` **(** :ref:`Color` color **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_normal_map` **(** :ref:`Resource` normal_map **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_region_rect` **(** :ref:`Rect2` region **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_texture` **(** :ref:`Resource` texture **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_v_axis_stretch_mode` **(** :ref:`int` mode **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_StyleBoxTexture_texture_changed: -- **texture_changed** **(** **)** +- **texture_changed** **(** **)** Member Variables @@ -150,82 +150,82 @@ Member Function Description .. _class_StyleBoxTexture_get_expand_margin_size: -- :ref:`float` **get_expand_margin_size** **(** :ref:`int` margin **)** const +- :ref:`float` **get_expand_margin_size** **(** :ref:`int` margin **)** const .. _class_StyleBoxTexture_get_h_axis_stretch_mode: -- :ref:`int` **get_h_axis_stretch_mode** **(** **)** const +- :ref:`int` **get_h_axis_stretch_mode** **(** **)** const .. _class_StyleBoxTexture_get_margin_size: -- :ref:`float` **get_margin_size** **(** :ref:`int` margin **)** const +- :ref:`float` **get_margin_size** **(** :ref:`int` margin **)** const .. _class_StyleBoxTexture_get_modulate: -- :ref:`Color` **get_modulate** **(** **)** const +- :ref:`Color` **get_modulate** **(** **)** const .. _class_StyleBoxTexture_get_normal_map: -- :ref:`Resource` **get_normal_map** **(** **)** const +- :ref:`Resource` **get_normal_map** **(** **)** const .. _class_StyleBoxTexture_get_region_rect: -- :ref:`Rect2` **get_region_rect** **(** **)** const +- :ref:`Rect2` **get_region_rect** **(** **)** const .. _class_StyleBoxTexture_get_texture: -- :ref:`Resource` **get_texture** **(** **)** const +- :ref:`Resource` **get_texture** **(** **)** const .. _class_StyleBoxTexture_get_v_axis_stretch_mode: -- :ref:`int` **get_v_axis_stretch_mode** **(** **)** const +- :ref:`int` **get_v_axis_stretch_mode** **(** **)** const .. _class_StyleBoxTexture_is_draw_center_enabled: -- :ref:`bool` **is_draw_center_enabled** **(** **)** const +- :ref:`bool` **is_draw_center_enabled** **(** **)** const .. _class_StyleBoxTexture_set_draw_center: -- void **set_draw_center** **(** :ref:`bool` enable **)** +- void **set_draw_center** **(** :ref:`bool` enable **)** .. _class_StyleBoxTexture_set_expand_margin_all: -- void **set_expand_margin_all** **(** :ref:`float` size **)** +- void **set_expand_margin_all** **(** :ref:`float` size **)** .. _class_StyleBoxTexture_set_expand_margin_individual: -- void **set_expand_margin_individual** **(** :ref:`float` size_left, :ref:`float` size_top, :ref:`float` size_right, :ref:`float` size_bottom **)** +- void **set_expand_margin_individual** **(** :ref:`float` size_left, :ref:`float` size_top, :ref:`float` size_right, :ref:`float` size_bottom **)** .. _class_StyleBoxTexture_set_expand_margin_size: -- void **set_expand_margin_size** **(** :ref:`int` margin, :ref:`float` size **)** +- void **set_expand_margin_size** **(** :ref:`int` margin, :ref:`float` size **)** .. _class_StyleBoxTexture_set_h_axis_stretch_mode: -- void **set_h_axis_stretch_mode** **(** :ref:`int` mode **)** +- void **set_h_axis_stretch_mode** **(** :ref:`int` mode **)** .. _class_StyleBoxTexture_set_margin_size: -- void **set_margin_size** **(** :ref:`int` margin, :ref:`float` size **)** +- void **set_margin_size** **(** :ref:`int` margin, :ref:`float` size **)** .. _class_StyleBoxTexture_set_modulate: -- void **set_modulate** **(** :ref:`Color` color **)** +- void **set_modulate** **(** :ref:`Color` color **)** .. _class_StyleBoxTexture_set_normal_map: -- void **set_normal_map** **(** :ref:`Resource` normal_map **)** +- void **set_normal_map** **(** :ref:`Resource` normal_map **)** .. _class_StyleBoxTexture_set_region_rect: -- void **set_region_rect** **(** :ref:`Rect2` region **)** +- void **set_region_rect** **(** :ref:`Rect2` region **)** .. _class_StyleBoxTexture_set_texture: -- void **set_texture** **(** :ref:`Resource` texture **)** +- void **set_texture** **(** :ref:`Resource` texture **)** .. _class_StyleBoxTexture_set_v_axis_stretch_mode: -- void **set_v_axis_stretch_mode** **(** :ref:`int` mode **)** +- void **set_v_axis_stretch_mode** **(** :ref:`int` mode **)** diff --git a/classes/class_surfacetool.rst b/classes/class_surfacetool.rst index 24685a2d6..718402007 100644 --- a/classes/class_surfacetool.rst +++ b/classes/class_surfacetool.rst @@ -19,51 +19,51 @@ Helper tool to create geometry. Member Functions ---------------- -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_bones` **(** :ref:`PoolIntArray` bones **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_color` **(** :ref:`Color` color **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_index` **(** :ref:`int` index **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_normal` **(** :ref:`Vector3` normal **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_smooth_group` **(** :ref:`bool` smooth **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_tangent` **(** :ref:`Plane` tangent **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_to_format` **(** :ref:`int` flags **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_triangle_fan` **(** :ref:`PoolVector3Array` vertexes, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`PoolColorArray` colors=PoolColorArray( ), :ref:`PoolVector2Array` uv2s=PoolVector2Array( ), :ref:`PoolVector3Array` normals=PoolVector3Array( ), :ref:`Array` tangents=[ ] **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_uv` **(** :ref:`Vector2` uv **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_uv2` **(** :ref:`Vector2` uv2 **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_vertex` **(** :ref:`Vector3` vertex **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_weights` **(** :ref:`PoolRealArray` weights **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append_from` **(** :ref:`Mesh` existing, :ref:`int` surface, :ref:`Transform` transform **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`begin` **(** :ref:`int` primitive **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ArrayMesh` | :ref:`commit` **(** :ref:`ArrayMesh` existing=null **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_from` **(** :ref:`Mesh` existing, :ref:`int` surface **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`deindex` **(** **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`generate_normals` **(** **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`generate_tangents` **(** **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`index` **(** **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_material` **(** :ref:`Material` material **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_bones` **(** :ref:`PoolIntArray` bones **)** | ++------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_color` **(** :ref:`Color` color **)** | ++------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_index` **(** :ref:`int` index **)** | ++------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_normal` **(** :ref:`Vector3` normal **)** | ++------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_smooth_group` **(** :ref:`bool` smooth **)** | ++------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_tangent` **(** :ref:`Plane` tangent **)** | ++------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_to_format` **(** :ref:`int` flags **)** | ++------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_triangle_fan` **(** :ref:`PoolVector3Array` vertexes, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`PoolColorArray` colors=PoolColorArray( ), :ref:`PoolVector2Array` uv2s=PoolVector2Array( ), :ref:`PoolVector3Array` normals=PoolVector3Array( ), :ref:`Array` tangents=[ ] **)** | ++------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_uv` **(** :ref:`Vector2` uv **)** | ++------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_uv2` **(** :ref:`Vector2` uv2 **)** | ++------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_vertex` **(** :ref:`Vector3` vertex **)** | ++------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_weights` **(** :ref:`PoolRealArray` weights **)** | ++------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append_from` **(** :ref:`Mesh` existing, :ref:`int` surface, :ref:`Transform` transform **)** | ++------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`begin` **(** :ref:`int` primitive **)** | ++------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ArrayMesh` | :ref:`commit` **(** :ref:`ArrayMesh` existing=null **)** | ++------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create_from` **(** :ref:`Mesh` existing, :ref:`int` surface **)** | ++------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`deindex` **(** **)** | ++------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`generate_normals` **(** **)** | ++------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`generate_tangents` **(** **)** | ++------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`index` **(** **)** | ++------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_material` **(** :ref:`Material` material **)** | ++------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -87,125 +87,125 @@ Member Function Description .. _class_SurfaceTool_add_bones: -- void **add_bones** **(** :ref:`PoolIntArray` bones **)** +- void **add_bones** **(** :ref:`PoolIntArray` bones **)** Add an array of bones for the next Vertex to use. .. _class_SurfaceTool_add_color: -- void **add_color** **(** :ref:`Color` color **)** +- void **add_color** **(** :ref:`Color` color **)** Specify a :ref:`Color` for the next Vertex to use. .. _class_SurfaceTool_add_index: -- void **add_index** **(** :ref:`int` index **)** +- void **add_index** **(** :ref:`int` index **)** Adds an index to index array if you are using indexed Vertices. Does not need to be called before adding Vertex. .. _class_SurfaceTool_add_normal: -- void **add_normal** **(** :ref:`Vector3` normal **)** +- void **add_normal** **(** :ref:`Vector3` normal **)** Specify a normal for the next Vertex to use. .. _class_SurfaceTool_add_smooth_group: -- void **add_smooth_group** **(** :ref:`bool` smooth **)** +- void **add_smooth_group** **(** :ref:`bool` smooth **)** Specify whether current Vertex (if using only Vertex arrays) or current index (if also using index arrays) should utilize smooth normals for normal calculation. .. _class_SurfaceTool_add_tangent: -- void **add_tangent** **(** :ref:`Plane` tangent **)** +- void **add_tangent** **(** :ref:`Plane` tangent **)** Specify a Tangent for the next Vertex to use. .. _class_SurfaceTool_add_to_format: -- void **add_to_format** **(** :ref:`int` flags **)** +- void **add_to_format** **(** :ref:`int` flags **)** .. _class_SurfaceTool_add_triangle_fan: -- void **add_triangle_fan** **(** :ref:`PoolVector3Array` vertexes, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`PoolColorArray` colors=PoolColorArray( ), :ref:`PoolVector2Array` uv2s=PoolVector2Array( ), :ref:`PoolVector3Array` normals=PoolVector3Array( ), :ref:`Array` tangents=[ ] **)** +- void **add_triangle_fan** **(** :ref:`PoolVector3Array` vertexes, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`PoolColorArray` colors=PoolColorArray( ), :ref:`PoolVector2Array` uv2s=PoolVector2Array( ), :ref:`PoolVector3Array` normals=PoolVector3Array( ), :ref:`Array` tangents=[ ] **)** Insert a triangle fan made of array data into :ref:`Mesh` being constructed. .. _class_SurfaceTool_add_uv: -- void **add_uv** **(** :ref:`Vector2` uv **)** +- void **add_uv** **(** :ref:`Vector2` uv **)** Specify UV Coordinate for next Vertex to use. .. _class_SurfaceTool_add_uv2: -- void **add_uv2** **(** :ref:`Vector2` uv2 **)** +- void **add_uv2** **(** :ref:`Vector2` uv2 **)** Specify an optional second set of UV coordinates for next Vertex to use. .. _class_SurfaceTool_add_vertex: -- void **add_vertex** **(** :ref:`Vector3` vertex **)** +- void **add_vertex** **(** :ref:`Vector3` vertex **)** Specify position of current Vertex. Should be called after specifying other vertex properties (e.g. Color, UV). .. _class_SurfaceTool_add_weights: -- void **add_weights** **(** :ref:`PoolRealArray` weights **)** +- void **add_weights** **(** :ref:`PoolRealArray` weights **)** Specify weight value for next Vertex to use. .. _class_SurfaceTool_append_from: -- void **append_from** **(** :ref:`Mesh` existing, :ref:`int` surface, :ref:`Transform` transform **)** +- void **append_from** **(** :ref:`Mesh` existing, :ref:`int` surface, :ref:`Transform` transform **)** .. _class_SurfaceTool_begin: -- void **begin** **(** :ref:`int` primitive **)** +- void **begin** **(** :ref:`int` primitive **)** Called before adding any Vertices. Takes the primitive type as an argument (e.g. Mesh.PRIMITIVE_TRIANGLES). .. _class_SurfaceTool_clear: -- void **clear** **(** **)** +- void **clear** **(** **)** Clear all information passed into the surface tool so far. .. _class_SurfaceTool_commit: -- :ref:`ArrayMesh` **commit** **(** :ref:`ArrayMesh` existing=null **)** +- :ref:`ArrayMesh` **commit** **(** :ref:`ArrayMesh` existing=null **)** Returns a constructed :ref:`ArrayMesh` from current information passed in. If an existing :ref:`ArrayMesh` is passed in as an argument, will add an extra surface to the existing :ref:`ArrayMesh`. .. _class_SurfaceTool_create_from: -- void **create_from** **(** :ref:`Mesh` existing, :ref:`int` surface **)** +- void **create_from** **(** :ref:`Mesh` existing, :ref:`int` surface **)** .. _class_SurfaceTool_deindex: -- void **deindex** **(** **)** +- void **deindex** **(** **)** Removes index array by expanding Vertex array. .. _class_SurfaceTool_generate_normals: -- void **generate_normals** **(** **)** +- void **generate_normals** **(** **)** Generates normals from Vertices so you do not have to do it manually. .. _class_SurfaceTool_generate_tangents: -- void **generate_tangents** **(** **)** +- void **generate_tangents** **(** **)** .. _class_SurfaceTool_index: -- void **index** **(** **)** +- void **index** **(** **)** Shrinks Vertex array by creating an index array. Avoids reusing Vertices. .. _class_SurfaceTool_set_material: -- void **set_material** **(** :ref:`Material` material **)** +- void **set_material** **(** :ref:`Material` material **)** Sets :ref:`Material` to be used by the :ref:`Mesh` you are constructing. diff --git a/classes/class_tabcontainer.rst b/classes/class_tabcontainer.rst index faa22a5dc..5e6036ed5 100644 --- a/classes/class_tabcontainer.rst +++ b/classes/class_tabcontainer.rst @@ -19,60 +19,60 @@ Tabbed Container. Member Functions ---------------- -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`are_tabs_visible` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_current_tab` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Control` | :ref:`get_current_tab_control` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Popup` | :ref:`get_popup` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_previous_tab` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_tab_align` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Control` | :ref:`get_tab_control` **(** :ref:`int` idx **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_tab_count` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_tab_disabled` **(** :ref:`int` tab_idx **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_tab_icon` **(** :ref:`int` tab_idx **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_tab_title` **(** :ref:`int` tab_idx **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_current_tab` **(** :ref:`int` tab_idx **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_popup` **(** :ref:`Node` popup **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tab_align` **(** :ref:`int` align **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tab_disabled` **(** :ref:`int` tab_idx, :ref:`bool` disabled **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tab_icon` **(** :ref:`int` tab_idx, :ref:`Texture` icon **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tab_title` **(** :ref:`int` tab_idx, :ref:`String` title **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tabs_visible` **(** :ref:`bool` visible **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`are_tabs_visible` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_current_tab` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Control` | :ref:`get_current_tab_control` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Popup` | :ref:`get_popup` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_previous_tab` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_tab_align` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Control` | :ref:`get_tab_control` **(** :ref:`int` idx **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_tab_count` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_tab_disabled` **(** :ref:`int` tab_idx **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_tab_icon` **(** :ref:`int` tab_idx **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_tab_title` **(** :ref:`int` tab_idx **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_current_tab` **(** :ref:`int` tab_idx **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_popup` **(** :ref:`Node` popup **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tab_align` **(** :ref:`int` align **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tab_disabled` **(** :ref:`int` tab_idx, :ref:`bool` disabled **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tab_icon` **(** :ref:`int` tab_idx, :ref:`Texture` icon **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tab_title` **(** :ref:`int` tab_idx, :ref:`String` title **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tabs_visible` **(** :ref:`bool` visible **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_TabContainer_pre_popup_pressed: -- **pre_popup_pressed** **(** **)** +- **pre_popup_pressed** **(** **)** .. _class_TabContainer_tab_changed: -- **tab_changed** **(** :ref:`int` tab **)** +- **tab_changed** **(** :ref:`int` tab **)** Emitted only when the current tab changes. .. _class_TabContainer_tab_selected: -- **tab_selected** **(** :ref:`int` tab **)** +- **tab_selected** **(** :ref:`int` tab **)** Emitted when a tab is being selected, even if it is the same tab. @@ -112,103 +112,103 @@ Member Function Description .. _class_TabContainer_are_tabs_visible: -- :ref:`bool` **are_tabs_visible** **(** **)** const +- :ref:`bool` **are_tabs_visible** **(** **)** const Returns ``true`` if the tabs are visible. .. _class_TabContainer_get_current_tab: -- :ref:`int` **get_current_tab** **(** **)** const +- :ref:`int` **get_current_tab** **(** **)** const Returns the current tab index that is being shown. .. _class_TabContainer_get_current_tab_control: -- :ref:`Control` **get_current_tab_control** **(** **)** const +- :ref:`Control` **get_current_tab_control** **(** **)** const .. _class_TabContainer_get_popup: -- :ref:`Popup` **get_popup** **(** **)** const +- :ref:`Popup` **get_popup** **(** **)** const .. _class_TabContainer_get_previous_tab: -- :ref:`int` **get_previous_tab** **(** **)** const +- :ref:`int` **get_previous_tab** **(** **)** const Returns the previous tab index that was being shown. .. _class_TabContainer_get_tab_align: -- :ref:`int` **get_tab_align** **(** **)** const +- :ref:`int` **get_tab_align** **(** **)** const Returns the tab alignment.See the ALIGN\_\* constants. .. _class_TabContainer_get_tab_control: -- :ref:`Control` **get_tab_control** **(** :ref:`int` idx **)** const +- :ref:`Control` **get_tab_control** **(** :ref:`int` idx **)** const Returns the current tab control that is being shown. .. _class_TabContainer_get_tab_count: -- :ref:`int` **get_tab_count** **(** **)** const +- :ref:`int` **get_tab_count** **(** **)** const Returns the amount of tabs. .. _class_TabContainer_get_tab_disabled: -- :ref:`bool` **get_tab_disabled** **(** :ref:`int` tab_idx **)** const +- :ref:`bool` **get_tab_disabled** **(** :ref:`int` tab_idx **)** const Returns ``true`` if the tab at index ``tab_idx`` is disabled. .. _class_TabContainer_get_tab_icon: -- :ref:`Texture` **get_tab_icon** **(** :ref:`int` tab_idx **)** const +- :ref:`Texture` **get_tab_icon** **(** :ref:`int` tab_idx **)** const Returns the :ref:`Texture` for the tab at index ``tab_idx`` or null if the tab has no :ref:`Texture`. .. _class_TabContainer_get_tab_title: -- :ref:`String` **get_tab_title** **(** :ref:`int` tab_idx **)** const +- :ref:`String` **get_tab_title** **(** :ref:`int` tab_idx **)** const Returns the title for the tab at index ``tab_idx``. Tab titles are by default the children node name, but this can be overridden. .. _class_TabContainer_set_current_tab: -- void **set_current_tab** **(** :ref:`int` tab_idx **)** +- void **set_current_tab** **(** :ref:`int` tab_idx **)** Bring a tab (and the Control it represents) to the front, and hide the rest. .. _class_TabContainer_set_popup: -- void **set_popup** **(** :ref:`Node` popup **)** +- void **set_popup** **(** :ref:`Node` popup **)** .. _class_TabContainer_set_tab_align: -- void **set_tab_align** **(** :ref:`int` align **)** +- void **set_tab_align** **(** :ref:`int` align **)** Set tab alignment, from the ALIGN\_\* enum. Moves tabs to the left, right or center. .. _class_TabContainer_set_tab_disabled: -- void **set_tab_disabled** **(** :ref:`int` tab_idx, :ref:`bool` disabled **)** +- void **set_tab_disabled** **(** :ref:`int` tab_idx, :ref:`bool` disabled **)** Set tab at index ``tab_idx`` disabled. .. _class_TabContainer_set_tab_icon: -- void **set_tab_icon** **(** :ref:`int` tab_idx, :ref:`Texture` icon **)** +- void **set_tab_icon** **(** :ref:`int` tab_idx, :ref:`Texture` icon **)** Set an icon for a tab at index ``tab_idx``. .. _class_TabContainer_set_tab_title: -- void **set_tab_title** **(** :ref:`int` tab_idx, :ref:`String` title **)** +- void **set_tab_title** **(** :ref:`int` tab_idx, :ref:`String` title **)** Set a title for the tab at index ``tab_idx``. Tab titles are by default the children node name, but this can be overridden. .. _class_TabContainer_set_tabs_visible: -- void **set_tabs_visible** **(** :ref:`bool` visible **)** +- void **set_tabs_visible** **(** :ref:`bool` visible **)** If ``true`` all the tabs will be visible. diff --git a/classes/class_tabs.rst b/classes/class_tabs.rst index 8383f792a..ecbbb32ca 100644 --- a/classes/class_tabs.rst +++ b/classes/class_tabs.rst @@ -19,70 +19,70 @@ Tabs Control. Member Functions ---------------- -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_tab` **(** :ref:`String` title="", :ref:`Texture` icon=null **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`ensure_tab_visible` **(** :ref:`int` idx **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_current_tab` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_tab_align` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_tab_close_display_policy` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_tab_count` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_tab_disabled` **(** :ref:`int` tab_idx **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_tab_icon` **(** :ref:`int` tab_idx **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_tab_rect` **(** :ref:`int` tab_idx **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_tab_title` **(** :ref:`int` tab_idx **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`move_tab` **(** :ref:`int` from, :ref:`int` to **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_tab` **(** :ref:`int` tab_idx **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_current_tab` **(** :ref:`int` tab_idx **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tab_align` **(** :ref:`int` align **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tab_close_display_policy` **(** :ref:`int` policy **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tab_disabled` **(** :ref:`int` tab_idx, :ref:`bool` disabled **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tab_icon` **(** :ref:`int` tab_idx, :ref:`Texture` icon **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tab_title` **(** :ref:`int` tab_idx, :ref:`String` title **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_tab` **(** :ref:`String` title="", :ref:`Texture` icon=null **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`ensure_tab_visible` **(** :ref:`int` idx **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_current_tab` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_tab_align` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_tab_close_display_policy` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_tab_count` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_tab_disabled` **(** :ref:`int` tab_idx **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_tab_icon` **(** :ref:`int` tab_idx **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_tab_rect` **(** :ref:`int` tab_idx **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_tab_title` **(** :ref:`int` tab_idx **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`move_tab` **(** :ref:`int` from, :ref:`int` to **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_tab` **(** :ref:`int` tab_idx **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_current_tab` **(** :ref:`int` tab_idx **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tab_align` **(** :ref:`int` align **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tab_close_display_policy` **(** :ref:`int` policy **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tab_disabled` **(** :ref:`int` tab_idx, :ref:`bool` disabled **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tab_icon` **(** :ref:`int` tab_idx, :ref:`Texture` icon **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tab_title` **(** :ref:`int` tab_idx, :ref:`String` title **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_Tabs_reposition_active_tab_request: -- **reposition_active_tab_request** **(** :ref:`int` idx_to **)** +- **reposition_active_tab_request** **(** :ref:`int` idx_to **)** .. _class_Tabs_right_button_pressed: -- **right_button_pressed** **(** :ref:`int` tab **)** +- **right_button_pressed** **(** :ref:`int` tab **)** .. _class_Tabs_tab_changed: -- **tab_changed** **(** :ref:`int` tab **)** +- **tab_changed** **(** :ref:`int` tab **)** .. _class_Tabs_tab_clicked: -- **tab_clicked** **(** :ref:`int` tab **)** +- **tab_clicked** **(** :ref:`int` tab **)** .. _class_Tabs_tab_close: -- **tab_close** **(** :ref:`int` tab **)** +- **tab_close** **(** :ref:`int` tab **)** .. _class_Tabs_tab_hover: -- **tab_hover** **(** :ref:`int` tab **)** +- **tab_hover** **(** :ref:`int` tab **)** Member Variables @@ -119,78 +119,78 @@ Member Function Description .. _class_Tabs_add_tab: -- void **add_tab** **(** :ref:`String` title="", :ref:`Texture` icon=null **)** +- void **add_tab** **(** :ref:`String` title="", :ref:`Texture` icon=null **)** .. _class_Tabs_ensure_tab_visible: -- void **ensure_tab_visible** **(** :ref:`int` idx **)** +- void **ensure_tab_visible** **(** :ref:`int` idx **)** .. _class_Tabs_get_current_tab: -- :ref:`int` **get_current_tab** **(** **)** const +- :ref:`int` **get_current_tab** **(** **)** const .. _class_Tabs_get_tab_align: -- :ref:`int` **get_tab_align** **(** **)** const +- :ref:`int` **get_tab_align** **(** **)** const .. _class_Tabs_get_tab_close_display_policy: -- :ref:`int` **get_tab_close_display_policy** **(** **)** const +- :ref:`int` **get_tab_close_display_policy** **(** **)** const .. _class_Tabs_get_tab_count: -- :ref:`int` **get_tab_count** **(** **)** const +- :ref:`int` **get_tab_count** **(** **)** const .. _class_Tabs_get_tab_disabled: -- :ref:`bool` **get_tab_disabled** **(** :ref:`int` tab_idx **)** const +- :ref:`bool` **get_tab_disabled** **(** :ref:`int` tab_idx **)** const .. _class_Tabs_get_tab_icon: -- :ref:`Texture` **get_tab_icon** **(** :ref:`int` tab_idx **)** const +- :ref:`Texture` **get_tab_icon** **(** :ref:`int` tab_idx **)** const .. _class_Tabs_get_tab_rect: -- :ref:`Rect2` **get_tab_rect** **(** :ref:`int` tab_idx **)** const +- :ref:`Rect2` **get_tab_rect** **(** :ref:`int` tab_idx **)** const Returns tab :ref:`Rect2` with local position and size. .. _class_Tabs_get_tab_title: -- :ref:`String` **get_tab_title** **(** :ref:`int` tab_idx **)** const +- :ref:`String` **get_tab_title** **(** :ref:`int` tab_idx **)** const .. _class_Tabs_move_tab: -- void **move_tab** **(** :ref:`int` from, :ref:`int` to **)** +- void **move_tab** **(** :ref:`int` from, :ref:`int` to **)** Rearrange tab. .. _class_Tabs_remove_tab: -- void **remove_tab** **(** :ref:`int` tab_idx **)** +- void **remove_tab** **(** :ref:`int` tab_idx **)** .. _class_Tabs_set_current_tab: -- void **set_current_tab** **(** :ref:`int` tab_idx **)** +- void **set_current_tab** **(** :ref:`int` tab_idx **)** .. _class_Tabs_set_tab_align: -- void **set_tab_align** **(** :ref:`int` align **)** +- void **set_tab_align** **(** :ref:`int` align **)** .. _class_Tabs_set_tab_close_display_policy: -- void **set_tab_close_display_policy** **(** :ref:`int` policy **)** +- void **set_tab_close_display_policy** **(** :ref:`int` policy **)** .. _class_Tabs_set_tab_disabled: -- void **set_tab_disabled** **(** :ref:`int` tab_idx, :ref:`bool` disabled **)** +- void **set_tab_disabled** **(** :ref:`int` tab_idx, :ref:`bool` disabled **)** .. _class_Tabs_set_tab_icon: -- void **set_tab_icon** **(** :ref:`int` tab_idx, :ref:`Texture` icon **)** +- void **set_tab_icon** **(** :ref:`int` tab_idx, :ref:`Texture` icon **)** .. _class_Tabs_set_tab_title: -- void **set_tab_title** **(** :ref:`int` tab_idx, :ref:`String` title **)** +- void **set_tab_title** **(** :ref:`int` tab_idx, :ref:`String` title **)** diff --git a/classes/class_tcp_server.rst b/classes/class_tcp_server.rst index ee2af49fd..6f129e21f 100644 --- a/classes/class_tcp_server.rst +++ b/classes/class_tcp_server.rst @@ -19,15 +19,15 @@ TCP Server. Member Functions ---------------- -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_connection_available` **(** **)** const | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`listen` **(** :ref:`int` port, :ref:`String` bind_address="*" **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StreamPeerTCP` | :ref:`take_connection` **(** **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_connection_available` **(** **)** const | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`listen` **(** :ref:`int` port, :ref:`String` bind_address="*" **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`StreamPeerTCP` | :ref:`take_connection` **(** **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -39,13 +39,13 @@ Member Function Description .. _class_TCP_Server_is_connection_available: -- :ref:`bool` **is_connection_available** **(** **)** const +- :ref:`bool` **is_connection_available** **(** **)** const Return true if a connection is available for taking. .. _class_TCP_Server_listen: -- :ref:`int` **listen** **(** :ref:`int` port, :ref:`String` bind_address="*" **)** +- :ref:`int` **listen** **(** :ref:`int` port, :ref:`String` bind_address="*" **)** Listen on the "port" binding to "bind_address". @@ -57,13 +57,13 @@ If "bind_address" is set to any valid address (e.g. "192.168.1.101", "::1", etc) .. _class_TCP_Server_stop: -- void **stop** **(** **)** +- void **stop** **(** **)** Stop listening. .. _class_TCP_Server_take_connection: -- :ref:`StreamPeerTCP` **take_connection** **(** **)** +- :ref:`StreamPeerTCP` **take_connection** **(** **)** If a connection is available, return a StreamPeerTCP with the connection/ diff --git a/classes/class_textedit.rst b/classes/class_textedit.rst index d1275b7f8..b25b512a3 100644 --- a/classes/class_textedit.rst +++ b/classes/class_textedit.rst @@ -19,136 +19,136 @@ Multiline text editing control. Member Functions ---------------- -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_color_region` **(** :ref:`String` begin_key, :ref:`String` end_key, :ref:`Color` color, :ref:`bool` line_only=false **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_keyword_color` **(** :ref:`String` keyword, :ref:`Color` color **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_colors` **(** **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_undo_history` **(** **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`copy` **(** **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`cursor_get_blink_enabled` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`cursor_get_blink_speed` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`cursor_get_column` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`cursor_get_line` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`cursor_is_block_mode` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cursor_set_blink_enabled` **(** :ref:`bool` enable **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cursor_set_blink_speed` **(** :ref:`float` blink_speed **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cursor_set_block_mode` **(** :ref:`bool` enable **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cursor_set_column` **(** :ref:`int` column, :ref:`bool` adjust_viewport=true **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cursor_set_line` **(** :ref:`int` line, :ref:`bool` adjust_viewport=true **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cut` **(** **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_line` **(** :ref:`int` line **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_line_count` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PopupMenu` | :ref:`get_menu` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_selection_from_column` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_selection_from_line` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_selection_text` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_selection_to_column` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_selection_to_line` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_text` **(** **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_v_scroll_speed` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_word_under_cursor` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`insert_text_at_cursor` **(** :ref:`String` text **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_highlight_all_occurrences_enabled` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_overriding_selected_font_color` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_selection_active` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_show_line_numbers_enabled` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_smooth_scroll_enabled` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_syntax_coloring_enabled` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`menu_option` **(** :ref:`int` option **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`paste` **(** **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`redo` **(** **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`search` **(** :ref:`String` key, :ref:`int` flags, :ref:`int` from_line, :ref:`int` from_column **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`select` **(** :ref:`int` from_line, :ref:`int` from_column, :ref:`int` to_line, :ref:`int` to_column **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`select_all` **(** **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_highlight_all_occurrences` **(** :ref:`bool` enable **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_max_chars` **(** :ref:`int` amount **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_override_selected_font_color` **(** :ref:`bool` override **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_readonly` **(** :ref:`bool` enable **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_show_line_numbers` **(** :ref:`bool` enable **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_smooth_scroll_enable` **(** :ref:`bool` enable **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_syntax_coloring` **(** :ref:`bool` enable **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_text` **(** :ref:`String` text **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_v_scroll_speed` **(** :ref:`float` speed **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_wrap` **(** :ref:`bool` enable **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`undo` **(** **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_color_region` **(** :ref:`String` begin_key, :ref:`String` end_key, :ref:`Color` color, :ref:`bool` line_only=false **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_keyword_color` **(** :ref:`String` keyword, :ref:`Color` color **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_colors` **(** **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_undo_history` **(** **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`copy` **(** **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`cursor_get_blink_enabled` **(** **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`cursor_get_blink_speed` **(** **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`cursor_get_column` **(** **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`cursor_get_line` **(** **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`cursor_is_block_mode` **(** **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`cursor_set_blink_enabled` **(** :ref:`bool` enable **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`cursor_set_blink_speed` **(** :ref:`float` blink_speed **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`cursor_set_block_mode` **(** :ref:`bool` enable **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`cursor_set_column` **(** :ref:`int` column, :ref:`bool` adjust_viewport=true **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`cursor_set_line` **(** :ref:`int` line, :ref:`bool` adjust_viewport=true **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`cut` **(** **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_line` **(** :ref:`int` line **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_line_count` **(** **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PopupMenu` | :ref:`get_menu` **(** **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_selection_from_column` **(** **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_selection_from_line` **(** **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_selection_text` **(** **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_selection_to_column` **(** **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_selection_to_line` **(** **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_text` **(** **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_v_scroll_speed` **(** **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_word_under_cursor` **(** **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`insert_text_at_cursor` **(** :ref:`String` text **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_highlight_all_occurrences_enabled` **(** **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_overriding_selected_font_color` **(** **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_selection_active` **(** **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_show_line_numbers_enabled` **(** **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_smooth_scroll_enabled` **(** **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_syntax_coloring_enabled` **(** **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`menu_option` **(** :ref:`int` option **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`paste` **(** **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`redo` **(** **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`search` **(** :ref:`String` key, :ref:`int` flags, :ref:`int` from_line, :ref:`int` from_column **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`select` **(** :ref:`int` from_line, :ref:`int` from_column, :ref:`int` to_line, :ref:`int` to_column **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`select_all` **(** **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_highlight_all_occurrences` **(** :ref:`bool` enable **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_max_chars` **(** :ref:`int` amount **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_override_selected_font_color` **(** :ref:`bool` override **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_readonly` **(** :ref:`bool` enable **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_show_line_numbers` **(** :ref:`bool` enable **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_smooth_scroll_enable` **(** :ref:`bool` enable **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_syntax_coloring` **(** :ref:`bool` enable **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_text` **(** :ref:`String` text **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_v_scroll_speed` **(** :ref:`float` speed **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_wrap` **(** :ref:`bool` enable **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`undo` **(** **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_TextEdit_breakpoint_toggled: -- **breakpoint_toggled** **(** :ref:`int` row **)** +- **breakpoint_toggled** **(** :ref:`int` row **)** Emitted when a breakpoint is placed via the breakpoint gutter. .. _class_TextEdit_cursor_changed: -- **cursor_changed** **(** **)** +- **cursor_changed** **(** **)** Emitted when the cursor changes. .. _class_TextEdit_request_completion: -- **request_completion** **(** **)** +- **request_completion** **(** **)** .. _class_TextEdit_symbol_lookup: -- **symbol_lookup** **(** :ref:`String` symbol, :ref:`int` row, :ref:`int` column **)** +- **symbol_lookup** **(** :ref:`String` symbol, :ref:`int` row, :ref:`int` column **)** .. _class_TextEdit_text_changed: -- **text_changed** **(** **)** +- **text_changed** **(** **)** Emitted when the text changes. @@ -217,285 +217,285 @@ Member Function Description .. _class_TextEdit_add_color_region: -- void **add_color_region** **(** :ref:`String` begin_key, :ref:`String` end_key, :ref:`Color` color, :ref:`bool` line_only=false **)** +- void **add_color_region** **(** :ref:`String` begin_key, :ref:`String` end_key, :ref:`Color` color, :ref:`bool` line_only=false **)** Add color region (given the delimiters) and its colors. .. _class_TextEdit_add_keyword_color: -- void **add_keyword_color** **(** :ref:`String` keyword, :ref:`Color` color **)** +- void **add_keyword_color** **(** :ref:`String` keyword, :ref:`Color` color **)** Add a keyword and its color. .. _class_TextEdit_clear_colors: -- void **clear_colors** **(** **)** +- void **clear_colors** **(** **)** Clear all the syntax coloring information. .. _class_TextEdit_clear_undo_history: -- void **clear_undo_history** **(** **)** +- void **clear_undo_history** **(** **)** Clear the undo history. .. _class_TextEdit_copy: -- void **copy** **(** **)** +- void **copy** **(** **)** Copy the current selection. .. _class_TextEdit_cursor_get_blink_enabled: -- :ref:`bool` **cursor_get_blink_enabled** **(** **)** const +- :ref:`bool` **cursor_get_blink_enabled** **(** **)** const Gets whether the text editor caret is blinking. .. _class_TextEdit_cursor_get_blink_speed: -- :ref:`float` **cursor_get_blink_speed** **(** **)** const +- :ref:`float` **cursor_get_blink_speed** **(** **)** const Gets the text editor caret blink speed. .. _class_TextEdit_cursor_get_column: -- :ref:`int` **cursor_get_column** **(** **)** const +- :ref:`int` **cursor_get_column** **(** **)** const Return the column the editing cursor is at. .. _class_TextEdit_cursor_get_line: -- :ref:`int` **cursor_get_line** **(** **)** const +- :ref:`int` **cursor_get_line** **(** **)** const Return the line the editing cursor is at. .. _class_TextEdit_cursor_is_block_mode: -- :ref:`bool` **cursor_is_block_mode** **(** **)** const +- :ref:`bool` **cursor_is_block_mode** **(** **)** const Gets whether the text editor caret is in block mode. .. _class_TextEdit_cursor_set_blink_enabled: -- void **cursor_set_blink_enabled** **(** :ref:`bool` enable **)** +- void **cursor_set_blink_enabled** **(** :ref:`bool` enable **)** Set the text editor caret to blink. .. _class_TextEdit_cursor_set_blink_speed: -- void **cursor_set_blink_speed** **(** :ref:`float` blink_speed **)** +- void **cursor_set_blink_speed** **(** :ref:`float` blink_speed **)** Set the text editor caret blink speed. Cannot be less then or equal to 0. .. _class_TextEdit_cursor_set_block_mode: -- void **cursor_set_block_mode** **(** :ref:`bool` enable **)** +- void **cursor_set_block_mode** **(** :ref:`bool` enable **)** Set the text editor caret to block mode. .. _class_TextEdit_cursor_set_column: -- void **cursor_set_column** **(** :ref:`int` column, :ref:`bool` adjust_viewport=true **)** +- void **cursor_set_column** **(** :ref:`int` column, :ref:`bool` adjust_viewport=true **)** .. _class_TextEdit_cursor_set_line: -- void **cursor_set_line** **(** :ref:`int` line, :ref:`bool` adjust_viewport=true **)** +- void **cursor_set_line** **(** :ref:`int` line, :ref:`bool` adjust_viewport=true **)** .. _class_TextEdit_cut: -- void **cut** **(** **)** +- void **cut** **(** **)** Cut the current selection. .. _class_TextEdit_get_line: -- :ref:`String` **get_line** **(** :ref:`int` line **)** const +- :ref:`String` **get_line** **(** :ref:`int` line **)** const Return the text of a specific line. .. _class_TextEdit_get_line_count: -- :ref:`int` **get_line_count** **(** **)** const +- :ref:`int` **get_line_count** **(** **)** const Return the amount of total lines in the text. .. _class_TextEdit_get_menu: -- :ref:`PopupMenu` **get_menu** **(** **)** const +- :ref:`PopupMenu` **get_menu** **(** **)** const .. _class_TextEdit_get_selection_from_column: -- :ref:`int` **get_selection_from_column** **(** **)** const +- :ref:`int` **get_selection_from_column** **(** **)** const Return the selection begin column. .. _class_TextEdit_get_selection_from_line: -- :ref:`int` **get_selection_from_line** **(** **)** const +- :ref:`int` **get_selection_from_line** **(** **)** const Return the selection begin line. .. _class_TextEdit_get_selection_text: -- :ref:`String` **get_selection_text** **(** **)** const +- :ref:`String` **get_selection_text** **(** **)** const Return the text inside the selection. .. _class_TextEdit_get_selection_to_column: -- :ref:`int` **get_selection_to_column** **(** **)** const +- :ref:`int` **get_selection_to_column** **(** **)** const Return the selection end column. .. _class_TextEdit_get_selection_to_line: -- :ref:`int` **get_selection_to_line** **(** **)** const +- :ref:`int` **get_selection_to_line** **(** **)** const Return the selection end line. .. _class_TextEdit_get_text: -- :ref:`String` **get_text** **(** **)** +- :ref:`String` **get_text** **(** **)** Return the whole text. .. _class_TextEdit_get_v_scroll_speed: -- :ref:`float` **get_v_scroll_speed** **(** **)** const +- :ref:`float` **get_v_scroll_speed** **(** **)** const .. _class_TextEdit_get_word_under_cursor: -- :ref:`String` **get_word_under_cursor** **(** **)** const +- :ref:`String` **get_word_under_cursor** **(** **)** const .. _class_TextEdit_insert_text_at_cursor: -- void **insert_text_at_cursor** **(** :ref:`String` text **)** +- void **insert_text_at_cursor** **(** :ref:`String` text **)** Insert a given text at the cursor position. .. _class_TextEdit_is_highlight_all_occurrences_enabled: -- :ref:`bool` **is_highlight_all_occurrences_enabled** **(** **)** const +- :ref:`bool` **is_highlight_all_occurrences_enabled** **(** **)** const Returns true if highlight all occurrences is enabled. .. _class_TextEdit_is_overriding_selected_font_color: -- :ref:`bool` **is_overriding_selected_font_color** **(** **)** const +- :ref:`bool` **is_overriding_selected_font_color** **(** **)** const .. _class_TextEdit_is_selection_active: -- :ref:`bool` **is_selection_active** **(** **)** const +- :ref:`bool` **is_selection_active** **(** **)** const Return true if the selection is active. .. _class_TextEdit_is_show_line_numbers_enabled: -- :ref:`bool` **is_show_line_numbers_enabled** **(** **)** const +- :ref:`bool` **is_show_line_numbers_enabled** **(** **)** const Returns true if line numbers are enabled. .. _class_TextEdit_is_smooth_scroll_enabled: -- :ref:`bool` **is_smooth_scroll_enabled** **(** **)** const +- :ref:`bool` **is_smooth_scroll_enabled** **(** **)** const .. _class_TextEdit_is_syntax_coloring_enabled: -- :ref:`bool` **is_syntax_coloring_enabled** **(** **)** const +- :ref:`bool` **is_syntax_coloring_enabled** **(** **)** const Return true if the syntax coloring is enabled. .. _class_TextEdit_menu_option: -- void **menu_option** **(** :ref:`int` option **)** +- void **menu_option** **(** :ref:`int` option **)** .. _class_TextEdit_paste: -- void **paste** **(** **)** +- void **paste** **(** **)** Paste the current selection. .. _class_TextEdit_redo: -- void **redo** **(** **)** +- void **redo** **(** **)** Perform redo operation. .. _class_TextEdit_search: -- :ref:`PoolIntArray` **search** **(** :ref:`String` key, :ref:`int` flags, :ref:`int` from_line, :ref:`int` from_column **)** const +- :ref:`PoolIntArray` **search** **(** :ref:`String` key, :ref:`int` flags, :ref:`int` from_line, :ref:`int` from_column **)** const Perform a search inside the text. Search flags can be specified in the SEARCH\_\* enum. .. _class_TextEdit_select: -- void **select** **(** :ref:`int` from_line, :ref:`int` from_column, :ref:`int` to_line, :ref:`int` to_column **)** +- void **select** **(** :ref:`int` from_line, :ref:`int` from_column, :ref:`int` to_line, :ref:`int` to_column **)** Perform selection, from line/column to line/column. .. _class_TextEdit_select_all: -- void **select_all** **(** **)** +- void **select_all** **(** **)** Select all the text. .. _class_TextEdit_set_highlight_all_occurrences: -- void **set_highlight_all_occurrences** **(** :ref:`bool` enable **)** +- void **set_highlight_all_occurrences** **(** :ref:`bool` enable **)** Set to enable highlighting all occurrences of the current selection. .. _class_TextEdit_set_max_chars: -- void **set_max_chars** **(** :ref:`int` amount **)** +- void **set_max_chars** **(** :ref:`int` amount **)** Set the maximum amount of characters editable. .. _class_TextEdit_set_override_selected_font_color: -- void **set_override_selected_font_color** **(** :ref:`bool` override **)** +- void **set_override_selected_font_color** **(** :ref:`bool` override **)** .. _class_TextEdit_set_readonly: -- void **set_readonly** **(** :ref:`bool` enable **)** +- void **set_readonly** **(** :ref:`bool` enable **)** Set the text editor as read-only. Text can be displayed but not edited. .. _class_TextEdit_set_show_line_numbers: -- void **set_show_line_numbers** **(** :ref:`bool` enable **)** +- void **set_show_line_numbers** **(** :ref:`bool` enable **)** Set to enable showing line numbers. .. _class_TextEdit_set_smooth_scroll_enable: -- void **set_smooth_scroll_enable** **(** :ref:`bool` enable **)** +- void **set_smooth_scroll_enable** **(** :ref:`bool` enable **)** .. _class_TextEdit_set_syntax_coloring: -- void **set_syntax_coloring** **(** :ref:`bool` enable **)** +- void **set_syntax_coloring** **(** :ref:`bool` enable **)** Set to enable the syntax coloring. .. _class_TextEdit_set_text: -- void **set_text** **(** :ref:`String` text **)** +- void **set_text** **(** :ref:`String` text **)** Set the entire text. .. _class_TextEdit_set_v_scroll_speed: -- void **set_v_scroll_speed** **(** :ref:`float` speed **)** +- void **set_v_scroll_speed** **(** :ref:`float` speed **)** .. _class_TextEdit_set_wrap: -- void **set_wrap** **(** :ref:`bool` enable **)** +- void **set_wrap** **(** :ref:`bool` enable **)** Enable text wrapping when it goes beyond he edge of what is visible. .. _class_TextEdit_undo: -- void **undo** **(** **)** +- void **undo** **(** **)** Perform undo operation. diff --git a/classes/class_texture.rst b/classes/class_texture.rst index 5b8ea660c..1c0252601 100644 --- a/classes/class_texture.rst +++ b/classes/class_texture.rst @@ -21,27 +21,27 @@ Texture for 2D and 3D. Member Functions ---------------- -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw` **(** :ref:`RID` canvas_item, :ref:`Vector2` position, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_rect` **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_rect_region` **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null, :ref:`bool` clip_uv=true **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`get_data` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_flags` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_height` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_size` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_width` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_alpha` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_flags` **(** :ref:`int` flags **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw` **(** :ref:`RID` canvas_item, :ref:`Vector2` position, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_rect` **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_rect_region` **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null, :ref:`bool` clip_uv=true **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Image` | :ref:`get_data` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_flags` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_height` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_size` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_width` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_alpha` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_flags` **(** :ref:`int` flags **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -65,51 +65,51 @@ Member Function Description .. _class_Texture_draw: -- void **draw** **(** :ref:`RID` canvas_item, :ref:`Vector2` position, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** const +- void **draw** **(** :ref:`RID` canvas_item, :ref:`Vector2` position, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** const .. _class_Texture_draw_rect: -- void **draw_rect** **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** const +- void **draw_rect** **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** const .. _class_Texture_draw_rect_region: -- void **draw_rect_region** **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null, :ref:`bool` clip_uv=true **)** const +- void **draw_rect_region** **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null, :ref:`bool` clip_uv=true **)** const .. _class_Texture_get_data: -- :ref:`Image` **get_data** **(** **)** const +- :ref:`Image` **get_data** **(** **)** const .. _class_Texture_get_flags: -- :ref:`int` **get_flags** **(** **)** const +- :ref:`int` **get_flags** **(** **)** const Return the current texture flags. .. _class_Texture_get_height: -- :ref:`int` **get_height** **(** **)** const +- :ref:`int` **get_height** **(** **)** const Return the texture height. .. _class_Texture_get_size: -- :ref:`Vector2` **get_size** **(** **)** const +- :ref:`Vector2` **get_size** **(** **)** const Return the texture size. .. _class_Texture_get_width: -- :ref:`int` **get_width** **(** **)** const +- :ref:`int` **get_width** **(** **)** const Return the texture width. .. _class_Texture_has_alpha: -- :ref:`bool` **has_alpha** **(** **)** const +- :ref:`bool` **has_alpha** **(** **)** const .. _class_Texture_set_flags: -- void **set_flags** **(** :ref:`int` flags **)** +- void **set_flags** **(** :ref:`int` flags **)** Change the texture flags. diff --git a/classes/class_texturebutton.rst b/classes/class_texturebutton.rst index d6d8d3f4d..eedf1bf1c 100644 --- a/classes/class_texturebutton.rst +++ b/classes/class_texturebutton.rst @@ -19,39 +19,39 @@ Texture-based button. Supports Pressed, Hover, Disabled and Focused states. Member Functions ---------------- -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`BitMap` | :ref:`get_click_mask` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_disabled_texture` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_expand` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_focused_texture` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_hover_texture` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_normal_texture` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_pressed_texture` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_stretch_mode` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_click_mask` **(** :ref:`BitMap` mask **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_disabled_texture` **(** :ref:`Texture` texture **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_expand` **(** :ref:`bool` p_expand **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_focused_texture` **(** :ref:`Texture` texture **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_hover_texture` **(** :ref:`Texture` texture **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_normal_texture` **(** :ref:`Texture` texture **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pressed_texture` **(** :ref:`Texture` texture **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_stretch_mode` **(** :ref:`int` p_mode **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`BitMap` | :ref:`get_click_mask` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_disabled_texture` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_expand` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_focused_texture` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_hover_texture` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_normal_texture` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_pressed_texture` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_stretch_mode` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_click_mask` **(** :ref:`BitMap` mask **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_disabled_texture` **(** :ref:`Texture` texture **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_expand` **(** :ref:`bool` p_expand **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_focused_texture` **(** :ref:`Texture` texture **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_hover_texture` **(** :ref:`Texture` texture **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_normal_texture` **(** :ref:`Texture` texture **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pressed_texture` **(** :ref:`Texture` texture **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_stretch_mode` **(** :ref:`int` p_mode **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -112,66 +112,66 @@ Member Function Description .. _class_TextureButton_get_click_mask: -- :ref:`BitMap` **get_click_mask** **(** **)** const +- :ref:`BitMap` **get_click_mask** **(** **)** const .. _class_TextureButton_get_disabled_texture: -- :ref:`Texture` **get_disabled_texture** **(** **)** const +- :ref:`Texture` **get_disabled_texture** **(** **)** const .. _class_TextureButton_get_expand: -- :ref:`bool` **get_expand** **(** **)** const +- :ref:`bool` **get_expand** **(** **)** const .. _class_TextureButton_get_focused_texture: -- :ref:`Texture` **get_focused_texture** **(** **)** const +- :ref:`Texture` **get_focused_texture** **(** **)** const .. _class_TextureButton_get_hover_texture: -- :ref:`Texture` **get_hover_texture** **(** **)** const +- :ref:`Texture` **get_hover_texture** **(** **)** const .. _class_TextureButton_get_normal_texture: -- :ref:`Texture` **get_normal_texture** **(** **)** const +- :ref:`Texture` **get_normal_texture** **(** **)** const .. _class_TextureButton_get_pressed_texture: -- :ref:`Texture` **get_pressed_texture** **(** **)** const +- :ref:`Texture` **get_pressed_texture** **(** **)** const .. _class_TextureButton_get_stretch_mode: -- :ref:`int` **get_stretch_mode** **(** **)** const +- :ref:`int` **get_stretch_mode** **(** **)** const .. _class_TextureButton_set_click_mask: -- void **set_click_mask** **(** :ref:`BitMap` mask **)** +- void **set_click_mask** **(** :ref:`BitMap` mask **)** .. _class_TextureButton_set_disabled_texture: -- void **set_disabled_texture** **(** :ref:`Texture` texture **)** +- void **set_disabled_texture** **(** :ref:`Texture` texture **)** .. _class_TextureButton_set_expand: -- void **set_expand** **(** :ref:`bool` p_expand **)** +- void **set_expand** **(** :ref:`bool` p_expand **)** .. _class_TextureButton_set_focused_texture: -- void **set_focused_texture** **(** :ref:`Texture` texture **)** +- void **set_focused_texture** **(** :ref:`Texture` texture **)** .. _class_TextureButton_set_hover_texture: -- void **set_hover_texture** **(** :ref:`Texture` texture **)** +- void **set_hover_texture** **(** :ref:`Texture` texture **)** .. _class_TextureButton_set_normal_texture: -- void **set_normal_texture** **(** :ref:`Texture` texture **)** +- void **set_normal_texture** **(** :ref:`Texture` texture **)** .. _class_TextureButton_set_pressed_texture: -- void **set_pressed_texture** **(** :ref:`Texture` texture **)** +- void **set_pressed_texture** **(** :ref:`Texture` texture **)** .. _class_TextureButton_set_stretch_mode: -- void **set_stretch_mode** **(** :ref:`int` p_mode **)** +- void **set_stretch_mode** **(** :ref:`int` p_mode **)** diff --git a/classes/class_textureprogress.rst b/classes/class_textureprogress.rst index 5a0c23b4e..5f22561e0 100644 --- a/classes/class_textureprogress.rst +++ b/classes/class_textureprogress.rst @@ -19,43 +19,43 @@ Texture-based progress bar. Useful for loading screens and life or stamina bars. Member Functions ---------------- -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_fill_degrees` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_fill_mode` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_nine_patch_stretch` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_over_texture` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_progress_texture` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_radial_center_offset` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_radial_initial_angle` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_stretch_margin` **(** :ref:`int` margin **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_under_texture` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fill_degrees` **(** :ref:`float` mode **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fill_mode` **(** :ref:`int` mode **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_nine_patch_stretch` **(** :ref:`bool` stretch **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_over_texture` **(** :ref:`Texture` tex **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_progress_texture` **(** :ref:`Texture` tex **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_radial_center_offset` **(** :ref:`Vector2` mode **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_radial_initial_angle` **(** :ref:`float` mode **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_stretch_margin` **(** :ref:`int` margin, :ref:`int` value **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_under_texture` **(** :ref:`Texture` tex **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_fill_degrees` **(** **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_fill_mode` **(** **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_nine_patch_stretch` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_over_texture` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_progress_texture` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_radial_center_offset` **(** **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_radial_initial_angle` **(** **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_stretch_margin` **(** :ref:`int` margin **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_under_texture` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fill_degrees` **(** :ref:`float` mode **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fill_mode` **(** :ref:`int` mode **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_nine_patch_stretch` **(** :ref:`bool` stretch **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_over_texture` **(** :ref:`Texture` tex **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_progress_texture` **(** :ref:`Texture` tex **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_radial_center_offset` **(** :ref:`Vector2` mode **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_radial_initial_angle` **(** :ref:`float` mode **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_stretch_margin` **(** :ref:`int` margin, :ref:`int` value **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_under_texture` **(** :ref:`Texture` tex **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -133,82 +133,82 @@ Member Function Description .. _class_TextureProgress_get_fill_degrees: -- :ref:`float` **get_fill_degrees** **(** **)** +- :ref:`float` **get_fill_degrees** **(** **)** .. _class_TextureProgress_get_fill_mode: -- :ref:`int` **get_fill_mode** **(** **)** +- :ref:`int` **get_fill_mode** **(** **)** .. _class_TextureProgress_get_nine_patch_stretch: -- :ref:`bool` **get_nine_patch_stretch** **(** **)** const +- :ref:`bool` **get_nine_patch_stretch** **(** **)** const Returns true if textures are stretched as nine-patches or false otherwise. .. _class_TextureProgress_get_over_texture: -- :ref:`Texture` **get_over_texture** **(** **)** const +- :ref:`Texture` **get_over_texture** **(** **)** const .. _class_TextureProgress_get_progress_texture: -- :ref:`Texture` **get_progress_texture** **(** **)** const +- :ref:`Texture` **get_progress_texture** **(** **)** const .. _class_TextureProgress_get_radial_center_offset: -- :ref:`Vector2` **get_radial_center_offset** **(** **)** +- :ref:`Vector2` **get_radial_center_offset** **(** **)** .. _class_TextureProgress_get_radial_initial_angle: -- :ref:`float` **get_radial_initial_angle** **(** **)** +- :ref:`float` **get_radial_initial_angle** **(** **)** .. _class_TextureProgress_get_stretch_margin: -- :ref:`int` **get_stretch_margin** **(** :ref:`int` margin **)** const +- :ref:`int` **get_stretch_margin** **(** :ref:`int` margin **)** const Return nine-patch texture offset for a given margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). .. _class_TextureProgress_get_under_texture: -- :ref:`Texture` **get_under_texture** **(** **)** const +- :ref:`Texture` **get_under_texture** **(** **)** const .. _class_TextureProgress_set_fill_degrees: -- void **set_fill_degrees** **(** :ref:`float` mode **)** +- void **set_fill_degrees** **(** :ref:`float` mode **)** .. _class_TextureProgress_set_fill_mode: -- void **set_fill_mode** **(** :ref:`int` mode **)** +- void **set_fill_mode** **(** :ref:`int` mode **)** .. _class_TextureProgress_set_nine_patch_stretch: -- void **set_nine_patch_stretch** **(** :ref:`bool` stretch **)** +- void **set_nine_patch_stretch** **(** :ref:`bool` stretch **)** Set if textures should be stretched as nine-patches. .. _class_TextureProgress_set_over_texture: -- void **set_over_texture** **(** :ref:`Texture` tex **)** +- void **set_over_texture** **(** :ref:`Texture` tex **)** .. _class_TextureProgress_set_progress_texture: -- void **set_progress_texture** **(** :ref:`Texture` tex **)** +- void **set_progress_texture** **(** :ref:`Texture` tex **)** .. _class_TextureProgress_set_radial_center_offset: -- void **set_radial_center_offset** **(** :ref:`Vector2` mode **)** +- void **set_radial_center_offset** **(** :ref:`Vector2` mode **)** .. _class_TextureProgress_set_radial_initial_angle: -- void **set_radial_initial_angle** **(** :ref:`float` mode **)** +- void **set_radial_initial_angle** **(** :ref:`float` mode **)** .. _class_TextureProgress_set_stretch_margin: -- void **set_stretch_margin** **(** :ref:`int` margin, :ref:`int` value **)** +- void **set_stretch_margin** **(** :ref:`int` margin, :ref:`int` value **)** Set nine-patch texture offset for a given margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). .. _class_TextureProgress_set_under_texture: -- void **set_under_texture** **(** :ref:`Texture` tex **)** +- void **set_under_texture** **(** :ref:`Texture` tex **)** diff --git a/classes/class_texturerect.rst b/classes/class_texturerect.rst index 460f0d5b7..4127c4dc7 100644 --- a/classes/class_texturerect.rst +++ b/classes/class_texturerect.rst @@ -19,19 +19,19 @@ Draws a sprite or a texture inside a User Interface. The texture can tile or not Member Functions ---------------- -+--------------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_stretch_mode` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_texture` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_expand` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_expand` **(** :ref:`bool` enable **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_stretch_mode` **(** :ref:`int` stretch_mode **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture` **(** :ref:`Texture` texture **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------+ ++--------------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_stretch_mode` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_texture` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_expand` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_expand` **(** :ref:`bool` enable **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_stretch_mode` **(** :ref:`int` stretch_mode **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_texture` **(** :ref:`Texture` texture **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -71,26 +71,26 @@ Member Function Description .. _class_TextureRect_get_stretch_mode: -- :ref:`int` **get_stretch_mode** **(** **)** const +- :ref:`int` **get_stretch_mode** **(** **)** const .. _class_TextureRect_get_texture: -- :ref:`Texture` **get_texture** **(** **)** const +- :ref:`Texture` **get_texture** **(** **)** const .. _class_TextureRect_has_expand: -- :ref:`bool` **has_expand** **(** **)** const +- :ref:`bool` **has_expand** **(** **)** const .. _class_TextureRect_set_expand: -- void **set_expand** **(** :ref:`bool` enable **)** +- void **set_expand** **(** :ref:`bool` enable **)** .. _class_TextureRect_set_stretch_mode: -- void **set_stretch_mode** **(** :ref:`int` stretch_mode **)** +- void **set_stretch_mode** **(** :ref:`int` stretch_mode **)** .. _class_TextureRect_set_texture: -- void **set_texture** **(** :ref:`Texture` texture **)** +- void **set_texture** **(** :ref:`Texture` texture **)** diff --git a/classes/class_theme.rst b/classes/class_theme.rst index 0feef4576..519c7f6a5 100644 --- a/classes/class_theme.rst +++ b/classes/class_theme.rst @@ -19,67 +19,67 @@ Theme for controls. Member Functions ---------------- -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_color` **(** :ref:`String` name, :ref:`String` type **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_constant` **(** :ref:`String` name, :ref:`String` type **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_font` **(** :ref:`String` name, :ref:`String` type **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_icon` **(** :ref:`String` name, :ref:`String` type **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_stylebox` **(** :ref:`String` name, :ref:`String` type **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`copy_default_theme` **(** **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_color` **(** :ref:`String` name, :ref:`String` type **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_color_list` **(** :ref:`String` type **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_constant` **(** :ref:`String` name, :ref:`String` type **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_constant_list` **(** :ref:`String` type **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Font` | :ref:`get_default_font` **(** **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Font` | :ref:`get_font` **(** :ref:`String` name, :ref:`String` type **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_font_list` **(** :ref:`String` type **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_icon` **(** :ref:`String` name, :ref:`String` type **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_icon_list` **(** :ref:`String` type **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`get_stylebox` **(** :ref:`String` name, :ref:`String` type **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_stylebox_list` **(** :ref:`String` type **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_stylebox_types` **(** **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_type_list` **(** :ref:`String` type **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_color` **(** :ref:`String` name, :ref:`String` type **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_constant` **(** :ref:`String` name, :ref:`String` type **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_font` **(** :ref:`String` name, :ref:`String` type **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_icon` **(** :ref:`String` name, :ref:`String` type **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_stylebox` **(** :ref:`String` name, :ref:`String` type **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_color` **(** :ref:`String` name, :ref:`String` type, :ref:`Color` color **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_constant` **(** :ref:`String` name, :ref:`String` type, :ref:`int` constant **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_default_font` **(** :ref:`Font` font **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_font` **(** :ref:`String` name, :ref:`String` type, :ref:`Font` font **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_icon` **(** :ref:`String` name, :ref:`String` type, :ref:`Texture` texture **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_stylebox` **(** :ref:`String` name, :ref:`String` type, :ref:`StyleBox` texture **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_color` **(** :ref:`String` name, :ref:`String` type **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_constant` **(** :ref:`String` name, :ref:`String` type **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_font` **(** :ref:`String` name, :ref:`String` type **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_icon` **(** :ref:`String` name, :ref:`String` type **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_stylebox` **(** :ref:`String` name, :ref:`String` type **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`copy_default_theme` **(** **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_color` **(** :ref:`String` name, :ref:`String` type **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_color_list` **(** :ref:`String` type **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_constant` **(** :ref:`String` name, :ref:`String` type **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_constant_list` **(** :ref:`String` type **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Font` | :ref:`get_default_font` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Font` | :ref:`get_font` **(** :ref:`String` name, :ref:`String` type **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_font_list` **(** :ref:`String` type **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_icon` **(** :ref:`String` name, :ref:`String` type **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_icon_list` **(** :ref:`String` type **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`StyleBox` | :ref:`get_stylebox` **(** :ref:`String` name, :ref:`String` type **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_stylebox_list` **(** :ref:`String` type **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_stylebox_types` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_type_list` **(** :ref:`String` type **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_color` **(** :ref:`String` name, :ref:`String` type **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_constant` **(** :ref:`String` name, :ref:`String` type **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_font` **(** :ref:`String` name, :ref:`String` type **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_icon` **(** :ref:`String` name, :ref:`String` type **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_stylebox` **(** :ref:`String` name, :ref:`String` type **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_color` **(** :ref:`String` name, :ref:`String` type, :ref:`Color` color **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_constant` **(** :ref:`String` name, :ref:`String` type, :ref:`int` constant **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_default_font` **(** :ref:`Font` font **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_font` **(** :ref:`String` name, :ref:`String` type, :ref:`Font` font **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_icon` **(** :ref:`String` name, :ref:`String` type, :ref:`Texture` texture **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_stylebox` **(** :ref:`String` name, :ref:`String` type, :ref:`StyleBox` texture **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -101,122 +101,122 @@ Member Function Description .. _class_Theme_clear_color: -- void **clear_color** **(** :ref:`String` name, :ref:`String` type **)** +- void **clear_color** **(** :ref:`String` name, :ref:`String` type **)** .. _class_Theme_clear_constant: -- void **clear_constant** **(** :ref:`String` name, :ref:`String` type **)** +- void **clear_constant** **(** :ref:`String` name, :ref:`String` type **)** .. _class_Theme_clear_font: -- void **clear_font** **(** :ref:`String` name, :ref:`String` type **)** +- void **clear_font** **(** :ref:`String` name, :ref:`String` type **)** .. _class_Theme_clear_icon: -- void **clear_icon** **(** :ref:`String` name, :ref:`String` type **)** +- void **clear_icon** **(** :ref:`String` name, :ref:`String` type **)** .. _class_Theme_clear_stylebox: -- void **clear_stylebox** **(** :ref:`String` name, :ref:`String` type **)** +- void **clear_stylebox** **(** :ref:`String` name, :ref:`String` type **)** .. _class_Theme_copy_default_theme: -- void **copy_default_theme** **(** **)** +- void **copy_default_theme** **(** **)** .. _class_Theme_get_color: -- :ref:`Color` **get_color** **(** :ref:`String` name, :ref:`String` type **)** const +- :ref:`Color` **get_color** **(** :ref:`String` name, :ref:`String` type **)** const .. _class_Theme_get_color_list: -- :ref:`PoolStringArray` **get_color_list** **(** :ref:`String` type **)** const +- :ref:`PoolStringArray` **get_color_list** **(** :ref:`String` type **)** const .. _class_Theme_get_constant: -- :ref:`int` **get_constant** **(** :ref:`String` name, :ref:`String` type **)** const +- :ref:`int` **get_constant** **(** :ref:`String` name, :ref:`String` type **)** const .. _class_Theme_get_constant_list: -- :ref:`PoolStringArray` **get_constant_list** **(** :ref:`String` type **)** const +- :ref:`PoolStringArray` **get_constant_list** **(** :ref:`String` type **)** const .. _class_Theme_get_default_font: -- :ref:`Font` **get_default_font** **(** **)** const +- :ref:`Font` **get_default_font** **(** **)** const .. _class_Theme_get_font: -- :ref:`Font` **get_font** **(** :ref:`String` name, :ref:`String` type **)** const +- :ref:`Font` **get_font** **(** :ref:`String` name, :ref:`String` type **)** const .. _class_Theme_get_font_list: -- :ref:`PoolStringArray` **get_font_list** **(** :ref:`String` type **)** const +- :ref:`PoolStringArray` **get_font_list** **(** :ref:`String` type **)** const .. _class_Theme_get_icon: -- :ref:`Texture` **get_icon** **(** :ref:`String` name, :ref:`String` type **)** const +- :ref:`Texture` **get_icon** **(** :ref:`String` name, :ref:`String` type **)** const .. _class_Theme_get_icon_list: -- :ref:`PoolStringArray` **get_icon_list** **(** :ref:`String` type **)** const +- :ref:`PoolStringArray` **get_icon_list** **(** :ref:`String` type **)** const .. _class_Theme_get_stylebox: -- :ref:`StyleBox` **get_stylebox** **(** :ref:`String` name, :ref:`String` type **)** const +- :ref:`StyleBox` **get_stylebox** **(** :ref:`String` name, :ref:`String` type **)** const .. _class_Theme_get_stylebox_list: -- :ref:`PoolStringArray` **get_stylebox_list** **(** :ref:`String` type **)** const +- :ref:`PoolStringArray` **get_stylebox_list** **(** :ref:`String` type **)** const .. _class_Theme_get_stylebox_types: -- :ref:`PoolStringArray` **get_stylebox_types** **(** **)** const +- :ref:`PoolStringArray` **get_stylebox_types** **(** **)** const .. _class_Theme_get_type_list: -- :ref:`PoolStringArray` **get_type_list** **(** :ref:`String` type **)** const +- :ref:`PoolStringArray` **get_type_list** **(** :ref:`String` type **)** const .. _class_Theme_has_color: -- :ref:`bool` **has_color** **(** :ref:`String` name, :ref:`String` type **)** const +- :ref:`bool` **has_color** **(** :ref:`String` name, :ref:`String` type **)** const .. _class_Theme_has_constant: -- :ref:`bool` **has_constant** **(** :ref:`String` name, :ref:`String` type **)** const +- :ref:`bool` **has_constant** **(** :ref:`String` name, :ref:`String` type **)** const .. _class_Theme_has_font: -- :ref:`bool` **has_font** **(** :ref:`String` name, :ref:`String` type **)** const +- :ref:`bool` **has_font** **(** :ref:`String` name, :ref:`String` type **)** const .. _class_Theme_has_icon: -- :ref:`bool` **has_icon** **(** :ref:`String` name, :ref:`String` type **)** const +- :ref:`bool` **has_icon** **(** :ref:`String` name, :ref:`String` type **)** const .. _class_Theme_has_stylebox: -- :ref:`bool` **has_stylebox** **(** :ref:`String` name, :ref:`String` type **)** const +- :ref:`bool` **has_stylebox** **(** :ref:`String` name, :ref:`String` type **)** const .. _class_Theme_set_color: -- void **set_color** **(** :ref:`String` name, :ref:`String` type, :ref:`Color` color **)** +- void **set_color** **(** :ref:`String` name, :ref:`String` type, :ref:`Color` color **)** .. _class_Theme_set_constant: -- void **set_constant** **(** :ref:`String` name, :ref:`String` type, :ref:`int` constant **)** +- void **set_constant** **(** :ref:`String` name, :ref:`String` type, :ref:`int` constant **)** .. _class_Theme_set_default_font: -- void **set_default_font** **(** :ref:`Font` font **)** +- void **set_default_font** **(** :ref:`Font` font **)** .. _class_Theme_set_font: -- void **set_font** **(** :ref:`String` name, :ref:`String` type, :ref:`Font` font **)** +- void **set_font** **(** :ref:`String` name, :ref:`String` type, :ref:`Font` font **)** .. _class_Theme_set_icon: -- void **set_icon** **(** :ref:`String` name, :ref:`String` type, :ref:`Texture` texture **)** +- void **set_icon** **(** :ref:`String` name, :ref:`String` type, :ref:`Texture` texture **)** .. _class_Theme_set_stylebox: -- void **set_stylebox** **(** :ref:`String` name, :ref:`String` type, :ref:`StyleBox` texture **)** +- void **set_stylebox** **(** :ref:`String` name, :ref:`String` type, :ref:`StyleBox` texture **)** diff --git a/classes/class_thread.rst b/classes/class_thread.rst index fdc34938e..0f8593c30 100644 --- a/classes/class_thread.rst +++ b/classes/class_thread.rst @@ -19,15 +19,15 @@ A unit of execution in a process. Member Functions ---------------- -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_id` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_active` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`start` **(** :ref:`Object` instance, :ref:`String` method, :ref:`Variant` userdata=null, :ref:`int` priority=1 **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`wait_to_finish` **(** **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_id` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_active` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`start` **(** :ref:`Object` instance, :ref:`String` method, :ref:`Variant` userdata=null, :ref:`int` priority=1 **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`wait_to_finish` **(** **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -46,19 +46,19 @@ Member Function Description .. _class_Thread_get_id: -- :ref:`String` **get_id** **(** **)** const +- :ref:`String` **get_id** **(** **)** const Returns the current :ref:`Thread`\ s id, uniquely identifying it among all threads. .. _class_Thread_is_active: -- :ref:`bool` **is_active** **(** **)** const +- :ref:`bool` **is_active** **(** **)** const Returns true if this :ref:`Thread` is currently active. An active :ref:`Thread` cannot start work on a new method but can be joined with :ref:`wait_to_finish`. .. _class_Thread_start: -- :ref:`int` **start** **(** :ref:`Object` instance, :ref:`String` method, :ref:`Variant` userdata=null, :ref:`int` priority=1 **)** +- :ref:`int` **start** **(** :ref:`Object` instance, :ref:`String` method, :ref:`Variant` userdata=null, :ref:`int` priority=1 **)** Starts a new :ref:`Thread` that runs "method" on object "instance" with "userdata" passed as an argument. The "priority" of the :ref:`Thread` can be changed by passing a PRIORITY\_\* enum. @@ -66,7 +66,7 @@ Returns OK on success, or ERR_CANT_CREATE on failure. .. _class_Thread_wait_to_finish: -- :ref:`Variant` **wait_to_finish** **(** **)** +- :ref:`Variant` **wait_to_finish** **(** **)** Joins the :ref:`Thread` and waits for it to finish. Returns what the method called returned. diff --git a/classes/class_tilemap.rst b/classes/class_tilemap.rst index edeb0c8a1..a0ea0a965 100644 --- a/classes/class_tilemap.rst +++ b/classes/class_tilemap.rst @@ -19,112 +19,112 @@ Node for 2D tile-based maps. Member Functions ---------------- -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_cell` **(** :ref:`int` x, :ref:`int` y **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_cell_size` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_cellv` **(** :ref:`Vector2` position **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_center_x` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_center_y` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_collision_bounce` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_collision_friction` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_layer` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_mask` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_use_kinematic` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_custom_transform` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_half_offset` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_mode` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_occluder_light_mask` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_quadrant_size` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_tile_origin` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TileSet` | :ref:`get_tileset` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_used_cells` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_used_cells_by_id` **(** :ref:`int` id **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_used_rect` **(** **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_cell_transposed` **(** :ref:`int` x, :ref:`int` y **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_cell_x_flipped` **(** :ref:`int` x, :ref:`int` y **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_cell_y_flipped` **(** :ref:`int` x, :ref:`int` y **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_y_sort_mode_enabled` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`map_to_world` **(** :ref:`Vector2` map_position, :ref:`bool` ignore_half_ofs=false **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cell` **(** :ref:`int` x, :ref:`int` y, :ref:`int` tile, :ref:`bool` flip_x=false, :ref:`bool` flip_y=false, :ref:`bool` transpose=false **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cell_size` **(** :ref:`Vector2` size **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cellv` **(** :ref:`Vector2` position, :ref:`int` tile, :ref:`bool` flip_x=false, :ref:`bool` flip_y=false, :ref:`bool` transpose=false **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_center_x` **(** :ref:`bool` enable **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_center_y` **(** :ref:`bool` enable **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_bounce` **(** :ref:`float` value **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_friction` **(** :ref:`float` value **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_layer` **(** :ref:`int` layer **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_mask` **(** :ref:`int` mask **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_use_kinematic` **(** :ref:`bool` use_kinematic **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_transform` **(** :ref:`Transform2D` custom_transform **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_half_offset` **(** :ref:`int` half_offset **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mode` **(** :ref:`int` mode **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_occluder_light_mask` **(** :ref:`int` mask **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_quadrant_size` **(** :ref:`int` size **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tile_origin` **(** :ref:`int` origin **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tileset` **(** :ref:`TileSet` tileset **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_y_sort_mode` **(** :ref:`bool` enable **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`world_to_map` **(** :ref:`Vector2` world_position **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_cell` **(** :ref:`int` x, :ref:`int` y **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_cell_size` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_cellv` **(** :ref:`Vector2` position **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_center_x` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_center_y` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_collision_bounce` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_collision_friction` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_layer` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_mask` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_use_kinematic` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_custom_transform` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_half_offset` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_mode` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_occluder_light_mask` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_quadrant_size` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_tile_origin` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TileSet` | :ref:`get_tileset` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_used_cells` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_used_cells_by_id` **(** :ref:`int` id **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_used_rect` **(** **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_cell_transposed` **(** :ref:`int` x, :ref:`int` y **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_cell_x_flipped` **(** :ref:`int` x, :ref:`int` y **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_cell_y_flipped` **(** :ref:`int` x, :ref:`int` y **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_y_sort_mode_enabled` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`map_to_world` **(** :ref:`Vector2` map_position, :ref:`bool` ignore_half_ofs=false **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cell` **(** :ref:`int` x, :ref:`int` y, :ref:`int` tile, :ref:`bool` flip_x=false, :ref:`bool` flip_y=false, :ref:`bool` transpose=false **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cell_size` **(** :ref:`Vector2` size **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cellv` **(** :ref:`Vector2` position, :ref:`int` tile, :ref:`bool` flip_x=false, :ref:`bool` flip_y=false, :ref:`bool` transpose=false **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_center_x` **(** :ref:`bool` enable **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_center_y` **(** :ref:`bool` enable **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_bounce` **(** :ref:`float` value **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_friction` **(** :ref:`float` value **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_layer` **(** :ref:`int` layer **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_mask` **(** :ref:`int` mask **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_use_kinematic` **(** :ref:`bool` use_kinematic **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_transform` **(** :ref:`Transform2D` custom_transform **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_half_offset` **(** :ref:`int` half_offset **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_mode` **(** :ref:`int` mode **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_occluder_light_mask` **(** :ref:`int` mask **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_quadrant_size` **(** :ref:`int` size **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tile_origin` **(** :ref:`int` origin **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tileset` **(** :ref:`TileSet` tileset **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_y_sort_mode` **(** :ref:`bool` enable **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`world_to_map` **(** :ref:`Vector2` world_position **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_TileMap_settings_changed: -- **settings_changed** **(** **)** +- **settings_changed** **(** **)** Emitted when a tilemap setting has changed. @@ -217,159 +217,159 @@ Member Function Description .. _class_TileMap_clear: -- void **clear** **(** **)** +- void **clear** **(** **)** Clear all cells. .. _class_TileMap_get_cell: -- :ref:`int` **get_cell** **(** :ref:`int` x, :ref:`int` y **)** const +- :ref:`int` **get_cell** **(** :ref:`int` x, :ref:`int` y **)** const Return the tile index of the referenced cell. .. _class_TileMap_get_cell_size: -- :ref:`Vector2` **get_cell_size** **(** **)** const +- :ref:`Vector2` **get_cell_size** **(** **)** const Return the cell size. .. _class_TileMap_get_cellv: -- :ref:`int` **get_cellv** **(** :ref:`Vector2` position **)** const +- :ref:`int` **get_cellv** **(** :ref:`Vector2` position **)** const Return the tile index of the cell referenced by a Vector2. .. _class_TileMap_get_center_x: -- :ref:`bool` **get_center_x** **(** **)** const +- :ref:`bool` **get_center_x** **(** **)** const Return true if tiles are to be centered in x coordinate (by default this is false and they are drawn from upper left cell corner). .. _class_TileMap_get_center_y: -- :ref:`bool` **get_center_y** **(** **)** const +- :ref:`bool` **get_center_y** **(** **)** const Return true if tiles are to be centered in y coordinate (by default this is false and they are drawn from upper left cell corner). .. _class_TileMap_get_collision_bounce: -- :ref:`float` **get_collision_bounce** **(** **)** const +- :ref:`float` **get_collision_bounce** **(** **)** const Return the collision bounce parameter. .. _class_TileMap_get_collision_friction: -- :ref:`float` **get_collision_friction** **(** **)** const +- :ref:`float` **get_collision_friction** **(** **)** const Return the collision friction parameter. .. _class_TileMap_get_collision_layer: -- :ref:`int` **get_collision_layer** **(** **)** const +- :ref:`int` **get_collision_layer** **(** **)** const Return the collision layer. .. _class_TileMap_get_collision_layer_bit: -- :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const +- :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const .. _class_TileMap_get_collision_mask: -- :ref:`int` **get_collision_mask** **(** **)** const +- :ref:`int` **get_collision_mask** **(** **)** const Return the collision mask. .. _class_TileMap_get_collision_mask_bit: -- :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const +- :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const .. _class_TileMap_get_collision_use_kinematic: -- :ref:`bool` **get_collision_use_kinematic** **(** **)** const +- :ref:`bool` **get_collision_use_kinematic** **(** **)** const Return whether the tilemap handles collisions as a kinematic body. .. _class_TileMap_get_custom_transform: -- :ref:`Transform2D` **get_custom_transform** **(** **)** const +- :ref:`Transform2D` **get_custom_transform** **(** **)** const Return the custom transform matrix. .. _class_TileMap_get_half_offset: -- :ref:`int` **get_half_offset** **(** **)** const +- :ref:`int` **get_half_offset** **(** **)** const Return the current half offset configuration. .. _class_TileMap_get_mode: -- :ref:`int` **get_mode** **(** **)** const +- :ref:`int` **get_mode** **(** **)** const Return the orientation mode. .. _class_TileMap_get_occluder_light_mask: -- :ref:`int` **get_occluder_light_mask** **(** **)** const +- :ref:`int` **get_occluder_light_mask** **(** **)** const .. _class_TileMap_get_quadrant_size: -- :ref:`int` **get_quadrant_size** **(** **)** const +- :ref:`int` **get_quadrant_size** **(** **)** const Return the quadrant size. .. _class_TileMap_get_tile_origin: -- :ref:`int` **get_tile_origin** **(** **)** const +- :ref:`int` **get_tile_origin** **(** **)** const Return the tile origin configuration. .. _class_TileMap_get_tileset: -- :ref:`TileSet` **get_tileset** **(** **)** const +- :ref:`TileSet` **get_tileset** **(** **)** const Return the current tileset. .. _class_TileMap_get_used_cells: -- :ref:`Array` **get_used_cells** **(** **)** const +- :ref:`Array` **get_used_cells** **(** **)** const Return an array of all cells containing a tile from the tileset (i.e. a tile index different from -1). .. _class_TileMap_get_used_cells_by_id: -- :ref:`Array` **get_used_cells_by_id** **(** :ref:`int` id **)** const +- :ref:`Array` **get_used_cells_by_id** **(** :ref:`int` id **)** const .. _class_TileMap_get_used_rect: -- :ref:`Rect2` **get_used_rect** **(** **)** +- :ref:`Rect2` **get_used_rect** **(** **)** .. _class_TileMap_is_cell_transposed: -- :ref:`bool` **is_cell_transposed** **(** :ref:`int` x, :ref:`int` y **)** const +- :ref:`bool` **is_cell_transposed** **(** :ref:`int` x, :ref:`int` y **)** const Return whether the referenced cell is transposed, i.e. the X and Y axes are swapped (mirroring with regard to the (1,1) vector). .. _class_TileMap_is_cell_x_flipped: -- :ref:`bool` **is_cell_x_flipped** **(** :ref:`int` x, :ref:`int` y **)** const +- :ref:`bool` **is_cell_x_flipped** **(** :ref:`int` x, :ref:`int` y **)** const Return whether the referenced cell is flipped over the X axis. .. _class_TileMap_is_cell_y_flipped: -- :ref:`bool` **is_cell_y_flipped** **(** :ref:`int` x, :ref:`int` y **)** const +- :ref:`bool` **is_cell_y_flipped** **(** :ref:`int` x, :ref:`int` y **)** const Return whether the referenced cell is flipped over the Y axis. .. _class_TileMap_is_y_sort_mode_enabled: -- :ref:`bool` **is_y_sort_mode_enabled** **(** **)** const +- :ref:`bool` **is_y_sort_mode_enabled** **(** **)** const Return the Y sort mode. .. _class_TileMap_map_to_world: -- :ref:`Vector2` **map_to_world** **(** :ref:`Vector2` map_position, :ref:`bool` ignore_half_ofs=false **)** const +- :ref:`Vector2` **map_to_world** **(** :ref:`Vector2` map_position, :ref:`bool` ignore_half_ofs=false **)** const Return the absolute world position corresponding to the tilemap (grid-based) coordinates given as an argument. @@ -377,7 +377,7 @@ Optionally, the tilemap's potential half offset can be ignored. .. _class_TileMap_set_cell: -- void **set_cell** **(** :ref:`int` x, :ref:`int` y, :ref:`int` tile, :ref:`bool` flip_x=false, :ref:`bool` flip_y=false, :ref:`bool` transpose=false **)** +- void **set_cell** **(** :ref:`int` x, :ref:`int` y, :ref:`int` tile, :ref:`bool` flip_x=false, :ref:`bool` flip_y=false, :ref:`bool` transpose=false **)** Set the tile index for the cell referenced by its grid-based X and Y coordinates. @@ -387,13 +387,13 @@ Optionally, the tile can also be flipped over the X and Y coordinates or transpo .. _class_TileMap_set_cell_size: -- void **set_cell_size** **(** :ref:`Vector2` size **)** +- void **set_cell_size** **(** :ref:`Vector2` size **)** Set the cell size. .. _class_TileMap_set_cellv: -- void **set_cellv** **(** :ref:`Vector2` position, :ref:`int` tile, :ref:`bool` flip_x=false, :ref:`bool` flip_y=false, :ref:`bool` transpose=false **)** +- void **set_cellv** **(** :ref:`Vector2` position, :ref:`int` tile, :ref:`bool` flip_x=false, :ref:`bool` flip_y=false, :ref:`bool` transpose=false **)** Set the tile index for the cell referenced by a Vector2 of grid-based coordinates. @@ -403,31 +403,31 @@ Optionally, the tile can also be flipped over the X and Y axes or transposed. .. _class_TileMap_set_center_x: -- void **set_center_x** **(** :ref:`bool` enable **)** +- void **set_center_x** **(** :ref:`bool` enable **)** Set tiles to be centered in x coordinate. (by default this is false and they are drawn from upper left cell corner). .. _class_TileMap_set_center_y: -- void **set_center_y** **(** :ref:`bool` enable **)** +- void **set_center_y** **(** :ref:`bool` enable **)** Set tiles to be centered in y coordinate. (by default this is false and they are drawn from upper left cell corner). .. _class_TileMap_set_collision_bounce: -- void **set_collision_bounce** **(** :ref:`float` value **)** +- void **set_collision_bounce** **(** :ref:`float` value **)** Set the collision bounce parameter. Allowable values range from 0 to 1. .. _class_TileMap_set_collision_friction: -- void **set_collision_friction** **(** :ref:`float` value **)** +- void **set_collision_friction** **(** :ref:`float` value **)** Set the collision friction parameter. Allowable values range from 0 to 1. .. _class_TileMap_set_collision_layer: -- void **set_collision_layer** **(** :ref:`int` layer **)** +- void **set_collision_layer** **(** :ref:`int` layer **)** Set the collision layer. @@ -435,11 +435,11 @@ Layers are referenced by binary indexes, so allowable values to describe the 20 .. _class_TileMap_set_collision_layer_bit: -- void **set_collision_layer_bit** **(** :ref:`int` bit, :ref:`bool` value **)** +- void **set_collision_layer_bit** **(** :ref:`int` bit, :ref:`bool` value **)** .. _class_TileMap_set_collision_mask: -- void **set_collision_mask** **(** :ref:`int` mask **)** +- void **set_collision_mask** **(** :ref:`int` mask **)** Set the collision masks. @@ -447,23 +447,23 @@ Masks are referenced by binary indexes, so allowable values to describe the 20 a .. _class_TileMap_set_collision_mask_bit: -- void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** +- void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** .. _class_TileMap_set_collision_use_kinematic: -- void **set_collision_use_kinematic** **(** :ref:`bool` use_kinematic **)** +- void **set_collision_use_kinematic** **(** :ref:`bool` use_kinematic **)** Set the tilemap to handle collisions as a kinematic body (enabled) or a static body (disabled). .. _class_TileMap_set_custom_transform: -- void **set_custom_transform** **(** :ref:`Transform2D` custom_transform **)** +- void **set_custom_transform** **(** :ref:`Transform2D` custom_transform **)** Set custom transform matrix, to use in combination with the custom orientation mode. .. _class_TileMap_set_half_offset: -- void **set_half_offset** **(** :ref:`int` half_offset **)** +- void **set_half_offset** **(** :ref:`int` half_offset **)** Set a half offset on the X coordinate, Y coordinate, or none (use HALF_OFFSET\_\* constants as argument). @@ -471,17 +471,17 @@ Half offset sets every other tile off by a half tile size in the specified direc .. _class_TileMap_set_mode: -- void **set_mode** **(** :ref:`int` mode **)** +- void **set_mode** **(** :ref:`int` mode **)** Set the orientation mode as square, isometric or custom (use MODE\_\* constants as argument). .. _class_TileMap_set_occluder_light_mask: -- void **set_occluder_light_mask** **(** :ref:`int` mask **)** +- void **set_occluder_light_mask** **(** :ref:`int` mask **)** .. _class_TileMap_set_quadrant_size: -- void **set_quadrant_size** **(** :ref:`int` size **)** +- void **set_quadrant_size** **(** :ref:`int` size **)** Set the quadrant size, this optimizes drawing by batching chunks of map at draw/cull time. @@ -489,19 +489,19 @@ Allowed values are integers ranging from 1 to 128. .. _class_TileMap_set_tile_origin: -- void **set_tile_origin** **(** :ref:`int` origin **)** +- void **set_tile_origin** **(** :ref:`int` origin **)** Set the tile origin to the tile center or its top-left corner (use TILE_ORIGIN\_\* constants as argument). .. _class_TileMap_set_tileset: -- void **set_tileset** **(** :ref:`TileSet` tileset **)** +- void **set_tileset** **(** :ref:`TileSet` tileset **)** Set the current tileset. .. _class_TileMap_set_y_sort_mode: -- void **set_y_sort_mode** **(** :ref:`bool` enable **)** +- void **set_y_sort_mode** **(** :ref:`bool` enable **)** Set the Y sort mode. Enabled Y sort mode means that children of the tilemap will be drawn in the order defined by their Y coordinate. @@ -509,7 +509,7 @@ A tile with a higher Y coordinate will therefore be drawn later, potentially cov .. _class_TileMap_world_to_map: -- :ref:`Vector2` **world_to_map** **(** :ref:`Vector2` world_position **)** const +- :ref:`Vector2` **world_to_map** **(** :ref:`Vector2` world_position **)** const Return the tilemap (grid-based) coordinates corresponding to the absolute world position given as an argument. diff --git a/classes/class_tileset.rst b/classes/class_tileset.rst index 209e0beef..52cf836e4 100644 --- a/classes/class_tileset.rst +++ b/classes/class_tileset.rst @@ -19,79 +19,79 @@ Tile library for tilemaps. Member Functions ---------------- -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_tile` **(** :ref:`int` id **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_tile_by_name` **(** :ref:`String` name **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_last_unused_tile_id` **(** **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_tiles_ids` **(** **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_tile` **(** :ref:`int` id **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_add_shape` **(** :ref:`int` id, :ref:`Shape2D` shape, :ref:`Transform2D` shape_transform, :ref:`bool` one_way=false **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`OccluderPolygon2D` | :ref:`tile_get_light_occluder` **(** :ref:`int` id **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ShaderMaterial` | :ref:`tile_get_material` **(** :ref:`int` id **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`tile_get_name` **(** :ref:`int` id **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NavigationPolygon` | :ref:`tile_get_navigation_polygon` **(** :ref:`int` id **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`tile_get_navigation_polygon_offset` **(** :ref:`int` id **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`tile_get_normal_map` **(** :ref:`int` id **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`tile_get_occluder_offset` **(** :ref:`int` id **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`tile_get_region` **(** :ref:`int` id **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Shape2D` | :ref:`tile_get_shape` **(** :ref:`int` id, :ref:`int` shape_id **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`tile_get_shape_count` **(** :ref:`int` id **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`tile_get_shape_one_way` **(** :ref:`int` id, :ref:`int` shape_id **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`tile_get_shape_transform` **(** :ref:`int` id, :ref:`int` shape_id **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`tile_get_shapes` **(** :ref:`int` id **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`tile_get_texture` **(** :ref:`int` id **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`tile_get_texture_offset` **(** :ref:`int` id **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_light_occluder` **(** :ref:`int` id, :ref:`OccluderPolygon2D` light_occluder **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_material` **(** :ref:`int` id, :ref:`ShaderMaterial` material **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_name` **(** :ref:`int` id, :ref:`String` name **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_navigation_polygon` **(** :ref:`int` id, :ref:`NavigationPolygon` navigation_polygon **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_navigation_polygon_offset` **(** :ref:`int` id, :ref:`Vector2` navigation_polygon_offset **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_normal_map` **(** :ref:`int` id, :ref:`Texture` normal_map **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_occluder_offset` **(** :ref:`int` id, :ref:`Vector2` occluder_offset **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_region` **(** :ref:`int` id, :ref:`Rect2` region **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_shape` **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Shape2D` shape **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_shape_one_way` **(** :ref:`int` id, :ref:`int` shape_id, :ref:`bool` one_way **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_shape_transform` **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Transform2D` shape_transform **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_shapes` **(** :ref:`int` id, :ref:`Array` shapes **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_texture` **(** :ref:`int` id, :ref:`Texture` texture **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_texture_offset` **(** :ref:`int` id, :ref:`Vector2` texture_offset **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create_tile` **(** :ref:`int` id **)** | ++----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find_tile_by_name` **(** :ref:`String` name **)** const | ++----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_last_unused_tile_id` **(** **)** const | ++----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_tiles_ids` **(** **)** const | ++----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_tile` **(** :ref:`int` id **)** | ++----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_add_shape` **(** :ref:`int` id, :ref:`Shape2D` shape, :ref:`Transform2D` shape_transform, :ref:`bool` one_way=false **)** | ++----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`OccluderPolygon2D` | :ref:`tile_get_light_occluder` **(** :ref:`int` id **)** const | ++----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ShaderMaterial` | :ref:`tile_get_material` **(** :ref:`int` id **)** const | ++----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`tile_get_name` **(** :ref:`int` id **)** const | ++----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NavigationPolygon` | :ref:`tile_get_navigation_polygon` **(** :ref:`int` id **)** const | ++----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`tile_get_navigation_polygon_offset` **(** :ref:`int` id **)** const | ++----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`tile_get_normal_map` **(** :ref:`int` id **)** const | ++----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`tile_get_occluder_offset` **(** :ref:`int` id **)** const | ++----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`tile_get_region` **(** :ref:`int` id **)** const | ++----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Shape2D` | :ref:`tile_get_shape` **(** :ref:`int` id, :ref:`int` shape_id **)** const | ++----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`tile_get_shape_count` **(** :ref:`int` id **)** const | ++----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`tile_get_shape_one_way` **(** :ref:`int` id, :ref:`int` shape_id **)** const | ++----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`tile_get_shape_transform` **(** :ref:`int` id, :ref:`int` shape_id **)** const | ++----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`tile_get_shapes` **(** :ref:`int` id **)** const | ++----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`tile_get_texture` **(** :ref:`int` id **)** const | ++----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`tile_get_texture_offset` **(** :ref:`int` id **)** const | ++----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_light_occluder` **(** :ref:`int` id, :ref:`OccluderPolygon2D` light_occluder **)** | ++----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_material` **(** :ref:`int` id, :ref:`ShaderMaterial` material **)** | ++----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_name` **(** :ref:`int` id, :ref:`String` name **)** | ++----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_navigation_polygon` **(** :ref:`int` id, :ref:`NavigationPolygon` navigation_polygon **)** | ++----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_navigation_polygon_offset` **(** :ref:`int` id, :ref:`Vector2` navigation_polygon_offset **)** | ++----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_normal_map` **(** :ref:`int` id, :ref:`Texture` normal_map **)** | ++----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_occluder_offset` **(** :ref:`int` id, :ref:`Vector2` occluder_offset **)** | ++----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_region` **(** :ref:`int` id, :ref:`Rect2` region **)** | ++----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_shape` **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Shape2D` shape **)** | ++----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_shape_one_way` **(** :ref:`int` id, :ref:`int` shape_id, :ref:`bool` one_way **)** | ++----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_shape_transform` **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Transform2D` shape_transform **)** | ++----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_shapes` **(** :ref:`int` id, :ref:`Array` shapes **)** | ++----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_texture` **(** :ref:`int` id, :ref:`Texture` texture **)** | ++----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_texture_offset` **(** :ref:`int` id, :ref:`Vector2` texture_offset **)** | ++----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -105,197 +105,197 @@ Member Function Description .. _class_TileSet_clear: -- void **clear** **(** **)** +- void **clear** **(** **)** Clear all tiles. .. _class_TileSet_create_tile: -- void **create_tile** **(** :ref:`int` id **)** +- void **create_tile** **(** :ref:`int` id **)** Create a new tile which will be referenced by the given ID. .. _class_TileSet_find_tile_by_name: -- :ref:`int` **find_tile_by_name** **(** :ref:`String` name **)** const +- :ref:`int` **find_tile_by_name** **(** :ref:`String` name **)** const Find the first tile matching the given name. .. _class_TileSet_get_last_unused_tile_id: -- :ref:`int` **get_last_unused_tile_id** **(** **)** const +- :ref:`int` **get_last_unused_tile_id** **(** **)** const Return the ID following the last currently used ID, useful when creating a new tile. .. _class_TileSet_get_tiles_ids: -- :ref:`Array` **get_tiles_ids** **(** **)** const +- :ref:`Array` **get_tiles_ids** **(** **)** const Return an array of all currently used tile IDs. .. _class_TileSet_remove_tile: -- void **remove_tile** **(** :ref:`int` id **)** +- void **remove_tile** **(** :ref:`int` id **)** Remove the tile referenced by the given ID. .. _class_TileSet_tile_add_shape: -- void **tile_add_shape** **(** :ref:`int` id, :ref:`Shape2D` shape, :ref:`Transform2D` shape_transform, :ref:`bool` one_way=false **)** +- void **tile_add_shape** **(** :ref:`int` id, :ref:`Shape2D` shape, :ref:`Transform2D` shape_transform, :ref:`bool` one_way=false **)** .. _class_TileSet_tile_get_light_occluder: -- :ref:`OccluderPolygon2D` **tile_get_light_occluder** **(** :ref:`int` id **)** const +- :ref:`OccluderPolygon2D` **tile_get_light_occluder** **(** :ref:`int` id **)** const Return the light occluder of the tile. .. _class_TileSet_tile_get_material: -- :ref:`ShaderMaterial` **tile_get_material** **(** :ref:`int` id **)** const +- :ref:`ShaderMaterial` **tile_get_material** **(** :ref:`int` id **)** const Return the material of the tile. .. _class_TileSet_tile_get_name: -- :ref:`String` **tile_get_name** **(** :ref:`int` id **)** const +- :ref:`String` **tile_get_name** **(** :ref:`int` id **)** const Return the name of the tile. .. _class_TileSet_tile_get_navigation_polygon: -- :ref:`NavigationPolygon` **tile_get_navigation_polygon** **(** :ref:`int` id **)** const +- :ref:`NavigationPolygon` **tile_get_navigation_polygon** **(** :ref:`int` id **)** const Return the navigation polygon of the tile. .. _class_TileSet_tile_get_navigation_polygon_offset: -- :ref:`Vector2` **tile_get_navigation_polygon_offset** **(** :ref:`int` id **)** const +- :ref:`Vector2` **tile_get_navigation_polygon_offset** **(** :ref:`int` id **)** const Return the offset of the tile's navigation polygon. .. _class_TileSet_tile_get_normal_map: -- :ref:`Texture` **tile_get_normal_map** **(** :ref:`int` id **)** const +- :ref:`Texture` **tile_get_normal_map** **(** :ref:`int` id **)** const .. _class_TileSet_tile_get_occluder_offset: -- :ref:`Vector2` **tile_get_occluder_offset** **(** :ref:`int` id **)** const +- :ref:`Vector2` **tile_get_occluder_offset** **(** :ref:`int` id **)** const Return the offset of the tile's light occluder. .. _class_TileSet_tile_get_region: -- :ref:`Rect2` **tile_get_region** **(** :ref:`int` id **)** const +- :ref:`Rect2` **tile_get_region** **(** :ref:`int` id **)** const Return the tile sub-region in the texture. .. _class_TileSet_tile_get_shape: -- :ref:`Shape2D` **tile_get_shape** **(** :ref:`int` id, :ref:`int` shape_id **)** const +- :ref:`Shape2D` **tile_get_shape** **(** :ref:`int` id, :ref:`int` shape_id **)** const .. _class_TileSet_tile_get_shape_count: -- :ref:`int` **tile_get_shape_count** **(** :ref:`int` id **)** const +- :ref:`int` **tile_get_shape_count** **(** :ref:`int` id **)** const .. _class_TileSet_tile_get_shape_one_way: -- :ref:`bool` **tile_get_shape_one_way** **(** :ref:`int` id, :ref:`int` shape_id **)** const +- :ref:`bool` **tile_get_shape_one_way** **(** :ref:`int` id, :ref:`int` shape_id **)** const .. _class_TileSet_tile_get_shape_transform: -- :ref:`Transform2D` **tile_get_shape_transform** **(** :ref:`int` id, :ref:`int` shape_id **)** const +- :ref:`Transform2D` **tile_get_shape_transform** **(** :ref:`int` id, :ref:`int` shape_id **)** const .. _class_TileSet_tile_get_shapes: -- :ref:`Array` **tile_get_shapes** **(** :ref:`int` id **)** const +- :ref:`Array` **tile_get_shapes** **(** :ref:`int` id **)** const Return the array of shapes of the tile. .. _class_TileSet_tile_get_texture: -- :ref:`Texture` **tile_get_texture** **(** :ref:`int` id **)** const +- :ref:`Texture` **tile_get_texture** **(** :ref:`int` id **)** const Return the texture of the tile. .. _class_TileSet_tile_get_texture_offset: -- :ref:`Vector2` **tile_get_texture_offset** **(** :ref:`int` id **)** const +- :ref:`Vector2` **tile_get_texture_offset** **(** :ref:`int` id **)** const Return the texture offset of the tile. .. _class_TileSet_tile_set_light_occluder: -- void **tile_set_light_occluder** **(** :ref:`int` id, :ref:`OccluderPolygon2D` light_occluder **)** +- void **tile_set_light_occluder** **(** :ref:`int` id, :ref:`OccluderPolygon2D` light_occluder **)** Set a light occluder for the tile. .. _class_TileSet_tile_set_material: -- void **tile_set_material** **(** :ref:`int` id, :ref:`ShaderMaterial` material **)** +- void **tile_set_material** **(** :ref:`int` id, :ref:`ShaderMaterial` material **)** Set the material of the tile. .. _class_TileSet_tile_set_name: -- void **tile_set_name** **(** :ref:`int` id, :ref:`String` name **)** +- void **tile_set_name** **(** :ref:`int` id, :ref:`String` name **)** Set the name of the tile, for descriptive purposes. .. _class_TileSet_tile_set_navigation_polygon: -- void **tile_set_navigation_polygon** **(** :ref:`int` id, :ref:`NavigationPolygon` navigation_polygon **)** +- void **tile_set_navigation_polygon** **(** :ref:`int` id, :ref:`NavigationPolygon` navigation_polygon **)** Set a navigation polygon for the tile. .. _class_TileSet_tile_set_navigation_polygon_offset: -- void **tile_set_navigation_polygon_offset** **(** :ref:`int` id, :ref:`Vector2` navigation_polygon_offset **)** +- void **tile_set_navigation_polygon_offset** **(** :ref:`int` id, :ref:`Vector2` navigation_polygon_offset **)** Set an offset for the tile's navigation polygon. .. _class_TileSet_tile_set_normal_map: -- void **tile_set_normal_map** **(** :ref:`int` id, :ref:`Texture` normal_map **)** +- void **tile_set_normal_map** **(** :ref:`int` id, :ref:`Texture` normal_map **)** .. _class_TileSet_tile_set_occluder_offset: -- void **tile_set_occluder_offset** **(** :ref:`int` id, :ref:`Vector2` occluder_offset **)** +- void **tile_set_occluder_offset** **(** :ref:`int` id, :ref:`Vector2` occluder_offset **)** Set an offset for the tile's light occluder. .. _class_TileSet_tile_set_region: -- void **tile_set_region** **(** :ref:`int` id, :ref:`Rect2` region **)** +- void **tile_set_region** **(** :ref:`int` id, :ref:`Rect2` region **)** Set the tile sub-region in the texture. This is common in texture atlases. .. _class_TileSet_tile_set_shape: -- void **tile_set_shape** **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Shape2D` shape **)** +- void **tile_set_shape** **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Shape2D` shape **)** .. _class_TileSet_tile_set_shape_one_way: -- void **tile_set_shape_one_way** **(** :ref:`int` id, :ref:`int` shape_id, :ref:`bool` one_way **)** +- void **tile_set_shape_one_way** **(** :ref:`int` id, :ref:`int` shape_id, :ref:`bool` one_way **)** .. _class_TileSet_tile_set_shape_transform: -- void **tile_set_shape_transform** **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Transform2D` shape_transform **)** +- void **tile_set_shape_transform** **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Transform2D` shape_transform **)** .. _class_TileSet_tile_set_shapes: -- void **tile_set_shapes** **(** :ref:`int` id, :ref:`Array` shapes **)** +- void **tile_set_shapes** **(** :ref:`int` id, :ref:`Array` shapes **)** Set an array of shapes for the tile, enabling physics to collide with it. .. _class_TileSet_tile_set_texture: -- void **tile_set_texture** **(** :ref:`int` id, :ref:`Texture` texture **)** +- void **tile_set_texture** **(** :ref:`int` id, :ref:`Texture` texture **)** Set the texture of the tile. .. _class_TileSet_tile_set_texture_offset: -- void **tile_set_texture_offset** **(** :ref:`int` id, :ref:`Vector2` texture_offset **)** +- void **tile_set_texture_offset** **(** :ref:`int` id, :ref:`Vector2` texture_offset **)** Set the texture offset of the tile. diff --git a/classes/class_timer.rst b/classes/class_timer.rst index 97f1b7e84..d8f404b3a 100644 --- a/classes/class_timer.rst +++ b/classes/class_timer.rst @@ -19,42 +19,42 @@ A countdown timer. Member Functions ---------------- -+----------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_time_left` **(** **)** const | -+----------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_timer_process_mode` **(** **)** const | -+----------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_wait_time` **(** **)** const | -+----------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_autostart` **(** **)** const | -+----------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_one_shot` **(** **)** const | -+----------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_paused` **(** **)** const | -+----------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_stopped` **(** **)** const | -+----------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_autostart` **(** :ref:`bool` enable **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_one_shot` **(** :ref:`bool` enable **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_paused` **(** :ref:`bool` paused **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_timer_process_mode` **(** :ref:`int` mode **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_wait_time` **(** :ref:`float` time_sec **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`start` **(** **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------+ ++----------------------------+----------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_time_left` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_timer_process_mode` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_wait_time` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_autostart` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_one_shot` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_paused` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_stopped` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_autostart` **(** :ref:`bool` enable **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_one_shot` **(** :ref:`bool` enable **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_paused` **(** :ref:`bool` paused **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_timer_process_mode` **(** :ref:`int` mode **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_wait_time` **(** :ref:`float` time_sec **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------+ +| void | :ref:`start` **(** **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_Timer_timeout: -- **timeout** **(** **)** +- **timeout** **(** **)** Emitted when the Timer reaches 0. @@ -95,83 +95,83 @@ Member Function Description .. _class_Timer_get_time_left: -- :ref:`float` **get_time_left** **(** **)** const +- :ref:`float` **get_time_left** **(** **)** const Return the time left for timeout in seconds if the timer is active, 0 otherwise. .. _class_Timer_get_timer_process_mode: -- :ref:`int` **get_timer_process_mode** **(** **)** const +- :ref:`int` **get_timer_process_mode** **(** **)** const Return the timer's processing mode. .. _class_Timer_get_wait_time: -- :ref:`float` **get_wait_time** **(** **)** const +- :ref:`float` **get_wait_time** **(** **)** const Return the wait time in seconds. .. _class_Timer_has_autostart: -- :ref:`bool` **has_autostart** **(** **)** const +- :ref:`bool` **has_autostart** **(** **)** const Return true if set to automatically start when entering the scene. .. _class_Timer_is_one_shot: -- :ref:`bool` **is_one_shot** **(** **)** const +- :ref:`bool` **is_one_shot** **(** **)** const Return true if configured as one-shot. .. _class_Timer_is_paused: -- :ref:`bool` **is_paused** **(** **)** const +- :ref:`bool` **is_paused** **(** **)** const Return if the timer is paused or not. .. _class_Timer_is_stopped: -- :ref:`bool` **is_stopped** **(** **)** const +- :ref:`bool` **is_stopped** **(** **)** const .. _class_Timer_set_autostart: -- void **set_autostart** **(** :ref:`bool` enable **)** +- void **set_autostart** **(** :ref:`bool` enable **)** Set to automatically start when entering the scene. .. _class_Timer_set_one_shot: -- void **set_one_shot** **(** :ref:`bool` enable **)** +- void **set_one_shot** **(** :ref:`bool` enable **)** Set as one-shot. If enabled, the timer will stop after timeout, otherwise it will automatically restart. .. _class_Timer_set_paused: -- void **set_paused** **(** :ref:`bool` paused **)** +- void **set_paused** **(** :ref:`bool` paused **)** Set whether the timer is paused or not. A paused timer will be inactive until it is unpaused again. .. _class_Timer_set_timer_process_mode: -- void **set_timer_process_mode** **(** :ref:`int` mode **)** +- void **set_timer_process_mode** **(** :ref:`int` mode **)** Set the timer's processing mode (fixed or idle, use TIMER_PROCESS\_\* constants as argument). .. _class_Timer_set_wait_time: -- void **set_wait_time** **(** :ref:`float` time_sec **)** +- void **set_wait_time** **(** :ref:`float` time_sec **)** Set wait time in seconds. When the time is over, it will emit the timeout signal. .. _class_Timer_start: -- void **start** **(** **)** +- void **start** **(** **)** Start the Timer. .. _class_Timer_stop: -- void **stop** **(** **)** +- void **stop** **(** **)** Stop (cancel) the Timer. diff --git a/classes/class_touchscreenbutton.rst b/classes/class_touchscreenbutton.rst index 776eed8da..096384da5 100644 --- a/classes/class_touchscreenbutton.rst +++ b/classes/class_touchscreenbutton.rst @@ -19,58 +19,58 @@ Button for touch screen devices. Member Functions ---------------- -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_action` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`BitMap` | :ref:`get_bitmask` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Shape2D` | :ref:`get_shape` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_texture` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_texture_pressed` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_visibility_mode` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_passby_press_enabled` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_pressed` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_shape_centered` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_shape_visible` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_action` **(** :ref:`String` action **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bitmask` **(** :ref:`BitMap` bitmask **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_passby_press` **(** :ref:`bool` enabled **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shape` **(** :ref:`Shape2D` shape **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shape_centered` **(** :ref:`bool` bool **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shape_visible` **(** :ref:`bool` bool **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture` **(** :ref:`Texture` texture **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture_pressed` **(** :ref:`Texture` texture_pressed **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_visibility_mode` **(** :ref:`int` mode **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_action` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`BitMap` | :ref:`get_bitmask` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Shape2D` | :ref:`get_shape` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_texture` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_texture_pressed` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_visibility_mode` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_passby_press_enabled` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_pressed` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_shape_centered` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_shape_visible` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_action` **(** :ref:`String` action **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bitmask` **(** :ref:`BitMap` bitmask **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_passby_press` **(** :ref:`bool` enabled **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shape` **(** :ref:`Shape2D` shape **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shape_centered` **(** :ref:`bool` bool **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shape_visible` **(** :ref:`bool` bool **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_texture` **(** :ref:`Texture` texture **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_texture_pressed` **(** :ref:`Texture` texture_pressed **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_visibility_mode` **(** :ref:`int` mode **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_TouchScreenButton_pressed: -- **pressed** **(** **)** +- **pressed** **(** **)** Emitted when the button is pressed (down). .. _class_TouchScreenButton_released: -- **released** **(** **)** +- **released** **(** **)** Emitted when the button is released (up). @@ -131,109 +131,109 @@ Member Function Description .. _class_TouchScreenButton_get_action: -- :ref:`String` **get_action** **(** **)** const +- :ref:`String` **get_action** **(** **)** const Returns the button's action. .. _class_TouchScreenButton_get_bitmask: -- :ref:`BitMap` **get_bitmask** **(** **)** const +- :ref:`BitMap` **get_bitmask** **(** **)** const Returns the button's bitmask. .. _class_TouchScreenButton_get_shape: -- :ref:`Shape2D` **get_shape** **(** **)** const +- :ref:`Shape2D` **get_shape** **(** **)** const Returns the button's shape. .. _class_TouchScreenButton_get_texture: -- :ref:`Texture` **get_texture** **(** **)** const +- :ref:`Texture` **get_texture** **(** **)** const Returns the button's texture for the normal state. .. _class_TouchScreenButton_get_texture_pressed: -- :ref:`Texture` **get_texture_pressed** **(** **)** const +- :ref:`Texture` **get_texture_pressed** **(** **)** const Returns the button's texture for the pressed state. .. _class_TouchScreenButton_get_visibility_mode: -- :ref:`int` **get_visibility_mode** **(** **)** const +- :ref:`int` **get_visibility_mode** **(** **)** const Sets the button's visibility mode. See ``VISIBILITY\_\*`` constants. .. _class_TouchScreenButton_is_passby_press_enabled: -- :ref:`bool` **is_passby_press_enabled** **(** **)** const +- :ref:`bool` **is_passby_press_enabled** **(** **)** const .. _class_TouchScreenButton_is_pressed: -- :ref:`bool` **is_pressed** **(** **)** const +- :ref:`bool` **is_pressed** **(** **)** const Returns ``true`` if this button is currently pressed. .. _class_TouchScreenButton_is_shape_centered: -- :ref:`bool` **is_shape_centered** **(** **)** const +- :ref:`bool` **is_shape_centered** **(** **)** const .. _class_TouchScreenButton_is_shape_visible: -- :ref:`bool` **is_shape_visible** **(** **)** const +- :ref:`bool` **is_shape_visible** **(** **)** const .. _class_TouchScreenButton_set_action: -- void **set_action** **(** :ref:`String` action **)** +- void **set_action** **(** :ref:`String` action **)** Sets the button's action. .. _class_TouchScreenButton_set_bitmask: -- void **set_bitmask** **(** :ref:`BitMap` bitmask **)** +- void **set_bitmask** **(** :ref:`BitMap` bitmask **)** Sets the button's :ref:`BitMap` bitmask. .. _class_TouchScreenButton_set_passby_press: -- void **set_passby_press** **(** :ref:`bool` enabled **)** +- void **set_passby_press** **(** :ref:`bool` enabled **)** If ``true`` passby presses are enabled for this button. .. _class_TouchScreenButton_set_shape: -- void **set_shape** **(** :ref:`Shape2D` shape **)** +- void **set_shape** **(** :ref:`Shape2D` shape **)** Sets the button's shape. .. _class_TouchScreenButton_set_shape_centered: -- void **set_shape_centered** **(** :ref:`bool` bool **)** +- void **set_shape_centered** **(** :ref:`bool` bool **)** If ``true`` the button's shape is centered. .. _class_TouchScreenButton_set_shape_visible: -- void **set_shape_visible** **(** :ref:`bool` bool **)** +- void **set_shape_visible** **(** :ref:`bool` bool **)** If ``true`` the button's shape is visible. .. _class_TouchScreenButton_set_texture: -- void **set_texture** **(** :ref:`Texture` texture **)** +- void **set_texture** **(** :ref:`Texture` texture **)** Sets the button's :ref:`Texture` for the normal state. .. _class_TouchScreenButton_set_texture_pressed: -- void **set_texture_pressed** **(** :ref:`Texture` texture_pressed **)** +- void **set_texture_pressed** **(** :ref:`Texture` texture_pressed **)** Sets the button's :ref:`Texture` for the pressed state. .. _class_TouchScreenButton_set_visibility_mode: -- void **set_visibility_mode** **(** :ref:`int` mode **)** +- void **set_visibility_mode** **(** :ref:`int` mode **)** Sets the button's visibility mode. See the ``VISIBILITY\_\*`` constants. diff --git a/classes/class_transform.rst b/classes/class_transform.rst index 6b7960657..e1ec90cc9 100644 --- a/classes/class_transform.rst +++ b/classes/class_transform.rst @@ -17,37 +17,37 @@ Brief Description Member Functions ---------------- -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`Transform` **(** :ref:`Vector3` x_axis, :ref:`Vector3` y_axis, :ref:`Vector3` z_axis, :ref:`Vector3` origin **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`Transform` **(** :ref:`Basis` basis, :ref:`Vector3` origin **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`Transform` **(** :ref:`Transform2D` from **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`Transform` **(** :ref:`Quat` from **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`Transform` **(** :ref:`Basis` from **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`affine_inverse` **(** **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`interpolate_with` **(** :ref:`Transform` transform, :ref:`float` weight **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`inverse` **(** **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`looking_at` **(** :ref:`Vector3` target, :ref:`Vector3` up **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`orthonormalized` **(** **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`rotated` **(** :ref:`Vector3` axis, :ref:`float` phi **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`scaled` **(** :ref:`Vector3` scale **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`translated` **(** :ref:`Vector3` ofs **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| var | :ref:`xform` **(** var v **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| var | :ref:`xform_inv` **(** var v **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`Transform` **(** :ref:`Vector3` x_axis, :ref:`Vector3` y_axis, :ref:`Vector3` z_axis, :ref:`Vector3` origin **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`Transform` **(** :ref:`Basis` basis, :ref:`Vector3` origin **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`Transform` **(** :ref:`Transform2D` from **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`Transform` **(** :ref:`Quat` from **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`Transform` **(** :ref:`Basis` from **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`affine_inverse` **(** **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`interpolate_with` **(** :ref:`Transform` transform, :ref:`float` weight **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`inverse` **(** **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`looking_at` **(** :ref:`Vector3` target, :ref:`Vector3` up **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`orthonormalized` **(** **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`rotated` **(** :ref:`Vector3` axis, :ref:`float` phi **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`scaled` **(** :ref:`Vector3` scale **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`translated` **(** :ref:`Vector3` ofs **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| var | :ref:`xform` **(** var v **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| var | :ref:`xform_inv` **(** var v **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -71,91 +71,91 @@ Member Function Description .. _class_Transform_Transform: -- :ref:`Transform` **Transform** **(** :ref:`Vector3` x_axis, :ref:`Vector3` y_axis, :ref:`Vector3` z_axis, :ref:`Vector3` origin **)** +- :ref:`Transform` **Transform** **(** :ref:`Vector3` x_axis, :ref:`Vector3` y_axis, :ref:`Vector3` z_axis, :ref:`Vector3` origin **)** Constructs the Transform from four :ref:`Vector3`. Each axis corresponds to local basis vectors (some of which may be scaled). .. _class_Transform_Transform: -- :ref:`Transform` **Transform** **(** :ref:`Basis` basis, :ref:`Vector3` origin **)** +- :ref:`Transform` **Transform** **(** :ref:`Basis` basis, :ref:`Vector3` origin **)** Constructs the Transform from a :ref:`Basis` and :ref:`Vector3`. .. _class_Transform_Transform: -- :ref:`Transform` **Transform** **(** :ref:`Transform2D` from **)** +- :ref:`Transform` **Transform** **(** :ref:`Transform2D` from **)** Constructs the Transform from a :ref:`Transform2D`. .. _class_Transform_Transform: -- :ref:`Transform` **Transform** **(** :ref:`Quat` from **)** +- :ref:`Transform` **Transform** **(** :ref:`Quat` from **)** Constructs the Transform from a :ref:`Quat`. The origin will be Vector3(0, 0, 0). .. _class_Transform_Transform: -- :ref:`Transform` **Transform** **(** :ref:`Basis` from **)** +- :ref:`Transform` **Transform** **(** :ref:`Basis` from **)** Constructs the Transform from a :ref:`Basis`. The origin will be Vector3(0, 0, 0). .. _class_Transform_affine_inverse: -- :ref:`Transform` **affine_inverse** **(** **)** +- :ref:`Transform` **affine_inverse** **(** **)** Returns the inverse of the transform, under the assumption that the transformation is composed of rotation, scaling and translation. .. _class_Transform_interpolate_with: -- :ref:`Transform` **interpolate_with** **(** :ref:`Transform` transform, :ref:`float` weight **)** +- :ref:`Transform` **interpolate_with** **(** :ref:`Transform` transform, :ref:`float` weight **)** Interpolates the transform to other Transform by weight amount (0-1). .. _class_Transform_inverse: -- :ref:`Transform` **inverse** **(** **)** +- :ref:`Transform` **inverse** **(** **)** Returns the inverse of the transform, under the assumption that the transformation is composed of rotation and translation (no scaling, use affine_inverse for transforms with scaling). .. _class_Transform_looking_at: -- :ref:`Transform` **looking_at** **(** :ref:`Vector3` target, :ref:`Vector3` up **)** +- :ref:`Transform` **looking_at** **(** :ref:`Vector3` target, :ref:`Vector3` up **)** Rotate the transform around the up vector to face the target. .. _class_Transform_orthonormalized: -- :ref:`Transform` **orthonormalized** **(** **)** +- :ref:`Transform` **orthonormalized** **(** **)** Returns the transform with the basis orthogonal (90 degrees), and normalized axis vectors. .. _class_Transform_rotated: -- :ref:`Transform` **rotated** **(** :ref:`Vector3` axis, :ref:`float` phi **)** +- :ref:`Transform` **rotated** **(** :ref:`Vector3` axis, :ref:`float` phi **)** Rotates the transform around given axis by phi. The axis must be a normalized vector. .. _class_Transform_scaled: -- :ref:`Transform` **scaled** **(** :ref:`Vector3` scale **)** +- :ref:`Transform` **scaled** **(** :ref:`Vector3` scale **)** Scales the transform by the specified 3D scaling factors. .. _class_Transform_translated: -- :ref:`Transform` **translated** **(** :ref:`Vector3` ofs **)** +- :ref:`Transform` **translated** **(** :ref:`Vector3` ofs **)** Translates the transform by the specified offset. .. _class_Transform_xform: -- var **xform** **(** var v **)** +- var **xform** **(** var v **)** Transforms the given vector "v" by this transform. .. _class_Transform_xform_inv: -- var **xform_inv** **(** var v **)** +- var **xform_inv** **(** var v **)** Inverse-transforms the given vector "v" by this transform. diff --git a/classes/class_transform2d.rst b/classes/class_transform2d.rst index f474aa558..bc969102d 100644 --- a/classes/class_transform2d.rst +++ b/classes/class_transform2d.rst @@ -17,41 +17,41 @@ Brief Description Member Functions ---------------- -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`Transform2D` **(** :ref:`Transform` from **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`Transform2D` **(** :ref:`Vector2` x_axis, :ref:`Vector2` y_axis, :ref:`Vector2` origin **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`Transform2D` **(** :ref:`float` rotation, :ref:`Vector2` position **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`affine_inverse` **(** **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`basis_xform` **(** var v **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`basis_xform_inv` **(** var v **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_origin` **(** **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_rotation` **(** **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_scale` **(** **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`interpolate_with` **(** :ref:`Transform2D` transform, :ref:`float` weight **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`inverse` **(** **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`orthonormalized` **(** **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`rotated` **(** :ref:`float` phi **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`scaled` **(** :ref:`Vector2` scale **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`translated` **(** :ref:`Vector2` offset **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`xform` **(** var v **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`xform_inv` **(** var v **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`Transform2D` **(** :ref:`Transform` from **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`Transform2D` **(** :ref:`Vector2` x_axis, :ref:`Vector2` y_axis, :ref:`Vector2` origin **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`Transform2D` **(** :ref:`float` rotation, :ref:`Vector2` position **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`affine_inverse` **(** **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`basis_xform` **(** var v **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`basis_xform_inv` **(** var v **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_origin` **(** **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_rotation` **(** **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_scale` **(** **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`interpolate_with` **(** :ref:`Transform2D` transform, :ref:`float` weight **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`inverse` **(** **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`orthonormalized` **(** **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`rotated` **(** :ref:`float` phi **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`scaled` **(** :ref:`Vector2` scale **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`translated` **(** :ref:`Vector2` offset **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`xform` **(** var v **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`xform_inv` **(** var v **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -79,103 +79,103 @@ Member Function Description .. _class_Transform2D_Transform2D: -- :ref:`Transform2D` **Transform2D** **(** :ref:`Transform` from **)** +- :ref:`Transform2D` **Transform2D** **(** :ref:`Transform` from **)** Constructs the :ref:`Transform2D` from a 3D :ref:`Transform`. .. _class_Transform2D_Transform2D: -- :ref:`Transform2D` **Transform2D** **(** :ref:`Vector2` x_axis, :ref:`Vector2` y_axis, :ref:`Vector2` origin **)** +- :ref:`Transform2D` **Transform2D** **(** :ref:`Vector2` x_axis, :ref:`Vector2` y_axis, :ref:`Vector2` origin **)** Constructs the :ref:`Transform2D` from 3 :ref:`Vector2` consisting of rows x, y and origin. .. _class_Transform2D_Transform2D: -- :ref:`Transform2D` **Transform2D** **(** :ref:`float` rotation, :ref:`Vector2` position **)** +- :ref:`Transform2D` **Transform2D** **(** :ref:`float` rotation, :ref:`Vector2` position **)** Constructs the :ref:`Transform2D` from rotation angle in radians and position :ref:`Vector2`. .. _class_Transform2D_affine_inverse: -- :ref:`Transform2D` **affine_inverse** **(** **)** +- :ref:`Transform2D` **affine_inverse** **(** **)** Returns the inverse of the matrix. .. _class_Transform2D_basis_xform: -- :ref:`Transform2D` **basis_xform** **(** var v **)** +- :ref:`Transform2D` **basis_xform** **(** var v **)** Transforms the given vector "v" by this transform basis (no translation). .. _class_Transform2D_basis_xform_inv: -- :ref:`Transform2D` **basis_xform_inv** **(** var v **)** +- :ref:`Transform2D` **basis_xform_inv** **(** var v **)** Inverse-transforms the given vector "v" by this transform basis (no translation). .. _class_Transform2D_get_origin: -- :ref:`Vector2` **get_origin** **(** **)** +- :ref:`Vector2` **get_origin** **(** **)** Returns the origin :ref:`Vector2` (translation). .. _class_Transform2D_get_rotation: -- :ref:`float` **get_rotation** **(** **)** +- :ref:`float` **get_rotation** **(** **)** Returns the rotation (in radians). .. _class_Transform2D_get_scale: -- :ref:`Vector2` **get_scale** **(** **)** +- :ref:`Vector2` **get_scale** **(** **)** Returns the scale. .. _class_Transform2D_interpolate_with: -- :ref:`Transform2D` **interpolate_with** **(** :ref:`Transform2D` transform, :ref:`float` weight **)** +- :ref:`Transform2D` **interpolate_with** **(** :ref:`Transform2D` transform, :ref:`float` weight **)** Interpolates the transform to other Transform2D by weight amount (0-1). .. _class_Transform2D_inverse: -- :ref:`Transform2D` **inverse** **(** **)** +- :ref:`Transform2D` **inverse** **(** **)** Returns the inverse of the transform, under the assumption that the transformation is composed of rotation and translation (no scaling, use affine_inverse for transforms with scaling). .. _class_Transform2D_orthonormalized: -- :ref:`Transform2D` **orthonormalized** **(** **)** +- :ref:`Transform2D` **orthonormalized** **(** **)** Returns the transform with the basis orthogonal (90 degrees), and normalized axis vectors. .. _class_Transform2D_rotated: -- :ref:`Transform2D` **rotated** **(** :ref:`float` phi **)** +- :ref:`Transform2D` **rotated** **(** :ref:`float` phi **)** Rotates the transform by phi. .. _class_Transform2D_scaled: -- :ref:`Transform2D` **scaled** **(** :ref:`Vector2` scale **)** +- :ref:`Transform2D` **scaled** **(** :ref:`Vector2` scale **)** Scales the transform by the specified 2D scaling factors. .. _class_Transform2D_translated: -- :ref:`Transform2D` **translated** **(** :ref:`Vector2` offset **)** +- :ref:`Transform2D` **translated** **(** :ref:`Vector2` offset **)** Translates the transform by the specified offset. .. _class_Transform2D_xform: -- :ref:`Transform2D` **xform** **(** var v **)** +- :ref:`Transform2D` **xform** **(** var v **)** Transforms the given vector "v" by this transform. .. _class_Transform2D_xform_inv: -- :ref:`Transform2D` **xform_inv** **(** var v **)** +- :ref:`Transform2D` **xform_inv** **(** var v **)** Inverse-transforms the given vector "v" by this transform. diff --git a/classes/class_translation.rst b/classes/class_translation.rst index bb31cb254..c7f24c399 100644 --- a/classes/class_translation.rst +++ b/classes/class_translation.rst @@ -21,21 +21,21 @@ Language Translation. Member Functions ---------------- -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_message` **(** :ref:`String` src_message, :ref:`String` xlated_message **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase_message` **(** :ref:`String` src_message **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_locale` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_message` **(** :ref:`String` src_message **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_message_count` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_message_list` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_locale` **(** :ref:`String` locale **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_message` **(** :ref:`String` src_message, :ref:`String` xlated_message **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`erase_message` **(** :ref:`String` src_message **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_locale` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_message` **(** :ref:`String` src_message **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_message_count` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_message_list` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_locale` **(** :ref:`String` locale **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -59,41 +59,41 @@ Member Function Description .. _class_Translation_add_message: -- void **add_message** **(** :ref:`String` src_message, :ref:`String` xlated_message **)** +- void **add_message** **(** :ref:`String` src_message, :ref:`String` xlated_message **)** Add a message for translation. .. _class_Translation_erase_message: -- void **erase_message** **(** :ref:`String` src_message **)** +- void **erase_message** **(** :ref:`String` src_message **)** Erase a message. .. _class_Translation_get_locale: -- :ref:`String` **get_locale** **(** **)** const +- :ref:`String` **get_locale** **(** **)** const Return the locale of the translation. .. _class_Translation_get_message: -- :ref:`String` **get_message** **(** :ref:`String` src_message **)** const +- :ref:`String` **get_message** **(** :ref:`String` src_message **)** const Return a message for translation. .. _class_Translation_get_message_count: -- :ref:`int` **get_message_count** **(** **)** const +- :ref:`int` **get_message_count** **(** **)** const .. _class_Translation_get_message_list: -- :ref:`PoolStringArray` **get_message_list** **(** **)** const +- :ref:`PoolStringArray` **get_message_list** **(** **)** const Return all the messages (keys). .. _class_Translation_set_locale: -- void **set_locale** **(** :ref:`String` locale **)** +- void **set_locale** **(** :ref:`String` locale **)** Set the locale of the translation. diff --git a/classes/class_translationserver.rst b/classes/class_translationserver.rst index cb829cb70..42841c268 100644 --- a/classes/class_translationserver.rst +++ b/classes/class_translationserver.rst @@ -19,45 +19,45 @@ Server that manages all translations. Translations can be set to it and removed Member Functions ---------------- -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_translation` **(** :ref:`Translation` translation **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_locale` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_translation` **(** :ref:`Translation` translation **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_locale` **(** :ref:`String` locale **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`translate` **(** :ref:`String` message **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_translation` **(** :ref:`Translation` translation **)** | ++------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_locale` **(** **)** const | ++------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_translation` **(** :ref:`Translation` translation **)** | ++------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_locale` **(** :ref:`String` locale **)** | ++------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`translate` **(** :ref:`String` message **)** const | ++------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ Member Function Description --------------------------- .. _class_TranslationServer_add_translation: -- void **add_translation** **(** :ref:`Translation` translation **)** +- void **add_translation** **(** :ref:`Translation` translation **)** .. _class_TranslationServer_clear: -- void **clear** **(** **)** +- void **clear** **(** **)** .. _class_TranslationServer_get_locale: -- :ref:`String` **get_locale** **(** **)** const +- :ref:`String` **get_locale** **(** **)** const .. _class_TranslationServer_remove_translation: -- void **remove_translation** **(** :ref:`Translation` translation **)** +- void **remove_translation** **(** :ref:`Translation` translation **)** .. _class_TranslationServer_set_locale: -- void **set_locale** **(** :ref:`String` locale **)** +- void **set_locale** **(** :ref:`String` locale **)** .. _class_TranslationServer_translate: -- :ref:`String` **translate** **(** :ref:`String` message **)** const +- :ref:`String` **translate** **(** :ref:`String` message **)** const diff --git a/classes/class_tree.rst b/classes/class_tree.rst index 0efd59dd7..4222aadf9 100644 --- a/classes/class_tree.rst +++ b/classes/class_tree.rst @@ -19,160 +19,160 @@ Control to show a tree of items. Member Functions ---------------- -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`are_column_titles_visible` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`create_item` **(** :ref:`Object` parent=null **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`ensure_cursor_is_visible` **(** **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_allow_reselect` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_allow_rmb_select` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_column_at_position` **(** :ref:`Vector2` position **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_column_title` **(** :ref:`int` column **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_column_width` **(** :ref:`int` column **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_columns` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_custom_popup_rect` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_drop_mode_flags` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_drop_section_at_position` **(** :ref:`Vector2` position **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_edited` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_edited_column` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_item_area_rect` **(** :ref:`Object` item, :ref:`int` column=-1 **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_item_at_position` **(** :ref:`Vector2` position **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_next_selected` **(** :ref:`Object` from **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_pressed_button` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_root` **(** **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_scroll` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_selected` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_selected_column` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_folding_hidden` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_allow_reselect` **(** :ref:`bool` allow **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_allow_rmb_select` **(** :ref:`bool` allow **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_column_expand` **(** :ref:`int` column, :ref:`bool` expand **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_column_min_width` **(** :ref:`int` column, :ref:`int` min_width **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_column_title` **(** :ref:`int` column, :ref:`String` title **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_column_titles_visible` **(** :ref:`bool` visible **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_columns` **(** :ref:`int` amount **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_drop_mode_flags` **(** :ref:`int` flags **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_hide_folding` **(** :ref:`bool` hide **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_hide_root` **(** :ref:`bool` enable **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_select_mode` **(** :ref:`int` mode **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`are_column_titles_visible` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`create_item` **(** :ref:`Object` parent=null **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`ensure_cursor_is_visible` **(** **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_allow_reselect` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_allow_rmb_select` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_column_at_position` **(** :ref:`Vector2` position **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_column_title` **(** :ref:`int` column **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_column_width` **(** :ref:`int` column **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_columns` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_custom_popup_rect` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_drop_mode_flags` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_drop_section_at_position` **(** :ref:`Vector2` position **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_edited` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_edited_column` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_item_area_rect` **(** :ref:`Object` item, :ref:`int` column=-1 **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_item_at_position` **(** :ref:`Vector2` position **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_next_selected` **(** :ref:`Object` from **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_pressed_button` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_root` **(** **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_scroll` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_selected` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_selected_column` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_folding_hidden` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_allow_reselect` **(** :ref:`bool` allow **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_allow_rmb_select` **(** :ref:`bool` allow **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_column_expand` **(** :ref:`int` column, :ref:`bool` expand **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_column_min_width` **(** :ref:`int` column, :ref:`int` min_width **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_column_title` **(** :ref:`int` column, :ref:`String` title **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_column_titles_visible` **(** :ref:`bool` visible **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_columns` **(** :ref:`int` amount **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_drop_mode_flags` **(** :ref:`int` flags **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_hide_folding` **(** :ref:`bool` hide **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_hide_root` **(** :ref:`bool` enable **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_select_mode` **(** :ref:`int` mode **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_Tree_button_pressed: -- **button_pressed** **(** :ref:`Object` item, :ref:`int` column, :ref:`int` id **)** +- **button_pressed** **(** :ref:`Object` item, :ref:`int` column, :ref:`int` id **)** Emitted when a button on the tree was pressed (see :ref:`TreeItem.add_button`). .. _class_Tree_cell_selected: -- **cell_selected** **(** **)** +- **cell_selected** **(** **)** Emitted when a cell is selected. .. _class_Tree_column_title_pressed: -- **column_title_pressed** **(** :ref:`int` column **)** +- **column_title_pressed** **(** :ref:`int` column **)** Emitted when a column's title is pressed. .. _class_Tree_custom_popup_edited: -- **custom_popup_edited** **(** :ref:`bool` arrow_clicked **)** +- **custom_popup_edited** **(** :ref:`bool` arrow_clicked **)** Emitted when a cell with the ``CELL_MODE_CUSTOM`` is clicked to be edited. .. _class_Tree_empty_tree_rmb_selected: -- **empty_tree_rmb_selected** **(** :ref:`Vector2` position **)** +- **empty_tree_rmb_selected** **(** :ref:`Vector2` position **)** Emitted when the right mouse button is pressed if RMB selection is active and the tree is empty. .. _class_Tree_item_activated: -- **item_activated** **(** **)** +- **item_activated** **(** **)** Emitted when an item is activated (double-clicked). .. _class_Tree_item_collapsed: -- **item_collapsed** **(** :ref:`Object` item **)** +- **item_collapsed** **(** :ref:`Object` item **)** Emitted when an item is collapsed by a click on the folding arrow. .. _class_Tree_item_custom_button_pressed: -- **item_custom_button_pressed** **(** **)** +- **item_custom_button_pressed** **(** **)** .. _class_Tree_item_double_clicked: -- **item_double_clicked** **(** **)** +- **item_double_clicked** **(** **)** Emitted when an item is double clicked. .. _class_Tree_item_edited: -- **item_edited** **(** **)** +- **item_edited** **(** **)** Emitted when an item is edited. .. _class_Tree_item_rmb_edited: -- **item_rmb_edited** **(** **)** +- **item_rmb_edited** **(** **)** Emitted when an item is edited using the right mouse button. .. _class_Tree_item_rmb_selected: -- **item_rmb_selected** **(** :ref:`Vector2` position **)** +- **item_rmb_selected** **(** :ref:`Vector2` position **)** Emitted when an item is selected with right mouse button. .. _class_Tree_item_selected: -- **item_selected** **(** **)** +- **item_selected** **(** **)** Emitted when an item is selected with right mouse button. .. _class_Tree_multi_selected: -- **multi_selected** **(** :ref:`Object` item, :ref:`int` column, :ref:`bool` selected **)** +- **multi_selected** **(** :ref:`Object` item, :ref:`int` column, :ref:`bool` selected **)** Emitted instead of ``item_selected`` when ``select_mode`` is ``SELECT_MULTI``. @@ -210,209 +210,209 @@ Member Function Description .. _class_Tree_are_column_titles_visible: -- :ref:`bool` **are_column_titles_visible** **(** **)** const +- :ref:`bool` **are_column_titles_visible** **(** **)** const Returns ``true`` if the column titles are being shown. .. _class_Tree_clear: -- void **clear** **(** **)** +- void **clear** **(** **)** Clears the tree. This removes all items. .. _class_Tree_create_item: -- :ref:`Object` **create_item** **(** :ref:`Object` parent=null **)** +- :ref:`Object` **create_item** **(** :ref:`Object` parent=null **)** Create an item in the tree and add it as the last child of ``parent``. If parent is not given, it will be added as the root's last child, or it'll the be the root itself if the tree is empty. .. _class_Tree_ensure_cursor_is_visible: -- void **ensure_cursor_is_visible** **(** **)** +- void **ensure_cursor_is_visible** **(** **)** Makes the currently selected item visible. This will scroll the tree to make sure the selected item is visible. .. _class_Tree_get_allow_reselect: -- :ref:`bool` **get_allow_reselect** **(** **)** const +- :ref:`bool` **get_allow_reselect** **(** **)** const Returns ``true`` if a cell that is currently already selected may be selected again. .. _class_Tree_get_allow_rmb_select: -- :ref:`bool` **get_allow_rmb_select** **(** **)** const +- :ref:`bool` **get_allow_rmb_select** **(** **)** const Returns ``true`` if a right click can select items. .. _class_Tree_get_column_at_position: -- :ref:`int` **get_column_at_position** **(** :ref:`Vector2` position **)** const +- :ref:`int` **get_column_at_position** **(** :ref:`Vector2` position **)** const Returns the column index under the given point. .. _class_Tree_get_column_title: -- :ref:`String` **get_column_title** **(** :ref:`int` column **)** const +- :ref:`String` **get_column_title** **(** :ref:`int` column **)** const Returns the column's title. .. _class_Tree_get_column_width: -- :ref:`int` **get_column_width** **(** :ref:`int` column **)** const +- :ref:`int` **get_column_width** **(** :ref:`int` column **)** const Returns the column's width in pixels. .. _class_Tree_get_columns: -- :ref:`int` **get_columns** **(** **)** const +- :ref:`int` **get_columns** **(** **)** const Returns the amount of columns. .. _class_Tree_get_custom_popup_rect: -- :ref:`Rect2` **get_custom_popup_rect** **(** **)** const +- :ref:`Rect2` **get_custom_popup_rect** **(** **)** const Returns the rectangle for custom popups. Helper to create custom cell controls that display a popup. See :ref:`TreeItem.set_cell_mode`. .. _class_Tree_get_drop_mode_flags: -- :ref:`int` **get_drop_mode_flags** **(** **)** const +- :ref:`int` **get_drop_mode_flags** **(** **)** const Returns the current drop mode's flags. .. _class_Tree_get_drop_section_at_position: -- :ref:`int` **get_drop_section_at_position** **(** :ref:`Vector2` position **)** const +- :ref:`int` **get_drop_section_at_position** **(** :ref:`Vector2` position **)** const .. _class_Tree_get_edited: -- :ref:`TreeItem` **get_edited** **(** **)** const +- :ref:`TreeItem` **get_edited** **(** **)** const Returns the currently edited item. This is only available for custom cell mode. .. _class_Tree_get_edited_column: -- :ref:`int` **get_edited_column** **(** **)** const +- :ref:`int` **get_edited_column** **(** **)** const Returns the column for the currently edited item. This is only available for custom cell mode. .. _class_Tree_get_item_area_rect: -- :ref:`Rect2` **get_item_area_rect** **(** :ref:`Object` item, :ref:`int` column=-1 **)** const +- :ref:`Rect2` **get_item_area_rect** **(** :ref:`Object` item, :ref:`int` column=-1 **)** const Returns the rectangle area for the specified item. If column is specified, only get the position and size of that column, otherwise get the rectangle containing all columns. .. _class_Tree_get_item_at_position: -- :ref:`TreeItem` **get_item_at_position** **(** :ref:`Vector2` position **)** const +- :ref:`TreeItem` **get_item_at_position** **(** :ref:`Vector2` position **)** const Returns the tree item at the specified position (relative to the tree origin position). .. _class_Tree_get_next_selected: -- :ref:`TreeItem` **get_next_selected** **(** :ref:`Object` from **)** +- :ref:`TreeItem` **get_next_selected** **(** :ref:`Object` from **)** Returns the next selected item after the given one. .. _class_Tree_get_pressed_button: -- :ref:`int` **get_pressed_button** **(** **)** const +- :ref:`int` **get_pressed_button** **(** **)** const Returns the last pressed button's index. .. _class_Tree_get_root: -- :ref:`TreeItem` **get_root** **(** **)** +- :ref:`TreeItem` **get_root** **(** **)** Returns the tree's root item. .. _class_Tree_get_scroll: -- :ref:`Vector2` **get_scroll** **(** **)** const +- :ref:`Vector2` **get_scroll** **(** **)** const Returns the current scrolling position. .. _class_Tree_get_selected: -- :ref:`TreeItem` **get_selected** **(** **)** const +- :ref:`TreeItem` **get_selected** **(** **)** const Returns the currently selected item. .. _class_Tree_get_selected_column: -- :ref:`int` **get_selected_column** **(** **)** const +- :ref:`int` **get_selected_column** **(** **)** const Returns the current selection's column. .. _class_Tree_is_folding_hidden: -- :ref:`bool` **is_folding_hidden** **(** **)** const +- :ref:`bool` **is_folding_hidden** **(** **)** const Returns ``true`` if the folding arrow is hidden. .. _class_Tree_set_allow_reselect: -- void **set_allow_reselect** **(** :ref:`bool` allow **)** +- void **set_allow_reselect** **(** :ref:`bool` allow **)** If ``true`` the currently selected cell may be selected again. .. _class_Tree_set_allow_rmb_select: -- void **set_allow_rmb_select** **(** :ref:`bool` allow **)** +- void **set_allow_rmb_select** **(** :ref:`bool` allow **)** If ``true`` a right mouse button click can select items. .. _class_Tree_set_column_expand: -- void **set_column_expand** **(** :ref:`int` column, :ref:`bool` expand **)** +- void **set_column_expand** **(** :ref:`int` column, :ref:`bool` expand **)** If ``true`` the column will have the "Expand" flag of :ref:`Control`. .. _class_Tree_set_column_min_width: -- void **set_column_min_width** **(** :ref:`int` column, :ref:`int` min_width **)** +- void **set_column_min_width** **(** :ref:`int` column, :ref:`int` min_width **)** Set the minimum width of a column. .. _class_Tree_set_column_title: -- void **set_column_title** **(** :ref:`int` column, :ref:`String` title **)** +- void **set_column_title** **(** :ref:`int` column, :ref:`String` title **)** Set the title of a column. .. _class_Tree_set_column_titles_visible: -- void **set_column_titles_visible** **(** :ref:`bool` visible **)** +- void **set_column_titles_visible** **(** :ref:`bool` visible **)** If ``true`` column titles are visible. .. _class_Tree_set_columns: -- void **set_columns** **(** :ref:`int` amount **)** +- void **set_columns** **(** :ref:`int` amount **)** Set the amount of columns. .. _class_Tree_set_drop_mode_flags: -- void **set_drop_mode_flags** **(** :ref:`int` flags **)** +- void **set_drop_mode_flags** **(** :ref:`int` flags **)** Set the drop mode as an OR combination of flags. See ``DROP_MODE\_\*`` constants. .. _class_Tree_set_hide_folding: -- void **set_hide_folding** **(** :ref:`bool` hide **)** +- void **set_hide_folding** **(** :ref:`bool` hide **)** If ``true`` the folding arrow is hidden. .. _class_Tree_set_hide_root: -- void **set_hide_root** **(** :ref:`bool` enable **)** +- void **set_hide_root** **(** :ref:`bool` enable **)** If ``true`` the tree's root is hidden. .. _class_Tree_set_select_mode: -- void **set_select_mode** **(** :ref:`int` mode **)** +- void **set_select_mode** **(** :ref:`int` mode **)** Allow single or multiple selection. See the ``SELECT\_\*`` constants. diff --git a/classes/class_treeitem.rst b/classes/class_treeitem.rst index fcc2ca5e9..f3cec7095 100644 --- a/classes/class_treeitem.rst +++ b/classes/class_treeitem.rst @@ -19,127 +19,127 @@ Control for a single item inside a :ref:`Tree`. Member Functions ---------------- -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_button` **(** :ref:`int` column, :ref:`Texture` button, :ref:`int` button_idx=-1, :ref:`bool` disabled=false, :ref:`String` tooltip="" **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_custom_bg_color` **(** :ref:`int` column **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_custom_color` **(** :ref:`int` column **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`deselect` **(** :ref:`int` column **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase_button` **(** :ref:`int` column, :ref:`int` button_idx **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_button` **(** :ref:`int` column, :ref:`int` button_idx **)** const | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_button_count` **(** :ref:`int` column **)** const | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_cell_mode` **(** :ref:`int` column **)** const | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_children` **(** **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_custom_bg_color` **(** :ref:`int` column **)** const | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_custom_minimum_height` **(** **)** const | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_expand_right` **(** :ref:`int` column **)** const | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_icon` **(** :ref:`int` column **)** const | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_icon_max_width` **(** :ref:`int` column **)** const | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_icon_region` **(** :ref:`int` column **)** const | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_metadata` **(** :ref:`int` column **)** const | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_next` **(** **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_next_visible` **(** **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_parent` **(** **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_prev` **(** **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_prev_visible` **(** **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_range` **(** :ref:`int` column **)** const | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_range_config` **(** :ref:`int` column **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_text` **(** :ref:`int` column **)** const | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_text_align` **(** :ref:`int` column **)** const | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_tooltip` **(** :ref:`int` column **)** const | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_button_disabled` **(** :ref:`int` column, :ref:`int` button_idx **)** const | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_checked` **(** :ref:`int` column **)** const | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_collapsed` **(** **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_custom_set_as_button` **(** :ref:`int` column **)** const | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_editable` **(** :ref:`int` column **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_folding_disabled` **(** **)** const | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_selectable` **(** :ref:`int` column **)** const | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_selected` **(** :ref:`int` column **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`move_to_bottom` **(** **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`move_to_top` **(** **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_child` **(** :ref:`Object` child **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`select` **(** :ref:`int` column **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_button` **(** :ref:`int` column, :ref:`int` button_idx, :ref:`Texture` button **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cell_mode` **(** :ref:`int` column, :ref:`int` mode **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_checked` **(** :ref:`int` column, :ref:`bool` checked **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collapsed` **(** :ref:`bool` enable **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_as_button` **(** :ref:`int` column, :ref:`bool` enable **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_bg_color` **(** :ref:`int` column, :ref:`Color` color, :ref:`bool` just_outline=false **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_color` **(** :ref:`int` column, :ref:`Color` color **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_draw` **(** :ref:`int` column, :ref:`Object` object, :ref:`String` callback **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_minimum_height` **(** :ref:`int` height **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_disable_folding` **(** :ref:`bool` disable **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_editable` **(** :ref:`int` column, :ref:`bool` enabled **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_expand_right` **(** :ref:`int` column, :ref:`bool` enable **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_icon` **(** :ref:`int` column, :ref:`Texture` texture **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_icon_max_width` **(** :ref:`int` column, :ref:`int` width **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_icon_region` **(** :ref:`int` column, :ref:`Rect2` region **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_metadata` **(** :ref:`int` column, :ref:`Variant` meta **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_range` **(** :ref:`int` column, :ref:`float` value **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_range_config` **(** :ref:`int` column, :ref:`float` min, :ref:`float` max, :ref:`float` step, :ref:`bool` expr=false **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_selectable` **(** :ref:`int` column, :ref:`bool` selectable **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_text` **(** :ref:`int` column, :ref:`String` text **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_text_align` **(** :ref:`int` column, :ref:`int` text_align **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tooltip` **(** :ref:`int` column, :ref:`String` tooltip **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_button` **(** :ref:`int` column, :ref:`Texture` button, :ref:`int` button_idx=-1, :ref:`bool` disabled=false, :ref:`String` tooltip="" **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_custom_bg_color` **(** :ref:`int` column **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_custom_color` **(** :ref:`int` column **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`deselect` **(** :ref:`int` column **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`erase_button` **(** :ref:`int` column, :ref:`int` button_idx **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_button` **(** :ref:`int` column, :ref:`int` button_idx **)** const | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_button_count` **(** :ref:`int` column **)** const | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_cell_mode` **(** :ref:`int` column **)** const | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_children` **(** **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_custom_bg_color` **(** :ref:`int` column **)** const | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_custom_minimum_height` **(** **)** const | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_expand_right` **(** :ref:`int` column **)** const | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_icon` **(** :ref:`int` column **)** const | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_icon_max_width` **(** :ref:`int` column **)** const | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_icon_region` **(** :ref:`int` column **)** const | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_metadata` **(** :ref:`int` column **)** const | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_next` **(** **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_next_visible` **(** **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_parent` **(** **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_prev` **(** **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_prev_visible` **(** **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_range` **(** :ref:`int` column **)** const | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_range_config` **(** :ref:`int` column **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_text` **(** :ref:`int` column **)** const | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_text_align` **(** :ref:`int` column **)** const | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_tooltip` **(** :ref:`int` column **)** const | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_button_disabled` **(** :ref:`int` column, :ref:`int` button_idx **)** const | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_checked` **(** :ref:`int` column **)** const | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_collapsed` **(** **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_custom_set_as_button` **(** :ref:`int` column **)** const | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_editable` **(** :ref:`int` column **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_folding_disabled` **(** **)** const | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_selectable` **(** :ref:`int` column **)** const | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_selected` **(** :ref:`int` column **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`move_to_bottom` **(** **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`move_to_top` **(** **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_child` **(** :ref:`Object` child **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`select` **(** :ref:`int` column **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_button` **(** :ref:`int` column, :ref:`int` button_idx, :ref:`Texture` button **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cell_mode` **(** :ref:`int` column, :ref:`int` mode **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_checked` **(** :ref:`int` column, :ref:`bool` checked **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collapsed` **(** :ref:`bool` enable **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_as_button` **(** :ref:`int` column, :ref:`bool` enable **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_bg_color` **(** :ref:`int` column, :ref:`Color` color, :ref:`bool` just_outline=false **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_color` **(** :ref:`int` column, :ref:`Color` color **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_draw` **(** :ref:`int` column, :ref:`Object` object, :ref:`String` callback **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_minimum_height` **(** :ref:`int` height **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_disable_folding` **(** :ref:`bool` disable **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_editable` **(** :ref:`int` column, :ref:`bool` enabled **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_expand_right` **(** :ref:`int` column, :ref:`bool` enable **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_icon` **(** :ref:`int` column, :ref:`Texture` texture **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_icon_max_width` **(** :ref:`int` column, :ref:`int` width **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_icon_region` **(** :ref:`int` column, :ref:`Rect2` region **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_metadata` **(** :ref:`int` column, :ref:`Variant` meta **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_range` **(** :ref:`int` column, :ref:`float` value **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_range_config` **(** :ref:`int` column, :ref:`float` min, :ref:`float` max, :ref:`float` step, :ref:`bool` expr=false **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_selectable` **(** :ref:`int` column, :ref:`bool` selectable **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_text` **(** :ref:`int` column, :ref:`String` text **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_text_align` **(** :ref:`int` column, :ref:`int` text_align **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tooltip` **(** :ref:`int` column, :ref:`String` tooltip **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -164,343 +164,343 @@ Member Function Description .. _class_TreeItem_add_button: -- void **add_button** **(** :ref:`int` column, :ref:`Texture` button, :ref:`int` button_idx=-1, :ref:`bool` disabled=false, :ref:`String` tooltip="" **)** +- void **add_button** **(** :ref:`int` column, :ref:`Texture` button, :ref:`int` button_idx=-1, :ref:`bool` disabled=false, :ref:`String` tooltip="" **)** Adds a button with :ref:`Texture` ``button`` at column ``column``. The ``button_idx`` index is used to identify the button when calling other methods. If not specified, the next available index is used, which may be retrieved by calling ``get_buton_count()`` immediately after this method. Optionally, the button can be ``disabled`` and have a ``tooltip``. .. _class_TreeItem_clear_custom_bg_color: -- void **clear_custom_bg_color** **(** :ref:`int` column **)** +- void **clear_custom_bg_color** **(** :ref:`int` column **)** Resets the background color for the given column to default. .. _class_TreeItem_clear_custom_color: -- void **clear_custom_color** **(** :ref:`int` column **)** +- void **clear_custom_color** **(** :ref:`int` column **)** Resets the color for the given column to default. .. _class_TreeItem_deselect: -- void **deselect** **(** :ref:`int` column **)** +- void **deselect** **(** :ref:`int` column **)** Deselects the given column. .. _class_TreeItem_erase_button: -- void **erase_button** **(** :ref:`int` column, :ref:`int` button_idx **)** +- void **erase_button** **(** :ref:`int` column, :ref:`int` button_idx **)** Removes the button at index ``button_idx`` in column ``column``. .. _class_TreeItem_get_button: -- :ref:`Texture` **get_button** **(** :ref:`int` column, :ref:`int` button_idx **)** const +- :ref:`Texture` **get_button** **(** :ref:`int` column, :ref:`int` button_idx **)** const Returns the :ref:`Texture` of the button at index ``button_idx`` in column ``column``. .. _class_TreeItem_get_button_count: -- :ref:`int` **get_button_count** **(** :ref:`int` column **)** const +- :ref:`int` **get_button_count** **(** :ref:`int` column **)** const Returns the number of buttons in column ``column``. May be used to get the most recently added button's index, if no index was specified. .. _class_TreeItem_get_cell_mode: -- :ref:`int` **get_cell_mode** **(** :ref:`int` column **)** const +- :ref:`int` **get_cell_mode** **(** :ref:`int` column **)** const Returns the column's cell mode. See ``CELL_MODE\_\*`` constants. .. _class_TreeItem_get_children: -- :ref:`TreeItem` **get_children** **(** **)** +- :ref:`TreeItem` **get_children** **(** **)** Returns the TreeItem's child items. .. _class_TreeItem_get_custom_bg_color: -- :ref:`Color` **get_custom_bg_color** **(** :ref:`int` column **)** const +- :ref:`Color` **get_custom_bg_color** **(** :ref:`int` column **)** const Returns the custom background color of column ``column``. .. _class_TreeItem_get_custom_minimum_height: -- :ref:`int` **get_custom_minimum_height** **(** **)** const +- :ref:`int` **get_custom_minimum_height** **(** **)** const Returns the custom minimum height. .. _class_TreeItem_get_expand_right: -- :ref:`bool` **get_expand_right** **(** :ref:`int` column **)** const +- :ref:`bool` **get_expand_right** **(** :ref:`int` column **)** const Returns ``true`` if ``expand_right`` is set. .. _class_TreeItem_get_icon: -- :ref:`Texture` **get_icon** **(** :ref:`int` column **)** const +- :ref:`Texture` **get_icon** **(** :ref:`int` column **)** const Returns the given column's icon :ref:`Texture`. Error if no icon is set. .. _class_TreeItem_get_icon_max_width: -- :ref:`int` **get_icon_max_width** **(** :ref:`int` column **)** const +- :ref:`int` **get_icon_max_width** **(** :ref:`int` column **)** const Returns the column's icon's maximum width. .. _class_TreeItem_get_icon_region: -- :ref:`Rect2` **get_icon_region** **(** :ref:`int` column **)** const +- :ref:`Rect2` **get_icon_region** **(** :ref:`int` column **)** const Returns the icon :ref:`Texture` region as :ref:`Rect2`. .. _class_TreeItem_get_metadata: -- :ref:`Variant` **get_metadata** **(** :ref:`int` column **)** const +- :ref:`Variant` **get_metadata** **(** :ref:`int` column **)** const .. _class_TreeItem_get_next: -- :ref:`TreeItem` **get_next** **(** **)** +- :ref:`TreeItem` **get_next** **(** **)** Returns the next TreeItem in the tree. .. _class_TreeItem_get_next_visible: -- :ref:`TreeItem` **get_next_visible** **(** **)** +- :ref:`TreeItem` **get_next_visible** **(** **)** Returns the next visible TreeItem in the tree. .. _class_TreeItem_get_parent: -- :ref:`TreeItem` **get_parent** **(** **)** +- :ref:`TreeItem` **get_parent** **(** **)** Returns the parent TreeItem. .. _class_TreeItem_get_prev: -- :ref:`TreeItem` **get_prev** **(** **)** +- :ref:`TreeItem` **get_prev** **(** **)** Returns the previous TreeItem in the tree. .. _class_TreeItem_get_prev_visible: -- :ref:`TreeItem` **get_prev_visible** **(** **)** +- :ref:`TreeItem` **get_prev_visible** **(** **)** Returns the previous visible TreeItem in the tree. .. _class_TreeItem_get_range: -- :ref:`float` **get_range** **(** :ref:`int` column **)** const +- :ref:`float` **get_range** **(** :ref:`int` column **)** const .. _class_TreeItem_get_range_config: -- :ref:`Dictionary` **get_range_config** **(** :ref:`int` column **)** +- :ref:`Dictionary` **get_range_config** **(** :ref:`int` column **)** .. _class_TreeItem_get_text: -- :ref:`String` **get_text** **(** :ref:`int` column **)** const +- :ref:`String` **get_text** **(** :ref:`int` column **)** const Returns the given column's text. .. _class_TreeItem_get_text_align: -- :ref:`int` **get_text_align** **(** :ref:`int` column **)** const +- :ref:`int` **get_text_align** **(** :ref:`int` column **)** const Returns the given column's text alignment. .. _class_TreeItem_get_tooltip: -- :ref:`String` **get_tooltip** **(** :ref:`int` column **)** const +- :ref:`String` **get_tooltip** **(** :ref:`int` column **)** const Returns the given column's tooltip. .. _class_TreeItem_is_button_disabled: -- :ref:`bool` **is_button_disabled** **(** :ref:`int` column, :ref:`int` button_idx **)** const +- :ref:`bool` **is_button_disabled** **(** :ref:`int` column, :ref:`int` button_idx **)** const Returns ``true`` if the button at index ``button_idx`` for the given column is disabled. .. _class_TreeItem_is_checked: -- :ref:`bool` **is_checked** **(** :ref:`int` column **)** const +- :ref:`bool` **is_checked** **(** :ref:`int` column **)** const Returns ``true`` if the given column is checked. .. _class_TreeItem_is_collapsed: -- :ref:`bool` **is_collapsed** **(** **)** +- :ref:`bool` **is_collapsed** **(** **)** Returns ``true`` if this TreeItem is collapsed. .. _class_TreeItem_is_custom_set_as_button: -- :ref:`bool` **is_custom_set_as_button** **(** :ref:`int` column **)** const +- :ref:`bool` **is_custom_set_as_button** **(** :ref:`int` column **)** const .. _class_TreeItem_is_editable: -- :ref:`bool` **is_editable** **(** :ref:`int` column **)** +- :ref:`bool` **is_editable** **(** :ref:`int` column **)** Returns ``true`` if column ``column`` is editable. .. _class_TreeItem_is_folding_disabled: -- :ref:`bool` **is_folding_disabled** **(** **)** const +- :ref:`bool` **is_folding_disabled** **(** **)** const Returns ``true`` if folding is disabled for this TreeItem. .. _class_TreeItem_is_selectable: -- :ref:`bool` **is_selectable** **(** :ref:`int` column **)** const +- :ref:`bool` **is_selectable** **(** :ref:`int` column **)** const Returns ``true`` if column ``column`` is selectable. .. _class_TreeItem_is_selected: -- :ref:`bool` **is_selected** **(** :ref:`int` column **)** +- :ref:`bool` **is_selected** **(** :ref:`int` column **)** Returns ``true`` if column ``column`` is selected. .. _class_TreeItem_move_to_bottom: -- void **move_to_bottom** **(** **)** +- void **move_to_bottom** **(** **)** Moves this TreeItem to the bottom in the :ref:`Tree` hierarchy. .. _class_TreeItem_move_to_top: -- void **move_to_top** **(** **)** +- void **move_to_top** **(** **)** Moves this TreeItem to the top in the :ref:`Tree` hierarchy. .. _class_TreeItem_remove_child: -- void **remove_child** **(** :ref:`Object` child **)** +- void **remove_child** **(** :ref:`Object` child **)** Removes the child TreeItem at index ``index``. .. _class_TreeItem_select: -- void **select** **(** :ref:`int` column **)** +- void **select** **(** :ref:`int` column **)** Selects the column ``column``. .. _class_TreeItem_set_button: -- void **set_button** **(** :ref:`int` column, :ref:`int` button_idx, :ref:`Texture` button **)** +- void **set_button** **(** :ref:`int` column, :ref:`int` button_idx, :ref:`Texture` button **)** Sets the given column's button :ref:`Texture` at index ``button_idx`` to ``button``. .. _class_TreeItem_set_cell_mode: -- void **set_cell_mode** **(** :ref:`int` column, :ref:`int` mode **)** +- void **set_cell_mode** **(** :ref:`int` column, :ref:`int` mode **)** Sets the given column's cell mode to ``mode``. See ``CELL_MODE\_\*`` constants. .. _class_TreeItem_set_checked: -- void **set_checked** **(** :ref:`int` column, :ref:`bool` checked **)** +- void **set_checked** **(** :ref:`int` column, :ref:`bool` checked **)** If ``true`` the column ``column`` is checked. .. _class_TreeItem_set_collapsed: -- void **set_collapsed** **(** :ref:`bool` enable **)** +- void **set_collapsed** **(** :ref:`bool` enable **)** If ``true`` the TreeItem is collapsed. .. _class_TreeItem_set_custom_as_button: -- void **set_custom_as_button** **(** :ref:`int` column, :ref:`bool` enable **)** +- void **set_custom_as_button** **(** :ref:`int` column, :ref:`bool` enable **)** .. _class_TreeItem_set_custom_bg_color: -- void **set_custom_bg_color** **(** :ref:`int` column, :ref:`Color` color, :ref:`bool` just_outline=false **)** +- void **set_custom_bg_color** **(** :ref:`int` column, :ref:`Color` color, :ref:`bool` just_outline=false **)** Sets the given column's custom background color and whether to just use it as an outline. .. _class_TreeItem_set_custom_color: -- void **set_custom_color** **(** :ref:`int` column, :ref:`Color` color **)** +- void **set_custom_color** **(** :ref:`int` column, :ref:`Color` color **)** Sets the given column's custom color. .. _class_TreeItem_set_custom_draw: -- void **set_custom_draw** **(** :ref:`int` column, :ref:`Object` object, :ref:`String` callback **)** +- void **set_custom_draw** **(** :ref:`int` column, :ref:`Object` object, :ref:`String` callback **)** Sets the given column's custom draw callback to ``callback`` method on ``object``. .. _class_TreeItem_set_custom_minimum_height: -- void **set_custom_minimum_height** **(** :ref:`int` height **)** +- void **set_custom_minimum_height** **(** :ref:`int` height **)** Sets the custom minimum height of this TreeItem. .. _class_TreeItem_set_disable_folding: -- void **set_disable_folding** **(** :ref:`bool` disable **)** +- void **set_disable_folding** **(** :ref:`bool` disable **)** If ``true`` folding is disabled for this TreeItem. .. _class_TreeItem_set_editable: -- void **set_editable** **(** :ref:`int` column, :ref:`bool` enabled **)** +- void **set_editable** **(** :ref:`int` column, :ref:`bool` enabled **)** If ``true`` column ``column`` is editable. .. _class_TreeItem_set_expand_right: -- void **set_expand_right** **(** :ref:`int` column, :ref:`bool` enable **)** +- void **set_expand_right** **(** :ref:`int` column, :ref:`bool` enable **)** If ``true`` column ``column`` is expanded to the right. .. _class_TreeItem_set_icon: -- void **set_icon** **(** :ref:`int` column, :ref:`Texture` texture **)** +- void **set_icon** **(** :ref:`int` column, :ref:`Texture` texture **)** Sets the given column's icon :ref:`Texture`. .. _class_TreeItem_set_icon_max_width: -- void **set_icon_max_width** **(** :ref:`int` column, :ref:`int` width **)** +- void **set_icon_max_width** **(** :ref:`int` column, :ref:`int` width **)** Sets the given column's icon's maximum width. .. _class_TreeItem_set_icon_region: -- void **set_icon_region** **(** :ref:`int` column, :ref:`Rect2` region **)** +- void **set_icon_region** **(** :ref:`int` column, :ref:`Rect2` region **)** Sets the given column's icon's texture region. .. _class_TreeItem_set_metadata: -- void **set_metadata** **(** :ref:`int` column, :ref:`Variant` meta **)** +- void **set_metadata** **(** :ref:`int` column, :ref:`Variant` meta **)** .. _class_TreeItem_set_range: -- void **set_range** **(** :ref:`int` column, :ref:`float` value **)** +- void **set_range** **(** :ref:`int` column, :ref:`float` value **)** .. _class_TreeItem_set_range_config: -- void **set_range_config** **(** :ref:`int` column, :ref:`float` min, :ref:`float` max, :ref:`float` step, :ref:`bool` expr=false **)** +- void **set_range_config** **(** :ref:`int` column, :ref:`float` min, :ref:`float` max, :ref:`float` step, :ref:`bool` expr=false **)** .. _class_TreeItem_set_selectable: -- void **set_selectable** **(** :ref:`int` column, :ref:`bool` selectable **)** +- void **set_selectable** **(** :ref:`int` column, :ref:`bool` selectable **)** If ``true`` the given column is selectable. .. _class_TreeItem_set_text: -- void **set_text** **(** :ref:`int` column, :ref:`String` text **)** +- void **set_text** **(** :ref:`int` column, :ref:`String` text **)** .. _class_TreeItem_set_text_align: -- void **set_text_align** **(** :ref:`int` column, :ref:`int` text_align **)** +- void **set_text_align** **(** :ref:`int` column, :ref:`int` text_align **)** Sets the given column's text alignment. See ``ALIGN\_\*`` constants. .. _class_TreeItem_set_tooltip: -- void **set_tooltip** **(** :ref:`int` column, :ref:`String` tooltip **)** +- void **set_tooltip** **(** :ref:`int` column, :ref:`String` tooltip **)** Sets the given column's tooltip text. diff --git a/classes/class_tween.rst b/classes/class_tween.rst index 48bbf42ab..a210ebfa3 100644 --- a/classes/class_tween.rst +++ b/classes/class_tween.rst @@ -19,82 +19,82 @@ Node useful for animations with unknown start and end points. Member Functions ---------------- -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`follow_method` **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`String` target_method, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`follow_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`String` target_property, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_runtime` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_speed_scale` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_tween_process_mode` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`interpolate_callback` **(** :ref:`Object` object, :ref:`float` duration, :ref:`String` callback, :ref:`Variant` arg1=null, :ref:`Variant` arg2=null, :ref:`Variant` arg3=null, :ref:`Variant` arg4=null, :ref:`Variant` arg5=null **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`interpolate_deferred_callback` **(** :ref:`Object` object, :ref:`float` duration, :ref:`String` callback, :ref:`Variant` arg1=null, :ref:`Variant` arg2=null, :ref:`Variant` arg3=null, :ref:`Variant` arg4=null, :ref:`Variant` arg5=null **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`interpolate_method` **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`interpolate_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_active` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_repeat` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`remove` **(** :ref:`Object` object, :ref:`String` key="" **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`remove_all` **(** **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`reset` **(** :ref:`Object` object, :ref:`String` key="" **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`reset_all` **(** **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`resume` **(** :ref:`Object` object, :ref:`String` key="" **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`resume_all` **(** **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`seek` **(** :ref:`float` time **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_active` **(** :ref:`bool` active **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_repeat` **(** :ref:`bool` repeat **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_speed_scale` **(** :ref:`float` speed **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tween_process_mode` **(** :ref:`int` mode **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`start` **(** **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`stop` **(** :ref:`Object` object, :ref:`String` key="" **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`stop_all` **(** **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`targeting_method` **(** :ref:`Object` object, :ref:`String` method, :ref:`Object` initial, :ref:`String` initial_method, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`targeting_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Object` initial, :ref:`String` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`tell` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`follow_method` **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`String` target_method, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`follow_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`String` target_property, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_runtime` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_speed_scale` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_tween_process_mode` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`interpolate_callback` **(** :ref:`Object` object, :ref:`float` duration, :ref:`String` callback, :ref:`Variant` arg1=null, :ref:`Variant` arg2=null, :ref:`Variant` arg3=null, :ref:`Variant` arg4=null, :ref:`Variant` arg5=null **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`interpolate_deferred_callback` **(** :ref:`Object` object, :ref:`float` duration, :ref:`String` callback, :ref:`Variant` arg1=null, :ref:`Variant` arg2=null, :ref:`Variant` arg3=null, :ref:`Variant` arg4=null, :ref:`Variant` arg5=null **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`interpolate_method` **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`interpolate_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_active` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_repeat` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`remove` **(** :ref:`Object` object, :ref:`String` key="" **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`remove_all` **(** **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`reset` **(** :ref:`Object` object, :ref:`String` key="" **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`reset_all` **(** **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`resume` **(** :ref:`Object` object, :ref:`String` key="" **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`resume_all` **(** **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`seek` **(** :ref:`float` time **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_active` **(** :ref:`bool` active **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_repeat` **(** :ref:`bool` repeat **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_speed_scale` **(** :ref:`float` speed **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tween_process_mode` **(** :ref:`int` mode **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`start` **(** **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`stop` **(** :ref:`Object` object, :ref:`String` key="" **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`stop_all` **(** **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`targeting_method` **(** :ref:`Object` object, :ref:`String` method, :ref:`Object` initial, :ref:`String` initial_method, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`targeting_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Object` initial, :ref:`String` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`tell` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_Tween_tween_completed: -- **tween_completed** **(** :ref:`Object` object, :ref:`String` key **)** +- **tween_completed** **(** :ref:`Object` object, :ref:`String` key **)** This signal is emitted when a tween ends. .. _class_Tween_tween_started: -- **tween_started** **(** :ref:`Object` object, :ref:`String` key **)** +- **tween_started** **(** :ref:`Object` object, :ref:`String` key **)** This signal is emitted when a tween starts. .. _class_Tween_tween_step: -- **tween_step** **(** :ref:`Object` object, :ref:`String` key, :ref:`float` elapsed, :ref:`Object` value **)** +- **tween_step** **(** :ref:`Object` object, :ref:`String` key, :ref:`float` elapsed, :ref:`Object` value **)** This signal is emitted each step of the tweening. @@ -150,7 +150,7 @@ Member Function Description .. _class_Tween_follow_method: -- :ref:`bool` **follow_method** **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`String` target_method, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** +- :ref:`bool` **follow_method** **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`String` target_method, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** Follow ``method`` of ``object`` and apply the returned value on ``target_method`` of ``target``, beginning from ``initial_val`` for ``duration`` seconds, ``delay`` later. Methods are animated by calling them with consequitive values. @@ -158,7 +158,7 @@ Follow ``method`` of ``object`` and apply the returned value on ``target_method` .. _class_Tween_follow_property: -- :ref:`bool` **follow_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`String` target_property, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** +- :ref:`bool` **follow_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`String` target_property, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** Follow ``property`` of ``object`` and apply it on ``target_property`` of ``target``, beginning from ``initial_val`` for ``duration`` seconds, ``delay`` seconds later. Note that ``target:target_property`` would equal ``object:property`` at the end of the tween. @@ -166,37 +166,37 @@ Follow ``property`` of ``object`` and apply it on ``target_property`` of ``targe .. _class_Tween_get_runtime: -- :ref:`float` **get_runtime** **(** **)** const +- :ref:`float` **get_runtime** **(** **)** const Returns the time needed for all tweens to end in seconds, measured from the start. Thus, if you have two tweens, one ending 10 seconds after the start and the other - 20 seconds, it would return 20 seconds, as by that time all tweens would have finished. .. _class_Tween_get_speed_scale: -- :ref:`float` **get_speed_scale** **(** **)** const +- :ref:`float` **get_speed_scale** **(** **)** const Returns the speed that has been set from editor GUI or :ref:`set_repeat`. .. _class_Tween_get_tween_process_mode: -- :ref:`int` **get_tween_process_mode** **(** **)** const +- :ref:`int` **get_tween_process_mode** **(** **)** const Returns the process mode that has been set from editor GUI or :ref:`set_tween_process_mode` .. _class_Tween_interpolate_callback: -- :ref:`bool` **interpolate_callback** **(** :ref:`Object` object, :ref:`float` duration, :ref:`String` callback, :ref:`Variant` arg1=null, :ref:`Variant` arg2=null, :ref:`Variant` arg3=null, :ref:`Variant` arg4=null, :ref:`Variant` arg5=null **)** +- :ref:`bool` **interpolate_callback** **(** :ref:`Object` object, :ref:`float` duration, :ref:`String` callback, :ref:`Variant` arg1=null, :ref:`Variant` arg2=null, :ref:`Variant` arg3=null, :ref:`Variant` arg4=null, :ref:`Variant` arg5=null **)** Call ``callback`` of ``object`` after ``duration``. ``arg1``-``arg5`` are arguments to be passed to the callback. .. _class_Tween_interpolate_deferred_callback: -- :ref:`bool` **interpolate_deferred_callback** **(** :ref:`Object` object, :ref:`float` duration, :ref:`String` callback, :ref:`Variant` arg1=null, :ref:`Variant` arg2=null, :ref:`Variant` arg3=null, :ref:`Variant` arg4=null, :ref:`Variant` arg5=null **)** +- :ref:`bool` **interpolate_deferred_callback** **(** :ref:`Object` object, :ref:`float` duration, :ref:`String` callback, :ref:`Variant` arg1=null, :ref:`Variant` arg2=null, :ref:`Variant` arg3=null, :ref:`Variant` arg4=null, :ref:`Variant` arg5=null **)** Call ``callback`` of ``object`` after ``duration`` on the main thread (similar to :ref:`Object.call_deferred`). ``arg1``-``arg5`` are arguments to be passed to the callback. .. _class_Tween_interpolate_method: -- :ref:`bool` **interpolate_method** **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** +- :ref:`bool` **interpolate_method** **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** Animate ``method`` of ``object`` from ``initial_val`` to ``final_val`` for ``duration`` seconds, ``delay`` seconds later. Methods are animated by calling them with consecutive values. @@ -204,7 +204,7 @@ Animate ``method`` of ``object`` from ``initial_val`` to ``final_val`` for ``dur .. _class_Tween_interpolate_property: -- :ref:`bool` **interpolate_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** +- :ref:`bool` **interpolate_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** Animate ``property`` of ``object`` from ``initial_val`` to ``final_val`` for ``duration`` seconds, ``delay`` seconds later. @@ -212,103 +212,103 @@ Animate ``property`` of ``object`` from ``initial_val`` to ``final_val`` for ``d .. _class_Tween_is_active: -- :ref:`bool` **is_active** **(** **)** const +- :ref:`bool` **is_active** **(** **)** const Returns true if any tweens are currently running, and false otherwise. Note that this method doesn't consider tweens that have ended. .. _class_Tween_is_repeat: -- :ref:`bool` **is_repeat** **(** **)** const +- :ref:`bool` **is_repeat** **(** **)** const Returns true if repeat has been set from editor GUI or :ref:`set_repeat`. .. _class_Tween_remove: -- :ref:`bool` **remove** **(** :ref:`Object` object, :ref:`String` key="" **)** +- :ref:`bool` **remove** **(** :ref:`Object` object, :ref:`String` key="" **)** Stop animating and completely remove a tween, given its object and property/method pair. Passing empty String as key will remove all tweens for given object. .. _class_Tween_remove_all: -- :ref:`bool` **remove_all** **(** **)** +- :ref:`bool` **remove_all** **(** **)** Stop animating and completely remove all tweens. .. _class_Tween_reset: -- :ref:`bool` **reset** **(** :ref:`Object` object, :ref:`String` key="" **)** +- :ref:`bool` **reset** **(** :ref:`Object` object, :ref:`String` key="" **)** Resets a tween to the initial value (the one given, not the one before the tween), given its object and property/method pair. Passing empty String as key will reset all tweens for given object. .. _class_Tween_reset_all: -- :ref:`bool` **reset_all** **(** **)** +- :ref:`bool` **reset_all** **(** **)** Resets all tweens to their initial values (the ones given, not those before the tween). .. _class_Tween_resume: -- :ref:`bool` **resume** **(** :ref:`Object` object, :ref:`String` key="" **)** +- :ref:`bool` **resume** **(** :ref:`Object` object, :ref:`String` key="" **)** Continue animating a stopped tween, given its object and property/method pair. Passing empty String as key will resume all tweens for given object. .. _class_Tween_resume_all: -- :ref:`bool` **resume_all** **(** **)** +- :ref:`bool` **resume_all** **(** **)** Continue animating all stopped tweens. .. _class_Tween_seek: -- :ref:`bool` **seek** **(** :ref:`float` time **)** +- :ref:`bool` **seek** **(** :ref:`float` time **)** Seek the animation to the given ``time`` in seconds. .. _class_Tween_set_active: -- void **set_active** **(** :ref:`bool` active **)** +- void **set_active** **(** :ref:`bool` active **)** Activate/deactivate the tween. You can use this for pausing animations, though :ref:`stop_all` and :ref:`resume_all` might be more fit for this. .. _class_Tween_set_repeat: -- void **set_repeat** **(** :ref:`bool` repeat **)** +- void **set_repeat** **(** :ref:`bool` repeat **)** Make the tween repeat after all tweens have finished. .. _class_Tween_set_speed_scale: -- void **set_speed_scale** **(** :ref:`float` speed **)** +- void **set_speed_scale** **(** :ref:`float` speed **)** Set the speed multiplier of the tween. Set it to 1 for normal speed, 2 for two times nromal speed, and 0.5 for half of the normal speed. Setting it to 0 would pause the animation, but you might consider using :ref:`set_active` or :ref:`stop_all` and :ref:`resume_all` for this. .. _class_Tween_set_tween_process_mode: -- void **set_tween_process_mode** **(** :ref:`int` mode **)** +- void **set_tween_process_mode** **(** :ref:`int` mode **)** Set whether the Tween uses ``_process`` or ``_physics_process`` (accepts TWEEN_PROCESS_IDLE and TWEEN_PROCESS_PHYSICS constants, respectively). .. _class_Tween_start: -- :ref:`bool` **start** **(** **)** +- :ref:`bool` **start** **(** **)** Start the tween node. You can define tweens both before and after this. .. _class_Tween_stop: -- :ref:`bool` **stop** **(** :ref:`Object` object, :ref:`String` key="" **)** +- :ref:`bool` **stop** **(** :ref:`Object` object, :ref:`String` key="" **)** Stop animating a tween, given its object and property/method pair. Passing empty String as key will stop all tweens for given object. .. _class_Tween_stop_all: -- :ref:`bool` **stop_all** **(** **)** +- :ref:`bool` **stop_all** **(** **)** Stop animating all tweens. .. _class_Tween_targeting_method: -- :ref:`bool` **targeting_method** **(** :ref:`Object` object, :ref:`String` method, :ref:`Object` initial, :ref:`String` initial_method, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** +- :ref:`bool` **targeting_method** **(** :ref:`Object` object, :ref:`String` method, :ref:`Object` initial, :ref:`String` initial_method, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** Animate ``method`` of ``object`` from the value returned by ``initial.initial_method`` to ``final_val`` for ``duration`` seconds, ``delay`` seconds later. Methods are animated by calling them with consecutive values. @@ -316,7 +316,7 @@ Animate ``method`` of ``object`` from the value returned by ``initial.initial_me .. _class_Tween_targeting_property: -- :ref:`bool` **targeting_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Object` initial, :ref:`String` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** +- :ref:`bool` **targeting_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Object` initial, :ref:`String` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** Animate ``property`` of ``object`` from the current value of the ``initial_val`` property of ``initial`` to ``final_val`` for ``duration`` seconds, ``delay`` seconds later. @@ -324,7 +324,7 @@ Animate ``property`` of ``object`` from the current value of the ``initial_val`` .. _class_Tween_tell: -- :ref:`float` **tell** **(** **)** const +- :ref:`float` **tell** **(** **)** const Returns the current time of the tween. diff --git a/classes/class_undoredo.rst b/classes/class_undoredo.rst index d94167de7..1938acda6 100644 --- a/classes/class_undoredo.rst +++ b/classes/class_undoredo.rst @@ -19,37 +19,37 @@ Helper to manage UndoRedo in the editor or custom tools. Member Functions ---------------- -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`add_do_method` **(** :ref:`Object` object, :ref:`String` method **)** vararg | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_do_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_do_reference` **(** :ref:`Object` object **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`add_undo_method` **(** :ref:`Object` object, :ref:`String` method **)** vararg | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_undo_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_undo_reference` **(** :ref:`Object` object **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_history` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`commit_action` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_action` **(** :ref:`String` name, :ref:`int` merge_mode=0 **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_current_action_name` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_max_steps` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_version` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`redo` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_max_steps` **(** :ref:`int` max_steps **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`undo` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`add_do_method` **(** :ref:`Object` object, :ref:`String` method **)** vararg | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_do_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_do_reference` **(** :ref:`Object` object **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`add_undo_method` **(** :ref:`Object` object, :ref:`String` method **)** vararg | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_undo_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_undo_reference` **(** :ref:`Object` object **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_history` **(** **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`commit_action` **(** **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create_action` **(** :ref:`String` name, :ref:`int` merge_mode=0 **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_current_action_name` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_max_steps` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_version` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`redo` **(** **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_max_steps` **(** :ref:`int` max_steps **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`undo` **(** **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -70,67 +70,67 @@ Member Function Description .. _class_UndoRedo_add_do_method: -- :ref:`Variant` **add_do_method** **(** :ref:`Object` object, :ref:`String` method **)** vararg +- :ref:`Variant` **add_do_method** **(** :ref:`Object` object, :ref:`String` method **)** vararg .. _class_UndoRedo_add_do_property: -- void **add_do_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** +- void **add_do_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** Set a property with a custom value. .. _class_UndoRedo_add_do_reference: -- void **add_do_reference** **(** :ref:`Object` object **)** +- void **add_do_reference** **(** :ref:`Object` object **)** Add a 'do' reference that will be erased if the 'do' history is lost. This is useful mostly for new nodes created for the 'do' call. Do not use for resources. .. _class_UndoRedo_add_undo_method: -- :ref:`Variant` **add_undo_method** **(** :ref:`Object` object, :ref:`String` method **)** vararg +- :ref:`Variant` **add_undo_method** **(** :ref:`Object` object, :ref:`String` method **)** vararg .. _class_UndoRedo_add_undo_property: -- void **add_undo_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** +- void **add_undo_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** Undo setting of a property with a custom value. .. _class_UndoRedo_add_undo_reference: -- void **add_undo_reference** **(** :ref:`Object` object **)** +- void **add_undo_reference** **(** :ref:`Object` object **)** Add an 'undo' reference that will be erased if the 'undo' history is lost. This is useful mostly for nodes removed with the 'do' call (not the 'undo' call!). .. _class_UndoRedo_clear_history: -- void **clear_history** **(** **)** +- void **clear_history** **(** **)** Clear the undo/redo history and associated references. .. _class_UndoRedo_commit_action: -- void **commit_action** **(** **)** +- void **commit_action** **(** **)** Commit the action. All 'do' methods/properties are called/set when this function is called. .. _class_UndoRedo_create_action: -- void **create_action** **(** :ref:`String` name, :ref:`int` merge_mode=0 **)** +- void **create_action** **(** :ref:`String` name, :ref:`int` merge_mode=0 **)** Create a new action. After this is called, do all your calls to :ref:`add_do_method`, :ref:`add_undo_method`, :ref:`add_do_property` and :ref:`add_undo_property`. .. _class_UndoRedo_get_current_action_name: -- :ref:`String` **get_current_action_name** **(** **)** const +- :ref:`String` **get_current_action_name** **(** **)** const Get the name of the current action. .. _class_UndoRedo_get_max_steps: -- :ref:`int` **get_max_steps** **(** **)** const +- :ref:`int` **get_max_steps** **(** **)** const .. _class_UndoRedo_get_version: -- :ref:`int` **get_version** **(** **)** const +- :ref:`int` **get_version** **(** **)** const Get the version, each time a new action is committed, the version number of the UndoRedo is increased automatically. @@ -138,14 +138,14 @@ This is useful mostly to check if something changed from a saved version. .. _class_UndoRedo_redo: -- void **redo** **(** **)** +- void **redo** **(** **)** .. _class_UndoRedo_set_max_steps: -- void **set_max_steps** **(** :ref:`int` max_steps **)** +- void **set_max_steps** **(** :ref:`int` max_steps **)** .. _class_UndoRedo_undo: -- void **undo** **(** **)** +- void **undo** **(** **)** diff --git a/classes/class_vector2.rst b/classes/class_vector2.rst index 54b193388..3e7eb6c4a 100644 --- a/classes/class_vector2.rst +++ b/classes/class_vector2.rst @@ -17,53 +17,53 @@ Vector used for 2D Math. Member Functions ---------------- -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`Vector2` **(** :ref:`float` x, :ref:`float` y **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`abs` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angle` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angle_to` **(** :ref:`Vector2` to **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angle_to_point` **(** :ref:`Vector2` to **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`aspect` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`bounce` **(** :ref:`Vector2` n **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`clamped` **(** :ref:`float` length **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`cubic_interpolate` **(** :ref:`Vector2` b, :ref:`Vector2` pre_a, :ref:`Vector2` post_b, :ref:`float` t **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`distance_squared_to` **(** :ref:`Vector2` to **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`distance_to` **(** :ref:`Vector2` to **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`dot` **(** :ref:`Vector2` with **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`floor` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_normalized` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`length` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`length_squared` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`linear_interpolate` **(** :ref:`Vector2` b, :ref:`float` t **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`normalized` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`reflect` **(** :ref:`Vector2` n **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`rotated` **(** :ref:`float` phi **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`slide` **(** :ref:`Vector2` n **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`snapped` **(** :ref:`Vector2` by **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`tangent` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`Vector2` **(** :ref:`float` x, :ref:`float` y **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`abs` **(** **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angle` **(** **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angle_to` **(** :ref:`Vector2` to **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angle_to_point` **(** :ref:`Vector2` to **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`aspect` **(** **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`bounce` **(** :ref:`Vector2` n **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`clamped` **(** :ref:`float` length **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`cubic_interpolate` **(** :ref:`Vector2` b, :ref:`Vector2` pre_a, :ref:`Vector2` post_b, :ref:`float` t **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`distance_squared_to` **(** :ref:`Vector2` to **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`distance_to` **(** :ref:`Vector2` to **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`dot` **(** :ref:`Vector2` with **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`floor` **(** **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_normalized` **(** **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`length` **(** **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`length_squared` **(** **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`linear_interpolate` **(** :ref:`Vector2` b, :ref:`float` t **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`normalized` **(** **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`reflect` **(** :ref:`Vector2` n **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`rotated` **(** :ref:`float` phi **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`slide` **(** :ref:`Vector2` n **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`snapped` **(** :ref:`Vector2` by **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`tangent` **(** **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -87,19 +87,19 @@ Member Function Description .. _class_Vector2_Vector2: -- :ref:`Vector2` **Vector2** **(** :ref:`float` x, :ref:`float` y **)** +- :ref:`Vector2` **Vector2** **(** :ref:`float` x, :ref:`float` y **)** Constructs a new Vector2 from the given x and y. .. _class_Vector2_abs: -- :ref:`Vector2` **abs** **(** **)** +- :ref:`Vector2` **abs** **(** **)** Returns a new vector with all components in absolute values (i.e. positive). .. _class_Vector2_angle: -- :ref:`float` **angle** **(** **)** +- :ref:`float` **angle** **(** **)** Returns the result of atan2 when called with the Vector's x and y as parameters (Math::atan2(x,y)). @@ -107,121 +107,121 @@ Be aware that it therefore returns an angle oriented clockwise with regard to th .. _class_Vector2_angle_to: -- :ref:`float` **angle_to** **(** :ref:`Vector2` to **)** +- :ref:`float` **angle_to** **(** :ref:`Vector2` to **)** Returns the angle in radians between the two vectors. .. _class_Vector2_angle_to_point: -- :ref:`float` **angle_to_point** **(** :ref:`Vector2` to **)** +- :ref:`float` **angle_to_point** **(** :ref:`Vector2` to **)** Returns the angle in radians between the line connecting the two points and the x coordinate. .. _class_Vector2_aspect: -- :ref:`float` **aspect** **(** **)** +- :ref:`float` **aspect** **(** **)** Returns the ratio of X to Y. .. _class_Vector2_bounce: -- :ref:`Vector2` **bounce** **(** :ref:`Vector2` n **)** +- :ref:`Vector2` **bounce** **(** :ref:`Vector2` n **)** Bounce returns the vector "bounced off" from the given plane, specified by its normal vector. .. _class_Vector2_clamped: -- :ref:`Vector2` **clamped** **(** :ref:`float` length **)** +- :ref:`Vector2` **clamped** **(** :ref:`float` length **)** Returns the vector with a maximum length. .. _class_Vector2_cubic_interpolate: -- :ref:`Vector2` **cubic_interpolate** **(** :ref:`Vector2` b, :ref:`Vector2` pre_a, :ref:`Vector2` post_b, :ref:`float` t **)** +- :ref:`Vector2` **cubic_interpolate** **(** :ref:`Vector2` b, :ref:`Vector2` pre_a, :ref:`Vector2` post_b, :ref:`float` t **)** Cubicly interpolates between this Vector and "b", using "pre_a" and "post_b" as handles, and returning the result at position "t". .. _class_Vector2_distance_squared_to: -- :ref:`float` **distance_squared_to** **(** :ref:`Vector2` to **)** +- :ref:`float` **distance_squared_to** **(** :ref:`Vector2` to **)** Returns the squared distance to vector "b". Prefer this function over "distance_to" if you need to sort vectors or need the squared distance for some formula. .. _class_Vector2_distance_to: -- :ref:`float` **distance_to** **(** :ref:`Vector2` to **)** +- :ref:`float` **distance_to** **(** :ref:`Vector2` to **)** Returns the distance to vector "b". .. _class_Vector2_dot: -- :ref:`float` **dot** **(** :ref:`Vector2` with **)** +- :ref:`float` **dot** **(** :ref:`Vector2` with **)** Returns the dot product with vector "b". .. _class_Vector2_floor: -- :ref:`Vector2` **floor** **(** **)** +- :ref:`Vector2` **floor** **(** **)** Remove the fractional part of x and y. .. _class_Vector2_is_normalized: -- :ref:`bool` **is_normalized** **(** **)** +- :ref:`bool` **is_normalized** **(** **)** Returns whether the vector is normalized or not. .. _class_Vector2_length: -- :ref:`float` **length** **(** **)** +- :ref:`float` **length** **(** **)** Returns the length of the vector. .. _class_Vector2_length_squared: -- :ref:`float` **length_squared** **(** **)** +- :ref:`float` **length_squared** **(** **)** Returns the squared length of the vector. Prefer this function over "length" if you need to sort vectors or need the squared length for some formula. .. _class_Vector2_linear_interpolate: -- :ref:`Vector2` **linear_interpolate** **(** :ref:`Vector2` b, :ref:`float` t **)** +- :ref:`Vector2` **linear_interpolate** **(** :ref:`Vector2` b, :ref:`float` t **)** Returns the result of the linear interpolation between this vector and "b", by amount "t". .. _class_Vector2_normalized: -- :ref:`Vector2` **normalized** **(** **)** +- :ref:`Vector2` **normalized** **(** **)** Returns a normalized vector to unit length. .. _class_Vector2_reflect: -- :ref:`Vector2` **reflect** **(** :ref:`Vector2` n **)** +- :ref:`Vector2` **reflect** **(** :ref:`Vector2` n **)** Reflects the vector along the given plane, specified by its normal vector. .. _class_Vector2_rotated: -- :ref:`Vector2` **rotated** **(** :ref:`float` phi **)** +- :ref:`Vector2` **rotated** **(** :ref:`float` phi **)** Rotates the vector by "phi" radians. .. _class_Vector2_slide: -- :ref:`Vector2` **slide** **(** :ref:`Vector2` n **)** +- :ref:`Vector2` **slide** **(** :ref:`Vector2` n **)** Slide returns the component of the vector along the given plane, specified by its normal vector. .. _class_Vector2_snapped: -- :ref:`Vector2` **snapped** **(** :ref:`Vector2` by **)** +- :ref:`Vector2` **snapped** **(** :ref:`Vector2` by **)** Snaps the vector to a grid with the given size. .. _class_Vector2_tangent: -- :ref:`Vector2` **tangent** **(** **)** +- :ref:`Vector2` **tangent** **(** **)** Returns a perpendicular vector. diff --git a/classes/class_vector3.rst b/classes/class_vector3.rst index 1a399cf72..ac18969bd 100644 --- a/classes/class_vector3.rst +++ b/classes/class_vector3.rst @@ -17,57 +17,57 @@ Vector class, which performs basic 3D vector math operations. Member Functions ---------------- -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`Vector3` **(** :ref:`float` x, :ref:`float` y, :ref:`float` z **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`abs` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angle_to` **(** :ref:`Vector3` to **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`bounce` **(** :ref:`Vector3` n **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`ceil` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`cross` **(** :ref:`Vector3` b **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`cubic_interpolate` **(** :ref:`Vector3` b, :ref:`Vector3` pre_a, :ref:`Vector3` post_b, :ref:`float` t **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`distance_squared_to` **(** :ref:`Vector3` b **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`distance_to` **(** :ref:`Vector3` b **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`dot` **(** :ref:`Vector3` b **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`floor` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`inverse` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_normalized` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`length` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`length_squared` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`linear_interpolate` **(** :ref:`Vector3` b, :ref:`float` t **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`max_axis` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`min_axis` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`normalized` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`outer` **(** :ref:`Vector3` b **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`reflect` **(** :ref:`Vector3` n **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`rotated` **(** :ref:`Vector3` axis, :ref:`float` phi **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`slide` **(** :ref:`Vector3` n **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`snapped` **(** :ref:`float` by **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`to_diagonal_matrix` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`Vector3` **(** :ref:`float` x, :ref:`float` y, :ref:`float` z **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`abs` **(** **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angle_to` **(** :ref:`Vector3` to **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`bounce` **(** :ref:`Vector3` n **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`ceil` **(** **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`cross` **(** :ref:`Vector3` b **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`cubic_interpolate` **(** :ref:`Vector3` b, :ref:`Vector3` pre_a, :ref:`Vector3` post_b, :ref:`float` t **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`distance_squared_to` **(** :ref:`Vector3` b **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`distance_to` **(** :ref:`Vector3` b **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`dot` **(** :ref:`Vector3` b **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`floor` **(** **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`inverse` **(** **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_normalized` **(** **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`length` **(** **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`length_squared` **(** **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`linear_interpolate` **(** :ref:`Vector3` b, :ref:`float` t **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`max_axis` **(** **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`min_axis` **(** **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`normalized` **(** **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`outer` **(** :ref:`Vector3` b **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`reflect` **(** :ref:`Vector3` n **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`rotated` **(** :ref:`Vector3` axis, :ref:`float` phi **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`slide` **(** :ref:`Vector3` n **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`snapped` **(** :ref:`float` by **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`to_diagonal_matrix` **(** **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -102,149 +102,149 @@ Member Function Description .. _class_Vector3_Vector3: -- :ref:`Vector3` **Vector3** **(** :ref:`float` x, :ref:`float` y, :ref:`float` z **)** +- :ref:`Vector3` **Vector3** **(** :ref:`float` x, :ref:`float` y, :ref:`float` z **)** Returns a Vector3 with the given components. .. _class_Vector3_abs: -- :ref:`Vector3` **abs** **(** **)** +- :ref:`Vector3` **abs** **(** **)** Returns a new vector with all components in absolute values (i.e. positive). .. _class_Vector3_angle_to: -- :ref:`float` **angle_to** **(** :ref:`Vector3` to **)** +- :ref:`float` **angle_to** **(** :ref:`Vector3` to **)** .. _class_Vector3_bounce: -- :ref:`Vector3` **bounce** **(** :ref:`Vector3` n **)** +- :ref:`Vector3` **bounce** **(** :ref:`Vector3` n **)** Bounce returns the vector "bounced off" from the given plane, specified by its normal vector. .. _class_Vector3_ceil: -- :ref:`Vector3` **ceil** **(** **)** +- :ref:`Vector3` **ceil** **(** **)** Returns a new vector with all components rounded up. .. _class_Vector3_cross: -- :ref:`Vector3` **cross** **(** :ref:`Vector3` b **)** +- :ref:`Vector3` **cross** **(** :ref:`Vector3` b **)** Return the cross product with b. .. _class_Vector3_cubic_interpolate: -- :ref:`Vector3` **cubic_interpolate** **(** :ref:`Vector3` b, :ref:`Vector3` pre_a, :ref:`Vector3` post_b, :ref:`float` t **)** +- :ref:`Vector3` **cubic_interpolate** **(** :ref:`Vector3` b, :ref:`Vector3` pre_a, :ref:`Vector3` post_b, :ref:`float` t **)** Perform a cubic interpolation between vectors pre_a, a, b, post_b (a is current), by the given amount (t). .. _class_Vector3_distance_squared_to: -- :ref:`float` **distance_squared_to** **(** :ref:`Vector3` b **)** +- :ref:`float` **distance_squared_to** **(** :ref:`Vector3` b **)** Return the squared distance (distance minus the last square root) to b. Prefer this function over distance_to if you need to sort vectors or need the squared distance for some formula. .. _class_Vector3_distance_to: -- :ref:`float` **distance_to** **(** :ref:`Vector3` b **)** +- :ref:`float` **distance_to** **(** :ref:`Vector3` b **)** Return the distance to b. .. _class_Vector3_dot: -- :ref:`float` **dot** **(** :ref:`Vector3` b **)** +- :ref:`float` **dot** **(** :ref:`Vector3` b **)** Return the dot product with b. .. _class_Vector3_floor: -- :ref:`Vector3` **floor** **(** **)** +- :ref:`Vector3` **floor** **(** **)** Returns a new vector with all components rounded down. .. _class_Vector3_inverse: -- :ref:`Vector3` **inverse** **(** **)** +- :ref:`Vector3` **inverse** **(** **)** Returns the inverse of the vector. This is the same as Vector3( 1.0 / v.x, 1.0 / v.y, 1.0 / v.z ) .. _class_Vector3_is_normalized: -- :ref:`bool` **is_normalized** **(** **)** +- :ref:`bool` **is_normalized** **(** **)** Returns whether the vector is normalized or not. .. _class_Vector3_length: -- :ref:`float` **length** **(** **)** +- :ref:`float` **length** **(** **)** Return the length of the vector. .. _class_Vector3_length_squared: -- :ref:`float` **length_squared** **(** **)** +- :ref:`float` **length_squared** **(** **)** Return the length of the vector, squared. Prefer this function over "length" if you need to sort vectors or need the squared length for some formula. .. _class_Vector3_linear_interpolate: -- :ref:`Vector3` **linear_interpolate** **(** :ref:`Vector3` b, :ref:`float` t **)** +- :ref:`Vector3` **linear_interpolate** **(** :ref:`Vector3` b, :ref:`float` t **)** Linearly interpolates the vector to a given one (b), by the given amount (t). .. _class_Vector3_max_axis: -- :ref:`int` **max_axis** **(** **)** +- :ref:`int` **max_axis** **(** **)** Returns AXIS_X, AXIS_Y or AXIS_Z depending on which axis is the largest. .. _class_Vector3_min_axis: -- :ref:`int` **min_axis** **(** **)** +- :ref:`int` **min_axis** **(** **)** Returns AXIS_X, AXIS_Y or AXIS_Z depending on which axis is the smallest. .. _class_Vector3_normalized: -- :ref:`Vector3` **normalized** **(** **)** +- :ref:`Vector3` **normalized** **(** **)** Return a copy of the normalized vector to unit length. This is the same as v / v.length(). .. _class_Vector3_outer: -- :ref:`Basis` **outer** **(** :ref:`Vector3` b **)** +- :ref:`Basis` **outer** **(** :ref:`Vector3` b **)** Return the outer product with b. .. _class_Vector3_reflect: -- :ref:`Vector3` **reflect** **(** :ref:`Vector3` n **)** +- :ref:`Vector3` **reflect** **(** :ref:`Vector3` n **)** Reflects the vector along the given plane, specified by its normal vector. .. _class_Vector3_rotated: -- :ref:`Vector3` **rotated** **(** :ref:`Vector3` axis, :ref:`float` phi **)** +- :ref:`Vector3` **rotated** **(** :ref:`Vector3` axis, :ref:`float` phi **)** Rotates the vector around some axis by phi radians. The axis must be a normalized vector. .. _class_Vector3_slide: -- :ref:`Vector3` **slide** **(** :ref:`Vector3` n **)** +- :ref:`Vector3` **slide** **(** :ref:`Vector3` n **)** Slide returns the component of the vector along the given plane, specified by its normal vector. .. _class_Vector3_snapped: -- :ref:`Vector3` **snapped** **(** :ref:`float` by **)** +- :ref:`Vector3` **snapped** **(** :ref:`float` by **)** Return a copy of the vector, snapped to the lowest neared multiple. .. _class_Vector3_to_diagonal_matrix: -- :ref:`Basis` **to_diagonal_matrix** **(** **)** +- :ref:`Basis` **to_diagonal_matrix** **(** **)** Return a diagonal matrix with the vector as main diagonal. diff --git a/classes/class_vehiclebody.rst b/classes/class_vehiclebody.rst index 6632134e2..a20c45251 100644 --- a/classes/class_vehiclebody.rst +++ b/classes/class_vehiclebody.rst @@ -19,29 +19,29 @@ Brief Description Member Functions ---------------- -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_brake` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_engine_force` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_friction` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_linear_velocity` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_mass` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_steering` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_brake` **(** :ref:`float` brake **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_engine_force` **(** :ref:`float` engine_force **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_friction` **(** :ref:`float` friction **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mass` **(** :ref:`float` mass **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_steering` **(** :ref:`float` steering **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_brake` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_engine_force` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_friction` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_linear_velocity` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_mass` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_steering` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_brake` **(** :ref:`float` brake **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_engine_force` **(** :ref:`float` engine_force **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_friction` **(** :ref:`float` friction **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_mass` **(** :ref:`float` mass **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_steering` **(** :ref:`float` steering **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -72,19 +72,19 @@ Member Function Description .. _class_VehicleBody_get_brake: -- :ref:`float` **get_brake** **(** **)** const +- :ref:`float` **get_brake** **(** **)** const .. _class_VehicleBody_get_engine_force: -- :ref:`float` **get_engine_force** **(** **)** const +- :ref:`float` **get_engine_force** **(** **)** const .. _class_VehicleBody_get_friction: -- :ref:`float` **get_friction** **(** **)** const +- :ref:`float` **get_friction** **(** **)** const .. _class_VehicleBody_get_linear_velocity: -- :ref:`Vector3` **get_linear_velocity** **(** **)** const +- :ref:`Vector3` **get_linear_velocity** **(** **)** const Returns the VehicleBody's velocity vector. To get the absolute speed in scalar value, get the length of the return vector in pixels/second. Example: @@ -95,33 +95,33 @@ Returns the VehicleBody's velocity vector. To get the absolute speed in scalar v .. _class_VehicleBody_get_mass: -- :ref:`float` **get_mass** **(** **)** const +- :ref:`float` **get_mass** **(** **)** const .. _class_VehicleBody_get_steering: -- :ref:`float` **get_steering** **(** **)** const +- :ref:`float` **get_steering** **(** **)** const Return the steering angle (in radians). .. _class_VehicleBody_set_brake: -- void **set_brake** **(** :ref:`float` brake **)** +- void **set_brake** **(** :ref:`float` brake **)** .. _class_VehicleBody_set_engine_force: -- void **set_engine_force** **(** :ref:`float` engine_force **)** +- void **set_engine_force** **(** :ref:`float` engine_force **)** .. _class_VehicleBody_set_friction: -- void **set_friction** **(** :ref:`float` friction **)** +- void **set_friction** **(** :ref:`float` friction **)** .. _class_VehicleBody_set_mass: -- void **set_mass** **(** :ref:`float` mass **)** +- void **set_mass** **(** :ref:`float` mass **)** .. _class_VehicleBody_set_steering: -- void **set_steering** **(** :ref:`float` steering **)** +- void **set_steering** **(** :ref:`float` steering **)** Set the steering angle (in radians). diff --git a/classes/class_vehiclewheel.rst b/classes/class_vehiclewheel.rst index 2366a4d2c..615ce59d3 100644 --- a/classes/class_vehiclewheel.rst +++ b/classes/class_vehiclewheel.rst @@ -19,55 +19,55 @@ Brief Description Member Functions ---------------- -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_damping_compression` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_damping_relaxation` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_friction_slip` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_radius` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_roll_influence` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_skidinfo` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_suspension_max_force` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_suspension_rest_length` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_suspension_stiffness` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_suspension_travel` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_in_contact` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_used_as_steering` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_used_as_traction` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_damping_compression` **(** :ref:`float` length **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_damping_relaxation` **(** :ref:`float` length **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_friction_slip` **(** :ref:`float` length **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_radius` **(** :ref:`float` length **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_roll_influence` **(** :ref:`float` roll_influence **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_suspension_max_force` **(** :ref:`float` length **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_suspension_rest_length` **(** :ref:`float` length **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_suspension_stiffness` **(** :ref:`float` length **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_suspension_travel` **(** :ref:`float` length **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_as_steering` **(** :ref:`bool` enable **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_as_traction` **(** :ref:`bool` enable **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_damping_compression` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_damping_relaxation` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_friction_slip` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_radius` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_roll_influence` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_skidinfo` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_suspension_max_force` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_suspension_rest_length` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_suspension_stiffness` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_suspension_travel` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_in_contact` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_used_as_steering` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_used_as_traction` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_damping_compression` **(** :ref:`float` length **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_damping_relaxation` **(** :ref:`float` length **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_friction_slip` **(** :ref:`float` length **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_radius` **(** :ref:`float` length **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_roll_influence` **(** :ref:`float` roll_influence **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_suspension_max_force` **(** :ref:`float` length **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_suspension_rest_length` **(** :ref:`float` length **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_suspension_stiffness` **(** :ref:`float` length **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_suspension_travel` **(** :ref:`float` length **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_as_steering` **(** :ref:`bool` enable **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_as_traction` **(** :ref:`bool` enable **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -122,98 +122,98 @@ Member Function Description .. _class_VehicleWheel_get_damping_compression: -- :ref:`float` **get_damping_compression** **(** **)** const +- :ref:`float` **get_damping_compression** **(** **)** const .. _class_VehicleWheel_get_damping_relaxation: -- :ref:`float` **get_damping_relaxation** **(** **)** const +- :ref:`float` **get_damping_relaxation** **(** **)** const .. _class_VehicleWheel_get_friction_slip: -- :ref:`float` **get_friction_slip** **(** **)** const +- :ref:`float` **get_friction_slip** **(** **)** const .. _class_VehicleWheel_get_radius: -- :ref:`float` **get_radius** **(** **)** const +- :ref:`float` **get_radius** **(** **)** const .. _class_VehicleWheel_get_roll_influence: -- :ref:`float` **get_roll_influence** **(** **)** const +- :ref:`float` **get_roll_influence** **(** **)** const .. _class_VehicleWheel_get_skidinfo: -- :ref:`float` **get_skidinfo** **(** **)** const +- :ref:`float` **get_skidinfo** **(** **)** const .. _class_VehicleWheel_get_suspension_max_force: -- :ref:`float` **get_suspension_max_force** **(** **)** const +- :ref:`float` **get_suspension_max_force** **(** **)** const .. _class_VehicleWheel_get_suspension_rest_length: -- :ref:`float` **get_suspension_rest_length** **(** **)** const +- :ref:`float` **get_suspension_rest_length** **(** **)** const .. _class_VehicleWheel_get_suspension_stiffness: -- :ref:`float` **get_suspension_stiffness** **(** **)** const +- :ref:`float` **get_suspension_stiffness** **(** **)** const .. _class_VehicleWheel_get_suspension_travel: -- :ref:`float` **get_suspension_travel** **(** **)** const +- :ref:`float` **get_suspension_travel** **(** **)** const .. _class_VehicleWheel_is_in_contact: -- :ref:`bool` **is_in_contact** **(** **)** const +- :ref:`bool` **is_in_contact** **(** **)** const .. _class_VehicleWheel_is_used_as_steering: -- :ref:`bool` **is_used_as_steering** **(** **)** const +- :ref:`bool` **is_used_as_steering** **(** **)** const .. _class_VehicleWheel_is_used_as_traction: -- :ref:`bool` **is_used_as_traction** **(** **)** const +- :ref:`bool` **is_used_as_traction** **(** **)** const .. _class_VehicleWheel_set_damping_compression: -- void **set_damping_compression** **(** :ref:`float` length **)** +- void **set_damping_compression** **(** :ref:`float` length **)** .. _class_VehicleWheel_set_damping_relaxation: -- void **set_damping_relaxation** **(** :ref:`float` length **)** +- void **set_damping_relaxation** **(** :ref:`float` length **)** .. _class_VehicleWheel_set_friction_slip: -- void **set_friction_slip** **(** :ref:`float` length **)** +- void **set_friction_slip** **(** :ref:`float` length **)** .. _class_VehicleWheel_set_radius: -- void **set_radius** **(** :ref:`float` length **)** +- void **set_radius** **(** :ref:`float` length **)** .. _class_VehicleWheel_set_roll_influence: -- void **set_roll_influence** **(** :ref:`float` roll_influence **)** +- void **set_roll_influence** **(** :ref:`float` roll_influence **)** .. _class_VehicleWheel_set_suspension_max_force: -- void **set_suspension_max_force** **(** :ref:`float` length **)** +- void **set_suspension_max_force** **(** :ref:`float` length **)** .. _class_VehicleWheel_set_suspension_rest_length: -- void **set_suspension_rest_length** **(** :ref:`float` length **)** +- void **set_suspension_rest_length** **(** :ref:`float` length **)** .. _class_VehicleWheel_set_suspension_stiffness: -- void **set_suspension_stiffness** **(** :ref:`float` length **)** +- void **set_suspension_stiffness** **(** :ref:`float` length **)** .. _class_VehicleWheel_set_suspension_travel: -- void **set_suspension_travel** **(** :ref:`float` length **)** +- void **set_suspension_travel** **(** :ref:`float` length **)** .. _class_VehicleWheel_set_use_as_steering: -- void **set_use_as_steering** **(** :ref:`bool` enable **)** +- void **set_use_as_steering** **(** :ref:`bool` enable **)** .. _class_VehicleWheel_set_use_as_traction: -- void **set_use_as_traction** **(** :ref:`bool` enable **)** +- void **set_use_as_traction** **(** :ref:`bool` enable **)** diff --git a/classes/class_videoplayer.rst b/classes/class_videoplayer.rst index b4ecf1e80..5be4f1a53 100644 --- a/classes/class_videoplayer.rst +++ b/classes/class_videoplayer.rst @@ -19,53 +19,53 @@ Control to play video files. Member Functions ---------------- -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_audio_track` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_buffering_msec` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`VideoStream` | :ref:`get_stream` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_stream_name` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_stream_position` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_video_texture` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_volume` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_volume_db` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_autoplay` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_expand` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_paused` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_playing` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`play` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_audio_track` **(** :ref:`int` track **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_autoplay` **(** :ref:`bool` enabled **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_buffering_msec` **(** :ref:`int` msec **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_expand` **(** :ref:`bool` enable **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_paused` **(** :ref:`bool` paused **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_stream` **(** :ref:`VideoStream` stream **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_stream_position` **(** :ref:`float` position **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_volume` **(** :ref:`float` volume **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_volume_db` **(** :ref:`float` db **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_audio_track` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_buffering_msec` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`VideoStream` | :ref:`get_stream` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_stream_name` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_stream_position` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_video_texture` **(** **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_volume` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_volume_db` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_autoplay` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_expand` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_paused` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_playing` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`play` **(** **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_audio_track` **(** :ref:`int` track **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_autoplay` **(** :ref:`bool` enabled **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_buffering_msec` **(** :ref:`int` msec **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_expand` **(** :ref:`bool` enable **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_paused` **(** :ref:`bool` paused **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_stream` **(** :ref:`VideoStream` stream **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_stream_position` **(** :ref:`float` position **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_volume` **(** :ref:`float` volume **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_volume_db` **(** :ref:`float` db **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -105,139 +105,139 @@ Member Function Description .. _class_VideoPlayer_get_audio_track: -- :ref:`int` **get_audio_track** **(** **)** const +- :ref:`int` **get_audio_track** **(** **)** const Get the selected audio track (for multitrack videos). .. _class_VideoPlayer_get_buffering_msec: -- :ref:`int` **get_buffering_msec** **(** **)** const +- :ref:`int` **get_buffering_msec** **(** **)** const Get the amount of milliseconds to store in buffer while playing. .. _class_VideoPlayer_get_stream: -- :ref:`VideoStream` **get_stream** **(** **)** const +- :ref:`VideoStream` **get_stream** **(** **)** const Get the video stream. .. _class_VideoPlayer_get_stream_name: -- :ref:`String` **get_stream_name** **(** **)** const +- :ref:`String` **get_stream_name** **(** **)** const Get the name of the video stream. .. _class_VideoPlayer_get_stream_position: -- :ref:`float` **get_stream_position** **(** **)** const +- :ref:`float` **get_stream_position** **(** **)** const Get the current position of the stream, in seconds. .. _class_VideoPlayer_get_video_texture: -- :ref:`Texture` **get_video_texture** **(** **)** +- :ref:`Texture` **get_video_texture** **(** **)** Get the current frame of the video as a :ref:`Texture`. .. _class_VideoPlayer_get_volume: -- :ref:`float` **get_volume** **(** **)** const +- :ref:`float` **get_volume** **(** **)** const Get the volume of the audio track as a linear value. .. _class_VideoPlayer_get_volume_db: -- :ref:`float` **get_volume_db** **(** **)** const +- :ref:`float` **get_volume_db** **(** **)** const Get the volume of the audio track in decibels. .. _class_VideoPlayer_has_autoplay: -- :ref:`bool` **has_autoplay** **(** **)** const +- :ref:`bool` **has_autoplay** **(** **)** const Get whether or not the video is set as autoplay. .. _class_VideoPlayer_has_expand: -- :ref:`bool` **has_expand** **(** **)** const +- :ref:`bool` **has_expand** **(** **)** const Get whether or not the expand property is set. .. _class_VideoPlayer_is_paused: -- :ref:`bool` **is_paused** **(** **)** const +- :ref:`bool` **is_paused** **(** **)** const Get whether or not the video is paused. .. _class_VideoPlayer_is_playing: -- :ref:`bool` **is_playing** **(** **)** const +- :ref:`bool` **is_playing** **(** **)** const Get whether or not the video is playing. .. _class_VideoPlayer_play: -- void **play** **(** **)** +- void **play** **(** **)** Start the video playback. .. _class_VideoPlayer_set_audio_track: -- void **set_audio_track** **(** :ref:`int` track **)** +- void **set_audio_track** **(** :ref:`int` track **)** Set the audio track (for multitrack videos). .. _class_VideoPlayer_set_autoplay: -- void **set_autoplay** **(** :ref:`bool` enabled **)** +- void **set_autoplay** **(** :ref:`bool` enabled **)** Set whether this node should start playing automatically. .. _class_VideoPlayer_set_buffering_msec: -- void **set_buffering_msec** **(** :ref:`int` msec **)** +- void **set_buffering_msec** **(** :ref:`int` msec **)** Set the amount of milliseconds to buffer during playback. .. _class_VideoPlayer_set_expand: -- void **set_expand** **(** :ref:`bool` enable **)** +- void **set_expand** **(** :ref:`bool` enable **)** Set the expand property. If enabled, the video will grow or shrink to fit the player size, otherwise it will play at the stream resolution. .. _class_VideoPlayer_set_paused: -- void **set_paused** **(** :ref:`bool` paused **)** +- void **set_paused** **(** :ref:`bool` paused **)** Set whether the video should pause the playback. .. _class_VideoPlayer_set_stream: -- void **set_stream** **(** :ref:`VideoStream` stream **)** +- void **set_stream** **(** :ref:`VideoStream` stream **)** Set the video stream for this player. .. _class_VideoPlayer_set_stream_position: -- void **set_stream_position** **(** :ref:`float` position **)** +- void **set_stream_position** **(** :ref:`float` position **)** Set the current position of the stream, in seconds. .. _class_VideoPlayer_set_volume: -- void **set_volume** **(** :ref:`float` volume **)** +- void **set_volume** **(** :ref:`float` volume **)** Set the audio volume as a linear value. .. _class_VideoPlayer_set_volume_db: -- void **set_volume_db** **(** :ref:`float` db **)** +- void **set_volume_db** **(** :ref:`float` db **)** Set the audio volume in decibels. .. _class_VideoPlayer_stop: -- void **stop** **(** **)** +- void **stop** **(** **)** Stop the video playback. diff --git a/classes/class_viewport.rst b/classes/class_viewport.rst index 999554228..9c288d98b 100644 --- a/classes/class_viewport.rst +++ b/classes/class_viewport.rst @@ -19,148 +19,148 @@ Creates a sub-view into the screen. Member Functions ---------------- -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`World` | :ref:`find_world` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`World2D` | :ref:`find_world_2d` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Camera` | :ref:`get_camera` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_canvas_transform` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_clear_mode` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_debug_draw` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_final_transform` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_global_canvas_transform` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_hdr` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_mouse_position` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_msaa` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_physics_object_picking` **(** **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_render_info` **(** :ref:`int` info **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_shadow_atlas_quadrant_subdiv` **(** :ref:`int` quadrant **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_shadow_atlas_size` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_size` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_size_override` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ViewportTexture` | :ref:`get_texture` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_update_mode` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_usage` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_vflip` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_viewport_rid` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_visible_rect` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`World` | :ref:`get_world` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`World2D` | :ref:`get_world_2d` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`gui_get_drag_data` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`gui_has_modal_stack` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_transparent_background` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`input` **(** :ref:`InputEvent` local_event **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_3d_disabled` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_audio_listener` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_audio_listener_2d` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_input_disabled` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_size_override_enabled` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_size_override_stretch_enabled` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_snap_controls_to_pixels_enabled` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_using_own_world` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_as_audio_listener` **(** :ref:`bool` enable **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_as_audio_listener_2d` **(** :ref:`bool` enable **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_attach_to_screen_rect` **(** :ref:`Rect2` rect **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_canvas_transform` **(** :ref:`Transform2D` xform **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_clear_mode` **(** :ref:`int` mode **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_debug_draw` **(** :ref:`int` debug_draw **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_disable_3d` **(** :ref:`bool` disable **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_disable_input` **(** :ref:`bool` disable **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_global_canvas_transform` **(** :ref:`Transform2D` xform **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_hdr` **(** :ref:`bool` enable **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_msaa` **(** :ref:`int` msaa **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_physics_object_picking` **(** :ref:`bool` enable **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shadow_atlas_quadrant_subdiv` **(** :ref:`int` quadrant, :ref:`int` subdiv **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shadow_atlas_size` **(** :ref:`int` size **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_size` **(** :ref:`Vector2` size **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_size_override` **(** :ref:`bool` enable, :ref:`Vector2` size=Vector2( -1, -1 ), :ref:`Vector2` margin=Vector2( 0, 0 ) **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_size_override_stretch` **(** :ref:`bool` enabled **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_snap_controls_to_pixels` **(** :ref:`bool` enabled **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_transparent_background` **(** :ref:`bool` enable **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_update_mode` **(** :ref:`int` mode **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_usage` **(** :ref:`int` usage **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_arvr` **(** :ref:`bool` use **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_own_world` **(** :ref:`bool` enable **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vflip` **(** :ref:`bool` enable **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_world` **(** :ref:`World` world **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_world_2d` **(** :ref:`World2D` world_2d **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`unhandled_input` **(** :ref:`InputEvent` local_event **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`update_worlds` **(** **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`use_arvr` **(** **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`warp_mouse` **(** :ref:`Vector2` to_position **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`World` | :ref:`find_world` **(** **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`World2D` | :ref:`find_world_2d` **(** **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Camera` | :ref:`get_camera` **(** **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_canvas_transform` **(** **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_clear_mode` **(** **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_debug_draw` **(** **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_final_transform` **(** **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_global_canvas_transform` **(** **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_hdr` **(** **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_mouse_position` **(** **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_msaa` **(** **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_physics_object_picking` **(** **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_render_info` **(** :ref:`int` info **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_shadow_atlas_quadrant_subdiv` **(** :ref:`int` quadrant **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_shadow_atlas_size` **(** **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_size` **(** **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_size_override` **(** **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ViewportTexture` | :ref:`get_texture` **(** **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_update_mode` **(** **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_usage` **(** **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_vflip` **(** **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_viewport_rid` **(** **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_visible_rect` **(** **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`World` | :ref:`get_world` **(** **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`World2D` | :ref:`get_world_2d` **(** **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`gui_get_drag_data` **(** **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`gui_has_modal_stack` **(** **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_transparent_background` **(** **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`input` **(** :ref:`InputEvent` local_event **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_3d_disabled` **(** **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_audio_listener` **(** **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_audio_listener_2d` **(** **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_input_disabled` **(** **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_size_override_enabled` **(** **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_size_override_stretch_enabled` **(** **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_snap_controls_to_pixels_enabled` **(** **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_using_own_world` **(** **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_as_audio_listener` **(** :ref:`bool` enable **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_as_audio_listener_2d` **(** :ref:`bool` enable **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_attach_to_screen_rect` **(** :ref:`Rect2` rect **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_canvas_transform` **(** :ref:`Transform2D` xform **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_clear_mode` **(** :ref:`int` mode **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_debug_draw` **(** :ref:`int` debug_draw **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_disable_3d` **(** :ref:`bool` disable **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_disable_input` **(** :ref:`bool` disable **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_global_canvas_transform` **(** :ref:`Transform2D` xform **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_hdr` **(** :ref:`bool` enable **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_msaa` **(** :ref:`int` msaa **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_physics_object_picking` **(** :ref:`bool` enable **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shadow_atlas_quadrant_subdiv` **(** :ref:`int` quadrant, :ref:`int` subdiv **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shadow_atlas_size` **(** :ref:`int` size **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_size` **(** :ref:`Vector2` size **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_size_override` **(** :ref:`bool` enable, :ref:`Vector2` size=Vector2( -1, -1 ), :ref:`Vector2` margin=Vector2( 0, 0 ) **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_size_override_stretch` **(** :ref:`bool` enabled **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_snap_controls_to_pixels` **(** :ref:`bool` enabled **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_transparent_background` **(** :ref:`bool` enable **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_update_mode` **(** :ref:`int` mode **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_usage` **(** :ref:`int` usage **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_arvr` **(** :ref:`bool` use **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_own_world` **(** :ref:`bool` enable **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vflip` **(** :ref:`bool` enable **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_world` **(** :ref:`World` world **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_world_2d` **(** :ref:`World2D` world_2d **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`unhandled_input` **(** :ref:`InputEvent` local_event **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`update_worlds` **(** **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`use_arvr` **(** **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`warp_mouse` **(** :ref:`Vector2` to_position **)** | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_Viewport_size_changed: -- **size_changed** **(** **)** +- **size_changed** **(** **)** Emitted when the size of the viewport is changed, whether by :ref:`set_size_override`, resize of window, or some other means. @@ -320,315 +320,315 @@ Member Function Description .. _class_Viewport_find_world: -- :ref:`World` **find_world** **(** **)** const +- :ref:`World` **find_world** **(** **)** const Return the 3D world of the viewport, or if no such present, the one of the parent viewport. .. _class_Viewport_find_world_2d: -- :ref:`World2D` **find_world_2d** **(** **)** const +- :ref:`World2D` **find_world_2d** **(** **)** const Return the 2D world of the viewport. .. _class_Viewport_get_camera: -- :ref:`Camera` **get_camera** **(** **)** const +- :ref:`Camera` **get_camera** **(** **)** const Return the active 3D camera. .. _class_Viewport_get_canvas_transform: -- :ref:`Transform2D` **get_canvas_transform** **(** **)** const +- :ref:`Transform2D` **get_canvas_transform** **(** **)** const Get the canvas transform of the viewport. .. _class_Viewport_get_clear_mode: -- :ref:`int` **get_clear_mode** **(** **)** const +- :ref:`int` **get_clear_mode** **(** **)** const .. _class_Viewport_get_debug_draw: -- :ref:`int` **get_debug_draw** **(** **)** const +- :ref:`int` **get_debug_draw** **(** **)** const .. _class_Viewport_get_final_transform: -- :ref:`Transform2D` **get_final_transform** **(** **)** const +- :ref:`Transform2D` **get_final_transform** **(** **)** const Get the total transform of the viewport. .. _class_Viewport_get_global_canvas_transform: -- :ref:`Transform2D` **get_global_canvas_transform** **(** **)** const +- :ref:`Transform2D` **get_global_canvas_transform** **(** **)** const Get the global canvas transform of the viewport. .. _class_Viewport_get_hdr: -- :ref:`bool` **get_hdr** **(** **)** const +- :ref:`bool` **get_hdr** **(** **)** const Get whether the rendered texture has filters enabled. .. _class_Viewport_get_mouse_position: -- :ref:`Vector2` **get_mouse_position** **(** **)** const +- :ref:`Vector2` **get_mouse_position** **(** **)** const Get the mouse position, relative to the viewport. .. _class_Viewport_get_msaa: -- :ref:`int` **get_msaa** **(** **)** const +- :ref:`int` **get_msaa** **(** **)** const .. _class_Viewport_get_physics_object_picking: -- :ref:`bool` **get_physics_object_picking** **(** **)** +- :ref:`bool` **get_physics_object_picking** **(** **)** Get whether picking for all physics objects inside the viewport is enabled. .. _class_Viewport_get_render_info: -- :ref:`int` **get_render_info** **(** :ref:`int` info **)** +- :ref:`int` **get_render_info** **(** :ref:`int` info **)** .. _class_Viewport_get_shadow_atlas_quadrant_subdiv: -- :ref:`int` **get_shadow_atlas_quadrant_subdiv** **(** :ref:`int` quadrant **)** const +- :ref:`int` **get_shadow_atlas_quadrant_subdiv** **(** :ref:`int` quadrant **)** const .. _class_Viewport_get_shadow_atlas_size: -- :ref:`int` **get_shadow_atlas_size** **(** **)** const +- :ref:`int` **get_shadow_atlas_size** **(** **)** const .. _class_Viewport_get_size: -- :ref:`Vector2` **get_size** **(** **)** const +- :ref:`Vector2` **get_size** **(** **)** const Return the viewport rect. If the viewport is child of a control, it will use the same rect as the parent. Otherwise, if the rect is empty, the viewport will use all the allowed space. .. _class_Viewport_get_size_override: -- :ref:`Vector2` **get_size_override** **(** **)** const +- :ref:`Vector2` **get_size_override** **(** **)** const Get the size override set with :ref:`set_size_override`. .. _class_Viewport_get_texture: -- :ref:`ViewportTexture` **get_texture** **(** **)** const +- :ref:`ViewportTexture` **get_texture** **(** **)** const Get the viewport's texture, for use with various objects that you want to texture with the viewport. .. _class_Viewport_get_update_mode: -- :ref:`int` **get_update_mode** **(** **)** const +- :ref:`int` **get_update_mode** **(** **)** const Get when the viewport would be updated, will be one of the ``UPDATE\_\*`` constants. .. _class_Viewport_get_usage: -- :ref:`int` **get_usage** **(** **)** const +- :ref:`int` **get_usage** **(** **)** const .. _class_Viewport_get_vflip: -- :ref:`bool` **get_vflip** **(** **)** const +- :ref:`bool` **get_vflip** **(** **)** const Set whether the render target is flipped on the Y axis. .. _class_Viewport_get_viewport_rid: -- :ref:`RID` **get_viewport_rid** **(** **)** const +- :ref:`RID` **get_viewport_rid** **(** **)** const Get the viewport RID from the :ref:`VisualServer`. .. _class_Viewport_get_visible_rect: -- :ref:`Rect2` **get_visible_rect** **(** **)** const +- :ref:`Rect2` **get_visible_rect** **(** **)** const Return the final, visible rect in global screen coordinates. .. _class_Viewport_get_world: -- :ref:`World` **get_world** **(** **)** const +- :ref:`World` **get_world** **(** **)** const Return the 3D world of the viewport. .. _class_Viewport_get_world_2d: -- :ref:`World2D` **get_world_2d** **(** **)** const +- :ref:`World2D` **get_world_2d** **(** **)** const Return the 2D world of the viewport. .. _class_Viewport_gui_get_drag_data: -- :ref:`Variant` **gui_get_drag_data** **(** **)** const +- :ref:`Variant` **gui_get_drag_data** **(** **)** const Returns the drag data from the GUI, that was previously returned by :ref:`Control.get_drag_data`. .. _class_Viewport_gui_has_modal_stack: -- :ref:`bool` **gui_has_modal_stack** **(** **)** const +- :ref:`bool` **gui_has_modal_stack** **(** **)** const Returns whether there are shown modals on-screen. .. _class_Viewport_has_transparent_background: -- :ref:`bool` **has_transparent_background** **(** **)** const +- :ref:`bool` **has_transparent_background** **(** **)** const Return whether the viewport lets whatever is behind it to show. .. _class_Viewport_input: -- void **input** **(** :ref:`InputEvent` local_event **)** +- void **input** **(** :ref:`InputEvent` local_event **)** .. _class_Viewport_is_3d_disabled: -- :ref:`bool` **is_3d_disabled** **(** **)** const +- :ref:`bool` **is_3d_disabled** **(** **)** const .. _class_Viewport_is_audio_listener: -- :ref:`bool` **is_audio_listener** **(** **)** const +- :ref:`bool` **is_audio_listener** **(** **)** const Returns whether the viewport sends sounds to the speakers. .. _class_Viewport_is_audio_listener_2d: -- :ref:`bool` **is_audio_listener_2d** **(** **)** const +- :ref:`bool` **is_audio_listener_2d** **(** **)** const Returns whether the viewport sends soundsfrom 2D emitters to the speakers. .. _class_Viewport_is_input_disabled: -- :ref:`bool` **is_input_disabled** **(** **)** const +- :ref:`bool` **is_input_disabled** **(** **)** const Return whether input to the viewport is disabled. .. _class_Viewport_is_size_override_enabled: -- :ref:`bool` **is_size_override_enabled** **(** **)** const +- :ref:`bool` **is_size_override_enabled** **(** **)** const Get the enabled status of the size override set with :ref:`set_size_override`. .. _class_Viewport_is_size_override_stretch_enabled: -- :ref:`bool` **is_size_override_stretch_enabled** **(** **)** const +- :ref:`bool` **is_size_override_stretch_enabled** **(** **)** const Get the enabled status of the size strech override set with :ref:`set_size_override_stretch`. .. _class_Viewport_is_snap_controls_to_pixels_enabled: -- :ref:`bool` **is_snap_controls_to_pixels_enabled** **(** **)** const +- :ref:`bool` **is_snap_controls_to_pixels_enabled** **(** **)** const .. _class_Viewport_is_using_own_world: -- :ref:`bool` **is_using_own_world** **(** **)** const +- :ref:`bool` **is_using_own_world** **(** **)** const Return whether the viewport is using a world separate from the parent viewport's world. .. _class_Viewport_set_as_audio_listener: -- void **set_as_audio_listener** **(** :ref:`bool` enable **)** +- void **set_as_audio_listener** **(** :ref:`bool` enable **)** Makes the viewport send sounds to the speakers. .. _class_Viewport_set_as_audio_listener_2d: -- void **set_as_audio_listener_2d** **(** :ref:`bool` enable **)** +- void **set_as_audio_listener_2d** **(** :ref:`bool` enable **)** Makes the viewport send sounds from 2D emitters to the speakers. .. _class_Viewport_set_attach_to_screen_rect: -- void **set_attach_to_screen_rect** **(** :ref:`Rect2` rect **)** +- void **set_attach_to_screen_rect** **(** :ref:`Rect2` rect **)** .. _class_Viewport_set_canvas_transform: -- void **set_canvas_transform** **(** :ref:`Transform2D` xform **)** +- void **set_canvas_transform** **(** :ref:`Transform2D` xform **)** Set the canvas transform of the viewport, useful for changing the on-screen positions of all child :ref:`CanvasItem`\ s. This is relative to the global canvas transform of the viewport. .. _class_Viewport_set_clear_mode: -- void **set_clear_mode** **(** :ref:`int` mode **)** +- void **set_clear_mode** **(** :ref:`int` mode **)** .. _class_Viewport_set_debug_draw: -- void **set_debug_draw** **(** :ref:`int` debug_draw **)** +- void **set_debug_draw** **(** :ref:`int` debug_draw **)** .. _class_Viewport_set_disable_3d: -- void **set_disable_3d** **(** :ref:`bool` disable **)** +- void **set_disable_3d** **(** :ref:`bool` disable **)** .. _class_Viewport_set_disable_input: -- void **set_disable_input** **(** :ref:`bool` disable **)** +- void **set_disable_input** **(** :ref:`bool` disable **)** Set whether input to the viewport is disabled. .. _class_Viewport_set_global_canvas_transform: -- void **set_global_canvas_transform** **(** :ref:`Transform2D` xform **)** +- void **set_global_canvas_transform** **(** :ref:`Transform2D` xform **)** Set the global canvas transform of the viewport. The canvas transform is relative to this. .. _class_Viewport_set_hdr: -- void **set_hdr** **(** :ref:`bool` enable **)** +- void **set_hdr** **(** :ref:`bool` enable **)** .. _class_Viewport_set_msaa: -- void **set_msaa** **(** :ref:`int` msaa **)** +- void **set_msaa** **(** :ref:`int` msaa **)** .. _class_Viewport_set_physics_object_picking: -- void **set_physics_object_picking** **(** :ref:`bool` enable **)** +- void **set_physics_object_picking** **(** :ref:`bool` enable **)** Enable/disable picking for all physics objects inside the viewport. .. _class_Viewport_set_shadow_atlas_quadrant_subdiv: -- void **set_shadow_atlas_quadrant_subdiv** **(** :ref:`int` quadrant, :ref:`int` subdiv **)** +- void **set_shadow_atlas_quadrant_subdiv** **(** :ref:`int` quadrant, :ref:`int` subdiv **)** .. _class_Viewport_set_shadow_atlas_size: -- void **set_shadow_atlas_size** **(** :ref:`int` size **)** +- void **set_shadow_atlas_size** **(** :ref:`int` size **)** .. _class_Viewport_set_size: -- void **set_size** **(** :ref:`Vector2` size **)** +- void **set_size** **(** :ref:`Vector2` size **)** Set the size of the viewport. .. _class_Viewport_set_size_override: -- void **set_size_override** **(** :ref:`bool` enable, :ref:`Vector2` size=Vector2( -1, -1 ), :ref:`Vector2` margin=Vector2( 0, 0 ) **)** +- void **set_size_override** **(** :ref:`bool` enable, :ref:`Vector2` size=Vector2( -1, -1 ), :ref:`Vector2` margin=Vector2( 0, 0 ) **)** Set the size override of the viewport. If the enable parameter is true, it would use the override, otherwise it would use the default size. If the size parameter is equal to ``(-1, -1)``, it won't update the size. .. _class_Viewport_set_size_override_stretch: -- void **set_size_override_stretch** **(** :ref:`bool` enabled **)** +- void **set_size_override_stretch** **(** :ref:`bool` enabled **)** Set whether the size override affects stretch as well. .. _class_Viewport_set_snap_controls_to_pixels: -- void **set_snap_controls_to_pixels** **(** :ref:`bool` enabled **)** +- void **set_snap_controls_to_pixels** **(** :ref:`bool` enabled **)** .. _class_Viewport_set_transparent_background: -- void **set_transparent_background** **(** :ref:`bool` enable **)** +- void **set_transparent_background** **(** :ref:`bool` enable **)** If this viewport is a child of another viewport, keep the previously drawn background visible. .. _class_Viewport_set_update_mode: -- void **set_update_mode** **(** :ref:`int` mode **)** +- void **set_update_mode** **(** :ref:`int` mode **)** Set when the render target would be updated, using the ``UPDATE\_\*`` constants .. _class_Viewport_set_usage: -- void **set_usage** **(** :ref:`int` usage **)** +- void **set_usage** **(** :ref:`int` usage **)** .. _class_Viewport_set_use_arvr: -- void **set_use_arvr** **(** :ref:`bool` use **)** +- void **set_use_arvr** **(** :ref:`bool` use **)** If true this viewport will be bound to our ARVR Server. @@ -640,45 +640,45 @@ If this is an extra viewport output will only work if redirection to an HMD is s .. _class_Viewport_set_use_own_world: -- void **set_use_own_world** **(** :ref:`bool` enable **)** +- void **set_use_own_world** **(** :ref:`bool` enable **)** Make the viewport use a world separate from the parent viewport's world. .. _class_Viewport_set_vflip: -- void **set_vflip** **(** :ref:`bool` enable **)** +- void **set_vflip** **(** :ref:`bool` enable **)** Set whether the viewport is flipped on the Y axis. .. _class_Viewport_set_world: -- void **set_world** **(** :ref:`World` world **)** +- void **set_world** **(** :ref:`World` world **)** Change the 3D world of the viewport. .. _class_Viewport_set_world_2d: -- void **set_world_2d** **(** :ref:`World2D` world_2d **)** +- void **set_world_2d** **(** :ref:`World2D` world_2d **)** .. _class_Viewport_unhandled_input: -- void **unhandled_input** **(** :ref:`InputEvent` local_event **)** +- void **unhandled_input** **(** :ref:`InputEvent` local_event **)** .. _class_Viewport_update_worlds: -- void **update_worlds** **(** **)** +- void **update_worlds** **(** **)** Force update of the 2D and 3D worlds. .. _class_Viewport_use_arvr: -- :ref:`bool` **use_arvr** **(** **)** +- :ref:`bool` **use_arvr** **(** **)** Returns whether this viewport is using our ARVR Server .. _class_Viewport_warp_mouse: -- void **warp_mouse** **(** :ref:`Vector2` to_position **)** +- void **warp_mouse** **(** :ref:`Vector2` to_position **)** Warp the mouse to a position, relative to the viewport. diff --git a/classes/class_viewportcontainer.rst b/classes/class_viewportcontainer.rst index cbc9c71ce..3fccbac8d 100644 --- a/classes/class_viewportcontainer.rst +++ b/classes/class_viewportcontainer.rst @@ -19,11 +19,11 @@ Brief Description Member Functions ---------------- -+--------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_stretch_enabled` **(** **)** const | -+--------------------------+------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_stretch` **(** :ref:`bool` enable **)** | -+--------------------------+------------------------------------------------------------------------------------------------------+ ++--------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_stretch_enabled` **(** **)** const | ++--------------------------+----------------------------------------------------------------------------------------------------+ +| void | :ref:`set_stretch` **(** :ref:`bool` enable **)** | ++--------------------------+----------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -38,10 +38,10 @@ Member Function Description .. _class_ViewportContainer_is_stretch_enabled: -- :ref:`bool` **is_stretch_enabled** **(** **)** const +- :ref:`bool` **is_stretch_enabled** **(** **)** const .. _class_ViewportContainer_set_stretch: -- void **set_stretch** **(** :ref:`bool` enable **)** +- void **set_stretch** **(** :ref:`bool` enable **)** diff --git a/classes/class_viewporttexture.rst b/classes/class_viewporttexture.rst index 544f08e65..8b46b1aa0 100644 --- a/classes/class_viewporttexture.rst +++ b/classes/class_viewporttexture.rst @@ -19,11 +19,11 @@ Brief Description Member Functions ---------------- -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_viewport_path_in_scene` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_viewport_path_in_scene` **(** :ref:`NodePath` path **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_viewport_path_in_scene` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_viewport_path_in_scene` **(** :ref:`NodePath` path **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -38,10 +38,10 @@ Member Function Description .. _class_ViewportTexture_get_viewport_path_in_scene: -- :ref:`NodePath` **get_viewport_path_in_scene** **(** **)** const +- :ref:`NodePath` **get_viewport_path_in_scene** **(** **)** const .. _class_ViewportTexture_set_viewport_path_in_scene: -- void **set_viewport_path_in_scene** **(** :ref:`NodePath` path **)** +- void **set_viewport_path_in_scene** **(** :ref:`NodePath` path **)** diff --git a/classes/class_visibilityenabler.rst b/classes/class_visibilityenabler.rst index ecdee554d..e3ef212a9 100644 --- a/classes/class_visibilityenabler.rst +++ b/classes/class_visibilityenabler.rst @@ -19,11 +19,11 @@ Enable certain nodes only when visible. Member Functions ---------------- -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_enabler_enabled` **(** :ref:`int` enabler **)** const | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_enabler` **(** :ref:`int` enabler, :ref:`bool` enabled **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_enabler_enabled` **(** :ref:`int` enabler **)** const | ++--------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_enabler` **(** :ref:`int` enabler, :ref:`bool` enabled **)** | ++--------------------------+------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -54,13 +54,13 @@ Member Function Description .. _class_VisibilityEnabler_is_enabler_enabled: -- :ref:`bool` **is_enabler_enabled** **(** :ref:`int` enabler **)** const +- :ref:`bool` **is_enabler_enabled** **(** :ref:`int` enabler **)** const Returns whether the specified enabler was set to true or not. .. _class_VisibilityEnabler_set_enabler: -- void **set_enabler** **(** :ref:`int` enabler, :ref:`bool` enabled **)** +- void **set_enabler** **(** :ref:`int` enabler, :ref:`bool` enabled **)** Set an enabler to true for all nodes of its type to be disabled when the VisibilityEnabler is not in view. See the constants for enablers and what they affect. diff --git a/classes/class_visibilityenabler2d.rst b/classes/class_visibilityenabler2d.rst index 8f53e1c6a..e37ebce3a 100644 --- a/classes/class_visibilityenabler2d.rst +++ b/classes/class_visibilityenabler2d.rst @@ -19,11 +19,11 @@ Enable certain nodes only when visible. Member Functions ---------------- -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_enabler_enabled` **(** :ref:`int` enabler **)** const | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_enabler` **(** :ref:`int` enabler, :ref:`bool` enabled **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_enabler_enabled` **(** :ref:`int` enabler **)** const | ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_enabler` **(** :ref:`int` enabler, :ref:`bool` enabled **)** | ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -74,13 +74,13 @@ Member Function Description .. _class_VisibilityEnabler2D_is_enabler_enabled: -- :ref:`bool` **is_enabler_enabled** **(** :ref:`int` enabler **)** const +- :ref:`bool` **is_enabler_enabled** **(** :ref:`int` enabler **)** const Returns whether the specified enabler was set to true or not. .. _class_VisibilityEnabler2D_set_enabler: -- void **set_enabler** **(** :ref:`int` enabler, :ref:`bool` enabled **)** +- void **set_enabler** **(** :ref:`int` enabler, :ref:`bool` enabled **)** Set an enabler to true for all nodes of its type to be disabled when the VisibilityEnabler2D is not in view. See the constants for enablers and what they affect. diff --git a/classes/class_visibilitynotifier.rst b/classes/class_visibilitynotifier.rst index de24afcff..4368fe496 100644 --- a/classes/class_visibilitynotifier.rst +++ b/classes/class_visibilitynotifier.rst @@ -21,38 +21,38 @@ Detects when the node is visible on screen. Member Functions ---------------- -+----------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`Rect3` | :ref:`get_aabb` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_on_screen` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------+ -| void | :ref:`set_aabb` **(** :ref:`Rect3` rect **)** | -+----------------------------+-------------------------------------------------------------------------------------------------+ ++----------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`Rect3` | :ref:`get_aabb` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_on_screen` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------+ +| void | :ref:`set_aabb` **(** :ref:`Rect3` rect **)** | ++----------------------------+-----------------------------------------------------------------------------------------------+ Signals ------- .. _class_VisibilityNotifier_camera_entered: -- **camera_entered** **(** :ref:`Object` camera **)** +- **camera_entered** **(** :ref:`Object` camera **)** Emitted when the VisibilityNotifier enters a :ref:`Camera`'s view. .. _class_VisibilityNotifier_camera_exited: -- **camera_exited** **(** :ref:`Object` camera **)** +- **camera_exited** **(** :ref:`Object` camera **)** Emitted when the VisibilityNotifier exits a :ref:`Camera`'s view. .. _class_VisibilityNotifier_screen_entered: -- **screen_entered** **(** **)** +- **screen_entered** **(** **)** Emitted when the VisibilityNotifier enters the screen. .. _class_VisibilityNotifier_screen_exited: -- **screen_exited** **(** **)** +- **screen_exited** **(** **)** Emitted when the VisibilityNotifier exits the screen. @@ -75,19 +75,19 @@ Member Function Description .. _class_VisibilityNotifier_get_aabb: -- :ref:`Rect3` **get_aabb** **(** **)** const +- :ref:`Rect3` **get_aabb** **(** **)** const Returns the bounding box of the VisibilityNotifier. .. _class_VisibilityNotifier_is_on_screen: -- :ref:`bool` **is_on_screen** **(** **)** const +- :ref:`bool` **is_on_screen** **(** **)** const If ``true`` the bounding box is on the screen. .. _class_VisibilityNotifier_set_aabb: -- void **set_aabb** **(** :ref:`Rect3` rect **)** +- void **set_aabb** **(** :ref:`Rect3` rect **)** Set the visibility bounding box of the VisibilityNotifier. diff --git a/classes/class_visibilitynotifier2d.rst b/classes/class_visibilitynotifier2d.rst index 58d721c0f..4d5b3a738 100644 --- a/classes/class_visibilitynotifier2d.rst +++ b/classes/class_visibilitynotifier2d.rst @@ -21,38 +21,38 @@ Detects when the node is visible on screen. Member Functions ---------------- -+----------------------------+---------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_rect` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_on_screen` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rect` **(** :ref:`Rect2` rect **)** | -+----------------------------+---------------------------------------------------------------------------------------------------+ ++----------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_rect` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_on_screen` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rect` **(** :ref:`Rect2` rect **)** | ++----------------------------+-------------------------------------------------------------------------------------------------+ Signals ------- .. _class_VisibilityNotifier2D_screen_entered: -- **screen_entered** **(** **)** +- **screen_entered** **(** **)** Emitted when the VisibilityNotifier2D enters the screen. .. _class_VisibilityNotifier2D_screen_exited: -- **screen_exited** **(** **)** +- **screen_exited** **(** **)** Emitted when the VisibilityNotifier2D exits the screen. .. _class_VisibilityNotifier2D_viewport_entered: -- **viewport_entered** **(** :ref:`Object` viewport **)** +- **viewport_entered** **(** :ref:`Object` viewport **)** Emitted when the VisibilityNotifier2D enters a :ref:`Viewport`'s view. .. _class_VisibilityNotifier2D_viewport_exited: -- **viewport_exited** **(** :ref:`Object` viewport **)** +- **viewport_exited** **(** :ref:`Object` viewport **)** Emitted when the VisibilityNotifier2D exits a :ref:`Viewport`'s view. @@ -75,19 +75,19 @@ Member Function Description .. _class_VisibilityNotifier2D_get_rect: -- :ref:`Rect2` **get_rect** **(** **)** const +- :ref:`Rect2` **get_rect** **(** **)** const Returns the bounding rectangle of the VisibilityNotifier2D. .. _class_VisibilityNotifier2D_is_on_screen: -- :ref:`bool` **is_on_screen** **(** **)** const +- :ref:`bool` **is_on_screen** **(** **)** const If ``true`` the bounding rectangle is on the screen. .. _class_VisibilityNotifier2D_set_rect: -- void **set_rect** **(** :ref:`Rect2` rect **)** +- void **set_rect** **(** :ref:`Rect2` rect **)** Set the visibility bounding rectangle of the VisibilityNotifier2D. diff --git a/classes/class_visualinstance.rst b/classes/class_visualinstance.rst index 9bf00ce38..c996af26f 100644 --- a/classes/class_visualinstance.rst +++ b/classes/class_visualinstance.rst @@ -21,17 +21,17 @@ Brief Description Member Functions ---------------- -+----------------------------+-----------------------------------------------------------------------------------------------------+ -| :ref:`Rect3` | :ref:`get_aabb` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_layer_mask` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------+ -| :ref:`Rect3` | :ref:`get_transformed_aabb` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------+ -| void | :ref:`set_base` **(** :ref:`RID` base **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------+ -| void | :ref:`set_layer_mask` **(** :ref:`int` mask **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------+ ++----------------------------+---------------------------------------------------------------------------------------------------+ +| :ref:`Rect3` | :ref:`get_aabb` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_layer_mask` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------+ +| :ref:`Rect3` | :ref:`get_transformed_aabb` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------+ +| void | :ref:`set_base` **(** :ref:`RID` base **)** | ++----------------------------+---------------------------------------------------------------------------------------------------+ +| void | :ref:`set_layer_mask` **(** :ref:`int` mask **)** | ++----------------------------+---------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -46,22 +46,22 @@ Member Function Description .. _class_VisualInstance_get_aabb: -- :ref:`Rect3` **get_aabb** **(** **)** const +- :ref:`Rect3` **get_aabb** **(** **)** const .. _class_VisualInstance_get_layer_mask: -- :ref:`int` **get_layer_mask** **(** **)** const +- :ref:`int` **get_layer_mask** **(** **)** const .. _class_VisualInstance_get_transformed_aabb: -- :ref:`Rect3` **get_transformed_aabb** **(** **)** const +- :ref:`Rect3` **get_transformed_aabb** **(** **)** const .. _class_VisualInstance_set_base: -- void **set_base** **(** :ref:`RID` base **)** +- void **set_base** **(** :ref:`RID` base **)** .. _class_VisualInstance_set_layer_mask: -- void **set_layer_mask** **(** :ref:`int` mask **)** +- void **set_layer_mask** **(** :ref:`int` mask **)** diff --git a/classes/class_visualscript.rst b/classes/class_visualscript.rst index 498b3ce80..d2a288501 100644 --- a/classes/class_visualscript.rst +++ b/classes/class_visualscript.rst @@ -19,98 +19,98 @@ A script implemented in the Visual Script programming environment. Member Functions ---------------- -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_custom_signal` **(** :ref:`String` name **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_function` **(** :ref:`String` name **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_node` **(** :ref:`String` func, :ref:`int` id, :ref:`VisualScriptNode` node, :ref:`Vector2` position=Vector2( 0, 0 ) **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_variable` **(** :ref:`String` name, :ref:`Variant` default_value=null, :ref:`bool` export=false **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`custom_signal_add_argument` **(** :ref:`String` name, :ref:`int` type, :ref:`String` argname, :ref:`int` index=-1 **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`custom_signal_get_argument_count` **(** :ref:`String` name **)** const | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`custom_signal_get_argument_name` **(** :ref:`String` name, :ref:`int` argidx **)** const | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`custom_signal_get_argument_type` **(** :ref:`String` name, :ref:`int` argidx **)** const | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`custom_signal_remove_argument` **(** :ref:`String` name, :ref:`int` argidx **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`custom_signal_set_argument_name` **(** :ref:`String` name, :ref:`int` argidx, :ref:`String` argname **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`custom_signal_set_argument_type` **(** :ref:`String` name, :ref:`int` argidx, :ref:`int` type **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`custom_signal_swap_argument` **(** :ref:`String` name, :ref:`int` argidx, :ref:`int` withidx **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`data_connect` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`data_disconnect` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_function_node_id` **(** :ref:`String` name **)** const | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_function_scroll` **(** :ref:`String` name **)** const | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`VisualScriptNode` | :ref:`get_node` **(** :ref:`String` func, :ref:`int` id **)** const | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_node_position` **(** :ref:`String` func, :ref:`int` id **)** const | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_variable_default_value` **(** :ref:`String` name **)** const | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_variable_export` **(** :ref:`String` name **)** const | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_variable_info` **(** :ref:`String` name **)** const | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_custom_signal` **(** :ref:`String` name **)** const | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_data_connection` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** const | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_function` **(** :ref:`String` name **)** const | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_node` **(** :ref:`String` func, :ref:`int` id **)** const | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_sequence_connection` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** const | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_variable` **(** :ref:`String` name **)** const | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_custom_signal` **(** :ref:`String` name **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_function` **(** :ref:`String` name **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_node` **(** :ref:`String` func, :ref:`int` id **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_variable` **(** :ref:`String` name **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rename_custom_signal` **(** :ref:`String` name, :ref:`String` new_name **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rename_function` **(** :ref:`String` name, :ref:`String` new_name **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rename_variable` **(** :ref:`String` name, :ref:`String` new_name **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sequence_connect` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sequence_disconnect` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_function_scroll` **(** :ref:`String` name, :ref:`Vector2` ofs **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_instance_base_type` **(** :ref:`String` type **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_node_position` **(** :ref:`String` func, :ref:`int` id, :ref:`Vector2` position **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_variable_default_value` **(** :ref:`String` name, :ref:`Variant` value **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_variable_export` **(** :ref:`String` name, :ref:`bool` enable **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_variable_info` **(** :ref:`String` name, :ref:`Dictionary` value **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_custom_signal` **(** :ref:`String` name **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_function` **(** :ref:`String` name **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_node` **(** :ref:`String` func, :ref:`int` id, :ref:`VisualScriptNode` node, :ref:`Vector2` position=Vector2( 0, 0 ) **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_variable` **(** :ref:`String` name, :ref:`Variant` default_value=null, :ref:`bool` export=false **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`custom_signal_add_argument` **(** :ref:`String` name, :ref:`int` type, :ref:`String` argname, :ref:`int` index=-1 **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`custom_signal_get_argument_count` **(** :ref:`String` name **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`custom_signal_get_argument_name` **(** :ref:`String` name, :ref:`int` argidx **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`custom_signal_get_argument_type` **(** :ref:`String` name, :ref:`int` argidx **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`custom_signal_remove_argument` **(** :ref:`String` name, :ref:`int` argidx **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`custom_signal_set_argument_name` **(** :ref:`String` name, :ref:`int` argidx, :ref:`String` argname **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`custom_signal_set_argument_type` **(** :ref:`String` name, :ref:`int` argidx, :ref:`int` type **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`custom_signal_swap_argument` **(** :ref:`String` name, :ref:`int` argidx, :ref:`int` withidx **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`data_connect` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`data_disconnect` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_function_node_id` **(** :ref:`String` name **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_function_scroll` **(** :ref:`String` name **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`VisualScriptNode` | :ref:`get_node` **(** :ref:`String` func, :ref:`int` id **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_node_position` **(** :ref:`String` func, :ref:`int` id **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_variable_default_value` **(** :ref:`String` name **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_variable_export` **(** :ref:`String` name **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_variable_info` **(** :ref:`String` name **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_custom_signal` **(** :ref:`String` name **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_data_connection` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_function` **(** :ref:`String` name **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_node` **(** :ref:`String` func, :ref:`int` id **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_sequence_connection` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_variable` **(** :ref:`String` name **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_custom_signal` **(** :ref:`String` name **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_function` **(** :ref:`String` name **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_node` **(** :ref:`String` func, :ref:`int` id **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_variable` **(** :ref:`String` name **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rename_custom_signal` **(** :ref:`String` name, :ref:`String` new_name **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rename_function` **(** :ref:`String` name, :ref:`String` new_name **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rename_variable` **(** :ref:`String` name, :ref:`String` new_name **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`sequence_connect` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`sequence_disconnect` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_function_scroll` **(** :ref:`String` name, :ref:`Vector2` ofs **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_instance_base_type` **(** :ref:`String` type **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_node_position` **(** :ref:`String` func, :ref:`int` id, :ref:`Vector2` position **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_variable_default_value` **(** :ref:`String` name, :ref:`Variant` value **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_variable_export` **(** :ref:`String` name, :ref:`bool` enable **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_variable_info` **(** :ref:`String` name, :ref:`Dictionary` value **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_VisualScript_node_ports_changed: -- **node_ports_changed** **(** :ref:`String` function, :ref:`int` id **)** +- **node_ports_changed** **(** :ref:`String` function, :ref:`int` id **)** Emitted when the ports of a node are changed. @@ -137,211 +137,211 @@ Member Function Description .. _class_VisualScript_add_custom_signal: -- void **add_custom_signal** **(** :ref:`String` name **)** +- void **add_custom_signal** **(** :ref:`String` name **)** Add a custom signal with the specified name to the VisualScript. .. _class_VisualScript_add_function: -- void **add_function** **(** :ref:`String` name **)** +- void **add_function** **(** :ref:`String` name **)** Add a function with the specified name to the VisualScript. .. _class_VisualScript_add_node: -- void **add_node** **(** :ref:`String` func, :ref:`int` id, :ref:`VisualScriptNode` node, :ref:`Vector2` position=Vector2( 0, 0 ) **)** +- void **add_node** **(** :ref:`String` func, :ref:`int` id, :ref:`VisualScriptNode` node, :ref:`Vector2` position=Vector2( 0, 0 ) **)** Add a node to a function of the VisualScript. .. _class_VisualScript_add_variable: -- void **add_variable** **(** :ref:`String` name, :ref:`Variant` default_value=null, :ref:`bool` export=false **)** +- void **add_variable** **(** :ref:`String` name, :ref:`Variant` default_value=null, :ref:`bool` export=false **)** Add a variable to the VisualScript, optionally giving it a default value or marking it as exported. .. _class_VisualScript_custom_signal_add_argument: -- void **custom_signal_add_argument** **(** :ref:`String` name, :ref:`int` type, :ref:`String` argname, :ref:`int` index=-1 **)** +- void **custom_signal_add_argument** **(** :ref:`String` name, :ref:`int` type, :ref:`String` argname, :ref:`int` index=-1 **)** Add an argument to a custom signal added with :ref:`add_custom_signal`. .. _class_VisualScript_custom_signal_get_argument_count: -- :ref:`int` **custom_signal_get_argument_count** **(** :ref:`String` name **)** const +- :ref:`int` **custom_signal_get_argument_count** **(** :ref:`String` name **)** const Get the count of a custom signal's arguments. .. _class_VisualScript_custom_signal_get_argument_name: -- :ref:`String` **custom_signal_get_argument_name** **(** :ref:`String` name, :ref:`int` argidx **)** const +- :ref:`String` **custom_signal_get_argument_name** **(** :ref:`String` name, :ref:`int` argidx **)** const Get the name of a custom signal's argument. .. _class_VisualScript_custom_signal_get_argument_type: -- :ref:`int` **custom_signal_get_argument_type** **(** :ref:`String` name, :ref:`int` argidx **)** const +- :ref:`int` **custom_signal_get_argument_type** **(** :ref:`String` name, :ref:`int` argidx **)** const Get the type of a custom signal's argument. .. _class_VisualScript_custom_signal_remove_argument: -- void **custom_signal_remove_argument** **(** :ref:`String` name, :ref:`int` argidx **)** +- void **custom_signal_remove_argument** **(** :ref:`String` name, :ref:`int` argidx **)** Remove a specific custom signal's argument. .. _class_VisualScript_custom_signal_set_argument_name: -- void **custom_signal_set_argument_name** **(** :ref:`String` name, :ref:`int` argidx, :ref:`String` argname **)** +- void **custom_signal_set_argument_name** **(** :ref:`String` name, :ref:`int` argidx, :ref:`String` argname **)** Rename a custom signal's argument. .. _class_VisualScript_custom_signal_set_argument_type: -- void **custom_signal_set_argument_type** **(** :ref:`String` name, :ref:`int` argidx, :ref:`int` type **)** +- void **custom_signal_set_argument_type** **(** :ref:`String` name, :ref:`int` argidx, :ref:`int` type **)** Change the type of a custom signal's argument. .. _class_VisualScript_custom_signal_swap_argument: -- void **custom_signal_swap_argument** **(** :ref:`String` name, :ref:`int` argidx, :ref:`int` withidx **)** +- void **custom_signal_swap_argument** **(** :ref:`String` name, :ref:`int` argidx, :ref:`int` withidx **)** Swap two of the arguments of a custom signal. .. _class_VisualScript_data_connect: -- void **data_connect** **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** +- void **data_connect** **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** Connect two data ports. The value of ``from_node``'s ``from_port`` would be fed into ``to_node``'s ``to_port``. .. _class_VisualScript_data_disconnect: -- void **data_disconnect** **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** +- void **data_disconnect** **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** Disconnect two data ports previously connected with :ref:`data_connect`. .. _class_VisualScript_get_function_node_id: -- :ref:`int` **get_function_node_id** **(** :ref:`String` name **)** const +- :ref:`int` **get_function_node_id** **(** :ref:`String` name **)** const Returns the id of a function's entry point node. .. _class_VisualScript_get_function_scroll: -- :ref:`Vector2` **get_function_scroll** **(** :ref:`String` name **)** const +- :ref:`Vector2` **get_function_scroll** **(** :ref:`String` name **)** const Returns the position of the center of the screen for a given function. .. _class_VisualScript_get_node: -- :ref:`VisualScriptNode` **get_node** **(** :ref:`String` func, :ref:`int` id **)** const +- :ref:`VisualScriptNode` **get_node** **(** :ref:`String` func, :ref:`int` id **)** const Returns a node given its id and its function. .. _class_VisualScript_get_node_position: -- :ref:`Vector2` **get_node_position** **(** :ref:`String` func, :ref:`int` id **)** const +- :ref:`Vector2` **get_node_position** **(** :ref:`String` func, :ref:`int` id **)** const Returns a node's position in pixels. .. _class_VisualScript_get_variable_default_value: -- :ref:`Variant` **get_variable_default_value** **(** :ref:`String` name **)** const +- :ref:`Variant` **get_variable_default_value** **(** :ref:`String` name **)** const Returns the default (initial) value of a variable. .. _class_VisualScript_get_variable_export: -- :ref:`bool` **get_variable_export** **(** :ref:`String` name **)** const +- :ref:`bool` **get_variable_export** **(** :ref:`String` name **)** const Returns whether a variable is exported. .. _class_VisualScript_get_variable_info: -- :ref:`Dictionary` **get_variable_info** **(** :ref:`String` name **)** const +- :ref:`Dictionary` **get_variable_info** **(** :ref:`String` name **)** const Returns the info for a given variable as a dictionary. The information includes its name, type, hint and usage. .. _class_VisualScript_has_custom_signal: -- :ref:`bool` **has_custom_signal** **(** :ref:`String` name **)** const +- :ref:`bool` **has_custom_signal** **(** :ref:`String` name **)** const Returns whether a signal exists with the specified name. .. _class_VisualScript_has_data_connection: -- :ref:`bool` **has_data_connection** **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** const +- :ref:`bool` **has_data_connection** **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** const Returns whether the specified data ports are connected. .. _class_VisualScript_has_function: -- :ref:`bool` **has_function** **(** :ref:`String` name **)** const +- :ref:`bool` **has_function** **(** :ref:`String` name **)** const Returns whether a function exists with the specified name. .. _class_VisualScript_has_node: -- :ref:`bool` **has_node** **(** :ref:`String` func, :ref:`int` id **)** const +- :ref:`bool` **has_node** **(** :ref:`String` func, :ref:`int` id **)** const Returns whether a node exists with the given id. .. _class_VisualScript_has_sequence_connection: -- :ref:`bool` **has_sequence_connection** **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** const +- :ref:`bool` **has_sequence_connection** **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** const Returns whether the specified sequence ports are connected. .. _class_VisualScript_has_variable: -- :ref:`bool` **has_variable** **(** :ref:`String` name **)** const +- :ref:`bool` **has_variable** **(** :ref:`String` name **)** const Returns whether a variable exists with the specified name. .. _class_VisualScript_remove_custom_signal: -- void **remove_custom_signal** **(** :ref:`String` name **)** +- void **remove_custom_signal** **(** :ref:`String` name **)** Remove a custom signal with the given name. .. _class_VisualScript_remove_function: -- void **remove_function** **(** :ref:`String` name **)** +- void **remove_function** **(** :ref:`String` name **)** Remove a specific function and its nodes from the script. .. _class_VisualScript_remove_node: -- void **remove_node** **(** :ref:`String` func, :ref:`int` id **)** +- void **remove_node** **(** :ref:`String` func, :ref:`int` id **)** Remove a specific node. .. _class_VisualScript_remove_variable: -- void **remove_variable** **(** :ref:`String` name **)** +- void **remove_variable** **(** :ref:`String` name **)** Remove a variable with the given name. .. _class_VisualScript_rename_custom_signal: -- void **rename_custom_signal** **(** :ref:`String` name, :ref:`String` new_name **)** +- void **rename_custom_signal** **(** :ref:`String` name, :ref:`String` new_name **)** Change the name of a custom signal. .. _class_VisualScript_rename_function: -- void **rename_function** **(** :ref:`String` name, :ref:`String` new_name **)** +- void **rename_function** **(** :ref:`String` name, :ref:`String` new_name **)** Change the name of a function. .. _class_VisualScript_rename_variable: -- void **rename_variable** **(** :ref:`String` name, :ref:`String` new_name **)** +- void **rename_variable** **(** :ref:`String` name, :ref:`String` new_name **)** Change the name of a variable. .. _class_VisualScript_sequence_connect: -- void **sequence_connect** **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** +- void **sequence_connect** **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** Connect two sequence ports. The execution will flow from of ``from_node``'s ``from_output`` into ``to_node``. @@ -349,43 +349,43 @@ Unlike :ref:`data_connect`, there isn't a ``to_ .. _class_VisualScript_sequence_disconnect: -- void **sequence_disconnect** **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** +- void **sequence_disconnect** **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** Disconnect two sequence ports previously connected with :ref:`sequence_connect`. .. _class_VisualScript_set_function_scroll: -- void **set_function_scroll** **(** :ref:`String` name, :ref:`Vector2` ofs **)** +- void **set_function_scroll** **(** :ref:`String` name, :ref:`Vector2` ofs **)** Position the center of the screen for a function. .. _class_VisualScript_set_instance_base_type: -- void **set_instance_base_type** **(** :ref:`String` type **)** +- void **set_instance_base_type** **(** :ref:`String` type **)** Set the base type of the script. .. _class_VisualScript_set_node_position: -- void **set_node_position** **(** :ref:`String` func, :ref:`int` id, :ref:`Vector2` position **)** +- void **set_node_position** **(** :ref:`String` func, :ref:`int` id, :ref:`Vector2` position **)** Position a node on the screen. .. _class_VisualScript_set_variable_default_value: -- void **set_variable_default_value** **(** :ref:`String` name, :ref:`Variant` value **)** +- void **set_variable_default_value** **(** :ref:`String` name, :ref:`Variant` value **)** Change the default (initial) value of a variable. .. _class_VisualScript_set_variable_export: -- void **set_variable_export** **(** :ref:`String` name, :ref:`bool` enable **)** +- void **set_variable_export** **(** :ref:`String` name, :ref:`bool` enable **)** Change whether a variable is exported. .. _class_VisualScript_set_variable_info: -- void **set_variable_info** **(** :ref:`String` name, :ref:`Dictionary` value **)** +- void **set_variable_info** **(** :ref:`String` name, :ref:`Dictionary` value **)** Set a variable's info, using the same format as :ref:`get_variable_info`. diff --git a/classes/class_visualscriptbasictypeconstant.rst b/classes/class_visualscriptbasictypeconstant.rst index 568da43ea..cfad4196b 100644 --- a/classes/class_visualscriptbasictypeconstant.rst +++ b/classes/class_visualscriptbasictypeconstant.rst @@ -19,15 +19,15 @@ A Visual Script node representing a constant from the base types. Member Functions ---------------- -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_basic_type` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_basic_type_constant` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_basic_type` **(** :ref:`int` name **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_basic_type_constant` **(** :ref:`String` name **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_basic_type` **(** **)** const | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_basic_type_constant` **(** **)** const | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_basic_type` **(** :ref:`int` name **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_basic_type_constant` **(** :ref:`String` name **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -51,18 +51,18 @@ Member Function Description .. _class_VisualScriptBasicTypeConstant_get_basic_type: -- :ref:`int` **get_basic_type** **(** **)** const +- :ref:`int` **get_basic_type** **(** **)** const .. _class_VisualScriptBasicTypeConstant_get_basic_type_constant: -- :ref:`String` **get_basic_type_constant** **(** **)** const +- :ref:`String` **get_basic_type_constant** **(** **)** const .. _class_VisualScriptBasicTypeConstant_set_basic_type: -- void **set_basic_type** **(** :ref:`int` name **)** +- void **set_basic_type** **(** :ref:`int` name **)** .. _class_VisualScriptBasicTypeConstant_set_basic_type_constant: -- void **set_basic_type_constant** **(** :ref:`String` name **)** +- void **set_basic_type_constant** **(** :ref:`String` name **)** diff --git a/classes/class_visualscriptbuiltinfunc.rst b/classes/class_visualscriptbuiltinfunc.rst index d807ec57a..9e3f3046c 100644 --- a/classes/class_visualscriptbuiltinfunc.rst +++ b/classes/class_visualscriptbuiltinfunc.rst @@ -19,11 +19,11 @@ A Visual Script node used to call built-in functions. Member Functions ---------------- -+------------------------+---------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_func` **(** **)** | -+------------------------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`set_func` **(** :ref:`int` which **)** | -+------------------------+---------------------------------------------------------------------------------------------------+ ++------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_func` **(** **)** | ++------------------------+-------------------------------------------------------------------------------------------------+ +| void | :ref:`set_func` **(** :ref:`int` which **)** | ++------------------------+-------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -109,10 +109,10 @@ Member Function Description .. _class_VisualScriptBuiltinFunc_get_func: -- :ref:`int` **get_func** **(** **)** +- :ref:`int` **get_func** **(** **)** .. _class_VisualScriptBuiltinFunc_set_func: -- void **set_func** **(** :ref:`int` which **)** +- void **set_func** **(** :ref:`int` which **)** diff --git a/classes/class_visualscriptclassconstant.rst b/classes/class_visualscriptclassconstant.rst index 4edbc6ddd..b576c1b7b 100644 --- a/classes/class_visualscriptclassconstant.rst +++ b/classes/class_visualscriptclassconstant.rst @@ -19,15 +19,15 @@ Gets a constant from a given class. Member Functions ---------------- -+------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_base_type` **(** **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_class_constant` **(** **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_base_type` **(** :ref:`String` name **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_class_constant` **(** :ref:`String` name **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_base_type` **(** **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_class_constant` **(** **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_base_type` **(** :ref:`String` name **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_class_constant` **(** :ref:`String` name **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -59,18 +59,18 @@ Member Function Description .. _class_VisualScriptClassConstant_get_base_type: -- :ref:`String` **get_base_type** **(** **)** +- :ref:`String` **get_base_type** **(** **)** .. _class_VisualScriptClassConstant_get_class_constant: -- :ref:`String` **get_class_constant** **(** **)** +- :ref:`String` **get_class_constant** **(** **)** .. _class_VisualScriptClassConstant_set_base_type: -- void **set_base_type** **(** :ref:`String` name **)** +- void **set_base_type** **(** :ref:`String` name **)** .. _class_VisualScriptClassConstant_set_class_constant: -- void **set_class_constant** **(** :ref:`String` name **)** +- void **set_class_constant** **(** :ref:`String` name **)** diff --git a/classes/class_visualscriptcomment.rst b/classes/class_visualscriptcomment.rst index 6755f52bb..0a3d16926 100644 --- a/classes/class_visualscriptcomment.rst +++ b/classes/class_visualscriptcomment.rst @@ -19,19 +19,19 @@ A Visual Script node used to annotate the script. Member Functions ---------------- -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_description` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_size` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_title` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_description` **(** :ref:`String` description **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_size` **(** :ref:`Vector2` size **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_title` **(** :ref:`String` title **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_description` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_size` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_title` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_description` **(** :ref:`String` description **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_size` **(** :ref:`Vector2` size **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_title` **(** :ref:`String` title **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -61,26 +61,26 @@ Member Function Description .. _class_VisualScriptComment_get_description: -- :ref:`String` **get_description** **(** **)** const +- :ref:`String` **get_description** **(** **)** const .. _class_VisualScriptComment_get_size: -- :ref:`Vector2` **get_size** **(** **)** const +- :ref:`Vector2` **get_size** **(** **)** const .. _class_VisualScriptComment_get_title: -- :ref:`String` **get_title** **(** **)** const +- :ref:`String` **get_title** **(** **)** const .. _class_VisualScriptComment_set_description: -- void **set_description** **(** :ref:`String` description **)** +- void **set_description** **(** :ref:`String` description **)** .. _class_VisualScriptComment_set_size: -- void **set_size** **(** :ref:`Vector2` size **)** +- void **set_size** **(** :ref:`Vector2` size **)** .. _class_VisualScriptComment_set_title: -- void **set_title** **(** :ref:`String` title **)** +- void **set_title** **(** :ref:`String` title **)** diff --git a/classes/class_visualscriptconstant.rst b/classes/class_visualscriptconstant.rst index 389e79e68..7d02b13fe 100644 --- a/classes/class_visualscriptconstant.rst +++ b/classes/class_visualscriptconstant.rst @@ -19,15 +19,15 @@ Gets a contant's value. Member Functions ---------------- -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_constant_type` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_constant_value` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_constant_type` **(** :ref:`int` type **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_constant_value` **(** :ref:`Variant` value **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_constant_type` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_constant_value` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_constant_type` **(** :ref:`int` type **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_constant_value` **(** :ref:`Variant` value **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -59,18 +59,18 @@ Member Function Description .. _class_VisualScriptConstant_get_constant_type: -- :ref:`int` **get_constant_type** **(** **)** const +- :ref:`int` **get_constant_type** **(** **)** const .. _class_VisualScriptConstant_get_constant_value: -- :ref:`Variant` **get_constant_value** **(** **)** const +- :ref:`Variant` **get_constant_value** **(** **)** const .. _class_VisualScriptConstant_set_constant_type: -- void **set_constant_type** **(** :ref:`int` type **)** +- void **set_constant_type** **(** :ref:`int` type **)** .. _class_VisualScriptConstant_set_constant_value: -- void **set_constant_value** **(** :ref:`Variant` value **)** +- void **set_constant_value** **(** :ref:`Variant` value **)** diff --git a/classes/class_visualscriptconstructor.rst b/classes/class_visualscriptconstructor.rst index 81783ab61..5662c9a44 100644 --- a/classes/class_visualscriptconstructor.rst +++ b/classes/class_visualscriptconstructor.rst @@ -19,15 +19,15 @@ A Visual Script node which calls a base type constructor. Member Functions ---------------- -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_constructor` **(** **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_constructor_type` **(** **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_constructor` **(** :ref:`Dictionary` constructor **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_constructor_type` **(** :ref:`int` type **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_constructor` **(** **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_constructor_type` **(** **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_constructor` **(** :ref:`Dictionary` constructor **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_constructor_type` **(** :ref:`int` type **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -68,18 +68,18 @@ Member Function Description .. _class_VisualScriptConstructor_get_constructor: -- :ref:`Dictionary` **get_constructor** **(** **)** const +- :ref:`Dictionary` **get_constructor** **(** **)** const .. _class_VisualScriptConstructor_get_constructor_type: -- :ref:`int` **get_constructor_type** **(** **)** const +- :ref:`int` **get_constructor_type** **(** **)** const .. _class_VisualScriptConstructor_set_constructor: -- void **set_constructor** **(** :ref:`Dictionary` constructor **)** +- void **set_constructor** **(** :ref:`Dictionary` constructor **)** .. _class_VisualScriptConstructor_set_constructor_type: -- void **set_constructor_type** **(** :ref:`int` type **)** +- void **set_constructor_type** **(** :ref:`int` type **)** diff --git a/classes/class_visualscriptcustomnode.rst b/classes/class_visualscriptcustomnode.rst index 0ad5cb42d..e8e3ae12a 100644 --- a/classes/class_visualscriptcustomnode.rst +++ b/classes/class_visualscriptcustomnode.rst @@ -19,35 +19,35 @@ A scripted Visual Script node. Member Functions ---------------- -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_get_caption` **(** **)** virtual | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_get_category` **(** **)** virtual | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_get_input_value_port_count` **(** **)** virtual | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_get_input_value_port_name` **(** :ref:`int` idx **)** virtual | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_get_input_value_port_type` **(** :ref:`int` idx **)** virtual | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_get_output_sequence_port_count` **(** **)** virtual | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_get_output_sequence_port_text` **(** :ref:`int` idx **)** virtual | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_get_output_value_port_count` **(** **)** virtual | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_get_output_value_port_name` **(** :ref:`int` idx **)** virtual | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_get_output_value_port_type` **(** :ref:`int` idx **)** virtual | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_get_text` **(** **)** virtual | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_get_working_memory_size` **(** **)** virtual | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`_has_input_sequence_port` **(** **)** virtual | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`_step` **(** :ref:`Array` inputs, :ref:`Array` outputs, :ref:`int` start_mode, :ref:`Array` working_mem **)** virtual | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`_get_caption` **(** **)** virtual | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`_get_category` **(** **)** virtual | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_input_value_port_count` **(** **)** virtual | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`_get_input_value_port_name` **(** :ref:`int` idx **)** virtual | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_input_value_port_type` **(** :ref:`int` idx **)** virtual | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_output_sequence_port_count` **(** **)** virtual | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`_get_output_sequence_port_text` **(** :ref:`int` idx **)** virtual | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_output_value_port_count` **(** **)** virtual | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`_get_output_value_port_name` **(** :ref:`int` idx **)** virtual | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_output_value_port_type` **(** :ref:`int` idx **)** virtual | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`_get_text` **(** **)** virtual | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_working_memory_size` **(** **)** virtual | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`_has_input_sequence_port` **(** **)** virtual | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`_step` **(** :ref:`Array` inputs, :ref:`Array` outputs, :ref:`int` start_mode, :ref:`Array` working_mem **)** virtual | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -75,85 +75,85 @@ Member Function Description .. _class_VisualScriptCustomNode__get_caption: -- :ref:`String` **_get_caption** **(** **)** virtual +- :ref:`String` **_get_caption** **(** **)** virtual Return the node's title. .. _class_VisualScriptCustomNode__get_category: -- :ref:`String` **_get_category** **(** **)** virtual +- :ref:`String` **_get_category** **(** **)** virtual Return the node's category. .. _class_VisualScriptCustomNode__get_input_value_port_count: -- :ref:`int` **_get_input_value_port_count** **(** **)** virtual +- :ref:`int` **_get_input_value_port_count** **(** **)** virtual Return the count of input value ports. .. _class_VisualScriptCustomNode__get_input_value_port_name: -- :ref:`String` **_get_input_value_port_name** **(** :ref:`int` idx **)** virtual +- :ref:`String` **_get_input_value_port_name** **(** :ref:`int` idx **)** virtual Return the specified input port's name. .. _class_VisualScriptCustomNode__get_input_value_port_type: -- :ref:`int` **_get_input_value_port_type** **(** :ref:`int` idx **)** virtual +- :ref:`int` **_get_input_value_port_type** **(** :ref:`int` idx **)** virtual Return the specified input port's type. See the TYPE\_\* enum in @GlobalScope. .. _class_VisualScriptCustomNode__get_output_sequence_port_count: -- :ref:`int` **_get_output_sequence_port_count** **(** **)** virtual +- :ref:`int` **_get_output_sequence_port_count** **(** **)** virtual Return the amount of output **sequence** ports. .. _class_VisualScriptCustomNode__get_output_sequence_port_text: -- :ref:`String` **_get_output_sequence_port_text** **(** :ref:`int` idx **)** virtual +- :ref:`String` **_get_output_sequence_port_text** **(** :ref:`int` idx **)** virtual Return the specified **sequence** output's name. .. _class_VisualScriptCustomNode__get_output_value_port_count: -- :ref:`int` **_get_output_value_port_count** **(** **)** virtual +- :ref:`int` **_get_output_value_port_count** **(** **)** virtual Return the amount of output value ports. .. _class_VisualScriptCustomNode__get_output_value_port_name: -- :ref:`String` **_get_output_value_port_name** **(** :ref:`int` idx **)** virtual +- :ref:`String` **_get_output_value_port_name** **(** :ref:`int` idx **)** virtual Return the specified output's name. .. _class_VisualScriptCustomNode__get_output_value_port_type: -- :ref:`int` **_get_output_value_port_type** **(** :ref:`int` idx **)** virtual +- :ref:`int` **_get_output_value_port_type** **(** :ref:`int` idx **)** virtual Return the specified output's type. See the TYPE\_\* enum in @GlobalScope. .. _class_VisualScriptCustomNode__get_text: -- :ref:`String` **_get_text** **(** **)** virtual +- :ref:`String` **_get_text** **(** **)** virtual Return the custom node's text, which is shown right next to the input **sequence** port (if there is none, on the place that is usually taken by it). .. _class_VisualScriptCustomNode__get_working_memory_size: -- :ref:`int` **_get_working_memory_size** **(** **)** virtual +- :ref:`int` **_get_working_memory_size** **(** **)** virtual Return the size of the custom node's working memory. See :ref:`_step` for more details. .. _class_VisualScriptCustomNode__has_input_sequence_port: -- :ref:`bool` **_has_input_sequence_port** **(** **)** virtual +- :ref:`bool` **_has_input_sequence_port** **(** **)** virtual Return whether the custom node has an input **sequence** port. .. _class_VisualScriptCustomNode__step: -- :ref:`Variant` **_step** **(** :ref:`Array` inputs, :ref:`Array` outputs, :ref:`int` start_mode, :ref:`Array` working_mem **)** virtual +- :ref:`Variant` **_step** **(** :ref:`Array` inputs, :ref:`Array` outputs, :ref:`int` start_mode, :ref:`Array` working_mem **)** virtual Execute the custom node's logic, returning the index of the output sequence port to use or a :ref:`String` when there is an error. diff --git a/classes/class_visualscriptdeconstruct.rst b/classes/class_visualscriptdeconstruct.rst index aef5270f4..e447fcd9b 100644 --- a/classes/class_visualscriptdeconstruct.rst +++ b/classes/class_visualscriptdeconstruct.rst @@ -19,11 +19,11 @@ A Visual Script node which deconstructs a base type instance into its parts. Member Functions ---------------- -+------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_deconstruct_type` **(** **)** const | -+------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_deconstruct_type` **(** :ref:`int` type **)** | -+------------------------+--------------------------------------------------------------------------------------------------------------------------+ ++------------------------+------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_deconstruct_type` **(** **)** const | ++------------------------+------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_deconstruct_type` **(** :ref:`int` type **)** | ++------------------------+------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -47,10 +47,10 @@ Member Function Description .. _class_VisualScriptDeconstruct_get_deconstruct_type: -- :ref:`int` **get_deconstruct_type** **(** **)** const +- :ref:`int` **get_deconstruct_type** **(** **)** const .. _class_VisualScriptDeconstruct_set_deconstruct_type: -- void **set_deconstruct_type** **(** :ref:`int` type **)** +- void **set_deconstruct_type** **(** :ref:`int` type **)** diff --git a/classes/class_visualscriptemitsignal.rst b/classes/class_visualscriptemitsignal.rst index 3e6a916b4..f6ca191e9 100644 --- a/classes/class_visualscriptemitsignal.rst +++ b/classes/class_visualscriptemitsignal.rst @@ -19,11 +19,11 @@ Emits a specified signal. Member Functions ---------------- -+------------------------------+-----------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_signal` **(** **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_signal` **(** :ref:`String` name **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------+ ++------------------------------+---------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_signal` **(** **)** const | ++------------------------------+---------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_signal` **(** :ref:`String` name **)** | ++------------------------------+---------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -51,10 +51,10 @@ Member Function Description .. _class_VisualScriptEmitSignal_get_signal: -- :ref:`String` **get_signal** **(** **)** const +- :ref:`String` **get_signal** **(** **)** const .. _class_VisualScriptEmitSignal_set_signal: -- void **set_signal** **(** :ref:`String` name **)** +- void **set_signal** **(** :ref:`String` name **)** diff --git a/classes/class_visualscriptenginesingleton.rst b/classes/class_visualscriptenginesingleton.rst index e697ae3d1..0d95a7e45 100644 --- a/classes/class_visualscriptenginesingleton.rst +++ b/classes/class_visualscriptenginesingleton.rst @@ -19,11 +19,11 @@ A Visual Script node returning a singleton from @GlobalScope Member Functions ---------------- -+------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_singleton` **(** **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_singleton` **(** :ref:`String` name **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------+ ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_singleton` **(** **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_singleton` **(** :ref:`String` name **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -43,10 +43,10 @@ Member Function Description .. _class_VisualScriptEngineSingleton_get_singleton: -- :ref:`String` **get_singleton** **(** **)** +- :ref:`String` **get_singleton** **(** **)** .. _class_VisualScriptEngineSingleton_set_singleton: -- void **set_singleton** **(** :ref:`String` name **)** +- void **set_singleton** **(** :ref:`String` name **)** diff --git a/classes/class_visualscriptfunctioncall.rst b/classes/class_visualscriptfunctioncall.rst index 3b59cd115..34bb31f5e 100644 --- a/classes/class_visualscriptfunctioncall.rst +++ b/classes/class_visualscriptfunctioncall.rst @@ -19,47 +19,47 @@ Brief Description Member Functions ---------------- -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_base_path` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_base_script` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_base_type` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_basic_type` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_call_mode` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_function` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_rpc_call_mode` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_singleton` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_use_default_args` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_validate` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_base_path` **(** :ref:`NodePath` base_path **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_base_script` **(** :ref:`String` base_script **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_base_type` **(** :ref:`String` base_type **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_basic_type` **(** :ref:`int` basic_type **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_call_mode` **(** :ref:`int` mode **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_function` **(** :ref:`String` function **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rpc_call_mode` **(** :ref:`int` mode **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_singleton` **(** :ref:`String` singleton **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_default_args` **(** :ref:`int` amount **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_validate` **(** :ref:`bool` enable **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_base_path` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_base_script` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_base_type` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_basic_type` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_call_mode` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_function` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_rpc_call_mode` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_singleton` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_use_default_args` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_validate` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_base_path` **(** :ref:`NodePath` base_path **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_base_script` **(** :ref:`String` base_script **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_base_type` **(** :ref:`String` base_type **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_basic_type` **(** :ref:`int` basic_type **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_call_mode` **(** :ref:`int` mode **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_function` **(** :ref:`String` function **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rpc_call_mode` **(** :ref:`int` mode **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_singleton` **(** :ref:`String` singleton **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_default_args` **(** :ref:`int` amount **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_validate` **(** :ref:`bool` enable **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -128,82 +128,82 @@ Member Function Description .. _class_VisualScriptFunctionCall_get_base_path: -- :ref:`NodePath` **get_base_path** **(** **)** const +- :ref:`NodePath` **get_base_path** **(** **)** const .. _class_VisualScriptFunctionCall_get_base_script: -- :ref:`String` **get_base_script** **(** **)** const +- :ref:`String` **get_base_script** **(** **)** const .. _class_VisualScriptFunctionCall_get_base_type: -- :ref:`String` **get_base_type** **(** **)** const +- :ref:`String` **get_base_type** **(** **)** const .. _class_VisualScriptFunctionCall_get_basic_type: -- :ref:`int` **get_basic_type** **(** **)** const +- :ref:`int` **get_basic_type** **(** **)** const .. _class_VisualScriptFunctionCall_get_call_mode: -- :ref:`int` **get_call_mode** **(** **)** const +- :ref:`int` **get_call_mode** **(** **)** const .. _class_VisualScriptFunctionCall_get_function: -- :ref:`String` **get_function** **(** **)** const +- :ref:`String` **get_function** **(** **)** const .. _class_VisualScriptFunctionCall_get_rpc_call_mode: -- :ref:`int` **get_rpc_call_mode** **(** **)** const +- :ref:`int` **get_rpc_call_mode** **(** **)** const .. _class_VisualScriptFunctionCall_get_singleton: -- :ref:`String` **get_singleton** **(** **)** const +- :ref:`String` **get_singleton** **(** **)** const .. _class_VisualScriptFunctionCall_get_use_default_args: -- :ref:`int` **get_use_default_args** **(** **)** const +- :ref:`int` **get_use_default_args** **(** **)** const .. _class_VisualScriptFunctionCall_get_validate: -- :ref:`bool` **get_validate** **(** **)** const +- :ref:`bool` **get_validate** **(** **)** const .. _class_VisualScriptFunctionCall_set_base_path: -- void **set_base_path** **(** :ref:`NodePath` base_path **)** +- void **set_base_path** **(** :ref:`NodePath` base_path **)** .. _class_VisualScriptFunctionCall_set_base_script: -- void **set_base_script** **(** :ref:`String` base_script **)** +- void **set_base_script** **(** :ref:`String` base_script **)** .. _class_VisualScriptFunctionCall_set_base_type: -- void **set_base_type** **(** :ref:`String` base_type **)** +- void **set_base_type** **(** :ref:`String` base_type **)** .. _class_VisualScriptFunctionCall_set_basic_type: -- void **set_basic_type** **(** :ref:`int` basic_type **)** +- void **set_basic_type** **(** :ref:`int` basic_type **)** .. _class_VisualScriptFunctionCall_set_call_mode: -- void **set_call_mode** **(** :ref:`int` mode **)** +- void **set_call_mode** **(** :ref:`int` mode **)** .. _class_VisualScriptFunctionCall_set_function: -- void **set_function** **(** :ref:`String` function **)** +- void **set_function** **(** :ref:`String` function **)** .. _class_VisualScriptFunctionCall_set_rpc_call_mode: -- void **set_rpc_call_mode** **(** :ref:`int` mode **)** +- void **set_rpc_call_mode** **(** :ref:`int` mode **)** .. _class_VisualScriptFunctionCall_set_singleton: -- void **set_singleton** **(** :ref:`String` singleton **)** +- void **set_singleton** **(** :ref:`String` singleton **)** .. _class_VisualScriptFunctionCall_set_use_default_args: -- void **set_use_default_args** **(** :ref:`int` amount **)** +- void **set_use_default_args** **(** :ref:`int` amount **)** .. _class_VisualScriptFunctionCall_set_validate: -- void **set_validate** **(** :ref:`bool` enable **)** +- void **set_validate** **(** :ref:`bool` enable **)** diff --git a/classes/class_visualscriptfunctionstate.rst b/classes/class_visualscriptfunctionstate.rst index 07304626f..23fd87af5 100644 --- a/classes/class_visualscriptfunctionstate.rst +++ b/classes/class_visualscriptfunctionstate.rst @@ -19,27 +19,27 @@ Brief Description Member Functions ---------------- -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`connect_to_signal` **(** :ref:`Object` obj, :ref:`String` signals, :ref:`Array` args **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_valid` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`resume` **(** :ref:`Array` args=null **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`connect_to_signal` **(** :ref:`Object` obj, :ref:`String` signals, :ref:`Array` args **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_valid` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`resume` **(** :ref:`Array` args=null **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Function Description --------------------------- .. _class_VisualScriptFunctionState_connect_to_signal: -- void **connect_to_signal** **(** :ref:`Object` obj, :ref:`String` signals, :ref:`Array` args **)** +- void **connect_to_signal** **(** :ref:`Object` obj, :ref:`String` signals, :ref:`Array` args **)** .. _class_VisualScriptFunctionState_is_valid: -- :ref:`bool` **is_valid** **(** **)** const +- :ref:`bool` **is_valid** **(** **)** const .. _class_VisualScriptFunctionState_resume: -- :ref:`Variant` **resume** **(** :ref:`Array` args=null **)** +- :ref:`Variant` **resume** **(** :ref:`Array` args=null **)** diff --git a/classes/class_visualscriptglobalconstant.rst b/classes/class_visualscriptglobalconstant.rst index 2db21a047..8bd155f75 100644 --- a/classes/class_visualscriptglobalconstant.rst +++ b/classes/class_visualscriptglobalconstant.rst @@ -19,11 +19,11 @@ Brief Description Member Functions ---------------- -+------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_global_constant` **(** **)** | -+------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_global_constant` **(** :ref:`int` index **)** | -+------------------------+----------------------------------------------------------------------------------------------------------------------------+ ++------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_global_constant` **(** **)** | ++------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_global_constant` **(** :ref:`int` index **)** | ++------------------------+--------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -38,10 +38,10 @@ Member Function Description .. _class_VisualScriptGlobalConstant_get_global_constant: -- :ref:`int` **get_global_constant** **(** **)** +- :ref:`int` **get_global_constant** **(** **)** .. _class_VisualScriptGlobalConstant_set_global_constant: -- void **set_global_constant** **(** :ref:`int` index **)** +- void **set_global_constant** **(** :ref:`int` index **)** diff --git a/classes/class_visualscriptinputaction.rst b/classes/class_visualscriptinputaction.rst index f34579b80..cdf7fd6e2 100644 --- a/classes/class_visualscriptinputaction.rst +++ b/classes/class_visualscriptinputaction.rst @@ -19,15 +19,15 @@ Brief Description Member Functions ---------------- -+------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_action_mode` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_action_name` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_action_mode` **(** :ref:`int` mode **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_action_name` **(** :ref:`String` name **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------+ ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_action_mode` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_action_name` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_action_mode` **(** :ref:`int` mode **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_action_name` **(** :ref:`String` name **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -54,18 +54,18 @@ Member Function Description .. _class_VisualScriptInputAction_get_action_mode: -- :ref:`int` **get_action_mode** **(** **)** const +- :ref:`int` **get_action_mode** **(** **)** const .. _class_VisualScriptInputAction_get_action_name: -- :ref:`String` **get_action_name** **(** **)** const +- :ref:`String` **get_action_name** **(** **)** const .. _class_VisualScriptInputAction_set_action_mode: -- void **set_action_mode** **(** :ref:`int` mode **)** +- void **set_action_mode** **(** :ref:`int` mode **)** .. _class_VisualScriptInputAction_set_action_name: -- void **set_action_name** **(** :ref:`String` name **)** +- void **set_action_name** **(** :ref:`String` name **)** diff --git a/classes/class_visualscriptlocalvar.rst b/classes/class_visualscriptlocalvar.rst index 29f907bb6..9eb992ff7 100644 --- a/classes/class_visualscriptlocalvar.rst +++ b/classes/class_visualscriptlocalvar.rst @@ -19,15 +19,15 @@ Gets a local variable's value. Member Functions ---------------- -+------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_var_name` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_var_type` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_var_name` **(** :ref:`String` name **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_var_type` **(** :ref:`int` type **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------+ ++------------------------------+-----------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_var_name` **(** **)** const | ++------------------------------+-----------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_var_type` **(** **)** const | ++------------------------------+-----------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_var_name` **(** :ref:`String` name **)** | ++------------------------------+-----------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_var_type` **(** :ref:`int` type **)** | ++------------------------------+-----------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -59,18 +59,18 @@ Member Function Description .. _class_VisualScriptLocalVar_get_var_name: -- :ref:`String` **get_var_name** **(** **)** const +- :ref:`String` **get_var_name** **(** **)** const .. _class_VisualScriptLocalVar_get_var_type: -- :ref:`int` **get_var_type** **(** **)** const +- :ref:`int` **get_var_type** **(** **)** const .. _class_VisualScriptLocalVar_set_var_name: -- void **set_var_name** **(** :ref:`String` name **)** +- void **set_var_name** **(** :ref:`String` name **)** .. _class_VisualScriptLocalVar_set_var_type: -- void **set_var_type** **(** :ref:`int` type **)** +- void **set_var_type** **(** :ref:`int` type **)** diff --git a/classes/class_visualscriptlocalvarset.rst b/classes/class_visualscriptlocalvarset.rst index 7aaa166f3..e43272148 100644 --- a/classes/class_visualscriptlocalvarset.rst +++ b/classes/class_visualscriptlocalvarset.rst @@ -19,15 +19,15 @@ Changes a local variable's value. Member Functions ---------------- -+------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_var_name` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_var_type` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_var_name` **(** :ref:`String` name **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_var_type` **(** :ref:`int` type **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------+ ++------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_var_name` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_var_type` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_var_name` **(** :ref:`String` name **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_var_type` **(** :ref:`int` type **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -63,18 +63,18 @@ Member Function Description .. _class_VisualScriptLocalVarSet_get_var_name: -- :ref:`String` **get_var_name** **(** **)** const +- :ref:`String` **get_var_name** **(** **)** const .. _class_VisualScriptLocalVarSet_get_var_type: -- :ref:`int` **get_var_type** **(** **)** const +- :ref:`int` **get_var_type** **(** **)** const .. _class_VisualScriptLocalVarSet_set_var_name: -- void **set_var_name** **(** :ref:`String` name **)** +- void **set_var_name** **(** :ref:`String` name **)** .. _class_VisualScriptLocalVarSet_set_var_type: -- void **set_var_type** **(** :ref:`int` type **)** +- void **set_var_type** **(** :ref:`int` type **)** diff --git a/classes/class_visualscriptmathconstant.rst b/classes/class_visualscriptmathconstant.rst index 45c528384..fe9a2c4d7 100644 --- a/classes/class_visualscriptmathconstant.rst +++ b/classes/class_visualscriptmathconstant.rst @@ -19,11 +19,11 @@ Commonly used mathematical constants. Member Functions ---------------- -+------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_math_constant` **(** **)** | -+------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_math_constant` **(** :ref:`int` which **)** | -+------------------------+----------------------------------------------------------------------------------------------------------------------+ ++------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_math_constant` **(** **)** | ++------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_math_constant` **(** :ref:`int` which **)** | ++------------------------+--------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -64,10 +64,10 @@ Member Function Description .. _class_VisualScriptMathConstant_get_math_constant: -- :ref:`int` **get_math_constant** **(** **)** +- :ref:`int` **get_math_constant** **(** **)** .. _class_VisualScriptMathConstant_set_math_constant: -- void **set_math_constant** **(** :ref:`int` which **)** +- void **set_math_constant** **(** :ref:`int` which **)** diff --git a/classes/class_visualscriptnode.rst b/classes/class_visualscriptnode.rst index b85fe6c70..22cf8f565 100644 --- a/classes/class_visualscriptnode.rst +++ b/classes/class_visualscriptnode.rst @@ -21,22 +21,22 @@ A node which is part of a :ref:`VisualScript`. Member Functions ---------------- -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_default_input_value` **(** :ref:`int` port_idx **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`VisualScript` | :ref:`get_visual_script` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`ports_changed_notify` **(** **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_default_input_value` **(** :ref:`int` port_idx, :ref:`Variant` value **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_default_input_value` **(** :ref:`int` port_idx **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`VisualScript` | :ref:`get_visual_script` **(** **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`ports_changed_notify` **(** **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_default_input_value` **(** :ref:`int` port_idx, :ref:`Variant` value **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_VisualScriptNode_ports_changed: -- **ports_changed** **(** **)** +- **ports_changed** **(** **)** Emitted when the available input/output ports are changed. @@ -59,25 +59,25 @@ Member Function Description .. _class_VisualScriptNode_get_default_input_value: -- :ref:`Variant` **get_default_input_value** **(** :ref:`int` port_idx **)** const +- :ref:`Variant` **get_default_input_value** **(** :ref:`int` port_idx **)** const Returns the default value of a given port. The default value is used when nothing is connected to the port. .. _class_VisualScriptNode_get_visual_script: -- :ref:`VisualScript` **get_visual_script** **(** **)** const +- :ref:`VisualScript` **get_visual_script** **(** **)** const Returns the :ref:`VisualScript` instance the node is bound to. .. _class_VisualScriptNode_ports_changed_notify: -- void **ports_changed_notify** **(** **)** +- void **ports_changed_notify** **(** **)** Notify that the node's ports have changed. Usually used in conjunction with :ref:`VisualScriptCustomNode` . .. _class_VisualScriptNode_set_default_input_value: -- void **set_default_input_value** **(** :ref:`int` port_idx, :ref:`Variant` value **)** +- void **set_default_input_value** **(** :ref:`int` port_idx, :ref:`Variant` value **)** Change the default value of a given port. diff --git a/classes/class_visualscriptoperator.rst b/classes/class_visualscriptoperator.rst index 63f25f325..ace8ca74d 100644 --- a/classes/class_visualscriptoperator.rst +++ b/classes/class_visualscriptoperator.rst @@ -19,15 +19,15 @@ Brief Description Member Functions ---------------- -+------------------------+-----------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_operator` **(** **)** const | -+------------------------+-----------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_typed` **(** **)** const | -+------------------------+-----------------------------------------------------------------------------------------------------+ -| void | :ref:`set_operator` **(** :ref:`int` op **)** | -+------------------------+-----------------------------------------------------------------------------------------------------+ -| void | :ref:`set_typed` **(** :ref:`int` type **)** | -+------------------------+-----------------------------------------------------------------------------------------------------+ ++------------------------+---------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_operator` **(** **)** const | ++------------------------+---------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_typed` **(** **)** const | ++------------------------+---------------------------------------------------------------------------------------------------+ +| void | :ref:`set_operator` **(** :ref:`int` op **)** | ++------------------------+---------------------------------------------------------------------------------------------------+ +| void | :ref:`set_typed` **(** :ref:`int` type **)** | ++------------------------+---------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -59,18 +59,18 @@ Member Function Description .. _class_VisualScriptOperator_get_operator: -- :ref:`int` **get_operator** **(** **)** const +- :ref:`int` **get_operator** **(** **)** const .. _class_VisualScriptOperator_get_typed: -- :ref:`int` **get_typed** **(** **)** const +- :ref:`int` **get_typed** **(** **)** const .. _class_VisualScriptOperator_set_operator: -- void **set_operator** **(** :ref:`int` op **)** +- void **set_operator** **(** :ref:`int` op **)** .. _class_VisualScriptOperator_set_typed: -- void **set_typed** **(** :ref:`int` type **)** +- void **set_typed** **(** :ref:`int` type **)** diff --git a/classes/class_visualscriptpreload.rst b/classes/class_visualscriptpreload.rst index 530ddd85c..ffa0393ae 100644 --- a/classes/class_visualscriptpreload.rst +++ b/classes/class_visualscriptpreload.rst @@ -19,11 +19,11 @@ Creates a new :ref:`Resource` or loads one from the filesystem. Member Functions ---------------- -+----------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`Resource` | :ref:`get_preload` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_preload` **(** :ref:`Resource` resource **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------+ ++----------------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`Resource` | :ref:`get_preload` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_preload` **(** :ref:`Resource` resource **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -51,10 +51,10 @@ Member Function Description .. _class_VisualScriptPreload_get_preload: -- :ref:`Resource` **get_preload** **(** **)** const +- :ref:`Resource` **get_preload** **(** **)** const .. _class_VisualScriptPreload_set_preload: -- void **set_preload** **(** :ref:`Resource` resource **)** +- void **set_preload** **(** :ref:`Resource` resource **)** diff --git a/classes/class_visualscriptpropertyget.rst b/classes/class_visualscriptpropertyget.rst index c36acbd1d..cb37fbdc3 100644 --- a/classes/class_visualscriptpropertyget.rst +++ b/classes/class_visualscriptpropertyget.rst @@ -19,35 +19,35 @@ Brief Description Member Functions ---------------- -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_base_path` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_base_script` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_base_type` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_basic_type` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_call_mode` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_index` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_property` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_base_path` **(** :ref:`NodePath` base_path **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_base_script` **(** :ref:`String` base_script **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_base_type` **(** :ref:`String` base_type **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_basic_type` **(** :ref:`int` basic_type **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_call_mode` **(** :ref:`int` mode **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_index` **(** :ref:`String` index **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_property` **(** :ref:`String` property **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_base_path` **(** **)** const | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_base_script` **(** **)** const | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_base_type` **(** **)** const | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_basic_type` **(** **)** const | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_call_mode` **(** **)** const | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_index` **(** **)** const | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_property` **(** **)** const | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_base_path` **(** :ref:`NodePath` base_path **)** | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_base_script` **(** :ref:`String` base_script **)** | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_base_type` **(** :ref:`String` base_type **)** | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_basic_type` **(** :ref:`int` basic_type **)** | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_call_mode` **(** :ref:`int` mode **)** | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_index` **(** :ref:`String` index **)** | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_property` **(** :ref:`String` property **)** | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -97,58 +97,58 @@ Member Function Description .. _class_VisualScriptPropertyGet_get_base_path: -- :ref:`NodePath` **get_base_path** **(** **)** const +- :ref:`NodePath` **get_base_path** **(** **)** const .. _class_VisualScriptPropertyGet_get_base_script: -- :ref:`String` **get_base_script** **(** **)** const +- :ref:`String` **get_base_script** **(** **)** const .. _class_VisualScriptPropertyGet_get_base_type: -- :ref:`String` **get_base_type** **(** **)** const +- :ref:`String` **get_base_type** **(** **)** const .. _class_VisualScriptPropertyGet_get_basic_type: -- :ref:`int` **get_basic_type** **(** **)** const +- :ref:`int` **get_basic_type** **(** **)** const .. _class_VisualScriptPropertyGet_get_call_mode: -- :ref:`int` **get_call_mode** **(** **)** const +- :ref:`int` **get_call_mode** **(** **)** const .. _class_VisualScriptPropertyGet_get_index: -- :ref:`String` **get_index** **(** **)** const +- :ref:`String` **get_index** **(** **)** const .. _class_VisualScriptPropertyGet_get_property: -- :ref:`String` **get_property** **(** **)** const +- :ref:`String` **get_property** **(** **)** const .. _class_VisualScriptPropertyGet_set_base_path: -- void **set_base_path** **(** :ref:`NodePath` base_path **)** +- void **set_base_path** **(** :ref:`NodePath` base_path **)** .. _class_VisualScriptPropertyGet_set_base_script: -- void **set_base_script** **(** :ref:`String` base_script **)** +- void **set_base_script** **(** :ref:`String` base_script **)** .. _class_VisualScriptPropertyGet_set_base_type: -- void **set_base_type** **(** :ref:`String` base_type **)** +- void **set_base_type** **(** :ref:`String` base_type **)** .. _class_VisualScriptPropertyGet_set_basic_type: -- void **set_basic_type** **(** :ref:`int` basic_type **)** +- void **set_basic_type** **(** :ref:`int` basic_type **)** .. _class_VisualScriptPropertyGet_set_call_mode: -- void **set_call_mode** **(** :ref:`int` mode **)** +- void **set_call_mode** **(** :ref:`int` mode **)** .. _class_VisualScriptPropertyGet_set_index: -- void **set_index** **(** :ref:`String` index **)** +- void **set_index** **(** :ref:`String` index **)** .. _class_VisualScriptPropertyGet_set_property: -- void **set_property** **(** :ref:`String` property **)** +- void **set_property** **(** :ref:`String` property **)** diff --git a/classes/class_visualscriptpropertyset.rst b/classes/class_visualscriptpropertyset.rst index 1f83d1cec..7354ff91c 100644 --- a/classes/class_visualscriptpropertyset.rst +++ b/classes/class_visualscriptpropertyset.rst @@ -19,39 +19,39 @@ Brief Description Member Functions ---------------- -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_assign_op` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_base_path` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_base_script` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_base_type` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_basic_type` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_call_mode` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_index` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_property` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_assign_op` **(** :ref:`int` assign_op **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_base_path` **(** :ref:`NodePath` base_path **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_base_script` **(** :ref:`String` base_script **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_base_type` **(** :ref:`String` base_type **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_basic_type` **(** :ref:`int` basic_type **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_call_mode` **(** :ref:`int` mode **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_index` **(** :ref:`String` index **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_property` **(** :ref:`String` property **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_assign_op` **(** **)** const | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_base_path` **(** **)** const | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_base_script` **(** **)** const | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_base_type` **(** **)** const | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_basic_type` **(** **)** const | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_call_mode` **(** **)** const | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_index` **(** **)** const | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_property` **(** **)** const | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_assign_op` **(** :ref:`int` assign_op **)** | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_base_path` **(** :ref:`NodePath` base_path **)** | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_base_script` **(** :ref:`String` base_script **)** | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_base_type` **(** :ref:`String` base_type **)** | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_basic_type` **(** :ref:`int` basic_type **)** | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_call_mode` **(** :ref:`int` mode **)** | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_index` **(** :ref:`String` index **)** | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_property` **(** :ref:`String` property **)** | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -117,66 +117,66 @@ Member Function Description .. _class_VisualScriptPropertySet_get_assign_op: -- :ref:`int` **get_assign_op** **(** **)** const +- :ref:`int` **get_assign_op** **(** **)** const .. _class_VisualScriptPropertySet_get_base_path: -- :ref:`NodePath` **get_base_path** **(** **)** const +- :ref:`NodePath` **get_base_path** **(** **)** const .. _class_VisualScriptPropertySet_get_base_script: -- :ref:`String` **get_base_script** **(** **)** const +- :ref:`String` **get_base_script** **(** **)** const .. _class_VisualScriptPropertySet_get_base_type: -- :ref:`String` **get_base_type** **(** **)** const +- :ref:`String` **get_base_type** **(** **)** const .. _class_VisualScriptPropertySet_get_basic_type: -- :ref:`int` **get_basic_type** **(** **)** const +- :ref:`int` **get_basic_type** **(** **)** const .. _class_VisualScriptPropertySet_get_call_mode: -- :ref:`int` **get_call_mode** **(** **)** const +- :ref:`int` **get_call_mode** **(** **)** const .. _class_VisualScriptPropertySet_get_index: -- :ref:`String` **get_index** **(** **)** const +- :ref:`String` **get_index** **(** **)** const .. _class_VisualScriptPropertySet_get_property: -- :ref:`String` **get_property** **(** **)** const +- :ref:`String` **get_property** **(** **)** const .. _class_VisualScriptPropertySet_set_assign_op: -- void **set_assign_op** **(** :ref:`int` assign_op **)** +- void **set_assign_op** **(** :ref:`int` assign_op **)** .. _class_VisualScriptPropertySet_set_base_path: -- void **set_base_path** **(** :ref:`NodePath` base_path **)** +- void **set_base_path** **(** :ref:`NodePath` base_path **)** .. _class_VisualScriptPropertySet_set_base_script: -- void **set_base_script** **(** :ref:`String` base_script **)** +- void **set_base_script** **(** :ref:`String` base_script **)** .. _class_VisualScriptPropertySet_set_base_type: -- void **set_base_type** **(** :ref:`String` base_type **)** +- void **set_base_type** **(** :ref:`String` base_type **)** .. _class_VisualScriptPropertySet_set_basic_type: -- void **set_basic_type** **(** :ref:`int` basic_type **)** +- void **set_basic_type** **(** :ref:`int` basic_type **)** .. _class_VisualScriptPropertySet_set_call_mode: -- void **set_call_mode** **(** :ref:`int` mode **)** +- void **set_call_mode** **(** :ref:`int` mode **)** .. _class_VisualScriptPropertySet_set_index: -- void **set_index** **(** :ref:`String` index **)** +- void **set_index** **(** :ref:`String` index **)** .. _class_VisualScriptPropertySet_set_property: -- void **set_property** **(** :ref:`String` property **)** +- void **set_property** **(** :ref:`String` property **)** diff --git a/classes/class_visualscriptresourcepath.rst b/classes/class_visualscriptresourcepath.rst index 83e4a3e5d..d2cdd0d82 100644 --- a/classes/class_visualscriptresourcepath.rst +++ b/classes/class_visualscriptresourcepath.rst @@ -19,11 +19,11 @@ Brief Description Member Functions ---------------- -+------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_resource_path` **(** **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_resource_path` **(** :ref:`String` path **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------+ ++------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_resource_path` **(** **)** | ++------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_resource_path` **(** :ref:`String` path **)** | ++------------------------------+-------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -38,10 +38,10 @@ Member Function Description .. _class_VisualScriptResourcePath_get_resource_path: -- :ref:`String` **get_resource_path** **(** **)** +- :ref:`String` **get_resource_path** **(** **)** .. _class_VisualScriptResourcePath_set_resource_path: -- void **set_resource_path** **(** :ref:`String` path **)** +- void **set_resource_path** **(** :ref:`String` path **)** diff --git a/classes/class_visualscriptreturn.rst b/classes/class_visualscriptreturn.rst index 6627e7c81..8d946d9bd 100644 --- a/classes/class_visualscriptreturn.rst +++ b/classes/class_visualscriptreturn.rst @@ -19,15 +19,15 @@ Exits a function and returns an optional value. Member Functions ---------------- -+--------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_return_type` **(** **)** const | -+--------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_return_value_enabled` **(** **)** const | -+--------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_enable_return_value` **(** :ref:`bool` enable **)** | -+--------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_return_type` **(** :ref:`int` type **)** | -+--------------------------+-------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_return_type` **(** **)** const | ++--------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_return_value_enabled` **(** **)** const | ++--------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_enable_return_value` **(** :ref:`bool` enable **)** | ++--------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_return_type` **(** :ref:`int` type **)** | ++--------------------------+-----------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -61,18 +61,18 @@ Member Function Description .. _class_VisualScriptReturn_get_return_type: -- :ref:`int` **get_return_type** **(** **)** const +- :ref:`int` **get_return_type** **(** **)** const .. _class_VisualScriptReturn_is_return_value_enabled: -- :ref:`bool` **is_return_value_enabled** **(** **)** const +- :ref:`bool` **is_return_value_enabled** **(** **)** const .. _class_VisualScriptReturn_set_enable_return_value: -- void **set_enable_return_value** **(** :ref:`bool` enable **)** +- void **set_enable_return_value** **(** :ref:`bool` enable **)** .. _class_VisualScriptReturn_set_return_type: -- void **set_return_type** **(** :ref:`int` type **)** +- void **set_return_type** **(** :ref:`int` type **)** diff --git a/classes/class_visualscriptscenenode.rst b/classes/class_visualscriptscenenode.rst index 72e2f4b1a..b37d4c1dc 100644 --- a/classes/class_visualscriptscenenode.rst +++ b/classes/class_visualscriptscenenode.rst @@ -19,11 +19,11 @@ Node reference. Member Functions ---------------- -+----------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_node_path` **(** **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_node_path` **(** :ref:`NodePath` path **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------+ ++----------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_node_path` **(** **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_node_path` **(** :ref:`NodePath` path **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -51,10 +51,10 @@ Member Function Description .. _class_VisualScriptSceneNode_get_node_path: -- :ref:`NodePath` **get_node_path** **(** **)** +- :ref:`NodePath` **get_node_path** **(** **)** .. _class_VisualScriptSceneNode_set_node_path: -- void **set_node_path** **(** :ref:`NodePath` path **)** +- void **set_node_path** **(** :ref:`NodePath` path **)** diff --git a/classes/class_visualscriptselect.rst b/classes/class_visualscriptselect.rst index f02b92b7c..8d1ee5930 100644 --- a/classes/class_visualscriptselect.rst +++ b/classes/class_visualscriptselect.rst @@ -19,11 +19,11 @@ Chooses between two input values. Member Functions ---------------- -+------------------------+-----------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_typed` **(** **)** const | -+------------------------+-----------------------------------------------------------------------------------------------+ -| void | :ref:`set_typed` **(** :ref:`int` type **)** | -+------------------------+-----------------------------------------------------------------------------------------------+ ++------------------------+---------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_typed` **(** **)** const | ++------------------------+---------------------------------------------------------------------------------------------+ +| void | :ref:`set_typed` **(** :ref:`int` type **)** | ++------------------------+---------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -55,10 +55,10 @@ Member Function Description .. _class_VisualScriptSelect_get_typed: -- :ref:`int` **get_typed** **(** **)** const +- :ref:`int` **get_typed** **(** **)** const .. _class_VisualScriptSelect_set_typed: -- void **set_typed** **(** :ref:`int` type **)** +- void **set_typed** **(** :ref:`int` type **)** diff --git a/classes/class_visualscriptsequence.rst b/classes/class_visualscriptsequence.rst index cd7d31da9..ed884e79d 100644 --- a/classes/class_visualscriptsequence.rst +++ b/classes/class_visualscriptsequence.rst @@ -19,11 +19,11 @@ Executes a series of Sequence ports. Member Functions ---------------- -+------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_steps` **(** **)** const | -+------------------------+--------------------------------------------------------------------------------------------------+ -| void | :ref:`set_steps` **(** :ref:`int` steps **)** | -+------------------------+--------------------------------------------------------------------------------------------------+ ++------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_steps` **(** **)** const | ++------------------------+------------------------------------------------------------------------------------------------+ +| void | :ref:`set_steps` **(** :ref:`int` steps **)** | ++------------------------+------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -55,10 +55,10 @@ Member Function Description .. _class_VisualScriptSequence_get_steps: -- :ref:`int` **get_steps** **(** **)** const +- :ref:`int` **get_steps** **(** **)** const .. _class_VisualScriptSequence_set_steps: -- void **set_steps** **(** :ref:`int` steps **)** +- void **set_steps** **(** :ref:`int` steps **)** diff --git a/classes/class_visualscriptsubcall.rst b/classes/class_visualscriptsubcall.rst index 7b1a0d4a7..95ef06a27 100644 --- a/classes/class_visualscriptsubcall.rst +++ b/classes/class_visualscriptsubcall.rst @@ -19,15 +19,15 @@ Brief Description Member Functions ---------------- -+--------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`_subcall` **(** :ref:`Variant` arguments **)** virtual | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`_subcall` **(** :ref:`Variant` arguments **)** virtual | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------+ Member Function Description --------------------------- .. _class_VisualScriptSubCall__subcall: -- :ref:`Variant` **_subcall** **(** :ref:`Variant` arguments **)** virtual +- :ref:`Variant` **_subcall** **(** :ref:`Variant` arguments **)** virtual diff --git a/classes/class_visualscripttypecast.rst b/classes/class_visualscripttypecast.rst index ab87efc52..8deb36f6a 100644 --- a/classes/class_visualscripttypecast.rst +++ b/classes/class_visualscripttypecast.rst @@ -19,15 +19,15 @@ Brief Description Member Functions ---------------- -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_base_script` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_base_type` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_base_script` **(** :ref:`String` path **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_base_type` **(** :ref:`String` type **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ ++------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_base_script` **(** **)** const | ++------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_base_type` **(** **)** const | ++------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_base_script` **(** :ref:`String` path **)** | ++------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_base_type` **(** :ref:`String` type **)** | ++------------------------------+-----------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -46,18 +46,18 @@ Member Function Description .. _class_VisualScriptTypeCast_get_base_script: -- :ref:`String` **get_base_script** **(** **)** const +- :ref:`String` **get_base_script** **(** **)** const .. _class_VisualScriptTypeCast_get_base_type: -- :ref:`String` **get_base_type** **(** **)** const +- :ref:`String` **get_base_type** **(** **)** const .. _class_VisualScriptTypeCast_set_base_script: -- void **set_base_script** **(** :ref:`String` path **)** +- void **set_base_script** **(** :ref:`String` path **)** .. _class_VisualScriptTypeCast_set_base_type: -- void **set_base_type** **(** :ref:`String` type **)** +- void **set_base_type** **(** :ref:`String` type **)** diff --git a/classes/class_visualscriptvariableget.rst b/classes/class_visualscriptvariableget.rst index e2938b774..b4ff36c3b 100644 --- a/classes/class_visualscriptvariableget.rst +++ b/classes/class_visualscriptvariableget.rst @@ -19,11 +19,11 @@ Gets a variable's value. Member Functions ---------------- -+------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_variable` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_variable` **(** :ref:`String` name **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------+ ++------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_variable` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_variable` **(** :ref:`String` name **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -51,10 +51,10 @@ Member Function Description .. _class_VisualScriptVariableGet_get_variable: -- :ref:`String` **get_variable** **(** **)** const +- :ref:`String` **get_variable** **(** **)** const .. _class_VisualScriptVariableGet_set_variable: -- void **set_variable** **(** :ref:`String` name **)** +- void **set_variable** **(** :ref:`String` name **)** diff --git a/classes/class_visualscriptvariableset.rst b/classes/class_visualscriptvariableset.rst index 00cd95287..5190d85f2 100644 --- a/classes/class_visualscriptvariableset.rst +++ b/classes/class_visualscriptvariableset.rst @@ -19,11 +19,11 @@ Changes a variable's value. Member Functions ---------------- -+------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_variable` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_variable` **(** :ref:`String` name **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------+ ++------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_variable` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_variable` **(** :ref:`String` name **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -53,10 +53,10 @@ Member Function Description .. _class_VisualScriptVariableSet_get_variable: -- :ref:`String` **get_variable** **(** **)** const +- :ref:`String` **get_variable** **(** **)** const .. _class_VisualScriptVariableSet_set_variable: -- void **set_variable** **(** :ref:`String` name **)** +- void **set_variable** **(** :ref:`String` name **)** diff --git a/classes/class_visualscriptyield.rst b/classes/class_visualscriptyield.rst index 2c6d94332..8753a7400 100644 --- a/classes/class_visualscriptyield.rst +++ b/classes/class_visualscriptyield.rst @@ -19,15 +19,15 @@ Brief Description Member Functions ---------------- -+----------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_wait_time` **(** **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_yield_mode` **(** **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_wait_time` **(** :ref:`float` sec **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_yield_mode` **(** :ref:`int` mode **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------+ ++----------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_wait_time` **(** **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_yield_mode` **(** **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_wait_time` **(** :ref:`float` sec **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_yield_mode` **(** :ref:`int` mode **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -53,18 +53,18 @@ Member Function Description .. _class_VisualScriptYield_get_wait_time: -- :ref:`float` **get_wait_time** **(** **)** +- :ref:`float` **get_wait_time** **(** **)** .. _class_VisualScriptYield_get_yield_mode: -- :ref:`int` **get_yield_mode** **(** **)** +- :ref:`int` **get_yield_mode** **(** **)** .. _class_VisualScriptYield_set_wait_time: -- void **set_wait_time** **(** :ref:`float` sec **)** +- void **set_wait_time** **(** :ref:`float` sec **)** .. _class_VisualScriptYield_set_yield_mode: -- void **set_yield_mode** **(** :ref:`int` mode **)** +- void **set_yield_mode** **(** :ref:`int` mode **)** diff --git a/classes/class_visualscriptyieldsignal.rst b/classes/class_visualscriptyieldsignal.rst index 3c389889e..429d662e8 100644 --- a/classes/class_visualscriptyieldsignal.rst +++ b/classes/class_visualscriptyieldsignal.rst @@ -19,23 +19,23 @@ Brief Description Member Functions ---------------- -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_base_path` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_base_type` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_call_mode` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_signal` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_base_path` **(** :ref:`NodePath` base_path **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_base_type` **(** :ref:`String` base_type **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_call_mode` **(** :ref:`int` mode **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_signal` **(** :ref:`String` signal **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_base_path` **(** **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_base_type` **(** **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_call_mode` **(** **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_signal` **(** **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_base_path` **(** :ref:`NodePath` base_path **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_base_type` **(** :ref:`String` base_type **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_call_mode` **(** :ref:`int` mode **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_signal` **(** :ref:`String` signal **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -69,34 +69,34 @@ Member Function Description .. _class_VisualScriptYieldSignal_get_base_path: -- :ref:`NodePath` **get_base_path** **(** **)** const +- :ref:`NodePath` **get_base_path** **(** **)** const .. _class_VisualScriptYieldSignal_get_base_type: -- :ref:`String` **get_base_type** **(** **)** const +- :ref:`String` **get_base_type** **(** **)** const .. _class_VisualScriptYieldSignal_get_call_mode: -- :ref:`int` **get_call_mode** **(** **)** const +- :ref:`int` **get_call_mode** **(** **)** const .. _class_VisualScriptYieldSignal_get_signal: -- :ref:`String` **get_signal** **(** **)** const +- :ref:`String` **get_signal** **(** **)** const .. _class_VisualScriptYieldSignal_set_base_path: -- void **set_base_path** **(** :ref:`NodePath` base_path **)** +- void **set_base_path** **(** :ref:`NodePath` base_path **)** .. _class_VisualScriptYieldSignal_set_base_type: -- void **set_base_type** **(** :ref:`String` base_type **)** +- void **set_base_type** **(** :ref:`String` base_type **)** .. _class_VisualScriptYieldSignal_set_call_mode: -- void **set_call_mode** **(** :ref:`int` mode **)** +- void **set_call_mode** **(** :ref:`int` mode **)** .. _class_VisualScriptYieldSignal_set_signal: -- void **set_signal** **(** :ref:`String` signal **)** +- void **set_signal** **(** :ref:`String` signal **)** diff --git a/classes/class_visualserver.rst b/classes/class_visualserver.rst index 39682ba55..c08ea5bce 100644 --- a/classes/class_visualserver.rst +++ b/classes/class_visualserver.rst @@ -19,357 +19,357 @@ Server for anything visible. Member Functions ---------------- -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`black_bars_set_images` **(** :ref:`RID` left, :ref:`RID` top, :ref:`RID` right, :ref:`RID` bottom **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`black_bars_set_margins` **(** :ref:`int` left, :ref:`int` top, :ref:`int` right, :ref:`int` bottom **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`canvas_create` **(** **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_circle` **(** :ref:`RID` item, :ref:`Vector2` pos, :ref:`float` radius, :ref:`Color` color **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_clip_ignore` **(** :ref:`RID` item, :ref:`bool` ignore **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_line` **(** :ref:`RID` item, :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_mesh` **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`RID` skeleton **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_multimesh` **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`RID` skeleton **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_nine_patch` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`Rect2` source, :ref:`RID` texture, :ref:`Vector2` topleft, :ref:`Vector2` bottomright, :ref:`int` x_axis_mode=0, :ref:`int` y_axis_mode=0, :ref:`bool` draw_center=true, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`RID` normal_map **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_particles` **(** :ref:`RID` item, :ref:`RID` particles, :ref:`RID` texture, :ref:`RID` normal_map, :ref:`int` h_frames, :ref:`int` v_frames **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_polygon` **(** :ref:`RID` item, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`RID` texture, :ref:`RID` normal_map, :ref:`bool` antialiased=false **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_polyline` **(** :ref:`RID` item, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_primitive` **(** :ref:`RID` item, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs, :ref:`RID` texture, :ref:`float` width=1.0, :ref:`RID` normal_map **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_rect` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`Color` color **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_set_transform` **(** :ref:`RID` item, :ref:`Transform2D` transform **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_texture_rect` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`bool` tile=false, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`RID` normal_map **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_texture_rect_region` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`RID` normal_map, :ref:`bool` clip_uv=true **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_triangle_array` **(** :ref:`RID` item, :ref:`PoolIntArray` indices, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`RID` texture, :ref:`int` count=-1, :ref:`RID` normal_map **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_clear` **(** :ref:`RID` item **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`canvas_item_create` **(** **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_clip` **(** :ref:`RID` item, :ref:`bool` clip **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_copy_to_backbuffer` **(** :ref:`RID` item, :ref:`bool` enabled, :ref:`Rect2` rect **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_custom_rect` **(** :ref:`RID` item, :ref:`bool` use_custom_rect, :ref:`Rect2` rect=Rect2( 0, 0, 0, 0 ) **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_distance_field_mode` **(** :ref:`RID` item, :ref:`bool` enabled **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_draw_behind_parent` **(** :ref:`RID` item, :ref:`bool` enabled **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_draw_index` **(** :ref:`RID` item, :ref:`int` index **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_light_mask` **(** :ref:`RID` item, :ref:`int` mask **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_material` **(** :ref:`RID` item, :ref:`RID` material **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_modulate` **(** :ref:`RID` item, :ref:`Color` color **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_parent` **(** :ref:`RID` item, :ref:`RID` parent **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_self_modulate` **(** :ref:`RID` item, :ref:`Color` color **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_sort_children_by_y` **(** :ref:`RID` item, :ref:`bool` enabled **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_transform` **(** :ref:`RID` item, :ref:`Transform2D` transform **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_use_parent_material` **(** :ref:`RID` item, :ref:`bool` enabled **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_visible` **(** :ref:`RID` item, :ref:`bool` visible **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_z` **(** :ref:`RID` item, :ref:`int` z **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_z_as_relative_to_parent` **(** :ref:`RID` item, :ref:`bool` enabled **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_attach_to_canvas` **(** :ref:`RID` light, :ref:`RID` canvas **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`canvas_light_create` **(** **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_occluder_attach_to_canvas` **(** :ref:`RID` occluder, :ref:`RID` canvas **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`canvas_light_occluder_create` **(** **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_occluder_set_enabled` **(** :ref:`RID` occluder, :ref:`bool` enabled **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_occluder_set_light_mask` **(** :ref:`RID` occluder, :ref:`int` mask **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_occluder_set_polygon` **(** :ref:`RID` occluder, :ref:`RID` polygon **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_occluder_set_transform` **(** :ref:`RID` occluder, :ref:`Transform2D` transform **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_color` **(** :ref:`RID` light, :ref:`Color` color **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_enabled` **(** :ref:`RID` light, :ref:`bool` enabled **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_energy` **(** :ref:`RID` light, :ref:`float` energy **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_height` **(** :ref:`RID` light, :ref:`float` height **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_item_cull_mask` **(** :ref:`RID` light, :ref:`int` mask **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_item_shadow_cull_mask` **(** :ref:`RID` light, :ref:`int` mask **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_layer_range` **(** :ref:`RID` light, :ref:`int` min_layer, :ref:`int` max_layer **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_mode` **(** :ref:`RID` light, :ref:`int` mode **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_scale` **(** :ref:`RID` light, :ref:`float` scale **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_shadow_buffer_size` **(** :ref:`RID` light, :ref:`int` size **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_shadow_color` **(** :ref:`RID` light, :ref:`Color` color **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_shadow_enabled` **(** :ref:`RID` light, :ref:`bool` enabled **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_shadow_filter` **(** :ref:`RID` light, :ref:`int` filter **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_shadow_gradient_length` **(** :ref:`RID` light, :ref:`float` length **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_shadow_smooth` **(** :ref:`RID` light, :ref:`float` smooth **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_texture` **(** :ref:`RID` light, :ref:`RID` texture **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_texture_offset` **(** :ref:`RID` light, :ref:`Vector2` offset **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_transform` **(** :ref:`RID` light, :ref:`Transform2D` transform **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_z_range` **(** :ref:`RID` light, :ref:`int` min_z, :ref:`int` max_z **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`canvas_occluder_polygon_create` **(** **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_occluder_polygon_set_cull_mode` **(** :ref:`RID` occluder_polygon, :ref:`int` mode **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_occluder_polygon_set_shape` **(** :ref:`RID` occluder_polygon, :ref:`PoolVector2Array` shape, :ref:`bool` closed **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_occluder_polygon_set_shape_as_lines` **(** :ref:`RID` occluder_polygon, :ref:`PoolVector2Array` shape **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_set_item_mirroring` **(** :ref:`RID` canvas, :ref:`RID` item, :ref:`Vector2` mirroring **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_set_modulate` **(** :ref:`RID` canvas, :ref:`Color` color **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw` **(** **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`finish` **(** **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`force_draw` **(** **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`force_sync` **(** **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`free` **(** :ref:`RID` rid **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_render_info` **(** :ref:`int` info **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_test_cube` **(** **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_test_texture` **(** **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_white_texture` **(** **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_changed` **(** **)** const | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_feature` **(** :ref:`int` feature **)** const | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_os_feature` **(** :ref:`String` feature **)** const | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`init` **(** **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`make_sphere_mesh` **(** :ref:`int` latitudes, :ref:`int` longitudes, :ref:`float` radius **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`material_create` **(** **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`material_get_param` **(** :ref:`RID` material, :ref:`String` parameter **)** const | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`material_get_shader` **(** :ref:`RID` shader_material **)** const | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`material_set_line_width` **(** :ref:`RID` material, :ref:`float` width **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`material_set_next_pass` **(** :ref:`RID` material, :ref:`RID` next_material **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`material_set_param` **(** :ref:`RID` material, :ref:`String` parameter, :ref:`Variant` value **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`material_set_render_priority` **(** :ref:`RID` material, :ref:`int` priority **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`material_set_shader` **(** :ref:`RID` shader_material, :ref:`RID` shader **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mesh_add_surface_from_arrays` **(** :ref:`RID` mesh, :ref:`int` primtive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[ ], :ref:`int` compress_format=97792 **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mesh_clear` **(** :ref:`RID` mesh **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`mesh_create` **(** **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`mesh_get_blend_shape_count` **(** :ref:`RID` mesh **)** const | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`mesh_get_blend_shape_mode` **(** :ref:`RID` mesh **)** const | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect3` | :ref:`mesh_get_custom_aabb` **(** :ref:`RID` mesh **)** const | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`mesh_get_surface_count` **(** :ref:`RID` mesh **)** const | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mesh_remove_surface` **(** :ref:`RID` mesh, :ref:`int` index **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mesh_set_blend_shape_count` **(** :ref:`RID` mesh, :ref:`int` amount **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mesh_set_blend_shape_mode` **(** :ref:`RID` mesh, :ref:`int` mode **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mesh_set_custom_aabb` **(** :ref:`RID` mesh, :ref:`Rect3` aabb **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect3` | :ref:`mesh_surface_get_aabb` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`mesh_surface_get_array` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`mesh_surface_get_array_index_len` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`mesh_surface_get_array_len` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`mesh_surface_get_arrays` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`mesh_surface_get_blend_shape_arrays` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`mesh_surface_get_format` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`mesh_surface_get_index_array` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`mesh_surface_get_material` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`mesh_surface_get_primitive_type` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`mesh_surface_get_skeleton_aabb` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mesh_surface_set_material` **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`RID` material **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`request_frame_drawn_callback` **(** :ref:`Object` where, :ref:`String` method, :ref:`Variant` userdata **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_boot_image` **(** :ref:`Image` image, :ref:`Color` color, :ref:`bool` scale **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_debug_generate_wireframes` **(** :ref:`bool` generate **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_default_clear_color` **(** :ref:`Color` color **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`shader_create` **(** **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`shader_get_code` **(** :ref:`RID` shader **)** const | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`shader_get_default_texture_param` **(** :ref:`RID` shader, :ref:`String` name **)** const | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`shader_get_param_list` **(** :ref:`RID` shader **)** const | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shader_set_code` **(** :ref:`RID` shader, :ref:`String` code **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shader_set_default_texture_param` **(** :ref:`RID` shader, :ref:`String` name, :ref:`RID` texture **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`sky_create` **(** **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sky_set_texture` **(** :ref:`RID` sky, :ref:`RID` cube_map, :ref:`int` radiance_size **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sync` **(** **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`texture_allocate` **(** :ref:`RID` texture, :ref:`int` width, :ref:`int` height, :ref:`int` format, :ref:`int` flags=7 **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`texture_create` **(** **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`texture_create_from_image` **(** :ref:`Image` image, :ref:`int` flags=7 **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`texture_debug_usage` **(** **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`texture_get_data` **(** :ref:`RID` texture, :ref:`int` cube_side=0 **)** const | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`texture_get_flags` **(** :ref:`RID` texture **)** const | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`texture_get_format` **(** :ref:`RID` texture **)** const | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`texture_get_height` **(** :ref:`RID` texture **)** const | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`texture_get_path` **(** :ref:`RID` texture **)** const | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`texture_get_texid` **(** :ref:`RID` texture **)** const | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`texture_get_width` **(** :ref:`RID` texture **)** const | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`texture_set_data` **(** :ref:`RID` texture, :ref:`Image` image, :ref:`int` cube_side=0 **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`texture_set_flags` **(** :ref:`RID` texture, :ref:`int` flags **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`texture_set_path` **(** :ref:`RID` texture, :ref:`String` path **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`texture_set_shrink_all_x2_on_set_data` **(** :ref:`bool` shrink **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`texture_set_size_override` **(** :ref:`RID` texture, :ref:`int` width, :ref:`int` height **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`textures_keep_original` **(** :ref:`bool` enable **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_attach_camera` **(** :ref:`RID` viewport, :ref:`RID` camera **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_attach_canvas` **(** :ref:`RID` viewport, :ref:`RID` canvas **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_attach_to_screen` **(** :ref:`RID` viewport, :ref:`Rect2` rect=Rect2( 0, 0, 0, 0 ), :ref:`int` screen=0 **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`viewport_create` **(** **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_detach` **(** :ref:`RID` viewport **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`viewport_get_render_info` **(** :ref:`RID` viewport, :ref:`int` info **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`viewport_get_texture` **(** :ref:`RID` viewport **)** const | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_remove_canvas` **(** :ref:`RID` viewport, :ref:`RID` canvas **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_active` **(** :ref:`RID` viewport, :ref:`bool` active **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_canvas_layer` **(** :ref:`RID` viewport, :ref:`RID` canvas, :ref:`int` layer **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_canvas_transform` **(** :ref:`RID` viewport, :ref:`RID` canvas, :ref:`Transform2D` offset **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_clear_mode` **(** :ref:`RID` viewport, :ref:`int` clear_mode **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_debug_draw` **(** :ref:`RID` viewport, :ref:`int` draw **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_disable_3d` **(** :ref:`RID` viewport, :ref:`bool` disabled **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_disable_environment` **(** :ref:`RID` viewport, :ref:`bool` disabled **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_global_canvas_transform` **(** :ref:`RID` viewport, :ref:`Transform2D` transform **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_hdr` **(** :ref:`RID` viewport, :ref:`bool` enabled **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_hide_canvas` **(** :ref:`RID` viewport, :ref:`bool` hidden **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_hide_scenario` **(** :ref:`RID` viewport, :ref:`bool` hidden **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_msaa` **(** :ref:`RID` viewport, :ref:`int` msaa **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_parent_viewport` **(** :ref:`RID` viewport, :ref:`RID` parent_viewport **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_scenario` **(** :ref:`RID` viewport, :ref:`RID` scenario **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_shadow_atlas_quadrant_subdivision` **(** :ref:`RID` viewport, :ref:`int` quadrant, :ref:`int` subdivision **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_shadow_atlas_size` **(** :ref:`RID` viewport, :ref:`int` size **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_size` **(** :ref:`RID` viewport, :ref:`int` width, :ref:`int` height **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_transparent_background` **(** :ref:`RID` viewport, :ref:`bool` enabled **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_update_mode` **(** :ref:`RID` viewport, :ref:`int` update_mode **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_usage` **(** :ref:`RID` viewport, :ref:`int` usage **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_use_arvr` **(** :ref:`RID` viewport, :ref:`bool` use_arvr **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_vflip` **(** :ref:`RID` viewport, :ref:`bool` enabled **)** | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`black_bars_set_images` **(** :ref:`RID` left, :ref:`RID` top, :ref:`RID` right, :ref:`RID` bottom **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`black_bars_set_margins` **(** :ref:`int` left, :ref:`int` top, :ref:`int` right, :ref:`int` bottom **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`canvas_create` **(** **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_circle` **(** :ref:`RID` item, :ref:`Vector2` pos, :ref:`float` radius, :ref:`Color` color **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_clip_ignore` **(** :ref:`RID` item, :ref:`bool` ignore **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_line` **(** :ref:`RID` item, :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_mesh` **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`RID` skeleton **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_multimesh` **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`RID` skeleton **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_nine_patch` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`Rect2` source, :ref:`RID` texture, :ref:`Vector2` topleft, :ref:`Vector2` bottomright, :ref:`int` x_axis_mode=0, :ref:`int` y_axis_mode=0, :ref:`bool` draw_center=true, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`RID` normal_map **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_particles` **(** :ref:`RID` item, :ref:`RID` particles, :ref:`RID` texture, :ref:`RID` normal_map, :ref:`int` h_frames, :ref:`int` v_frames **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_polygon` **(** :ref:`RID` item, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`RID` texture, :ref:`RID` normal_map, :ref:`bool` antialiased=false **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_polyline` **(** :ref:`RID` item, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_primitive` **(** :ref:`RID` item, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs, :ref:`RID` texture, :ref:`float` width=1.0, :ref:`RID` normal_map **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_rect` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`Color` color **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_set_transform` **(** :ref:`RID` item, :ref:`Transform2D` transform **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_texture_rect` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`bool` tile=false, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`RID` normal_map **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_texture_rect_region` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`RID` normal_map, :ref:`bool` clip_uv=true **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_triangle_array` **(** :ref:`RID` item, :ref:`PoolIntArray` indices, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`RID` texture, :ref:`int` count=-1, :ref:`RID` normal_map **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_clear` **(** :ref:`RID` item **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`canvas_item_create` **(** **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_clip` **(** :ref:`RID` item, :ref:`bool` clip **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_copy_to_backbuffer` **(** :ref:`RID` item, :ref:`bool` enabled, :ref:`Rect2` rect **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_custom_rect` **(** :ref:`RID` item, :ref:`bool` use_custom_rect, :ref:`Rect2` rect=Rect2( 0, 0, 0, 0 ) **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_distance_field_mode` **(** :ref:`RID` item, :ref:`bool` enabled **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_draw_behind_parent` **(** :ref:`RID` item, :ref:`bool` enabled **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_draw_index` **(** :ref:`RID` item, :ref:`int` index **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_light_mask` **(** :ref:`RID` item, :ref:`int` mask **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_material` **(** :ref:`RID` item, :ref:`RID` material **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_modulate` **(** :ref:`RID` item, :ref:`Color` color **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_parent` **(** :ref:`RID` item, :ref:`RID` parent **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_self_modulate` **(** :ref:`RID` item, :ref:`Color` color **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_sort_children_by_y` **(** :ref:`RID` item, :ref:`bool` enabled **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_transform` **(** :ref:`RID` item, :ref:`Transform2D` transform **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_use_parent_material` **(** :ref:`RID` item, :ref:`bool` enabled **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_visible` **(** :ref:`RID` item, :ref:`bool` visible **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_z` **(** :ref:`RID` item, :ref:`int` z **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_z_as_relative_to_parent` **(** :ref:`RID` item, :ref:`bool` enabled **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_attach_to_canvas` **(** :ref:`RID` light, :ref:`RID` canvas **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`canvas_light_create` **(** **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_occluder_attach_to_canvas` **(** :ref:`RID` occluder, :ref:`RID` canvas **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`canvas_light_occluder_create` **(** **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_occluder_set_enabled` **(** :ref:`RID` occluder, :ref:`bool` enabled **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_occluder_set_light_mask` **(** :ref:`RID` occluder, :ref:`int` mask **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_occluder_set_polygon` **(** :ref:`RID` occluder, :ref:`RID` polygon **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_occluder_set_transform` **(** :ref:`RID` occluder, :ref:`Transform2D` transform **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_color` **(** :ref:`RID` light, :ref:`Color` color **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_enabled` **(** :ref:`RID` light, :ref:`bool` enabled **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_energy` **(** :ref:`RID` light, :ref:`float` energy **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_height` **(** :ref:`RID` light, :ref:`float` height **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_item_cull_mask` **(** :ref:`RID` light, :ref:`int` mask **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_item_shadow_cull_mask` **(** :ref:`RID` light, :ref:`int` mask **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_layer_range` **(** :ref:`RID` light, :ref:`int` min_layer, :ref:`int` max_layer **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_mode` **(** :ref:`RID` light, :ref:`int` mode **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_scale` **(** :ref:`RID` light, :ref:`float` scale **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_shadow_buffer_size` **(** :ref:`RID` light, :ref:`int` size **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_shadow_color` **(** :ref:`RID` light, :ref:`Color` color **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_shadow_enabled` **(** :ref:`RID` light, :ref:`bool` enabled **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_shadow_filter` **(** :ref:`RID` light, :ref:`int` filter **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_shadow_gradient_length` **(** :ref:`RID` light, :ref:`float` length **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_shadow_smooth` **(** :ref:`RID` light, :ref:`float` smooth **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_texture` **(** :ref:`RID` light, :ref:`RID` texture **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_texture_offset` **(** :ref:`RID` light, :ref:`Vector2` offset **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_transform` **(** :ref:`RID` light, :ref:`Transform2D` transform **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_z_range` **(** :ref:`RID` light, :ref:`int` min_z, :ref:`int` max_z **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`canvas_occluder_polygon_create` **(** **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_occluder_polygon_set_cull_mode` **(** :ref:`RID` occluder_polygon, :ref:`int` mode **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_occluder_polygon_set_shape` **(** :ref:`RID` occluder_polygon, :ref:`PoolVector2Array` shape, :ref:`bool` closed **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_occluder_polygon_set_shape_as_lines` **(** :ref:`RID` occluder_polygon, :ref:`PoolVector2Array` shape **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_set_item_mirroring` **(** :ref:`RID` canvas, :ref:`RID` item, :ref:`Vector2` mirroring **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_set_modulate` **(** :ref:`RID` canvas, :ref:`Color` color **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw` **(** **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`finish` **(** **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`force_draw` **(** **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`force_sync` **(** **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`free` **(** :ref:`RID` rid **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_render_info` **(** :ref:`int` info **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_test_cube` **(** **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_test_texture` **(** **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_white_texture` **(** **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_changed` **(** **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_feature` **(** :ref:`int` feature **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_os_feature` **(** :ref:`String` feature **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`init` **(** **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`make_sphere_mesh` **(** :ref:`int` latitudes, :ref:`int` longitudes, :ref:`float` radius **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`material_create` **(** **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`material_get_param` **(** :ref:`RID` material, :ref:`String` parameter **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`material_get_shader` **(** :ref:`RID` shader_material **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`material_set_line_width` **(** :ref:`RID` material, :ref:`float` width **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`material_set_next_pass` **(** :ref:`RID` material, :ref:`RID` next_material **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`material_set_param` **(** :ref:`RID` material, :ref:`String` parameter, :ref:`Variant` value **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`material_set_render_priority` **(** :ref:`RID` material, :ref:`int` priority **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`material_set_shader` **(** :ref:`RID` shader_material, :ref:`RID` shader **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`mesh_add_surface_from_arrays` **(** :ref:`RID` mesh, :ref:`int` primtive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[ ], :ref:`int` compress_format=97792 **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`mesh_clear` **(** :ref:`RID` mesh **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`mesh_create` **(** **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`mesh_get_blend_shape_count` **(** :ref:`RID` mesh **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`mesh_get_blend_shape_mode` **(** :ref:`RID` mesh **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect3` | :ref:`mesh_get_custom_aabb` **(** :ref:`RID` mesh **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`mesh_get_surface_count` **(** :ref:`RID` mesh **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`mesh_remove_surface` **(** :ref:`RID` mesh, :ref:`int` index **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`mesh_set_blend_shape_count` **(** :ref:`RID` mesh, :ref:`int` amount **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`mesh_set_blend_shape_mode` **(** :ref:`RID` mesh, :ref:`int` mode **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`mesh_set_custom_aabb` **(** :ref:`RID` mesh, :ref:`Rect3` aabb **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect3` | :ref:`mesh_surface_get_aabb` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`mesh_surface_get_array` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`mesh_surface_get_array_index_len` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`mesh_surface_get_array_len` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`mesh_surface_get_arrays` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`mesh_surface_get_blend_shape_arrays` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`mesh_surface_get_format` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`mesh_surface_get_index_array` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`mesh_surface_get_material` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`mesh_surface_get_primitive_type` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`mesh_surface_get_skeleton_aabb` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`mesh_surface_set_material` **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`RID` material **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`request_frame_drawn_callback` **(** :ref:`Object` where, :ref:`String` method, :ref:`Variant` userdata **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_boot_image` **(** :ref:`Image` image, :ref:`Color` color, :ref:`bool` scale **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_debug_generate_wireframes` **(** :ref:`bool` generate **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_default_clear_color` **(** :ref:`Color` color **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`shader_create` **(** **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`shader_get_code` **(** :ref:`RID` shader **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`shader_get_default_texture_param` **(** :ref:`RID` shader, :ref:`String` name **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`shader_get_param_list` **(** :ref:`RID` shader **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shader_set_code` **(** :ref:`RID` shader, :ref:`String` code **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shader_set_default_texture_param` **(** :ref:`RID` shader, :ref:`String` name, :ref:`RID` texture **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`sky_create` **(** **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`sky_set_texture` **(** :ref:`RID` sky, :ref:`RID` cube_map, :ref:`int` radiance_size **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`sync` **(** **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`texture_allocate` **(** :ref:`RID` texture, :ref:`int` width, :ref:`int` height, :ref:`int` format, :ref:`int` flags=7 **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`texture_create` **(** **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`texture_create_from_image` **(** :ref:`Image` image, :ref:`int` flags=7 **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`texture_debug_usage` **(** **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Image` | :ref:`texture_get_data` **(** :ref:`RID` texture, :ref:`int` cube_side=0 **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`texture_get_flags` **(** :ref:`RID` texture **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`texture_get_format` **(** :ref:`RID` texture **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`texture_get_height` **(** :ref:`RID` texture **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`texture_get_path` **(** :ref:`RID` texture **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`texture_get_texid` **(** :ref:`RID` texture **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`texture_get_width` **(** :ref:`RID` texture **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`texture_set_data` **(** :ref:`RID` texture, :ref:`Image` image, :ref:`int` cube_side=0 **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`texture_set_flags` **(** :ref:`RID` texture, :ref:`int` flags **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`texture_set_path` **(** :ref:`RID` texture, :ref:`String` path **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`texture_set_shrink_all_x2_on_set_data` **(** :ref:`bool` shrink **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`texture_set_size_override` **(** :ref:`RID` texture, :ref:`int` width, :ref:`int` height **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`textures_keep_original` **(** :ref:`bool` enable **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_attach_camera` **(** :ref:`RID` viewport, :ref:`RID` camera **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_attach_canvas` **(** :ref:`RID` viewport, :ref:`RID` canvas **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_attach_to_screen` **(** :ref:`RID` viewport, :ref:`Rect2` rect=Rect2( 0, 0, 0, 0 ), :ref:`int` screen=0 **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`viewport_create` **(** **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_detach` **(** :ref:`RID` viewport **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`viewport_get_render_info` **(** :ref:`RID` viewport, :ref:`int` info **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`viewport_get_texture` **(** :ref:`RID` viewport **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_remove_canvas` **(** :ref:`RID` viewport, :ref:`RID` canvas **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_active` **(** :ref:`RID` viewport, :ref:`bool` active **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_canvas_layer` **(** :ref:`RID` viewport, :ref:`RID` canvas, :ref:`int` layer **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_canvas_transform` **(** :ref:`RID` viewport, :ref:`RID` canvas, :ref:`Transform2D` offset **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_clear_mode` **(** :ref:`RID` viewport, :ref:`int` clear_mode **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_debug_draw` **(** :ref:`RID` viewport, :ref:`int` draw **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_disable_3d` **(** :ref:`RID` viewport, :ref:`bool` disabled **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_disable_environment` **(** :ref:`RID` viewport, :ref:`bool` disabled **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_global_canvas_transform` **(** :ref:`RID` viewport, :ref:`Transform2D` transform **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_hdr` **(** :ref:`RID` viewport, :ref:`bool` enabled **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_hide_canvas` **(** :ref:`RID` viewport, :ref:`bool` hidden **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_hide_scenario` **(** :ref:`RID` viewport, :ref:`bool` hidden **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_msaa` **(** :ref:`RID` viewport, :ref:`int` msaa **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_parent_viewport` **(** :ref:`RID` viewport, :ref:`RID` parent_viewport **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_scenario` **(** :ref:`RID` viewport, :ref:`RID` scenario **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_shadow_atlas_quadrant_subdivision` **(** :ref:`RID` viewport, :ref:`int` quadrant, :ref:`int` subdivision **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_shadow_atlas_size` **(** :ref:`RID` viewport, :ref:`int` size **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_size` **(** :ref:`RID` viewport, :ref:`int` width, :ref:`int` height **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_transparent_background` **(** :ref:`RID` viewport, :ref:`bool` enabled **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_update_mode` **(** :ref:`RID` viewport, :ref:`int` update_mode **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_usage` **(** :ref:`RID` viewport, :ref:`int` usage **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_use_arvr` **(** :ref:`RID` viewport, :ref:`bool` use_arvr **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_vflip` **(** :ref:`RID` viewport, :ref:`bool` enabled **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -543,467 +543,467 @@ Member Function Description .. _class_VisualServer_black_bars_set_images: -- void **black_bars_set_images** **(** :ref:`RID` left, :ref:`RID` top, :ref:`RID` right, :ref:`RID` bottom **)** +- void **black_bars_set_images** **(** :ref:`RID` left, :ref:`RID` top, :ref:`RID` right, :ref:`RID` bottom **)** .. _class_VisualServer_black_bars_set_margins: -- void **black_bars_set_margins** **(** :ref:`int` left, :ref:`int` top, :ref:`int` right, :ref:`int` bottom **)** +- void **black_bars_set_margins** **(** :ref:`int` left, :ref:`int` top, :ref:`int` right, :ref:`int` bottom **)** .. _class_VisualServer_canvas_create: -- :ref:`RID` **canvas_create** **(** **)** +- :ref:`RID` **canvas_create** **(** **)** .. _class_VisualServer_canvas_item_add_circle: -- void **canvas_item_add_circle** **(** :ref:`RID` item, :ref:`Vector2` pos, :ref:`float` radius, :ref:`Color` color **)** +- void **canvas_item_add_circle** **(** :ref:`RID` item, :ref:`Vector2` pos, :ref:`float` radius, :ref:`Color` color **)** .. _class_VisualServer_canvas_item_add_clip_ignore: -- void **canvas_item_add_clip_ignore** **(** :ref:`RID` item, :ref:`bool` ignore **)** +- void **canvas_item_add_clip_ignore** **(** :ref:`RID` item, :ref:`bool` ignore **)** .. _class_VisualServer_canvas_item_add_line: -- void **canvas_item_add_line** **(** :ref:`RID` item, :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** +- void **canvas_item_add_line** **(** :ref:`RID` item, :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** .. _class_VisualServer_canvas_item_add_mesh: -- void **canvas_item_add_mesh** **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`RID` skeleton **)** +- void **canvas_item_add_mesh** **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`RID` skeleton **)** .. _class_VisualServer_canvas_item_add_multimesh: -- void **canvas_item_add_multimesh** **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`RID` skeleton **)** +- void **canvas_item_add_multimesh** **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`RID` skeleton **)** .. _class_VisualServer_canvas_item_add_nine_patch: -- void **canvas_item_add_nine_patch** **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`Rect2` source, :ref:`RID` texture, :ref:`Vector2` topleft, :ref:`Vector2` bottomright, :ref:`int` x_axis_mode=0, :ref:`int` y_axis_mode=0, :ref:`bool` draw_center=true, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`RID` normal_map **)** +- void **canvas_item_add_nine_patch** **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`Rect2` source, :ref:`RID` texture, :ref:`Vector2` topleft, :ref:`Vector2` bottomright, :ref:`int` x_axis_mode=0, :ref:`int` y_axis_mode=0, :ref:`bool` draw_center=true, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`RID` normal_map **)** .. _class_VisualServer_canvas_item_add_particles: -- void **canvas_item_add_particles** **(** :ref:`RID` item, :ref:`RID` particles, :ref:`RID` texture, :ref:`RID` normal_map, :ref:`int` h_frames, :ref:`int` v_frames **)** +- void **canvas_item_add_particles** **(** :ref:`RID` item, :ref:`RID` particles, :ref:`RID` texture, :ref:`RID` normal_map, :ref:`int` h_frames, :ref:`int` v_frames **)** .. _class_VisualServer_canvas_item_add_polygon: -- void **canvas_item_add_polygon** **(** :ref:`RID` item, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`RID` texture, :ref:`RID` normal_map, :ref:`bool` antialiased=false **)** +- void **canvas_item_add_polygon** **(** :ref:`RID` item, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`RID` texture, :ref:`RID` normal_map, :ref:`bool` antialiased=false **)** .. _class_VisualServer_canvas_item_add_polyline: -- void **canvas_item_add_polyline** **(** :ref:`RID` item, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** +- void **canvas_item_add_polyline** **(** :ref:`RID` item, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** .. _class_VisualServer_canvas_item_add_primitive: -- void **canvas_item_add_primitive** **(** :ref:`RID` item, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs, :ref:`RID` texture, :ref:`float` width=1.0, :ref:`RID` normal_map **)** +- void **canvas_item_add_primitive** **(** :ref:`RID` item, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs, :ref:`RID` texture, :ref:`float` width=1.0, :ref:`RID` normal_map **)** .. _class_VisualServer_canvas_item_add_rect: -- void **canvas_item_add_rect** **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`Color` color **)** +- void **canvas_item_add_rect** **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`Color` color **)** .. _class_VisualServer_canvas_item_add_set_transform: -- void **canvas_item_add_set_transform** **(** :ref:`RID` item, :ref:`Transform2D` transform **)** +- void **canvas_item_add_set_transform** **(** :ref:`RID` item, :ref:`Transform2D` transform **)** .. _class_VisualServer_canvas_item_add_texture_rect: -- void **canvas_item_add_texture_rect** **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`bool` tile=false, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`RID` normal_map **)** +- void **canvas_item_add_texture_rect** **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`bool` tile=false, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`RID` normal_map **)** .. _class_VisualServer_canvas_item_add_texture_rect_region: -- void **canvas_item_add_texture_rect_region** **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`RID` normal_map, :ref:`bool` clip_uv=true **)** +- void **canvas_item_add_texture_rect_region** **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`RID` normal_map, :ref:`bool` clip_uv=true **)** .. _class_VisualServer_canvas_item_add_triangle_array: -- void **canvas_item_add_triangle_array** **(** :ref:`RID` item, :ref:`PoolIntArray` indices, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`RID` texture, :ref:`int` count=-1, :ref:`RID` normal_map **)** +- void **canvas_item_add_triangle_array** **(** :ref:`RID` item, :ref:`PoolIntArray` indices, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`RID` texture, :ref:`int` count=-1, :ref:`RID` normal_map **)** .. _class_VisualServer_canvas_item_clear: -- void **canvas_item_clear** **(** :ref:`RID` item **)** +- void **canvas_item_clear** **(** :ref:`RID` item **)** .. _class_VisualServer_canvas_item_create: -- :ref:`RID` **canvas_item_create** **(** **)** +- :ref:`RID` **canvas_item_create** **(** **)** .. _class_VisualServer_canvas_item_set_clip: -- void **canvas_item_set_clip** **(** :ref:`RID` item, :ref:`bool` clip **)** +- void **canvas_item_set_clip** **(** :ref:`RID` item, :ref:`bool` clip **)** .. _class_VisualServer_canvas_item_set_copy_to_backbuffer: -- void **canvas_item_set_copy_to_backbuffer** **(** :ref:`RID` item, :ref:`bool` enabled, :ref:`Rect2` rect **)** +- void **canvas_item_set_copy_to_backbuffer** **(** :ref:`RID` item, :ref:`bool` enabled, :ref:`Rect2` rect **)** .. _class_VisualServer_canvas_item_set_custom_rect: -- void **canvas_item_set_custom_rect** **(** :ref:`RID` item, :ref:`bool` use_custom_rect, :ref:`Rect2` rect=Rect2( 0, 0, 0, 0 ) **)** +- void **canvas_item_set_custom_rect** **(** :ref:`RID` item, :ref:`bool` use_custom_rect, :ref:`Rect2` rect=Rect2( 0, 0, 0, 0 ) **)** .. _class_VisualServer_canvas_item_set_distance_field_mode: -- void **canvas_item_set_distance_field_mode** **(** :ref:`RID` item, :ref:`bool` enabled **)** +- void **canvas_item_set_distance_field_mode** **(** :ref:`RID` item, :ref:`bool` enabled **)** .. _class_VisualServer_canvas_item_set_draw_behind_parent: -- void **canvas_item_set_draw_behind_parent** **(** :ref:`RID` item, :ref:`bool` enabled **)** +- void **canvas_item_set_draw_behind_parent** **(** :ref:`RID` item, :ref:`bool` enabled **)** .. _class_VisualServer_canvas_item_set_draw_index: -- void **canvas_item_set_draw_index** **(** :ref:`RID` item, :ref:`int` index **)** +- void **canvas_item_set_draw_index** **(** :ref:`RID` item, :ref:`int` index **)** .. _class_VisualServer_canvas_item_set_light_mask: -- void **canvas_item_set_light_mask** **(** :ref:`RID` item, :ref:`int` mask **)** +- void **canvas_item_set_light_mask** **(** :ref:`RID` item, :ref:`int` mask **)** .. _class_VisualServer_canvas_item_set_material: -- void **canvas_item_set_material** **(** :ref:`RID` item, :ref:`RID` material **)** +- void **canvas_item_set_material** **(** :ref:`RID` item, :ref:`RID` material **)** .. _class_VisualServer_canvas_item_set_modulate: -- void **canvas_item_set_modulate** **(** :ref:`RID` item, :ref:`Color` color **)** +- void **canvas_item_set_modulate** **(** :ref:`RID` item, :ref:`Color` color **)** .. _class_VisualServer_canvas_item_set_parent: -- void **canvas_item_set_parent** **(** :ref:`RID` item, :ref:`RID` parent **)** +- void **canvas_item_set_parent** **(** :ref:`RID` item, :ref:`RID` parent **)** .. _class_VisualServer_canvas_item_set_self_modulate: -- void **canvas_item_set_self_modulate** **(** :ref:`RID` item, :ref:`Color` color **)** +- void **canvas_item_set_self_modulate** **(** :ref:`RID` item, :ref:`Color` color **)** .. _class_VisualServer_canvas_item_set_sort_children_by_y: -- void **canvas_item_set_sort_children_by_y** **(** :ref:`RID` item, :ref:`bool` enabled **)** +- void **canvas_item_set_sort_children_by_y** **(** :ref:`RID` item, :ref:`bool` enabled **)** .. _class_VisualServer_canvas_item_set_transform: -- void **canvas_item_set_transform** **(** :ref:`RID` item, :ref:`Transform2D` transform **)** +- void **canvas_item_set_transform** **(** :ref:`RID` item, :ref:`Transform2D` transform **)** .. _class_VisualServer_canvas_item_set_use_parent_material: -- void **canvas_item_set_use_parent_material** **(** :ref:`RID` item, :ref:`bool` enabled **)** +- void **canvas_item_set_use_parent_material** **(** :ref:`RID` item, :ref:`bool` enabled **)** .. _class_VisualServer_canvas_item_set_visible: -- void **canvas_item_set_visible** **(** :ref:`RID` item, :ref:`bool` visible **)** +- void **canvas_item_set_visible** **(** :ref:`RID` item, :ref:`bool` visible **)** .. _class_VisualServer_canvas_item_set_z: -- void **canvas_item_set_z** **(** :ref:`RID` item, :ref:`int` z **)** +- void **canvas_item_set_z** **(** :ref:`RID` item, :ref:`int` z **)** .. _class_VisualServer_canvas_item_set_z_as_relative_to_parent: -- void **canvas_item_set_z_as_relative_to_parent** **(** :ref:`RID` item, :ref:`bool` enabled **)** +- void **canvas_item_set_z_as_relative_to_parent** **(** :ref:`RID` item, :ref:`bool` enabled **)** .. _class_VisualServer_canvas_light_attach_to_canvas: -- void **canvas_light_attach_to_canvas** **(** :ref:`RID` light, :ref:`RID` canvas **)** +- void **canvas_light_attach_to_canvas** **(** :ref:`RID` light, :ref:`RID` canvas **)** .. _class_VisualServer_canvas_light_create: -- :ref:`RID` **canvas_light_create** **(** **)** +- :ref:`RID` **canvas_light_create** **(** **)** .. _class_VisualServer_canvas_light_occluder_attach_to_canvas: -- void **canvas_light_occluder_attach_to_canvas** **(** :ref:`RID` occluder, :ref:`RID` canvas **)** +- void **canvas_light_occluder_attach_to_canvas** **(** :ref:`RID` occluder, :ref:`RID` canvas **)** .. _class_VisualServer_canvas_light_occluder_create: -- :ref:`RID` **canvas_light_occluder_create** **(** **)** +- :ref:`RID` **canvas_light_occluder_create** **(** **)** .. _class_VisualServer_canvas_light_occluder_set_enabled: -- void **canvas_light_occluder_set_enabled** **(** :ref:`RID` occluder, :ref:`bool` enabled **)** +- void **canvas_light_occluder_set_enabled** **(** :ref:`RID` occluder, :ref:`bool` enabled **)** .. _class_VisualServer_canvas_light_occluder_set_light_mask: -- void **canvas_light_occluder_set_light_mask** **(** :ref:`RID` occluder, :ref:`int` mask **)** +- void **canvas_light_occluder_set_light_mask** **(** :ref:`RID` occluder, :ref:`int` mask **)** .. _class_VisualServer_canvas_light_occluder_set_polygon: -- void **canvas_light_occluder_set_polygon** **(** :ref:`RID` occluder, :ref:`RID` polygon **)** +- void **canvas_light_occluder_set_polygon** **(** :ref:`RID` occluder, :ref:`RID` polygon **)** .. _class_VisualServer_canvas_light_occluder_set_transform: -- void **canvas_light_occluder_set_transform** **(** :ref:`RID` occluder, :ref:`Transform2D` transform **)** +- void **canvas_light_occluder_set_transform** **(** :ref:`RID` occluder, :ref:`Transform2D` transform **)** .. _class_VisualServer_canvas_light_set_color: -- void **canvas_light_set_color** **(** :ref:`RID` light, :ref:`Color` color **)** +- void **canvas_light_set_color** **(** :ref:`RID` light, :ref:`Color` color **)** .. _class_VisualServer_canvas_light_set_enabled: -- void **canvas_light_set_enabled** **(** :ref:`RID` light, :ref:`bool` enabled **)** +- void **canvas_light_set_enabled** **(** :ref:`RID` light, :ref:`bool` enabled **)** .. _class_VisualServer_canvas_light_set_energy: -- void **canvas_light_set_energy** **(** :ref:`RID` light, :ref:`float` energy **)** +- void **canvas_light_set_energy** **(** :ref:`RID` light, :ref:`float` energy **)** .. _class_VisualServer_canvas_light_set_height: -- void **canvas_light_set_height** **(** :ref:`RID` light, :ref:`float` height **)** +- void **canvas_light_set_height** **(** :ref:`RID` light, :ref:`float` height **)** .. _class_VisualServer_canvas_light_set_item_cull_mask: -- void **canvas_light_set_item_cull_mask** **(** :ref:`RID` light, :ref:`int` mask **)** +- void **canvas_light_set_item_cull_mask** **(** :ref:`RID` light, :ref:`int` mask **)** .. _class_VisualServer_canvas_light_set_item_shadow_cull_mask: -- void **canvas_light_set_item_shadow_cull_mask** **(** :ref:`RID` light, :ref:`int` mask **)** +- void **canvas_light_set_item_shadow_cull_mask** **(** :ref:`RID` light, :ref:`int` mask **)** .. _class_VisualServer_canvas_light_set_layer_range: -- void **canvas_light_set_layer_range** **(** :ref:`RID` light, :ref:`int` min_layer, :ref:`int` max_layer **)** +- void **canvas_light_set_layer_range** **(** :ref:`RID` light, :ref:`int` min_layer, :ref:`int` max_layer **)** .. _class_VisualServer_canvas_light_set_mode: -- void **canvas_light_set_mode** **(** :ref:`RID` light, :ref:`int` mode **)** +- void **canvas_light_set_mode** **(** :ref:`RID` light, :ref:`int` mode **)** .. _class_VisualServer_canvas_light_set_scale: -- void **canvas_light_set_scale** **(** :ref:`RID` light, :ref:`float` scale **)** +- void **canvas_light_set_scale** **(** :ref:`RID` light, :ref:`float` scale **)** .. _class_VisualServer_canvas_light_set_shadow_buffer_size: -- void **canvas_light_set_shadow_buffer_size** **(** :ref:`RID` light, :ref:`int` size **)** +- void **canvas_light_set_shadow_buffer_size** **(** :ref:`RID` light, :ref:`int` size **)** .. _class_VisualServer_canvas_light_set_shadow_color: -- void **canvas_light_set_shadow_color** **(** :ref:`RID` light, :ref:`Color` color **)** +- void **canvas_light_set_shadow_color** **(** :ref:`RID` light, :ref:`Color` color **)** .. _class_VisualServer_canvas_light_set_shadow_enabled: -- void **canvas_light_set_shadow_enabled** **(** :ref:`RID` light, :ref:`bool` enabled **)** +- void **canvas_light_set_shadow_enabled** **(** :ref:`RID` light, :ref:`bool` enabled **)** .. _class_VisualServer_canvas_light_set_shadow_filter: -- void **canvas_light_set_shadow_filter** **(** :ref:`RID` light, :ref:`int` filter **)** +- void **canvas_light_set_shadow_filter** **(** :ref:`RID` light, :ref:`int` filter **)** .. _class_VisualServer_canvas_light_set_shadow_gradient_length: -- void **canvas_light_set_shadow_gradient_length** **(** :ref:`RID` light, :ref:`float` length **)** +- void **canvas_light_set_shadow_gradient_length** **(** :ref:`RID` light, :ref:`float` length **)** .. _class_VisualServer_canvas_light_set_shadow_smooth: -- void **canvas_light_set_shadow_smooth** **(** :ref:`RID` light, :ref:`float` smooth **)** +- void **canvas_light_set_shadow_smooth** **(** :ref:`RID` light, :ref:`float` smooth **)** .. _class_VisualServer_canvas_light_set_texture: -- void **canvas_light_set_texture** **(** :ref:`RID` light, :ref:`RID` texture **)** +- void **canvas_light_set_texture** **(** :ref:`RID` light, :ref:`RID` texture **)** .. _class_VisualServer_canvas_light_set_texture_offset: -- void **canvas_light_set_texture_offset** **(** :ref:`RID` light, :ref:`Vector2` offset **)** +- void **canvas_light_set_texture_offset** **(** :ref:`RID` light, :ref:`Vector2` offset **)** .. _class_VisualServer_canvas_light_set_transform: -- void **canvas_light_set_transform** **(** :ref:`RID` light, :ref:`Transform2D` transform **)** +- void **canvas_light_set_transform** **(** :ref:`RID` light, :ref:`Transform2D` transform **)** .. _class_VisualServer_canvas_light_set_z_range: -- void **canvas_light_set_z_range** **(** :ref:`RID` light, :ref:`int` min_z, :ref:`int` max_z **)** +- void **canvas_light_set_z_range** **(** :ref:`RID` light, :ref:`int` min_z, :ref:`int` max_z **)** .. _class_VisualServer_canvas_occluder_polygon_create: -- :ref:`RID` **canvas_occluder_polygon_create** **(** **)** +- :ref:`RID` **canvas_occluder_polygon_create** **(** **)** .. _class_VisualServer_canvas_occluder_polygon_set_cull_mode: -- void **canvas_occluder_polygon_set_cull_mode** **(** :ref:`RID` occluder_polygon, :ref:`int` mode **)** +- void **canvas_occluder_polygon_set_cull_mode** **(** :ref:`RID` occluder_polygon, :ref:`int` mode **)** .. _class_VisualServer_canvas_occluder_polygon_set_shape: -- void **canvas_occluder_polygon_set_shape** **(** :ref:`RID` occluder_polygon, :ref:`PoolVector2Array` shape, :ref:`bool` closed **)** +- void **canvas_occluder_polygon_set_shape** **(** :ref:`RID` occluder_polygon, :ref:`PoolVector2Array` shape, :ref:`bool` closed **)** .. _class_VisualServer_canvas_occluder_polygon_set_shape_as_lines: -- void **canvas_occluder_polygon_set_shape_as_lines** **(** :ref:`RID` occluder_polygon, :ref:`PoolVector2Array` shape **)** +- void **canvas_occluder_polygon_set_shape_as_lines** **(** :ref:`RID` occluder_polygon, :ref:`PoolVector2Array` shape **)** .. _class_VisualServer_canvas_set_item_mirroring: -- void **canvas_set_item_mirroring** **(** :ref:`RID` canvas, :ref:`RID` item, :ref:`Vector2` mirroring **)** +- void **canvas_set_item_mirroring** **(** :ref:`RID` canvas, :ref:`RID` item, :ref:`Vector2` mirroring **)** .. _class_VisualServer_canvas_set_modulate: -- void **canvas_set_modulate** **(** :ref:`RID` canvas, :ref:`Color` color **)** +- void **canvas_set_modulate** **(** :ref:`RID` canvas, :ref:`Color` color **)** .. _class_VisualServer_draw: -- void **draw** **(** **)** +- void **draw** **(** **)** .. _class_VisualServer_finish: -- void **finish** **(** **)** +- void **finish** **(** **)** .. _class_VisualServer_force_draw: -- void **force_draw** **(** **)** +- void **force_draw** **(** **)** .. _class_VisualServer_force_sync: -- void **force_sync** **(** **)** +- void **force_sync** **(** **)** .. _class_VisualServer_free: -- void **free** **(** :ref:`RID` rid **)** +- void **free** **(** :ref:`RID` rid **)** .. _class_VisualServer_get_render_info: -- :ref:`int` **get_render_info** **(** :ref:`int` info **)** +- :ref:`int` **get_render_info** **(** :ref:`int` info **)** .. _class_VisualServer_get_test_cube: -- :ref:`RID` **get_test_cube** **(** **)** +- :ref:`RID` **get_test_cube** **(** **)** .. _class_VisualServer_get_test_texture: -- :ref:`RID` **get_test_texture** **(** **)** +- :ref:`RID` **get_test_texture** **(** **)** .. _class_VisualServer_get_white_texture: -- :ref:`RID` **get_white_texture** **(** **)** +- :ref:`RID` **get_white_texture** **(** **)** .. _class_VisualServer_has_changed: -- :ref:`bool` **has_changed** **(** **)** const +- :ref:`bool` **has_changed** **(** **)** const .. _class_VisualServer_has_feature: -- :ref:`bool` **has_feature** **(** :ref:`int` feature **)** const +- :ref:`bool` **has_feature** **(** :ref:`int` feature **)** const .. _class_VisualServer_has_os_feature: -- :ref:`bool` **has_os_feature** **(** :ref:`String` feature **)** const +- :ref:`bool` **has_os_feature** **(** :ref:`String` feature **)** const .. _class_VisualServer_init: -- void **init** **(** **)** +- void **init** **(** **)** .. _class_VisualServer_make_sphere_mesh: -- :ref:`RID` **make_sphere_mesh** **(** :ref:`int` latitudes, :ref:`int` longitudes, :ref:`float` radius **)** +- :ref:`RID` **make_sphere_mesh** **(** :ref:`int` latitudes, :ref:`int` longitudes, :ref:`float` radius **)** .. _class_VisualServer_material_create: -- :ref:`RID` **material_create** **(** **)** +- :ref:`RID` **material_create** **(** **)** .. _class_VisualServer_material_get_param: -- :ref:`Variant` **material_get_param** **(** :ref:`RID` material, :ref:`String` parameter **)** const +- :ref:`Variant` **material_get_param** **(** :ref:`RID` material, :ref:`String` parameter **)** const .. _class_VisualServer_material_get_shader: -- :ref:`RID` **material_get_shader** **(** :ref:`RID` shader_material **)** const +- :ref:`RID` **material_get_shader** **(** :ref:`RID` shader_material **)** const .. _class_VisualServer_material_set_line_width: -- void **material_set_line_width** **(** :ref:`RID` material, :ref:`float` width **)** +- void **material_set_line_width** **(** :ref:`RID` material, :ref:`float` width **)** .. _class_VisualServer_material_set_next_pass: -- void **material_set_next_pass** **(** :ref:`RID` material, :ref:`RID` next_material **)** +- void **material_set_next_pass** **(** :ref:`RID` material, :ref:`RID` next_material **)** .. _class_VisualServer_material_set_param: -- void **material_set_param** **(** :ref:`RID` material, :ref:`String` parameter, :ref:`Variant` value **)** +- void **material_set_param** **(** :ref:`RID` material, :ref:`String` parameter, :ref:`Variant` value **)** .. _class_VisualServer_material_set_render_priority: -- void **material_set_render_priority** **(** :ref:`RID` material, :ref:`int` priority **)** +- void **material_set_render_priority** **(** :ref:`RID` material, :ref:`int` priority **)** .. _class_VisualServer_material_set_shader: -- void **material_set_shader** **(** :ref:`RID` shader_material, :ref:`RID` shader **)** +- void **material_set_shader** **(** :ref:`RID` shader_material, :ref:`RID` shader **)** .. _class_VisualServer_mesh_add_surface_from_arrays: -- void **mesh_add_surface_from_arrays** **(** :ref:`RID` mesh, :ref:`int` primtive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[ ], :ref:`int` compress_format=97792 **)** +- void **mesh_add_surface_from_arrays** **(** :ref:`RID` mesh, :ref:`int` primtive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[ ], :ref:`int` compress_format=97792 **)** .. _class_VisualServer_mesh_clear: -- void **mesh_clear** **(** :ref:`RID` mesh **)** +- void **mesh_clear** **(** :ref:`RID` mesh **)** .. _class_VisualServer_mesh_create: -- :ref:`RID` **mesh_create** **(** **)** +- :ref:`RID` **mesh_create** **(** **)** .. _class_VisualServer_mesh_get_blend_shape_count: -- :ref:`int` **mesh_get_blend_shape_count** **(** :ref:`RID` mesh **)** const +- :ref:`int` **mesh_get_blend_shape_count** **(** :ref:`RID` mesh **)** const .. _class_VisualServer_mesh_get_blend_shape_mode: -- :ref:`int` **mesh_get_blend_shape_mode** **(** :ref:`RID` mesh **)** const +- :ref:`int` **mesh_get_blend_shape_mode** **(** :ref:`RID` mesh **)** const .. _class_VisualServer_mesh_get_custom_aabb: -- :ref:`Rect3` **mesh_get_custom_aabb** **(** :ref:`RID` mesh **)** const +- :ref:`Rect3` **mesh_get_custom_aabb** **(** :ref:`RID` mesh **)** const .. _class_VisualServer_mesh_get_surface_count: -- :ref:`int` **mesh_get_surface_count** **(** :ref:`RID` mesh **)** const +- :ref:`int` **mesh_get_surface_count** **(** :ref:`RID` mesh **)** const .. _class_VisualServer_mesh_remove_surface: -- void **mesh_remove_surface** **(** :ref:`RID` mesh, :ref:`int` index **)** +- void **mesh_remove_surface** **(** :ref:`RID` mesh, :ref:`int` index **)** .. _class_VisualServer_mesh_set_blend_shape_count: -- void **mesh_set_blend_shape_count** **(** :ref:`RID` mesh, :ref:`int` amount **)** +- void **mesh_set_blend_shape_count** **(** :ref:`RID` mesh, :ref:`int` amount **)** .. _class_VisualServer_mesh_set_blend_shape_mode: -- void **mesh_set_blend_shape_mode** **(** :ref:`RID` mesh, :ref:`int` mode **)** +- void **mesh_set_blend_shape_mode** **(** :ref:`RID` mesh, :ref:`int` mode **)** .. _class_VisualServer_mesh_set_custom_aabb: -- void **mesh_set_custom_aabb** **(** :ref:`RID` mesh, :ref:`Rect3` aabb **)** +- void **mesh_set_custom_aabb** **(** :ref:`RID` mesh, :ref:`Rect3` aabb **)** .. _class_VisualServer_mesh_surface_get_aabb: -- :ref:`Rect3` **mesh_surface_get_aabb** **(** :ref:`RID` mesh, :ref:`int` surface **)** const +- :ref:`Rect3` **mesh_surface_get_aabb** **(** :ref:`RID` mesh, :ref:`int` surface **)** const .. _class_VisualServer_mesh_surface_get_array: -- :ref:`PoolByteArray` **mesh_surface_get_array** **(** :ref:`RID` mesh, :ref:`int` surface **)** const +- :ref:`PoolByteArray` **mesh_surface_get_array** **(** :ref:`RID` mesh, :ref:`int` surface **)** const .. _class_VisualServer_mesh_surface_get_array_index_len: -- :ref:`int` **mesh_surface_get_array_index_len** **(** :ref:`RID` mesh, :ref:`int` surface **)** const +- :ref:`int` **mesh_surface_get_array_index_len** **(** :ref:`RID` mesh, :ref:`int` surface **)** const .. _class_VisualServer_mesh_surface_get_array_len: -- :ref:`int` **mesh_surface_get_array_len** **(** :ref:`RID` mesh, :ref:`int` surface **)** const +- :ref:`int` **mesh_surface_get_array_len** **(** :ref:`RID` mesh, :ref:`int` surface **)** const .. _class_VisualServer_mesh_surface_get_arrays: -- :ref:`Array` **mesh_surface_get_arrays** **(** :ref:`RID` mesh, :ref:`int` surface **)** const +- :ref:`Array` **mesh_surface_get_arrays** **(** :ref:`RID` mesh, :ref:`int` surface **)** const .. _class_VisualServer_mesh_surface_get_blend_shape_arrays: -- :ref:`Array` **mesh_surface_get_blend_shape_arrays** **(** :ref:`RID` mesh, :ref:`int` surface **)** const +- :ref:`Array` **mesh_surface_get_blend_shape_arrays** **(** :ref:`RID` mesh, :ref:`int` surface **)** const .. _class_VisualServer_mesh_surface_get_format: -- :ref:`int` **mesh_surface_get_format** **(** :ref:`RID` mesh, :ref:`int` surface **)** const +- :ref:`int` **mesh_surface_get_format** **(** :ref:`RID` mesh, :ref:`int` surface **)** const .. _class_VisualServer_mesh_surface_get_index_array: -- :ref:`PoolByteArray` **mesh_surface_get_index_array** **(** :ref:`RID` mesh, :ref:`int` surface **)** const +- :ref:`PoolByteArray` **mesh_surface_get_index_array** **(** :ref:`RID` mesh, :ref:`int` surface **)** const .. _class_VisualServer_mesh_surface_get_material: -- :ref:`RID` **mesh_surface_get_material** **(** :ref:`RID` mesh, :ref:`int` surface **)** const +- :ref:`RID` **mesh_surface_get_material** **(** :ref:`RID` mesh, :ref:`int` surface **)** const .. _class_VisualServer_mesh_surface_get_primitive_type: -- :ref:`int` **mesh_surface_get_primitive_type** **(** :ref:`RID` mesh, :ref:`int` surface **)** const +- :ref:`int` **mesh_surface_get_primitive_type** **(** :ref:`RID` mesh, :ref:`int` surface **)** const .. _class_VisualServer_mesh_surface_get_skeleton_aabb: -- :ref:`Array` **mesh_surface_get_skeleton_aabb** **(** :ref:`RID` mesh, :ref:`int` surface **)** const +- :ref:`Array` **mesh_surface_get_skeleton_aabb** **(** :ref:`RID` mesh, :ref:`int` surface **)** const .. _class_VisualServer_mesh_surface_set_material: -- void **mesh_surface_set_material** **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`RID` material **)** +- void **mesh_surface_set_material** **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`RID` material **)** .. _class_VisualServer_request_frame_drawn_callback: -- void **request_frame_drawn_callback** **(** :ref:`Object` where, :ref:`String` method, :ref:`Variant` userdata **)** +- void **request_frame_drawn_callback** **(** :ref:`Object` where, :ref:`String` method, :ref:`Variant` userdata **)** Schedules a callback to the corresponding named 'method' on 'where' after a frame has been drawn. @@ -1011,238 +1011,238 @@ The callback method must use only 1 argument which will be called with 'userdata .. _class_VisualServer_set_boot_image: -- void **set_boot_image** **(** :ref:`Image` image, :ref:`Color` color, :ref:`bool` scale **)** +- void **set_boot_image** **(** :ref:`Image` image, :ref:`Color` color, :ref:`bool` scale **)** .. _class_VisualServer_set_debug_generate_wireframes: -- void **set_debug_generate_wireframes** **(** :ref:`bool` generate **)** +- void **set_debug_generate_wireframes** **(** :ref:`bool` generate **)** .. _class_VisualServer_set_default_clear_color: -- void **set_default_clear_color** **(** :ref:`Color` color **)** +- void **set_default_clear_color** **(** :ref:`Color` color **)** .. _class_VisualServer_shader_create: -- :ref:`RID` **shader_create** **(** **)** +- :ref:`RID` **shader_create** **(** **)** .. _class_VisualServer_shader_get_code: -- :ref:`String` **shader_get_code** **(** :ref:`RID` shader **)** const +- :ref:`String` **shader_get_code** **(** :ref:`RID` shader **)** const .. _class_VisualServer_shader_get_default_texture_param: -- :ref:`RID` **shader_get_default_texture_param** **(** :ref:`RID` shader, :ref:`String` name **)** const +- :ref:`RID` **shader_get_default_texture_param** **(** :ref:`RID` shader, :ref:`String` name **)** const .. _class_VisualServer_shader_get_param_list: -- :ref:`Array` **shader_get_param_list** **(** :ref:`RID` shader **)** const +- :ref:`Array` **shader_get_param_list** **(** :ref:`RID` shader **)** const .. _class_VisualServer_shader_set_code: -- void **shader_set_code** **(** :ref:`RID` shader, :ref:`String` code **)** +- void **shader_set_code** **(** :ref:`RID` shader, :ref:`String` code **)** .. _class_VisualServer_shader_set_default_texture_param: -- void **shader_set_default_texture_param** **(** :ref:`RID` shader, :ref:`String` name, :ref:`RID` texture **)** +- void **shader_set_default_texture_param** **(** :ref:`RID` shader, :ref:`String` name, :ref:`RID` texture **)** .. _class_VisualServer_sky_create: -- :ref:`RID` **sky_create** **(** **)** +- :ref:`RID` **sky_create** **(** **)** .. _class_VisualServer_sky_set_texture: -- void **sky_set_texture** **(** :ref:`RID` sky, :ref:`RID` cube_map, :ref:`int` radiance_size **)** +- void **sky_set_texture** **(** :ref:`RID` sky, :ref:`RID` cube_map, :ref:`int` radiance_size **)** .. _class_VisualServer_sync: -- void **sync** **(** **)** +- void **sync** **(** **)** .. _class_VisualServer_texture_allocate: -- void **texture_allocate** **(** :ref:`RID` texture, :ref:`int` width, :ref:`int` height, :ref:`int` format, :ref:`int` flags=7 **)** +- void **texture_allocate** **(** :ref:`RID` texture, :ref:`int` width, :ref:`int` height, :ref:`int` format, :ref:`int` flags=7 **)** .. _class_VisualServer_texture_create: -- :ref:`RID` **texture_create** **(** **)** +- :ref:`RID` **texture_create** **(** **)** .. _class_VisualServer_texture_create_from_image: -- :ref:`RID` **texture_create_from_image** **(** :ref:`Image` image, :ref:`int` flags=7 **)** +- :ref:`RID` **texture_create_from_image** **(** :ref:`Image` image, :ref:`int` flags=7 **)** .. _class_VisualServer_texture_debug_usage: -- :ref:`Array` **texture_debug_usage** **(** **)** +- :ref:`Array` **texture_debug_usage** **(** **)** .. _class_VisualServer_texture_get_data: -- :ref:`Image` **texture_get_data** **(** :ref:`RID` texture, :ref:`int` cube_side=0 **)** const +- :ref:`Image` **texture_get_data** **(** :ref:`RID` texture, :ref:`int` cube_side=0 **)** const .. _class_VisualServer_texture_get_flags: -- :ref:`int` **texture_get_flags** **(** :ref:`RID` texture **)** const +- :ref:`int` **texture_get_flags** **(** :ref:`RID` texture **)** const .. _class_VisualServer_texture_get_format: -- :ref:`int` **texture_get_format** **(** :ref:`RID` texture **)** const +- :ref:`int` **texture_get_format** **(** :ref:`RID` texture **)** const .. _class_VisualServer_texture_get_height: -- :ref:`int` **texture_get_height** **(** :ref:`RID` texture **)** const +- :ref:`int` **texture_get_height** **(** :ref:`RID` texture **)** const .. _class_VisualServer_texture_get_path: -- :ref:`String` **texture_get_path** **(** :ref:`RID` texture **)** const +- :ref:`String` **texture_get_path** **(** :ref:`RID` texture **)** const .. _class_VisualServer_texture_get_texid: -- :ref:`int` **texture_get_texid** **(** :ref:`RID` texture **)** const +- :ref:`int` **texture_get_texid** **(** :ref:`RID` texture **)** const .. _class_VisualServer_texture_get_width: -- :ref:`int` **texture_get_width** **(** :ref:`RID` texture **)** const +- :ref:`int` **texture_get_width** **(** :ref:`RID` texture **)** const .. _class_VisualServer_texture_set_data: -- void **texture_set_data** **(** :ref:`RID` texture, :ref:`Image` image, :ref:`int` cube_side=0 **)** +- void **texture_set_data** **(** :ref:`RID` texture, :ref:`Image` image, :ref:`int` cube_side=0 **)** .. _class_VisualServer_texture_set_flags: -- void **texture_set_flags** **(** :ref:`RID` texture, :ref:`int` flags **)** +- void **texture_set_flags** **(** :ref:`RID` texture, :ref:`int` flags **)** .. _class_VisualServer_texture_set_path: -- void **texture_set_path** **(** :ref:`RID` texture, :ref:`String` path **)** +- void **texture_set_path** **(** :ref:`RID` texture, :ref:`String` path **)** .. _class_VisualServer_texture_set_shrink_all_x2_on_set_data: -- void **texture_set_shrink_all_x2_on_set_data** **(** :ref:`bool` shrink **)** +- void **texture_set_shrink_all_x2_on_set_data** **(** :ref:`bool` shrink **)** .. _class_VisualServer_texture_set_size_override: -- void **texture_set_size_override** **(** :ref:`RID` texture, :ref:`int` width, :ref:`int` height **)** +- void **texture_set_size_override** **(** :ref:`RID` texture, :ref:`int` width, :ref:`int` height **)** .. _class_VisualServer_textures_keep_original: -- void **textures_keep_original** **(** :ref:`bool` enable **)** +- void **textures_keep_original** **(** :ref:`bool` enable **)** .. _class_VisualServer_viewport_attach_camera: -- void **viewport_attach_camera** **(** :ref:`RID` viewport, :ref:`RID` camera **)** +- void **viewport_attach_camera** **(** :ref:`RID` viewport, :ref:`RID` camera **)** .. _class_VisualServer_viewport_attach_canvas: -- void **viewport_attach_canvas** **(** :ref:`RID` viewport, :ref:`RID` canvas **)** +- void **viewport_attach_canvas** **(** :ref:`RID` viewport, :ref:`RID` canvas **)** .. _class_VisualServer_viewport_attach_to_screen: -- void **viewport_attach_to_screen** **(** :ref:`RID` viewport, :ref:`Rect2` rect=Rect2( 0, 0, 0, 0 ), :ref:`int` screen=0 **)** +- void **viewport_attach_to_screen** **(** :ref:`RID` viewport, :ref:`Rect2` rect=Rect2( 0, 0, 0, 0 ), :ref:`int` screen=0 **)** .. _class_VisualServer_viewport_create: -- :ref:`RID` **viewport_create** **(** **)** +- :ref:`RID` **viewport_create** **(** **)** .. _class_VisualServer_viewport_detach: -- void **viewport_detach** **(** :ref:`RID` viewport **)** +- void **viewport_detach** **(** :ref:`RID` viewport **)** .. _class_VisualServer_viewport_get_render_info: -- :ref:`int` **viewport_get_render_info** **(** :ref:`RID` viewport, :ref:`int` info **)** +- :ref:`int` **viewport_get_render_info** **(** :ref:`RID` viewport, :ref:`int` info **)** .. _class_VisualServer_viewport_get_texture: -- :ref:`RID` **viewport_get_texture** **(** :ref:`RID` viewport **)** const +- :ref:`RID` **viewport_get_texture** **(** :ref:`RID` viewport **)** const .. _class_VisualServer_viewport_remove_canvas: -- void **viewport_remove_canvas** **(** :ref:`RID` viewport, :ref:`RID` canvas **)** +- void **viewport_remove_canvas** **(** :ref:`RID` viewport, :ref:`RID` canvas **)** .. _class_VisualServer_viewport_set_active: -- void **viewport_set_active** **(** :ref:`RID` viewport, :ref:`bool` active **)** +- void **viewport_set_active** **(** :ref:`RID` viewport, :ref:`bool` active **)** .. _class_VisualServer_viewport_set_canvas_layer: -- void **viewport_set_canvas_layer** **(** :ref:`RID` viewport, :ref:`RID` canvas, :ref:`int` layer **)** +- void **viewport_set_canvas_layer** **(** :ref:`RID` viewport, :ref:`RID` canvas, :ref:`int` layer **)** .. _class_VisualServer_viewport_set_canvas_transform: -- void **viewport_set_canvas_transform** **(** :ref:`RID` viewport, :ref:`RID` canvas, :ref:`Transform2D` offset **)** +- void **viewport_set_canvas_transform** **(** :ref:`RID` viewport, :ref:`RID` canvas, :ref:`Transform2D` offset **)** .. _class_VisualServer_viewport_set_clear_mode: -- void **viewport_set_clear_mode** **(** :ref:`RID` viewport, :ref:`int` clear_mode **)** +- void **viewport_set_clear_mode** **(** :ref:`RID` viewport, :ref:`int` clear_mode **)** .. _class_VisualServer_viewport_set_debug_draw: -- void **viewport_set_debug_draw** **(** :ref:`RID` viewport, :ref:`int` draw **)** +- void **viewport_set_debug_draw** **(** :ref:`RID` viewport, :ref:`int` draw **)** .. _class_VisualServer_viewport_set_disable_3d: -- void **viewport_set_disable_3d** **(** :ref:`RID` viewport, :ref:`bool` disabled **)** +- void **viewport_set_disable_3d** **(** :ref:`RID` viewport, :ref:`bool` disabled **)** .. _class_VisualServer_viewport_set_disable_environment: -- void **viewport_set_disable_environment** **(** :ref:`RID` viewport, :ref:`bool` disabled **)** +- void **viewport_set_disable_environment** **(** :ref:`RID` viewport, :ref:`bool` disabled **)** .. _class_VisualServer_viewport_set_global_canvas_transform: -- void **viewport_set_global_canvas_transform** **(** :ref:`RID` viewport, :ref:`Transform2D` transform **)** +- void **viewport_set_global_canvas_transform** **(** :ref:`RID` viewport, :ref:`Transform2D` transform **)** .. _class_VisualServer_viewport_set_hdr: -- void **viewport_set_hdr** **(** :ref:`RID` viewport, :ref:`bool` enabled **)** +- void **viewport_set_hdr** **(** :ref:`RID` viewport, :ref:`bool` enabled **)** .. _class_VisualServer_viewport_set_hide_canvas: -- void **viewport_set_hide_canvas** **(** :ref:`RID` viewport, :ref:`bool` hidden **)** +- void **viewport_set_hide_canvas** **(** :ref:`RID` viewport, :ref:`bool` hidden **)** .. _class_VisualServer_viewport_set_hide_scenario: -- void **viewport_set_hide_scenario** **(** :ref:`RID` viewport, :ref:`bool` hidden **)** +- void **viewport_set_hide_scenario** **(** :ref:`RID` viewport, :ref:`bool` hidden **)** .. _class_VisualServer_viewport_set_msaa: -- void **viewport_set_msaa** **(** :ref:`RID` viewport, :ref:`int` msaa **)** +- void **viewport_set_msaa** **(** :ref:`RID` viewport, :ref:`int` msaa **)** .. _class_VisualServer_viewport_set_parent_viewport: -- void **viewport_set_parent_viewport** **(** :ref:`RID` viewport, :ref:`RID` parent_viewport **)** +- void **viewport_set_parent_viewport** **(** :ref:`RID` viewport, :ref:`RID` parent_viewport **)** .. _class_VisualServer_viewport_set_scenario: -- void **viewport_set_scenario** **(** :ref:`RID` viewport, :ref:`RID` scenario **)** +- void **viewport_set_scenario** **(** :ref:`RID` viewport, :ref:`RID` scenario **)** .. _class_VisualServer_viewport_set_shadow_atlas_quadrant_subdivision: -- void **viewport_set_shadow_atlas_quadrant_subdivision** **(** :ref:`RID` viewport, :ref:`int` quadrant, :ref:`int` subdivision **)** +- void **viewport_set_shadow_atlas_quadrant_subdivision** **(** :ref:`RID` viewport, :ref:`int` quadrant, :ref:`int` subdivision **)** .. _class_VisualServer_viewport_set_shadow_atlas_size: -- void **viewport_set_shadow_atlas_size** **(** :ref:`RID` viewport, :ref:`int` size **)** +- void **viewport_set_shadow_atlas_size** **(** :ref:`RID` viewport, :ref:`int` size **)** .. _class_VisualServer_viewport_set_size: -- void **viewport_set_size** **(** :ref:`RID` viewport, :ref:`int` width, :ref:`int` height **)** +- void **viewport_set_size** **(** :ref:`RID` viewport, :ref:`int` width, :ref:`int` height **)** .. _class_VisualServer_viewport_set_transparent_background: -- void **viewport_set_transparent_background** **(** :ref:`RID` viewport, :ref:`bool` enabled **)** +- void **viewport_set_transparent_background** **(** :ref:`RID` viewport, :ref:`bool` enabled **)** .. _class_VisualServer_viewport_set_update_mode: -- void **viewport_set_update_mode** **(** :ref:`RID` viewport, :ref:`int` update_mode **)** +- void **viewport_set_update_mode** **(** :ref:`RID` viewport, :ref:`int` update_mode **)** .. _class_VisualServer_viewport_set_usage: -- void **viewport_set_usage** **(** :ref:`RID` viewport, :ref:`int` usage **)** +- void **viewport_set_usage** **(** :ref:`RID` viewport, :ref:`int` usage **)** .. _class_VisualServer_viewport_set_use_arvr: -- void **viewport_set_use_arvr** **(** :ref:`RID` viewport, :ref:`bool` use_arvr **)** +- void **viewport_set_use_arvr** **(** :ref:`RID` viewport, :ref:`bool` use_arvr **)** .. _class_VisualServer_viewport_set_vflip: -- void **viewport_set_vflip** **(** :ref:`RID` viewport, :ref:`bool` enabled **)** +- void **viewport_set_vflip** **(** :ref:`RID` viewport, :ref:`bool` enabled **)** diff --git a/classes/class_weakref.rst b/classes/class_weakref.rst index 130ed5dbf..09a8f04c2 100644 --- a/classes/class_weakref.rst +++ b/classes/class_weakref.rst @@ -19,9 +19,9 @@ Holds an :ref:`Object`, but does not contribute to the reference c Member Functions ---------------- -+--------------------------------+----------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_ref` **(** **)** const | -+--------------------------------+----------------------------------------------------------+ ++--------------------------------+---------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_ref` **(** **)** const | ++--------------------------------+---------------------------------------------------------+ Description ----------- @@ -33,7 +33,7 @@ Member Function Description .. _class_WeakRef_get_ref: -- :ref:`Variant` **get_ref** **(** **)** const +- :ref:`Variant` **get_ref** **(** **)** const Returns the :ref:`Object` this weakref is referring to. diff --git a/classes/class_windowdialog.rst b/classes/class_windowdialog.rst index 66048af74..2b9926e48 100644 --- a/classes/class_windowdialog.rst +++ b/classes/class_windowdialog.rst @@ -21,17 +21,17 @@ Base class for window dialogs. Member Functions ---------------- -+--------------------------------------------+--------------------------------------------------------------------------------------------------------+ -| :ref:`TextureButton` | :ref:`get_close_button` **(** **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_resizable` **(** **)** const | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_title` **(** **)** const | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_resizable` **(** :ref:`bool` resizable **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_title` **(** :ref:`String` title **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------+ ++--------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`TextureButton` | :ref:`get_close_button` **(** **)** | ++--------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_resizable` **(** **)** const | ++--------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_title` **(** **)** const | ++--------------------------------------------+------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_resizable` **(** :ref:`bool` resizable **)** | ++--------------------------------------------+------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_title` **(** :ref:`String` title **)** | ++--------------------------------------------+------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -55,27 +55,27 @@ Member Function Description .. _class_WindowDialog_get_close_button: -- :ref:`TextureButton` **get_close_button** **(** **)** +- :ref:`TextureButton` **get_close_button** **(** **)** Return the close :ref:`TextureButton`. .. _class_WindowDialog_get_resizable: -- :ref:`bool` **get_resizable** **(** **)** const +- :ref:`bool` **get_resizable** **(** **)** const .. _class_WindowDialog_get_title: -- :ref:`String` **get_title** **(** **)** const +- :ref:`String` **get_title** **(** **)** const Return the title of the window. .. _class_WindowDialog_set_resizable: -- void **set_resizable** **(** :ref:`bool` resizable **)** +- void **set_resizable** **(** :ref:`bool` resizable **)** .. _class_WindowDialog_set_title: -- void **set_title** **(** :ref:`String` title **)** +- void **set_title** **(** :ref:`String` title **)** Set the title of the window. diff --git a/classes/class_world.rst b/classes/class_world.rst index 23c9da95e..a24dbcbf3 100644 --- a/classes/class_world.rst +++ b/classes/class_world.rst @@ -19,21 +19,21 @@ Class that has everything pertaining to a world. Member Functions ---------------- -+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PhysicsDirectSpaceState` | :ref:`get_direct_space_state` **(** **)** | -+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Environment` | :ref:`get_environment` **(** **)** const | -+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Environment` | :ref:`get_fallback_environment` **(** **)** const | -+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_scenario` **(** **)** const | -+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_space` **(** **)** const | -+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_environment` **(** :ref:`Environment` env **)** | -+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fallback_environment` **(** :ref:`Environment` env **)** | -+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PhysicsDirectSpaceState` | :ref:`get_direct_space_state` **(** **)** | ++----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Environment` | :ref:`get_environment` **(** **)** const | ++----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Environment` | :ref:`get_fallback_environment` **(** **)** const | ++----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_scenario` **(** **)** const | ++----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_space` **(** **)** const | ++----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_environment` **(** :ref:`Environment` env **)** | ++----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fallback_environment` **(** :ref:`Environment` env **)** | ++----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -57,30 +57,30 @@ Member Function Description .. _class_World_get_direct_space_state: -- :ref:`PhysicsDirectSpaceState` **get_direct_space_state** **(** **)** +- :ref:`PhysicsDirectSpaceState` **get_direct_space_state** **(** **)** .. _class_World_get_environment: -- :ref:`Environment` **get_environment** **(** **)** const +- :ref:`Environment` **get_environment** **(** **)** const .. _class_World_get_fallback_environment: -- :ref:`Environment` **get_fallback_environment** **(** **)** const +- :ref:`Environment` **get_fallback_environment** **(** **)** const .. _class_World_get_scenario: -- :ref:`RID` **get_scenario** **(** **)** const +- :ref:`RID` **get_scenario** **(** **)** const .. _class_World_get_space: -- :ref:`RID` **get_space** **(** **)** const +- :ref:`RID` **get_space** **(** **)** const .. _class_World_set_environment: -- void **set_environment** **(** :ref:`Environment` env **)** +- void **set_environment** **(** :ref:`Environment` env **)** .. _class_World_set_fallback_environment: -- void **set_fallback_environment** **(** :ref:`Environment` env **)** +- void **set_fallback_environment** **(** :ref:`Environment` env **)** diff --git a/classes/class_world2d.rst b/classes/class_world2d.rst index 9e4260432..60816fa4b 100644 --- a/classes/class_world2d.rst +++ b/classes/class_world2d.rst @@ -19,13 +19,13 @@ Class that has everything pertaining to a 2D world. Member Functions ---------------- -+--------------------------------------------------------------------+----------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_canvas` **(** **)** | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------+ -| :ref:`Physics2DDirectSpaceState` | :ref:`get_direct_space_state` **(** **)** | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_space` **(** **)** | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------+ ++--------------------------------------------------------------------+---------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_canvas` **(** **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------+ +| :ref:`Physics2DDirectSpaceState` | :ref:`get_direct_space_state` **(** **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_space` **(** **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------+ Description ----------- @@ -37,19 +37,19 @@ Member Function Description .. _class_World2D_get_canvas: -- :ref:`RID` **get_canvas** **(** **)** +- :ref:`RID` **get_canvas** **(** **)** Retrieve the :ref:`RID` of this world's canvas resource. Used by the :ref:`VisualServer` for 2D drawing. .. _class_World2D_get_direct_space_state: -- :ref:`Physics2DDirectSpaceState` **get_direct_space_state** **(** **)** +- :ref:`Physics2DDirectSpaceState` **get_direct_space_state** **(** **)** Retrieve the state of this world's physics space. This allows arbitrary querying for collision. .. _class_World2D_get_space: -- :ref:`RID` **get_space** **(** **)** +- :ref:`RID` **get_space** **(** **)** Retrieve the :ref:`RID` of this world's physics space resource. Used by the :ref:`Physics2DServer` for 2D physics, treating it as both a space and an area. diff --git a/classes/class_worldenvironment.rst b/classes/class_worldenvironment.rst index 49e183464..727a81ca5 100644 --- a/classes/class_worldenvironment.rst +++ b/classes/class_worldenvironment.rst @@ -19,11 +19,11 @@ Sets environment properties for the entire scene Member Functions ---------------- -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Environment` | :ref:`get_environment` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_environment` **(** :ref:`Environment` env **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`Environment` | :ref:`get_environment` **(** **)** const | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_environment` **(** :ref:`Environment` env **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -43,13 +43,13 @@ Member Function Description .. _class_WorldEnvironment_get_environment: -- :ref:`Environment` **get_environment** **(** **)** const +- :ref:`Environment` **get_environment** **(** **)** const Return the :ref:`Environment` currently bound. .. _class_WorldEnvironment_set_environment: -- void **set_environment** **(** :ref:`Environment` env **)** +- void **set_environment** **(** :ref:`Environment` env **)** Set the currently bound :ref:`Environment` to the one specified. diff --git a/classes/class_xmlparser.rst b/classes/class_xmlparser.rst index b425ec667..e92fd7132 100644 --- a/classes/class_xmlparser.rst +++ b/classes/class_xmlparser.rst @@ -19,41 +19,41 @@ Low-level class for creating parsers for XML files. Member Functions ---------------- -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_attribute_count` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_attribute_name` **(** :ref:`int` idx **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_attribute_value` **(** :ref:`int` idx **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_current_line` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_named_attribute_value` **(** :ref:`String` name **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_named_attribute_value_safe` **(** :ref:`String` name **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_node_data` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_node_name` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_node_offset` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_node_type` **(** **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_attribute` **(** :ref:`String` name **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_empty` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`open` **(** :ref:`String` file **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`open_buffer` **(** :ref:`PoolByteArray` buffer **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`read` **(** **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`seek` **(** :ref:`int` position **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`skip_section` **(** **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_attribute_count` **(** **)** const | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_attribute_name` **(** :ref:`int` idx **)** const | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_attribute_value` **(** :ref:`int` idx **)** const | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_current_line` **(** **)** const | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_named_attribute_value` **(** :ref:`String` name **)** const | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_named_attribute_value_safe` **(** :ref:`String` name **)** const | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_node_data` **(** **)** const | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_node_name` **(** **)** const | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_node_offset` **(** **)** const | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_node_type` **(** **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_attribute` **(** :ref:`String` name **)** const | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_empty` **(** **)** const | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`open` **(** :ref:`String` file **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`open_buffer` **(** :ref:`PoolByteArray` buffer **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`read` **(** **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`seek` **(** :ref:`int` position **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`skip_section` **(** **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -76,103 +76,103 @@ Member Function Description .. _class_XMLParser_get_attribute_count: -- :ref:`int` **get_attribute_count** **(** **)** const +- :ref:`int` **get_attribute_count** **(** **)** const Get the amount of attributes in the current element. .. _class_XMLParser_get_attribute_name: -- :ref:`String` **get_attribute_name** **(** :ref:`int` idx **)** const +- :ref:`String` **get_attribute_name** **(** :ref:`int` idx **)** const Get the name of the attribute specified by the index in ``idx`` argument. .. _class_XMLParser_get_attribute_value: -- :ref:`String` **get_attribute_value** **(** :ref:`int` idx **)** const +- :ref:`String` **get_attribute_value** **(** :ref:`int` idx **)** const Get the value of the attribute specified by the index in ``idx`` argument. .. _class_XMLParser_get_current_line: -- :ref:`int` **get_current_line** **(** **)** const +- :ref:`int` **get_current_line** **(** **)** const Get the current line in the parsed file (currently not implemented). .. _class_XMLParser_get_named_attribute_value: -- :ref:`String` **get_named_attribute_value** **(** :ref:`String` name **)** const +- :ref:`String` **get_named_attribute_value** **(** :ref:`String` name **)** const Get the value of a certain attribute of the current element by name. This will raise an error if the element has no such attribute. .. _class_XMLParser_get_named_attribute_value_safe: -- :ref:`String` **get_named_attribute_value_safe** **(** :ref:`String` name **)** const +- :ref:`String` **get_named_attribute_value_safe** **(** :ref:`String` name **)** const Get the value of a certain attribute of the current element by name. This will return an empty :ref:`String` if the attribute is not found. .. _class_XMLParser_get_node_data: -- :ref:`String` **get_node_data** **(** **)** const +- :ref:`String` **get_node_data** **(** **)** const Get the contents of a text node. This will raise an error in any other type of node. .. _class_XMLParser_get_node_name: -- :ref:`String` **get_node_name** **(** **)** const +- :ref:`String` **get_node_name** **(** **)** const Get the name of the current element node. This will raise an error if the current node type is not ``NODE_ELEMENT`` nor ``NODE_ELEMENT_END`` .. _class_XMLParser_get_node_offset: -- :ref:`int` **get_node_offset** **(** **)** const +- :ref:`int` **get_node_offset** **(** **)** const Get the byte offset of the current node since the beginning of the file or buffer. .. _class_XMLParser_get_node_type: -- :ref:`int` **get_node_type** **(** **)** +- :ref:`int` **get_node_type** **(** **)** Get the type of the current node. Compare with ``NODE\_\*`` constants. .. _class_XMLParser_has_attribute: -- :ref:`bool` **has_attribute** **(** :ref:`String` name **)** const +- :ref:`bool` **has_attribute** **(** :ref:`String` name **)** const Check whether or not the current element has a certain attribute. .. _class_XMLParser_is_empty: -- :ref:`bool` **is_empty** **(** **)** const +- :ref:`bool` **is_empty** **(** **)** const Check whether the current element is empty (this only works for completely empty tags, e.g. ). .. _class_XMLParser_open: -- :ref:`int` **open** **(** :ref:`String` file **)** +- :ref:`int` **open** **(** :ref:`String` file **)** Open a XML file for parsing. This returns an error code. .. _class_XMLParser_open_buffer: -- :ref:`int` **open_buffer** **(** :ref:`PoolByteArray` buffer **)** +- :ref:`int` **open_buffer** **(** :ref:`PoolByteArray` buffer **)** Open a XML raw buffer for parsing. This returns an error code. .. _class_XMLParser_read: -- :ref:`int` **read** **(** **)** +- :ref:`int` **read** **(** **)** Read the next node of the file. This returns an error code. .. _class_XMLParser_seek: -- :ref:`int` **seek** **(** :ref:`int` position **)** +- :ref:`int` **seek** **(** :ref:`int` position **)** Move the buffer cursor to a certain offset (since the beginning) and read the next node there. This returns an error code. .. _class_XMLParser_skip_section: -- void **skip_section** **(** **)** +- void **skip_section** **(** **)** Skips the current section. If the node contains other elements, they will be ignored and the cursor will go to the closing of the current element. diff --git a/classes/class_ysort.rst b/classes/class_ysort.rst index e6f7d4440..9f7c9d065 100644 --- a/classes/class_ysort.rst +++ b/classes/class_ysort.rst @@ -19,11 +19,11 @@ Sort all child nodes based on their Y positions. Member Functions ---------------- -+--------------------------+-----------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_sort_enabled` **(** **)** const | -+--------------------------+-----------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sort_enabled` **(** :ref:`bool` enabled **)** | -+--------------------------+-----------------------------------------------------------------------------------------------------+ ++--------------------------+---------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_sort_enabled` **(** **)** const | ++--------------------------+---------------------------------------------------------------------------------------------------+ +| void | :ref:`set_sort_enabled` **(** :ref:`bool` enabled **)** | ++--------------------------+---------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -43,13 +43,13 @@ Member Function Description .. _class_YSort_is_sort_enabled: -- :ref:`bool` **is_sort_enabled** **(** **)** const +- :ref:`bool` **is_sort_enabled** **(** **)** const Returns true if the children nodes are being sorted. .. _class_YSort_set_sort_enabled: -- void **set_sort_enabled** **(** :ref:`bool` enabled **)** +- void **set_sort_enabled** **(** :ref:`bool` enabled **)** Set whether the children nodes are sorted or not. (default true)