From 3e8e67ac950e2a5c67ce9fe4f0d2d2d722ad8e9c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Tue, 21 Jan 2020 09:28:25 +0100 Subject: [PATCH] Sync classref with current source --- classes/class_@gdscript.rst | 172 ++++ classes/class_@globalscope.rst | 74 +- classes/class_aabb.rst | 44 + classes/class_acceptdialog.rst | 12 + classes/class_animatedsprite.rst | 22 + classes/class_animatedsprite3d.rst | 10 + classes/class_animatedtexture.rst | 8 + classes/class_animation.rst | 118 +++ classes/class_animationnode.rst | 36 + classes/class_animationnodeblendspace1d.rst | 18 + classes/class_animationnodeblendspace2d.rst | 32 + classes/class_animationnodeblendtree.rst | 16 + classes/class_animationnodeoneshot.rst | 12 + classes/class_animationnodestatemachine.rst | 42 + ...lass_animationnodestatemachineplayback.rst | 10 + ...ss_animationnodestatemachinetransition.rst | 10 + classes/class_animationnodetransition.rst | 130 +++ classes/class_animationplayer.rst | 66 ++ classes/class_animationtree.rst | 12 + classes/class_animationtreeplayer.rst | 120 +++ classes/class_area.rst | 62 ++ classes/class_area2d.rst | 54 ++ classes/class_array.rst | 70 ++ classes/class_arraymesh.rst | 36 + classes/class_arvranchor.rst | 6 + classes/class_arvrcontroller.rst | 14 + classes/class_arvrinterface.rst | 20 + classes/class_arvrpositionaltracker.rst | 16 + classes/class_arvrserver.rst | 32 + classes/class_astar.rst | 42 + classes/class_atlastexture.rst | 6 + classes/class_audioeffectchorus.rst | 52 ++ classes/class_audioeffectcompressor.rst | 12 + classes/class_audioeffectdelay.rst | 24 + classes/class_audioeffectdistortion.rst | 8 + classes/class_audioeffecteq.rst | 4 + classes/class_audioeffectfilter.rst | 6 + classes/class_audioeffectlimiter.rst | 6 + classes/class_audioeffectphaser.rst | 8 + classes/class_audioeffectrecord.rst | 4 + classes/class_audioeffectreverb.rst | 14 + classes/class_audioeffectspectrumanalyzer.rst | 4 + classes/class_audioeffectstereoenhance.rst | 4 + classes/class_audioserver.rst | 80 ++ classes/class_audiostreamgenerator.rst | 2 + .../class_audiostreamgeneratorplayback.rst | 10 + classes/class_audiostreamoggvorbis.rst | 4 + classes/class_audiostreamplayer.rst | 22 + classes/class_audiostreamplayer2d.rst | 26 + classes/class_audiostreamplayer3d.rst | 48 ++ classes/class_audiostreamrandompitch.rst | 2 + classes/class_audiostreamsample.rst | 14 + classes/class_backbuffercopy.rst | 2 + classes/class_bakedlightmap.rst | 24 + classes/class_bakedlightmapdata.rst | 16 + classes/class_basebutton.rst | 30 + classes/class_basis.rst | 44 + classes/class_bitmap.rst | 16 + classes/class_bitmapfont.rst | 22 + classes/class_bone2d.rst | 6 + classes/class_bool.rst | 4 + classes/class_button.rst | 8 + classes/class_buttongroup.rst | 2 + classes/class_camera.rst | 52 ++ classes/class_camera2d.rst | 62 ++ classes/class_canvasitem.rst | 108 +++ classes/class_canvasitemmaterial.rst | 12 + classes/class_canvaslayer.rst | 12 + classes/class_capsulemesh.rst | 6 + classes/class_capsuleshape.rst | 2 + classes/class_capsuleshape2d.rst | 2 + classes/class_classdb.rst | 38 + classes/class_clippedcamera.rst | 20 + classes/class_collisionobject.rst | 38 + classes/class_collisionobject2d.rst | 44 + classes/class_collisionpolygon.rst | 4 + classes/class_collisionpolygon2d.rst | 8 + classes/class_collisionshape.rst | 4 + classes/class_collisionshape2d.rst | 6 + classes/class_color.rst | 56 ++ classes/class_colorpicker.rst | 14 + classes/class_colorpickerbutton.rst | 6 + classes/class_concavepolygonshape.rst | 2 + classes/class_conetwistjoint.rst | 8 + classes/class_configfile.rst | 16 + classes/class_container.rst | 2 + classes/class_control.rst | 212 +++++ classes/class_cpuparticles.rst | 124 +++ classes/class_cpuparticles2d.rst | 122 +++ classes/class_csgbox.rst | 6 + classes/class_csgcylinder.rst | 10 + classes/class_csgpolygon.rst | 26 + classes/class_csgshape.rst | 20 + classes/class_csgsphere.rst | 8 + classes/class_csgtorus.rst | 10 + classes/class_cubemap.rst | 14 + classes/class_cubemesh.rst | 6 + classes/class_curve.rst | 40 + classes/class_curve2d.rst | 34 + classes/class_curve3d.rst | 46 + classes/class_curvetexture.rst | 2 + classes/class_cylindermesh.rst | 8 + classes/class_cylindershape.rst | 2 + classes/class_dampedspringjoint2d.rst | 6 + classes/class_dictionary.rst | 20 + classes/class_directionallight.rst | 18 + classes/class_directory.rst | 34 + classes/class_dynamicfont.rst | 26 + classes/class_dynamicfontdata.rst | 4 + classes/class_editorexportplugin.rst | 26 + classes/class_editorfiledialog.rst | 28 + classes/class_editorfilesystem.rst | 22 + classes/class_editorfilesystemdirectory.rst | 26 + classes/class_editorimportplugin.rst | 22 + classes/class_editorinspector.rst | 12 + classes/class_editorinspectorplugin.rst | 14 + classes/class_editorinterface.rst | 40 + classes/class_editorplugin.rst | 116 ++- classes/class_editorproperty.rst | 32 + .../class_editorresourceconversionplugin.rst | 2 + classes/class_editorresourcepreview.rst | 8 + .../class_editorresourcepreviewgenerator.rst | 4 + classes/class_editorsceneimporter.rst | 10 + classes/class_editorscenepostimport.rst | 4 + classes/class_editorscript.rst | 6 + classes/class_editorselection.rst | 8 + classes/class_editorsettings.rst | 30 + classes/class_editorspatialgizmo.rst | 32 + classes/class_editorspatialgizmoplugin.rst | 32 + classes/class_engine.rst | 30 + classes/class_environment.rst | 174 ++++ classes/class_expression.rst | 6 + classes/class_file.rst | 88 ++ classes/class_filedialog.rst | 30 + classes/class_float.rst | 4 + classes/class_font.rst | 16 + classes/class_funcref.rst | 4 + classes/class_gdnative.rst | 4 + classes/class_gdnativelibrary.rst | 46 +- classes/class_gdscript.rst | 2 + classes/class_gdscriptfunctionstate.rst | 2 + classes/class_generic6dofjoint.rst | 170 ++++ classes/class_geometry.rst | 44 + classes/class_geometryinstance.rst | 32 +- classes/class_giprobe.rst | 20 + classes/class_giprobedata.rst | 20 + classes/class_godotsharp.rst | 14 + classes/class_gradient.rst | 16 + classes/class_gradienttexture.rst | 2 + classes/class_graphedit.rst | 54 ++ classes/class_graphnode.rst | 52 ++ classes/class_gridmap.rst | 52 ++ classes/class_groovejoint2d.rst | 2 + classes/class_heightmapshape.rst | 4 + classes/class_hingejoint.rst | 20 + classes/class_httpclient.rst | 34 + classes/class_httprequest.rst | 14 + classes/class_image.rst | 106 +++ classes/class_imagetexture.rst | 12 + classes/class_immediategeometry.rst | 18 + classes/class_input.rst | 269 ++++-- classes/class_inputevent.rst | 20 + classes/class_inputeventaction.rst | 2 + classes/class_inputeventjoypadbutton.rst | 4 + classes/class_inputeventjoypadmotion.rst | 2 + classes/class_inputeventkey.rst | 6 + classes/class_inputeventmidi.rst | 14 + classes/class_inputeventmouse.rst | 4 + classes/class_inputeventmousebutton.rst | 6 + classes/class_inputeventmousemotion.rst | 2 + classes/class_inputeventscreendrag.rst | 6 + classes/class_inputeventscreentouch.rst | 4 + classes/class_inputeventwithmodifiers.rst | 8 + classes/class_inputmap.rst | 22 + classes/class_instanceplaceholder.rst | 6 + classes/class_int.rst | 4 + classes/class_interpolatedcamera.rst | 4 + classes/class_ip.rst | 14 + classes/class_itemlist.rst | 110 +++ classes/class_joint.rst | 6 + classes/class_joint2d.rst | 6 + classes/class_json.rst | 2 + classes/class_jsonparseresult.rst | 6 + classes/class_kinematicbody.rst | 24 + classes/class_kinematicbody2d.rst | 20 + classes/class_kinematiccollision.rst | 20 + classes/class_kinematiccollision2d.rst | 20 + classes/class_label.rst | 26 + classes/class_largetexture.rst | 14 + classes/class_light.rst | 26 + classes/class_light2d.rst | 42 + classes/class_lightoccluder2d.rst | 2 + classes/class_line2d.rst | 34 + classes/class_lineedit.rst | 44 + classes/class_lineshape2d.rst | 2 + classes/class_linkbutton.rst | 2 + classes/class_listener.rst | 6 + classes/class_mainloop.rst | 24 + classes/class_marshalls.rst | 10 + classes/class_material.rst | 2 + classes/class_menubutton.rst | 2 + classes/class_mesh.rst | 22 + classes/class_meshdatatool.rst | 74 ++ classes/class_meshinstance.rst | 12 + classes/class_meshinstance2d.rst | 4 + classes/class_meshlibrary.rst | 30 + classes/class_mobilevrinterface.rst | 12 + classes/class_multimesh.rst | 30 + classes/class_multiplayerapi.rst | 30 + classes/class_mutex.rst | 4 + classes/class_nativescript.rst | 14 + classes/class_navigation.rst | 14 + classes/class_navigation2d.rst | 10 + classes/class_navigationmesh.rst | 44 + classes/class_navigationmeshinstance.rst | 2 + classes/class_navigationpolygon.rst | 26 + classes/class_navigationpolygoninstance.rst | 2 + classes/class_networkedmultiplayerenet.rst | 22 + classes/class_networkedmultiplayerpeer.rst | 20 + classes/class_nil.rst | 50 ++ classes/class_ninepatchrect.rst | 16 + classes/class_node.rst | 184 ++++ classes/class_node2d.rst | 42 + classes/class_nodepath.rst | 35 +- classes/class_noisetexture.rst | 10 + classes/class_object.rst | 84 ++ classes/class_occluderpolygon2d.rst | 4 + classes/class_omnilight.rst | 8 + classes/class_opensimplexnoise.rst | 20 + classes/class_optionbutton.rst | 42 + classes/class_os.rst | 218 +++++ classes/class_packeddatacontainer.rst | 2 + classes/class_packedscene.rst | 6 + classes/class_packetpeer.rst | 10 + classes/class_packetpeerstream.rst | 4 + classes/class_packetpeerudp.rst | 12 + classes/class_parallaxbackground.rst | 10 + classes/class_parallaxlayer.rst | 4 + classes/class_particles.rst | 38 + classes/class_particles2d.rst | 32 + classes/class_particlesmaterial.rst | 118 ++- classes/class_pathfollow.rst | 12 + classes/class_pathfollow2d.rst | 14 + classes/class_pckpacker.rst | 4 + classes/class_physicalbone.rst | 20 + classes/class_physics2ddirectbodystate.rst | 54 ++ classes/class_physics2ddirectspacestate.rst | 12 + classes/class_physics2dserver.rst | 226 +++++ .../class_physics2dshapequeryparameters.rst | 14 + classes/class_physics2dshapequeryresult.rst | 8 + classes/class_physics2dtestmotionresult.rst | 16 + classes/class_physicsbody.rst | 14 + classes/class_physicsbody2d.rst | 16 + classes/class_physicsdirectbodystate.rst | 58 ++ classes/class_physicsdirectspacestate.rst | 8 + classes/class_physicsmaterial.rst | 6 + classes/class_physicsserver.rst | 254 ++++++ classes/class_physicsshapequeryparameters.rst | 12 + classes/class_physicsshapequeryresult.rst | 8 + classes/class_pinjoint.rst | 4 + classes/class_plane.rst | 32 + classes/class_planemesh.rst | 4 + classes/class_polygon2d.rst | 46 + classes/class_polygonpathfinder.rst | 14 + classes/class_poolbytearray.rst | 28 + classes/class_poolcolorarray.rst | 18 + classes/class_poolintarray.rst | 24 +- classes/class_poolrealarray.rst | 18 + classes/class_poolstringarray.rst | 20 + classes/class_poolvector2array.rst | 18 + classes/class_poolvector3array.rst | 18 + classes/class_popup.rst | 8 + classes/class_popupmenu.rst | 106 +++ classes/class_primitivemesh.rst | 4 + classes/class_prismmesh.rst | 8 + classes/class_proceduralsky.rst | 30 + classes/class_projectsettings.rst | 584 +++++++++++++ classes/class_proximitygroup.rst | 4 + classes/class_quat.rst | 38 + classes/class_randomnumbergenerator.rst | 10 + classes/class_range.rst | 24 +- classes/class_raycast.rst | 34 + classes/class_raycast2d.rst | 34 + classes/class_rayshape.rst | 2 + classes/class_rayshape2d.rst | 2 + classes/class_rect2.rst | 30 + classes/class_reference.rst | 4 + classes/class_reflectionprobe.rst | 22 + classes/class_regex.rst | 16 + classes/class_regexmatch.rst | 10 + classes/class_remotetransform.rst | 8 + classes/class_remotetransform2d.rst | 8 + classes/class_resource.rst | 14 + classes/class_resourceformatloader.rst | 10 + classes/class_resourceformatsaver.rst | 4 + classes/class_resourceinteractiveloader.rst | 8 + classes/class_resourceloader.rst | 14 + classes/class_resourcepreloader.rst | 10 + classes/class_resourcesaver.rst | 2 + classes/class_richtextlabel.rst | 76 ++ classes/class_rid.rst | 2 + classes/class_rigidbody.rst | 68 ++ classes/class_rigidbody2d.rst | 66 ++ classes/class_rootmotionview.rst | 8 + classes/class_scenestate.rst | 38 + classes/class_scenetree.rst | 98 +++ classes/class_script.rst | 14 + classes/class_scripteditor.rst | 12 + classes/class_scrollcontainer.rst | 12 + classes/class_segmentshape2d.rst | 2 + classes/class_semaphore.rst | 2 + classes/class_shader.rst | 6 + classes/class_shadermaterial.rst | 6 + classes/class_shape2d.rst | 6 + classes/class_shortcut.rst | 4 + classes/class_skeleton.rst | 52 ++ classes/class_skeleton2d.rst | 4 + classes/class_skeletonik.rst | 24 + classes/class_slider.rst | 8 + classes/class_sliderjoint.rst | 42 + classes/class_softbody.rst | 38 + classes/class_spatial.rst | 78 ++ classes/class_spatialmaterial.rst | 222 +++++ classes/class_spatialvelocitytracker.rst | 4 + classes/class_spheremesh.rst | 8 + classes/class_spinbox.rst | 6 + classes/class_splitcontainer.rst | 4 + classes/class_spotlight.rst | 6 + classes/class_springarm.rst | 12 + classes/class_sprite.rst | 26 + classes/class_sprite3d.rst | 10 + classes/class_spritebase3d.rst | 26 + classes/class_spriteframes.rst | 30 + classes/class_staticbody.rst | 8 + classes/class_staticbody2d.rst | 8 + classes/class_streampeer.rst | 60 ++ classes/class_streampeerbuffer.rst | 10 + classes/class_streampeerssl.rst | 8 + classes/class_streampeertcp.rst | 12 + classes/class_string.rst | 206 ++++- classes/class_stylebox.rst | 18 + classes/class_styleboxflat.rst | 50 ++ classes/class_styleboxline.rst | 8 + classes/class_styleboxtexture.rst | 30 + classes/class_surfacetool.rst | 40 + classes/class_tabcontainer.rst | 36 + classes/class_tabs.rst | 54 ++ classes/class_tcp_server.rst | 6 + classes/class_textedit.rst | 124 +++ classes/class_texture.rst | 14 + classes/class_texturebutton.rst | 14 + classes/class_texturelayered.rst | 16 + classes/class_textureprogress.rst | 28 + classes/class_texturerect.rst | 4 + classes/class_theme.rst | 58 ++ classes/class_thread.rst | 6 + classes/class_tilemap.rst | 82 ++ classes/class_tileset.rst | 136 +++ classes/class_timer.rst | 14 + classes/class_touchscreenbutton.rst | 18 + classes/class_transform.rst | 30 + classes/class_transform2d.rst | 36 + classes/class_translation.rst | 8 + classes/class_translationserver.rst | 20 + classes/class_tree.rst | 86 ++ classes/class_treeitem.rst | 112 +++ classes/class_tween.rst | 56 ++ classes/class_undoredo.rst | 26 + classes/class_upnp.rst | 24 + classes/class_upnpdevice.rst | 16 + classes/class_vector2.rst | 60 +- classes/class_vector3.rst | 60 ++ classes/class_vehiclebody.rst | 4 + classes/class_vehiclewheel.rst | 22 + classes/class_videoplayer.rst | 26 + classes/class_videostreamgdnative.rst | 2 + classes/class_videostreamtheora.rst | 2 + classes/class_videostreamwebm.rst | 2 + classes/class_viewport.rst | 114 +++ classes/class_viewportcontainer.rst | 2 + classes/class_visibilityenabler.rst | 2 + classes/class_visibilityenabler2d.rst | 10 + classes/class_visibilitynotifier.rst | 6 + classes/class_visibilitynotifier2d.rst | 6 + classes/class_visualinstance.rst | 12 + classes/class_visualscript.rst | 82 ++ .../class_visualscriptbasictypeconstant.rst | 2 + classes/class_visualscriptclassconstant.rst | 2 + classes/class_visualscriptcomment.rst | 4 + classes/class_visualscriptconstant.rst | 2 + classes/class_visualscriptconstructor.rst | 6 + classes/class_visualscriptcustomnode.rst | 26 + classes/class_visualscripteditor.rst | 2 + classes/class_visualscriptfunctioncall.rst | 20 + classes/class_visualscriptfunctionstate.rst | 4 + classes/class_visualscriptinputaction.rst | 2 + classes/class_visualscriptlocalvar.rst | 2 + classes/class_visualscriptlocalvarset.rst | 2 + classes/class_visualscriptnode.rst | 6 + classes/class_visualscriptoperator.rst | 2 + classes/class_visualscriptpropertyget.rst | 12 + classes/class_visualscriptpropertyset.rst | 16 + classes/class_visualscriptreturn.rst | 2 + classes/class_visualscripttypecast.rst | 2 + classes/class_visualscriptyield.rst | 2 + classes/class_visualscriptyieldsignal.rst | 6 + classes/class_visualserver.rst | 792 ++++++++++++++++++ classes/class_visualshader.rst | 24 + classes/class_visualshadernode.rst | 4 + classes/class_visualshadernodecubemap.rst | 2 + classes/class_visualshadernodetexture.rst | 6 + .../class_visualshadernodetextureuniform.rst | 4 + classes/class_websocketclient.rst | 10 + classes/class_websocketpeer.rst | 12 + classes/class_websocketserver.rst | 18 + classes/class_windowdialog.rst | 2 + classes/class_world.rst | 8 + classes/class_world2d.rst | 4 + classes/class_xmlparser.rst | 32 + 419 files changed, 12807 insertions(+), 99 deletions(-) diff --git a/classes/class_@gdscript.rst b/classes/class_@gdscript.rst index 34a65a50d..6c2804cc0 100644 --- a/classes/class_@gdscript.rst +++ b/classes/class_@gdscript.rst @@ -240,6 +240,8 @@ Returns a 32 bit color with red, green, blue and alpha channels. Each channel ha red = Color8(255, 0, 0) +---- + .. _class_@GDScript_method_ColorN: - :ref:`Color` **ColorN** **(** :ref:`String` name, :ref:`float` alpha=1.0 **)** @@ -254,6 +256,8 @@ Supported color names: "aliceblue", "antiquewhite", "aqua", "aquamarine", "azure", "beige", "bisque", "black", "blanchedalmond", "blue", "blueviolet", "brown", "burlywood", "cadetblue", "chartreuse", "chocolate", "coral", "cornflower", "cornsilk", "crimson", "cyan", "darkblue", "darkcyan", "darkgoldenrod", "darkgray", "darkgreen", "darkkhaki", "darkmagenta", "darkolivegreen", "darkorange", "darkorchid", "darkred", "darksalmon", "darkseagreen", "darkslateblue", "darkslategray", "darkturquoise", "darkviolet", "deeppink", "deepskyblue", "dimgray", "dodgerblue", "firebrick", "floralwhite", "forestgreen", "fuchsia", "gainsboro", "ghostwhite", "gold", "goldenrod", "gray", "webgray", "green", "webgreen", "greenyellow", "honeydew", "hotpink", "indianred", "indigo", "ivory", "khaki", "lavender", "lavenderblush", "lawngreen", "lemonchiffon", "lightblue", "lightcoral", "lightcyan", "lightgoldenrod", "lightgray", "lightgreen", "lightpink", "lightsalmon", "lightseagreen", "lightskyblue", "lightslategray", "lightsteelblue", "lightyellow", "lime", "limegreen", "linen", "magenta", "maroon", "webmaroon", "mediumaquamarine", "mediumblue", "mediumorchid", "mediumpurple", "mediumseagreen", "mediumslateblue", "mediumspringgreen", "mediumturquoise", "mediumvioletred", "midnightblue", "mintcream", "mistyrose", "moccasin", "navajowhite", "navyblue", "oldlace", "olive", "olivedrab", "orange", "orangered", "orchid", "palegoldenrod", "palegreen", "paleturquoise", "palevioletred", "papayawhip", "peachpuff", "peru", "pink", "plum", "powderblue", "purple", "webpurple", "rebeccapurple", "red", "rosybrown", "royalblue", "saddlebrown", "salmon", "sandybrown", "seagreen", "seashell", "sienna", "silver", "skyblue", "slateblue", "slategray", "snow", "springgreen", "steelblue", "tan", "teal", "thistle", "tomato", "turquoise", "violet", "wheat", "white", "whitesmoke", "yellow", "yellowgreen". +---- + .. _class_@GDScript_method_abs: - :ref:`float` **abs** **(** :ref:`float` s **)** @@ -265,6 +269,8 @@ Returns the absolute value of parameter ``s`` (i.e. unsigned value, works for in # a is 1 a = abs(-1) +---- + .. _class_@GDScript_method_acos: - :ref:`float` **acos** **(** :ref:`float` s **)** @@ -276,6 +282,8 @@ Returns the arc cosine of ``s`` in radians. Use to get the angle of cosine ``s`` # c is 0.523599 or 30 degrees if converted with rad2deg(s) c = acos(0.866025) +---- + .. _class_@GDScript_method_asin: - :ref:`float` **asin** **(** :ref:`float` s **)** @@ -287,6 +295,8 @@ Returns the arc sine of ``s`` in radians. Use to get the angle of sine ``s``. # s is 0.523599 or 30 degrees if converted with rad2deg(s) s = asin(0.5) +---- + .. _class_@GDScript_method_assert: - void **assert** **(** :ref:`bool` condition **)** @@ -301,6 +311,8 @@ Asserts that the ``condition`` is ``true`` . If the ``condition`` is ``false``, assert(speed >= 0) # False, the program will stop assert(speed >= 0 && speed < 20) # You can also combine the two conditional statements in one check +---- + .. _class_@GDScript_method_atan: - :ref:`float` **atan** **(** :ref:`float` s **)** @@ -313,6 +325,8 @@ The method cannot know in which quadrant the angle should fall. See :ref:`atan2< a = atan(0.5) # a is 0.463648 +---- + .. _class_@GDScript_method_atan2: - :ref:`float` **atan2** **(** :ref:`float` y, :ref:`float` x **)** @@ -323,6 +337,8 @@ Returns the arc tangent of ``y/x`` in radians. Use to get the angle of tangent ` a = atan2(0, -1) # a is 3.141593 +---- + .. _class_@GDScript_method_bytes2var: - :ref:`Variant` **bytes2var** **(** :ref:`PoolByteArray` bytes, :ref:`bool` allow_objects=false **)** @@ -331,12 +347,16 @@ Decodes a byte array back to a value. When ``allow_objects`` is ``true`` decodin **WARNING:** Deserialized object can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats (remote code execution). +---- + .. _class_@GDScript_method_cartesian2polar: - :ref:`Vector2` **cartesian2polar** **(** :ref:`float` x, :ref:`float` y **)** Converts a 2D point expressed in the cartesian coordinate system (x and y axis) to the polar coordinate system (a distance from the origin and an angle). +---- + .. _class_@GDScript_method_ceil: - :ref:`float` **ceil** **(** :ref:`float` s **)** @@ -348,6 +368,8 @@ Rounds ``s`` upward, returning the smallest integral value that is not less than i = ceil(1.45) # i is 2 i = ceil(1.001) # i is 2 +---- + .. _class_@GDScript_method_char: - :ref:`String` **char** **(** :ref:`int` ascii **)** @@ -361,6 +383,8 @@ Returns a character as a String of the given ASCII code. # a is 'a' a = char(65 + 32) +---- + .. _class_@GDScript_method_clamp: - :ref:`float` **clamp** **(** :ref:`float` value, :ref:`float` min, :ref:`float` max **)** @@ -377,6 +401,8 @@ Clamps ``value`` and returns a value not less than ``min`` and not more than ``m # a is 1 a = clamp(speed, 1, 20) +---- + .. _class_@GDScript_method_convert: - :ref:`Variant` **convert** **(** :ref:`Variant` what, :ref:`int` type **)** @@ -393,6 +419,8 @@ Converts from a type to another in the best way possible. The ``type`` parameter # (1, 0) is 6 characters print(a.length()) +---- + .. _class_@GDScript_method_cos: - :ref:`float` **cos** **(** :ref:`float` s **)** @@ -405,6 +433,8 @@ Returns the cosine of angle ``s`` in radians. print(cos(PI * 2)) print(cos(PI)) +---- + .. _class_@GDScript_method_cosh: - :ref:`float` **cosh** **(** :ref:`float` s **)** @@ -416,12 +446,16 @@ Returns the hyperbolic cosine of ``s`` in radians. # prints 1.543081 print(cosh(1)) +---- + .. _class_@GDScript_method_db2linear: - :ref:`float` **db2linear** **(** :ref:`float` db **)** Converts from decibels to linear energy (audio). +---- + .. _class_@GDScript_method_decimals: - :ref:`float` **decimals** **(** :ref:`float` step **)** @@ -433,6 +467,8 @@ Returns the position of the first non-zero digit, after the decimal point. # n is 2 n = decimals(0.035) +---- + .. _class_@GDScript_method_dectime: - :ref:`float` **dectime** **(** :ref:`float` value, :ref:`float` amount, :ref:`float` step **)** @@ -444,6 +480,8 @@ Returns the result of ``value`` decreased by ``step`` \* ``amount``. # a = 59 a = dectime(60, 10, 0.1)) +---- + .. _class_@GDScript_method_deg2rad: - :ref:`float` **deg2rad** **(** :ref:`float` deg **)** @@ -455,18 +493,24 @@ Returns degrees converted to radians. # r is 3.141593 r = deg2rad(180) +---- + .. _class_@GDScript_method_dict2inst: - :ref:`Object` **dict2inst** **(** :ref:`Dictionary` dict **)** Converts a previously converted instance to a dictionary, back into an instance. Useful for deserializing. +---- + .. _class_@GDScript_method_ease: - :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_method_exp: - :ref:`float` **exp** **(** :ref:`float` s **)** @@ -475,10 +519,14 @@ The natural exponential function. It raises the mathematical constant **e** to t **e** has an approximate value of 2.71828. +For exponents to other bases use the method :ref:`pow`. + :: a = exp(2) # approximately 7.39 +---- + .. _class_@GDScript_method_floor: - :ref:`float` **floor** **(** :ref:`float` s **)** @@ -492,6 +540,8 @@ Rounds ``s`` to the closest smaller integer and returns it. # a is -3 a = floor(-2.99) +---- + .. _class_@GDScript_method_fmod: - :ref:`float` **fmod** **(** :ref:`float` x, :ref:`float` y **)** @@ -503,6 +553,8 @@ Returns the floating-point remainder of ``x/y``. # remainder is 1.5 var remainder = fmod(7, 5.5) +---- + .. _class_@GDScript_method_fposmod: - :ref:`float` **fposmod** **(** :ref:`float` x, :ref:`float` y **)** @@ -531,6 +583,8 @@ Produces: -2 8 -1 9 +---- + .. _class_@GDScript_method_funcref: - :ref:`FuncRef` **funcref** **(** :ref:`Object` instance, :ref:`String` funcname **)** @@ -545,6 +599,8 @@ Returns a reference to the specified function ``funcname`` in the ``instance`` n a = funcref(self, "foo") print(a.call_func()) # prints bar +---- + .. _class_@GDScript_method_get_stack: - :ref:`Array` **get_stack** **(** **)** @@ -568,6 +624,8 @@ would print [{function:bar, line:12, source:res://script.gd}, {function:foo, line:9, source:res://script.gd}, {function:_ready, line:6, source:res://script.gd}] +---- + .. _class_@GDScript_method_hash: - :ref:`int` **hash** **(** :ref:`Variant` var **)** @@ -578,6 +636,8 @@ Returns the integer hash of the variable passed. print(hash("a")) # prints 177670 +---- + .. _class_@GDScript_method_inst2dict: - :ref:`Dictionary` **inst2dict** **(** :ref:`Object` inst **)** @@ -599,6 +659,8 @@ Prints out: [@subpath, @path, foo] [, res://test.gd, bar] +---- + .. _class_@GDScript_method_instance_from_id: - :ref:`Object` **instance_from_id** **(** :ref:`int` instance_id **)** @@ -613,6 +675,8 @@ Returns the Object that corresponds to ``instance_id``. All Objects have a uniqu var inst = instance_from_id(id) print(inst.foo) # prints bar +---- + .. _class_@GDScript_method_inverse_lerp: - :ref:`float` **inverse_lerp** **(** :ref:`float` from, :ref:`float` to, :ref:`float` weight **)** @@ -623,24 +687,32 @@ Returns a normalized value considering the given range. inverse_lerp(3, 5, 4) # returns 0.5 +---- + .. _class_@GDScript_method_is_inf: - :ref:`bool` **is_inf** **(** :ref:`float` s **)** Returns whether ``s`` is an infinity value (either positive infinity or negative infinity). +---- + .. _class_@GDScript_method_is_instance_valid: - :ref:`bool` **is_instance_valid** **(** :ref:`Object` instance **)** Returns whether ``instance`` is a valid object (e.g. has not been deleted from memory). +---- + .. _class_@GDScript_method_is_nan: - :ref:`bool` **is_nan** **(** :ref:`float` s **)** Returns whether ``s`` is a NaN (Not-A-Number) value. +---- + .. _class_@GDScript_method_len: - :ref:`int` **len** **(** :ref:`Variant` var **)** @@ -654,6 +726,8 @@ Returns length of Variant ``var``. Length is the character count of String, elem a = [1, 2, 3, 4] len(a) # returns 4 +---- + .. _class_@GDScript_method_lerp: - :ref:`Variant` **lerp** **(** :ref:`Variant` from, :ref:`Variant` to, :ref:`float` weight **)** @@ -669,12 +743,16 @@ If both are of the same vector type (:ref:`Vector2`, :ref:`Vector lerp(0, 4, 0.75) # returns 3.0 lerp(Vector2(1, 5), Vector2(3, 2), 0.5) # returns Vector2(2, 3.5) +---- + .. _class_@GDScript_method_linear2db: - :ref:`float` **linear2db** **(** :ref:`float` nrg **)** Converts from linear energy to decibels (audio). +---- + .. _class_@GDScript_method_load: - :ref:`Resource` **load** **(** :ref:`String` path **)** @@ -688,6 +766,8 @@ Loads a resource from the filesystem located at ``path``. # load a scene called main located in the root of the project directory var main = load("res://main.tscn") +---- + .. _class_@GDScript_method_log: - :ref:`float` **log** **(** :ref:`float` s **)** @@ -700,6 +780,8 @@ Natural logarithm. The amount of time needed to reach a certain level of continu log(10) # returns 2.302585 +---- + .. _class_@GDScript_method_max: - :ref:`float` **max** **(** :ref:`float` a, :ref:`float` b **)** @@ -711,6 +793,8 @@ Returns the maximum of two values. max(1, 2) # returns 2 max(-3.99, -4) # returns -3.99 +---- + .. _class_@GDScript_method_min: - :ref:`float` **min** **(** :ref:`float` a, :ref:`float` b **)** @@ -722,6 +806,8 @@ Returns the minimum of two values. min(1, 2) # returns 1 min(-3.99, -4) # returns -4 +---- + .. _class_@GDScript_method_nearest_po2: - :ref:`int` **nearest_po2** **(** :ref:`int` value **)** @@ -734,6 +820,8 @@ Returns the nearest larger power of 2 for integer ``value``. nearest_po2(4) # returns 4 nearest_po2(5) # returns 8 +---- + .. _class_@GDScript_method_parse_json: - :ref:`Variant` **parse_json** **(** :ref:`String` json **)** @@ -752,12 +840,16 @@ Note that JSON objects do not preserve key order like Godot dictionaries, thus y else: print("unexpected results") +---- + .. _class_@GDScript_method_polar2cartesian: - :ref:`Vector2` **polar2cartesian** **(** :ref:`float` r, :ref:`float` th **)** Converts a 2D point expressed in the polar coordinate system (a distance from the origin ``r`` and an angle ``th``) to the cartesian coordinate system (x and y axis). +---- + .. _class_@GDScript_method_pow: - :ref:`float` **pow** **(** :ref:`float` x, :ref:`float` y **)** @@ -768,6 +860,8 @@ Returns the result of ``x`` raised to the power of ``y``. pow(2, 5) # returns 32 +---- + .. _class_@GDScript_method_preload: - :ref:`Resource` **preload** **(** :ref:`String` path **)** @@ -781,6 +875,8 @@ Returns a resource from the filesystem that is loaded during script parsing. # load a scene called main located in the root of the project directory var main = preload("res://main.tscn") +---- + .. _class_@GDScript_method_print: - void **print** **(** ... **)** vararg @@ -792,12 +888,16 @@ Converts one or more arguments to strings in the best way possible and prints th a = [1, 2, 3] print("a", "b", a) # prints ab[1, 2, 3] +---- + .. _class_@GDScript_method_print_debug: - void **print_debug** **(** ... **)** vararg Like :ref:`print`, but prints only when used in debug mode. +---- + .. _class_@GDScript_method_print_stack: - void **print_stack** **(** **)** @@ -810,6 +910,8 @@ Output in the console would look something like this: Frame 0 - res://test.gd:16 in function '_process' +---- + .. _class_@GDScript_method_printerr: - void **printerr** **(** ... **)** vararg @@ -820,6 +922,8 @@ Prints one or more arguments to strings in the best way possible to standard err printerr("prints to stderr") +---- + .. _class_@GDScript_method_printraw: - void **printraw** **(** ... **)** vararg @@ -832,6 +936,8 @@ Prints one or more arguments to strings in the best way possible to console. No printraw("B") # prints AB +---- + .. _class_@GDScript_method_prints: - void **prints** **(** ... **)** vararg @@ -842,6 +948,8 @@ Prints one or more arguments to the console with a space between each argument. prints("A", "B", "C") # prints A B C +---- + .. _class_@GDScript_method_printt: - void **printt** **(** ... **)** vararg @@ -852,6 +960,8 @@ Prints one or more arguments to the console with a tab between each argument. printt("A", "B", "C") # prints A B C +---- + .. _class_@GDScript_method_push_error: - void **push_error** **(** :ref:`String` message **)** @@ -862,6 +972,8 @@ Pushes an error message to Godot's built-in debugger and to the OS terminal. push_error("test error") # prints "test error" to debugger and terminal as error call +---- + .. _class_@GDScript_method_push_warning: - void **push_warning** **(** :ref:`String` message **)** @@ -872,6 +984,8 @@ Pushes a warning message to Godot's built-in debugger and to the OS terminal. push_warning("test warning") # prints "test warning" to debugger and terminal as warning call +---- + .. _class_@GDScript_method_rad2deg: - :ref:`float` **rad2deg** **(** :ref:`float` rad **)** @@ -882,6 +996,8 @@ Converts from radians to degrees. rad2deg(0.523599) # returns 30 +---- + .. _class_@GDScript_method_rand_range: - :ref:`float` **rand_range** **(** :ref:`float` from, :ref:`float` to **)** @@ -892,12 +1008,16 @@ Random range, any floating point value between ``from`` and ``to``. prints(rand_range(0, 1), rand_range(0, 1)) # prints e.g. 0.135591 0.405263 +---- + .. _class_@GDScript_method_rand_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_method_randf: - :ref:`float` **randf** **(** **)** @@ -908,6 +1028,8 @@ Returns a random floating point value on the interval ``[0, 1]``. randf() # returns e.g. 0.375671 +---- + .. _class_@GDScript_method_randi: - :ref:`int` **randi** **(** **)** @@ -921,6 +1043,8 @@ Returns a random unsigned 32 bit integer. Use remainder to obtain a random value randi() % 100 # returns random integer between 0 and 99 randi() % 100 + 1 # returns random integer between 1 and 100 +---- + .. _class_@GDScript_method_randomize: - void **randomize** **(** **)** @@ -932,6 +1056,8 @@ Randomizes the seed (or the internal state) of the random number generator. Curr func _ready(): randomize() +---- + .. _class_@GDScript_method_range: - :ref:`Array` **range** **(** ... **)** vararg @@ -964,6 +1090,8 @@ Output: 2 4 +---- + .. _class_@GDScript_method_range_lerp: - :ref:`float` **range_lerp** **(** :ref:`float` value, :ref:`float` istart, :ref:`float` istop, :ref:`float` ostart, :ref:`float` ostop **)** @@ -974,6 +1102,8 @@ Maps a ``value`` from range ``[istart, istop]`` to ``[ostart, ostop]``. range_lerp(75, 0, 100, -1, 1) # returns 0.5 +---- + .. _class_@GDScript_method_round: - :ref:`float` **round** **(** :ref:`float` s **)** @@ -984,6 +1114,8 @@ Returns the integral value that is nearest to ``s``, with halfway cases rounded round(2.6) # returns 3 +---- + .. _class_@GDScript_method_seed: - void **seed** **(** :ref:`int` seed **)** @@ -995,6 +1127,8 @@ Sets seed for the random number generator. my_seed = "Godot Rocks" seed(my_seed.hash()) +---- + .. _class_@GDScript_method_sign: - :ref:`float` **sign** **(** :ref:`float` s **)** @@ -1007,6 +1141,8 @@ Returns the sign of ``s``: -1 or 1. Returns 0 if ``s`` is 0. sign(0) # returns 0 sign(6) # returns 1 +---- + .. _class_@GDScript_method_sin: - :ref:`float` **sin** **(** :ref:`float` s **)** @@ -1017,6 +1153,8 @@ Returns the sine of angle ``s`` in radians. sin(0.523599) # returns 0.5 +---- + .. _class_@GDScript_method_sinh: - :ref:`float` **sinh** **(** :ref:`float` s **)** @@ -1028,6 +1166,8 @@ Returns the hyperbolic sine of ``s``. a = log(2.0) # returns 0.693147 sinh(a) # returns 0.75 +---- + .. _class_@GDScript_method_smoothstep: - :ref:`float` **smoothstep** **(** :ref:`float` from, :ref:`float` to, :ref:`float` weight **)** @@ -1040,6 +1180,8 @@ Returns a number smoothly interpolated between the ``from`` and ``to``, based on smoothstep(0, 2, 1.0) # returns 0.5 smoothstep(0, 2, 2.0) # returns 1.0 +---- + .. _class_@GDScript_method_sqrt: - :ref:`float` **sqrt** **(** :ref:`float` s **)** @@ -1050,12 +1192,16 @@ Returns the square root of ``s``. sqrt(9) # returns 3 +---- + .. _class_@GDScript_method_stepify: - :ref:`float` **stepify** **(** :ref:`float` s, :ref:`float` step **)** Snaps float value ``s`` to a given ``step``. +---- + .. _class_@GDScript_method_str: - :ref:`String` **str** **(** ... **)** vararg @@ -1069,6 +1215,8 @@ Converts one or more arguments to string in the best way possible. len(a) # returns 3 len(b) # returns 12 +---- + .. _class_@GDScript_method_str2var: - :ref:`Variant` **str2var** **(** :ref:`String` string **)** @@ -1081,6 +1229,8 @@ Converts a formatted string that was returned by :ref:`var2str` **tan** **(** :ref:`float` s **)** @@ -1091,6 +1241,8 @@ Returns the tangent of angle ``s`` in radians. tan(deg2rad(45)) # returns 1 +---- + .. _class_@GDScript_method_tanh: - :ref:`float` **tanh** **(** :ref:`float` s **)** @@ -1102,6 +1254,8 @@ Returns the hyperbolic tangent of ``s``. a = log(2.0) # returns 0.693147 tanh(a) # returns 0.6 +---- + .. _class_@GDScript_method_to_json: - :ref:`String` **to_json** **(** :ref:`Variant` var **)** @@ -1114,6 +1268,8 @@ Converts a Variant ``var`` to JSON text and return the result. Useful for serial b = to_json(a) print(b) # {"a":1, "b":2} +---- + .. _class_@GDScript_method_type_exists: - :ref:`bool` **type_exists** **(** :ref:`String` type **)** @@ -1125,6 +1281,8 @@ Returns whether the given class exists in :ref:`ClassDB`. type_exists("Sprite") # returns true type_exists("Variant") # returns false +---- + .. _class_@GDScript_method_typeof: - :ref:`int` **typeof** **(** :ref:`Variant` what **)** @@ -1139,6 +1297,8 @@ Returns the internal type of the given Variant object, using the TYPE\_\* enum i else: print("unexpected results") +---- + .. _class_@GDScript_method_validate_json: - :ref:`String` **validate_json** **(** :ref:`String` json **)** @@ -1154,12 +1314,16 @@ Checks that ``json`` is valid JSON data. Returns empty string if valid. Returns else: prints("invalid", v) +---- + .. _class_@GDScript_method_var2bytes: - :ref:`PoolByteArray` **var2bytes** **(** :ref:`Variant` var, :ref:`bool` full_objects=false **)** Encodes a variable value to a byte array. When ``full_objects`` is ``true`` encoding objects is allowed (and can potentially include code). +---- + .. _class_@GDScript_method_var2str: - :ref:`String` **var2str** **(** :ref:`Variant` var **)** @@ -1180,6 +1344,8 @@ prints "b": 2 } +---- + .. _class_@GDScript_method_weakref: - :ref:`WeakRef` **weakref** **(** :ref:`Object` obj **)** @@ -1188,6 +1354,8 @@ Returns a weak reference to an object. A weak reference to an object is not enough to keep the object alive: when the only remaining references to a referent are weak references, garbage collection is free to destroy the referent and reuse its memory for something else. However, until the object is actually destroyed the weak reference may return the object even if there are no strong references to it. +---- + .. _class_@GDScript_method_wrapf: - :ref:`float` **wrapf** **(** :ref:`float` value, :ref:`float` min, :ref:`float` max **)** @@ -1225,6 +1393,8 @@ The usage of ``wrapf`` is more flexible than using the :ref:`fmod` **wrapi** **(** :ref:`int` value, :ref:`int` min, :ref:`int` max **)** @@ -1257,6 +1427,8 @@ The usage of ``wrapi`` is more flexible than using the modulo approach by giving # result is -2 var result = wrapi(-6, -5, -1) +---- + .. _class_@GDScript_method_yield: - :ref:`GDScriptFunctionState` **yield** **(** :ref:`Object` object=null, :ref:`String` signal="" **)** diff --git a/classes/class_@globalscope.rst b/classes/class_@globalscope.rst index 75ae2a451..090aa2ef6 100644 --- a/classes/class_@globalscope.rst +++ b/classes/class_@globalscope.rst @@ -86,6 +86,8 @@ enum **Margin**: - **MARGIN_BOTTOM** = **3** --- Bottom margin, used usually for :ref:`Control` or :ref:`StyleBox` derived classes. +---- + .. _enum_@GlobalScope_Corner: .. _class_@GlobalScope_constant_CORNER_TOP_LEFT: @@ -106,6 +108,8 @@ enum **Corner**: - **CORNER_BOTTOM_LEFT** = **3** +---- + .. _enum_@GlobalScope_Orientation: .. _class_@GlobalScope_constant_VERTICAL: @@ -118,6 +122,8 @@ enum **Orientation**: - **HORIZONTAL** = **0** --- General horizontal alignment, used usually for :ref:`Separator`, :ref:`ScrollBar`, :ref:`Slider`, etc. +---- + .. _enum_@GlobalScope_HAlign: .. _class_@GlobalScope_constant_HALIGN_LEFT: @@ -134,6 +140,8 @@ enum **HAlign**: - **HALIGN_RIGHT** = **2** --- Horizontal right alignment, usually for text-derived classes. +---- + .. _enum_@GlobalScope_VAlign: .. _class_@GlobalScope_constant_VALIGN_TOP: @@ -150,6 +158,8 @@ enum **VAlign**: - **VALIGN_BOTTOM** = **2** --- Vertical bottom alignment, usually for text-derived classes. +---- + .. _enum_@GlobalScope_KeyList: .. _class_@GlobalScope_constant_KEY_ESCAPE: @@ -1122,6 +1132,8 @@ enum **KeyList**: - **KEY_YDIAERESIS** = **255** --- ΓΏ key +---- + .. _enum_@GlobalScope_KeyModifierMask: .. _class_@GlobalScope_constant_KEY_CODE_MASK: @@ -1162,6 +1174,8 @@ enum **KeyModifierMask**: - **KEY_MASK_GROUP_SWITCH** = **1073741824** --- Group Switch Key Mask +---- + .. _enum_@GlobalScope_ButtonList: .. _class_@GlobalScope_constant_BUTTON_LEFT: @@ -1222,6 +1236,8 @@ enum **ButtonList**: - **BUTTON_MASK_XBUTTON2** = **256** --- Extra Mouse Button 2 Mask +---- + .. _enum_@GlobalScope_JoystickList: .. _class_@GlobalScope_constant_JOY_BUTTON_0: @@ -1458,6 +1474,8 @@ enum **JoystickList**: - **JOY_ANALOG_R2** = **7** --- Joypad Right Analog Trigger +---- + .. _enum_@GlobalScope_MidiMessageList: .. _class_@GlobalScope_constant_MIDI_MESSAGE_NOTE_OFF: @@ -1490,6 +1508,8 @@ enum **MidiMessageList**: - **MIDI_MESSAGE_PITCH_BEND** = **14** --- MIDI pitch bend message. +---- + .. _enum_@GlobalScope_Error: .. _class_@GlobalScope_constant_OK: @@ -1701,6 +1721,8 @@ Since :ref:`OK` has value 0, and all other failu - **ERR_PRINTER_ON_FIRE** = **48** --- Printer on fire error. (This is an easter egg, no engine methods return this error code.) +---- + .. _enum_@GlobalScope_PropertyHint: .. _class_@GlobalScope_constant_PROPERTY_HINT_NONE: @@ -1751,9 +1773,9 @@ enum **PropertyHint**: - **PROPERTY_HINT_NONE** = **0** --- No hint for edited property. -- **PROPERTY_HINT_RANGE** = **1** --- Hints that an integer or float property should be within a range specified via the hint string ``"min,max"`` or ``"min,max,step"``. The hint string can optionally include ``"allow_greater"`` and/or ``"allow_lesser"`` to allow manual input going respectively above the max or below the min values. Example: ``"-360,360,1,allow_greater,allow_lesser"``. +- **PROPERTY_HINT_RANGE** = **1** --- Hints that an integer or float property should be within a range specified via the hint string ``"min,max"`` or ``"min,max,step"``. The hint string can optionally include ``"or_greater"`` and/or ``"or_lesser"`` to allow manual input going respectively above the max or below the min values. Example: ``"-360,360,1,or_greater,or_lesser"``. -- **PROPERTY_HINT_EXP_RANGE** = **2** --- Hints that an integer or float property should be within an exponential range specified via the hint string ``"min,max"`` or ``"min,max,step"``. The hint string can optionally include ``"allow_greater"`` and/or ``"allow_lesser"`` to allow manual input going respectively above the max or below the min values. Example: ``"0.01,100,0.01,allow_greater"``. +- **PROPERTY_HINT_EXP_RANGE** = **2** --- Hints that an integer or float property should be within an exponential range specified via the hint string ``"min,max"`` or ``"min,max,step"``. The hint string can optionally include ``"or_greater"`` and/or ``"or_lesser"`` to allow manual input going respectively above the max or below the min values. Example: ``"0.01,100,0.01,or_greater"``. - **PROPERTY_HINT_ENUM** = **3** --- Hints that an integer, float or string property is an enumerated value to pick in a list specified via a hint string such as ``"Hello,Something,Else"``. @@ -1793,6 +1815,8 @@ enum **PropertyHint**: - **PROPERTY_HINT_IMAGE_COMPRESS_LOSSLESS** = **22** --- Hints that an image is compressed using lossless compression. +---- + .. _enum_@GlobalScope_PropertyUsageFlags: .. _class_@GlobalScope_constant_PROPERTY_USAGE_STORAGE: @@ -1857,6 +1881,8 @@ enum **PropertyUsageFlags**: - **PROPERTY_USAGE_NOEDITOR** = **5** --- Default usage but without showing the property in the editor (storage, network). +---- + .. _enum_@GlobalScope_MethodFlags: .. _class_@GlobalScope_constant_METHOD_FLAG_NORMAL: @@ -1893,6 +1919,8 @@ enum **MethodFlags**: - **METHOD_FLAGS_DEFAULT** = **1** --- Default method flags +---- + .. _enum_@GlobalScope_Variant.Type: .. _class_@GlobalScope_constant_TYPE_NIL: @@ -2009,6 +2037,8 @@ enum **Variant.Type**: - **TYPE_MAX** = **27** --- Represents the size of the :ref:`Variant.Type` enum. +---- + .. _enum_@GlobalScope_Variant.Operator: .. _class_@GlobalScope_constant_OP_EQUAL: @@ -2140,120 +2170,160 @@ Property Descriptions :ref:`ARVRServer` singleton +---- + .. _class_@GlobalScope_property_AudioServer: - :ref:`AudioServer` **AudioServer** :ref:`AudioServer` singleton +---- + .. _class_@GlobalScope_property_ClassDB: - :ref:`ClassDB` **ClassDB** :ref:`ClassDB` singleton +---- + .. _class_@GlobalScope_property_Engine: - :ref:`Engine` **Engine** :ref:`Engine` singleton +---- + .. _class_@GlobalScope_property_Geometry: - :ref:`Geometry` **Geometry** :ref:`Geometry` singleton +---- + .. _class_@GlobalScope_property_IP: - :ref:`IP` **IP** :ref:`IP` singleton +---- + .. _class_@GlobalScope_property_Input: - :ref:`Input` **Input** :ref:`Input` singleton +---- + .. _class_@GlobalScope_property_InputMap: - :ref:`InputMap` **InputMap** :ref:`InputMap` singleton +---- + .. _class_@GlobalScope_property_JSON: - :ref:`JSON` **JSON** :ref:`JSON` singleton +---- + .. _class_@GlobalScope_property_JavaScript: - :ref:`JavaScript` **JavaScript** :ref:`JavaScript` singleton +---- + .. _class_@GlobalScope_property_Marshalls: - :ref:`Reference` **Marshalls** :ref:`Marshalls` singleton +---- + .. _class_@GlobalScope_property_OS: - :ref:`OS` **OS** :ref:`OS` singleton +---- + .. _class_@GlobalScope_property_Performance: - :ref:`Performance` **Performance** :ref:`Performance` singleton +---- + .. _class_@GlobalScope_property_Physics2DServer: - :ref:`Physics2DServer` **Physics2DServer** :ref:`Physics2DServer` singleton +---- + .. _class_@GlobalScope_property_PhysicsServer: - :ref:`PhysicsServer` **PhysicsServer** :ref:`PhysicsServer` singleton +---- + .. _class_@GlobalScope_property_ProjectSettings: - :ref:`ProjectSettings` **ProjectSettings** :ref:`ProjectSettings` singleton +---- + .. _class_@GlobalScope_property_ResourceLoader: - :ref:`ResourceLoader` **ResourceLoader** :ref:`ResourceLoader` singleton +---- + .. _class_@GlobalScope_property_ResourceSaver: - :ref:`ResourceSaver` **ResourceSaver** :ref:`ResourceSaver` singleton +---- + .. _class_@GlobalScope_property_TranslationServer: - :ref:`TranslationServer` **TranslationServer** :ref:`TranslationServer` singleton +---- + .. _class_@GlobalScope_property_VisualScriptEditor: - :ref:`VisualScriptEditor` **VisualScriptEditor** :ref:`VisualScriptEditor` singleton +---- + .. _class_@GlobalScope_property_VisualServer: - :ref:`VisualServer` **VisualServer** diff --git a/classes/class_aabb.rst b/classes/class_aabb.rst index c58d8e299..d146b2d2e 100644 --- a/classes/class_aabb.rst +++ b/classes/class_aabb.rst @@ -93,12 +93,16 @@ Property Descriptions Ending corner. +---- + .. _class_AABB_property_position: - :ref:`Vector3` **position** Beginning corner. +---- + .. _class_AABB_property_size: - :ref:`Vector3` **size** @@ -114,120 +118,160 @@ Method Descriptions Optional constructor, accepts position and size. +---- + .. _class_AABB_method_encloses: - :ref:`bool` **encloses** **(** :ref:`AABB` with **)** Returns ``true`` if this ``AABB`` completely encloses another one. +---- + .. _class_AABB_method_expand: - :ref:`AABB` **expand** **(** :ref:`Vector3` to_point **)** Returns this ``AABB`` expanded to include a given point. +---- + .. _class_AABB_method_get_area: - :ref:`float` **get_area** **(** **)** Gets the area of the ``AABB``. +---- + .. _class_AABB_method_get_endpoint: - :ref:`Vector3` **get_endpoint** **(** :ref:`int` idx **)** Gets the position of the 8 endpoints of the ``AABB`` in space. +---- + .. _class_AABB_method_get_longest_axis: - :ref:`Vector3` **get_longest_axis** **(** **)** Returns the normalized longest axis of the ``AABB``. +---- + .. _class_AABB_method_get_longest_axis_index: - :ref:`int` **get_longest_axis_index** **(** **)** Returns the index of the longest axis of the ``AABB`` (according to :ref:`Vector3`::AXIS\* enum). +---- + .. _class_AABB_method_get_longest_axis_size: - :ref:`float` **get_longest_axis_size** **(** **)** Returns the scalar length of the longest axis of the ``AABB``. +---- + .. _class_AABB_method_get_shortest_axis: - :ref:`Vector3` **get_shortest_axis** **(** **)** Returns the normalized shortest axis of the ``AABB``. +---- + .. _class_AABB_method_get_shortest_axis_index: - :ref:`int` **get_shortest_axis_index** **(** **)** Returns the index of the shortest axis of the ``AABB`` (according to :ref:`Vector3`::AXIS\* enum). +---- + .. _class_AABB_method_get_shortest_axis_size: - :ref:`float` **get_shortest_axis_size** **(** **)** Returns the scalar length of the shortest axis of the ``AABB``. +---- + .. _class_AABB_method_get_support: - :ref:`Vector3` **get_support** **(** :ref:`Vector3` dir **)** Returns the support point in a given direction. This is useful for collision detection algorithms. +---- + .. _class_AABB_method_grow: - :ref:`AABB` **grow** **(** :ref:`float` by **)** Returns a copy of the ``AABB`` grown a given amount of units towards all the sides. +---- + .. _class_AABB_method_has_no_area: - :ref:`bool` **has_no_area** **(** **)** Returns ``true`` if the ``AABB`` is flat or empty. +---- + .. _class_AABB_method_has_no_surface: - :ref:`bool` **has_no_surface** **(** **)** Returns ``true`` if the ``AABB`` is empty. +---- + .. _class_AABB_method_has_point: - :ref:`bool` **has_point** **(** :ref:`Vector3` point **)** Returns ``true`` if the ``AABB`` contains a point. +---- + .. _class_AABB_method_intersection: - :ref:`AABB` **intersection** **(** :ref:`AABB` with **)** Returns the intersection between two ``AABB``. An empty AABB (size 0,0,0) is returned on failure. +---- + .. _class_AABB_method_intersects: - :ref:`bool` **intersects** **(** :ref:`AABB` with **)** Returns ``true`` if the ``AABB`` overlaps with another. +---- + .. _class_AABB_method_intersects_plane: - :ref:`bool` **intersects_plane** **(** :ref:`Plane` plane **)** Returns ``true`` if the ``AABB`` is on both sides of a plane. +---- + .. _class_AABB_method_intersects_segment: - :ref:`bool` **intersects_segment** **(** :ref:`Vector3` from, :ref:`Vector3` to **)** Returns ``true`` if the ``AABB`` intersects the line segment between ``from`` and ``to``. +---- + .. _class_AABB_method_merge: - :ref:`AABB` **merge** **(** :ref:`AABB` with **)** diff --git a/classes/class_acceptdialog.rst b/classes/class_acceptdialog.rst index 482514560..70f1c4757 100644 --- a/classes/class_acceptdialog.rst +++ b/classes/class_acceptdialog.rst @@ -53,6 +53,8 @@ Signals Emitted when the dialog is accepted, i.e. the OK button is pressed. +---- + .. _class_AcceptDialog_signal_custom_action: - **custom_action** **(** :ref:`String` action **)** @@ -81,6 +83,8 @@ If ``true``, the dialog is hidden when the OK button is pressed. You can set it Note: Some nodes derived from this class can have a different default value, and potentially their own built-in logic overriding this setting. For example :ref:`FileDialog` defaults to ``false``, and has its own input validation code that is called when you press OK, which eventually hides the dialog if the input is valid. As such this property can't be used in :ref:`FileDialog` to disable hiding the dialog when pressing OK. +---- + .. _class_AcceptDialog_property_dialog_text: - :ref:`String` **dialog_text** @@ -104,24 +108,32 @@ Adds a button with label *text* and a custom *action* to the dialog and returns If ``true``, *right* will place the button to the right of any sibling buttons. Default value: ``false``. +---- + .. _class_AcceptDialog_method_add_cancel: - :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_method_get_label: - :ref:`Label` **get_label** **(** **)** Returns the label used for built-in text. +---- + .. _class_AcceptDialog_method_get_ok: - :ref:`Button` **get_ok** **(** **)** Returns the OK Button. +---- + .. _class_AcceptDialog_method_register_text_enter: - void **register_text_enter** **(** :ref:`Node` line_edit **)** diff --git a/classes/class_animatedsprite.rst b/classes/class_animatedsprite.rst index 46832372a..65442ffd9 100644 --- a/classes/class_animatedsprite.rst +++ b/classes/class_animatedsprite.rst @@ -61,6 +61,8 @@ Signals 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_signal_frame_changed: - **frame_changed** **(** **)** @@ -87,6 +89,8 @@ Property Descriptions The current animation from the ``frames`` resource. If this value changes, the ``frame`` counter is reset. +---- + .. _class_AnimatedSprite_property_centered: - :ref:`bool` **centered** @@ -99,6 +103,8 @@ The current animation from the ``frames`` resource. If this value changes, the ` If ``true``, texture will be centered. Default value: ``true``. +---- + .. _class_AnimatedSprite_property_flip_h: - :ref:`bool` **flip_h** @@ -111,6 +117,8 @@ If ``true``, texture will be centered. Default value: ``true``. If ``true``, texture is flipped horizontally. Default value: ``false``. +---- + .. _class_AnimatedSprite_property_flip_v: - :ref:`bool` **flip_v** @@ -123,6 +131,8 @@ If ``true``, texture is flipped horizontally. Default value: ``false``. If ``true``, texture is flipped vertically. Default value: ``false``. +---- + .. _class_AnimatedSprite_property_frame: - :ref:`int` **frame** @@ -135,6 +145,8 @@ If ``true``, texture is flipped vertically. Default value: ``false``. The displayed animation frame's index. +---- + .. _class_AnimatedSprite_property_frames: - :ref:`SpriteFrames` **frames** @@ -147,6 +159,8 @@ The displayed animation frame's index. The :ref:`SpriteFrames` resource containing the animation(s). +---- + .. _class_AnimatedSprite_property_offset: - :ref:`Vector2` **offset** @@ -159,12 +173,16 @@ The :ref:`SpriteFrames` resource containing the animation(s) The texture's drawing offset. +---- + .. _class_AnimatedSprite_property_playing: - :ref:`bool` **playing** If ``true``, the :ref:`animation` is currently playing. +---- + .. _class_AnimatedSprite_property_speed_scale: - :ref:`float` **speed_scale** @@ -186,12 +204,16 @@ Method Descriptions Returns ``true`` if an animation if currently being played. +---- + .. _class_AnimatedSprite_method_play: - void **play** **(** :ref:`String` anim="", :ref:`bool` backwards=false **)** Play the animation set in parameter. If no parameter is provided, the current animation is played. Property ``backwards`` plays the animation in reverse if set to ``true``. +---- + .. _class_AnimatedSprite_method_stop: - void **stop** **(** **)** diff --git a/classes/class_animatedsprite3d.rst b/classes/class_animatedsprite3d.rst index e4f1402cc..7afbb75fe 100644 --- a/classes/class_animatedsprite3d.rst +++ b/classes/class_animatedsprite3d.rst @@ -71,6 +71,8 @@ Property Descriptions The current animation from the ``frames`` resource. If this value changes, the ``frame`` counter is reset. +---- + .. _class_AnimatedSprite3D_property_frame: - :ref:`int` **frame** @@ -83,6 +85,8 @@ The current animation from the ``frames`` resource. If this value changes, the ` The displayed animation frame's index. +---- + .. _class_AnimatedSprite3D_property_frames: - :ref:`SpriteFrames` **frames** @@ -95,6 +99,8 @@ The displayed animation frame's index. The :ref:`SpriteFrames` resource containing the animation(s). +---- + .. _class_AnimatedSprite3D_property_playing: - :ref:`bool` **playing** @@ -110,12 +116,16 @@ Method Descriptions Returns ``true`` if an animation if currently being played. +---- + .. _class_AnimatedSprite3D_method_play: - void **play** **(** :ref:`String` anim="" **)** Play the animation set in parameter. If no parameter is provided, the current animation is played. +---- + .. _class_AnimatedSprite3D_method_stop: - void **stop** **(** **)** diff --git a/classes/class_animatedtexture.rst b/classes/class_animatedtexture.rst index f91144c20..28a24275a 100644 --- a/classes/class_animatedtexture.rst +++ b/classes/class_animatedtexture.rst @@ -73,6 +73,8 @@ Animation speed in frames per second. This value defines the default time interv For example, an animation with 8 frames, no frame delay and a ``fps`` value of 2 will run for 4 seconds, with each frame lasting 0.5 seconds. +---- + .. _class_AnimatedTexture_property_frames: - :ref:`int` **frames** @@ -94,12 +96,16 @@ Method Descriptions Returns the given frame's delay value. +---- + .. _class_AnimatedTexture_method_get_frame_texture: - :ref:`Texture` **get_frame_texture** **(** :ref:`int` frame **)** const Returns the given frame's :ref:`Texture`. +---- + .. _class_AnimatedTexture_method_set_frame_delay: - void **set_frame_delay** **(** :ref:`int` frame, :ref:`float` delay **)** @@ -115,6 +121,8 @@ For example, for an animation with 3 frames, 2 FPS and a frame delay on the seco Frame 2: 0.5 s (1 / fps) Total duration: 2.7 s +---- + .. _class_AnimatedTexture_method_set_frame_texture: - void **set_frame_texture** **(** :ref:`int` frame, :ref:`Texture` texture **)** diff --git a/classes/class_animation.rst b/classes/class_animation.rst index 08530d77b..8f37a1b36 100644 --- a/classes/class_animation.rst +++ b/classes/class_animation.rst @@ -184,6 +184,8 @@ enum **TrackType**: - **TYPE_ANIMATION** = **5** +---- + .. _enum_Animation_InterpolationType: .. _class_Animation_constant_INTERPOLATION_NEAREST: @@ -200,6 +202,8 @@ enum **InterpolationType**: - **INTERPOLATION_CUBIC** = **2** --- Cubic interpolation. +---- + .. _enum_Animation_UpdateMode: .. _class_Animation_constant_UPDATE_CONTINUOUS: @@ -257,6 +261,8 @@ Property Descriptions 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_property_loop: - :ref:`bool` **loop** @@ -269,6 +275,8 @@ The total length of the animation (in seconds). Note that length is not delimite 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_property_step: - :ref:`float` **step** @@ -290,258 +298,356 @@ Method Descriptions Add a track to the Animation. The track type must be specified as any of the values in the TYPE\_\* enumeration. +---- + .. _class_Animation_method_animation_track_get_key_animation: - :ref:`String` **animation_track_get_key_animation** **(** :ref:`int` idx, :ref:`int` key_idx **)** const +---- + .. _class_Animation_method_animation_track_insert_key: - :ref:`int` **animation_track_insert_key** **(** :ref:`int` track, :ref:`float` time, :ref:`String` animation **)** +---- + .. _class_Animation_method_animation_track_set_key_animation: - void **animation_track_set_key_animation** **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`String` animation **)** +---- + .. _class_Animation_method_audio_track_get_key_end_offset: - :ref:`float` **audio_track_get_key_end_offset** **(** :ref:`int` idx, :ref:`int` key_idx **)** const +---- + .. _class_Animation_method_audio_track_get_key_start_offset: - :ref:`float` **audio_track_get_key_start_offset** **(** :ref:`int` idx, :ref:`int` key_idx **)** const +---- + .. _class_Animation_method_audio_track_get_key_stream: - :ref:`Resource` **audio_track_get_key_stream** **(** :ref:`int` idx, :ref:`int` key_idx **)** const +---- + .. _class_Animation_method_audio_track_insert_key: - :ref:`int` **audio_track_insert_key** **(** :ref:`int` track, :ref:`float` time, :ref:`Resource` stream, :ref:`float` start_offset=0, :ref:`float` end_offset=0 **)** +---- + .. _class_Animation_method_audio_track_set_key_end_offset: - void **audio_track_set_key_end_offset** **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`float` offset **)** +---- + .. _class_Animation_method_audio_track_set_key_start_offset: - void **audio_track_set_key_start_offset** **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`float` offset **)** +---- + .. _class_Animation_method_audio_track_set_key_stream: - void **audio_track_set_key_stream** **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`Resource` stream **)** +---- + .. _class_Animation_method_bezier_track_get_key_in_handle: - :ref:`Vector2` **bezier_track_get_key_in_handle** **(** :ref:`int` idx, :ref:`int` key_idx **)** const +---- + .. _class_Animation_method_bezier_track_get_key_out_handle: - :ref:`Vector2` **bezier_track_get_key_out_handle** **(** :ref:`int` idx, :ref:`int` key_idx **)** const +---- + .. _class_Animation_method_bezier_track_get_key_value: - :ref:`float` **bezier_track_get_key_value** **(** :ref:`int` idx, :ref:`int` key_idx **)** const +---- + .. _class_Animation_method_bezier_track_insert_key: - :ref:`int` **bezier_track_insert_key** **(** :ref:`int` track, :ref:`float` time, :ref:`float` value, :ref:`Vector2` in_handle=Vector2( 0, 0 ), :ref:`Vector2` out_handle=Vector2( 0, 0 ) **)** +---- + .. _class_Animation_method_bezier_track_interpolate: - :ref:`float` **bezier_track_interpolate** **(** :ref:`int` track, :ref:`float` time **)** const +---- + .. _class_Animation_method_bezier_track_set_key_in_handle: - void **bezier_track_set_key_in_handle** **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`Vector2` in_handle **)** +---- + .. _class_Animation_method_bezier_track_set_key_out_handle: - void **bezier_track_set_key_out_handle** **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`Vector2` out_handle **)** +---- + .. _class_Animation_method_bezier_track_set_key_value: - void **bezier_track_set_key_value** **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`float` value **)** +---- + .. _class_Animation_method_clear: - void **clear** **(** **)** Clear the animation (clear all tracks and reset all). +---- + .. _class_Animation_method_copy_track: - void **copy_track** **(** :ref:`int` track, :ref:`Animation` to_animation **)** Adds a new track that is a copy of the given track from ``to_animation``. +---- + .. _class_Animation_method_find_track: - :ref:`int` **find_track** **(** :ref:`NodePath` path **)** const Returns the index of the specified track. If the track is not found, return -1. +---- + .. _class_Animation_method_get_track_count: - :ref:`int` **get_track_count** **(** **)** const Returns the amount of tracks in the animation. +---- + .. _class_Animation_method_method_track_get_key_indices: - :ref:`PoolIntArray` **method_track_get_key_indices** **(** :ref:`int` idx, :ref:`float` time_sec, :ref:`float` delta **)** const Returns all the key indices of a method track, given a position and delta time. +---- + .. _class_Animation_method_method_track_get_name: - :ref:`String` **method_track_get_name** **(** :ref:`int` idx, :ref:`int` key_idx **)** const Returns the method name of a method track. +---- + .. _class_Animation_method_method_track_get_params: - :ref:`Array` **method_track_get_params** **(** :ref:`int` idx, :ref:`int` key_idx **)** const Returns the arguments values to be called on a method track for a given key in a given track. +---- + .. _class_Animation_method_remove_track: - void **remove_track** **(** :ref:`int` idx **)** Remove a track by specifying the track index. +---- + .. _class_Animation_method_track_find_key: - :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_method_track_get_interpolation_loop_wrap: - :ref:`bool` **track_get_interpolation_loop_wrap** **(** :ref:`int` idx **)** const Returns ``true`` if the track at ``idx`` wraps the interpolation loop. Default value: ``true``. +---- + .. _class_Animation_method_track_get_interpolation_type: - :ref:`InterpolationType` **track_get_interpolation_type** **(** :ref:`int` idx **)** const Returns the interpolation type of a given track, from the INTERPOLATION\_\* enum. +---- + .. _class_Animation_method_track_get_key_count: - :ref:`int` **track_get_key_count** **(** :ref:`int` idx **)** const Returns the amount of keys in a given track. +---- + .. _class_Animation_method_track_get_key_time: - :ref:`float` **track_get_key_time** **(** :ref:`int` idx, :ref:`int` key_idx **)** const Returns the time at which the key is located. +---- + .. _class_Animation_method_track_get_key_transition: - :ref:`float` **track_get_key_transition** **(** :ref:`int` idx, :ref:`int` key_idx **)** const Returns the transition curve (easing) for a specific key (see built-in math function "ease"). +---- + .. _class_Animation_method_track_get_key_value: - :ref:`Variant` **track_get_key_value** **(** :ref:`int` idx, :ref:`int` key_idx **)** const Returns the value of a given key in a given track. +---- + .. _class_Animation_method_track_get_path: - :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_method_track_get_type: - :ref:`TrackType` **track_get_type** **(** :ref:`int` idx **)** const Get the type of a track. +---- + .. _class_Animation_method_track_insert_key: - 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_method_track_is_enabled: - :ref:`bool` **track_is_enabled** **(** :ref:`int` idx **)** const Returns ``true`` if the track at index ``idx`` is enabled. +---- + .. _class_Animation_method_track_is_imported: - :ref:`bool` **track_is_imported** **(** :ref:`int` idx **)** const Returns ``true`` if the given track is imported. Else, return ``false``. +---- + .. _class_Animation_method_track_move_down: - void **track_move_down** **(** :ref:`int` idx **)** Move a track down. +---- + .. _class_Animation_method_track_move_up: - void **track_move_up** **(** :ref:`int` idx **)** Move a track up. +---- + .. _class_Animation_method_track_remove_key: - void **track_remove_key** **(** :ref:`int` idx, :ref:`int` key_idx **)** Remove a key by index in a given track. +---- + .. _class_Animation_method_track_remove_key_at_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_method_track_set_enabled: - void **track_set_enabled** **(** :ref:`int` idx, :ref:`bool` enabled **)** Enables/disables the given track. Tracks are enabled by default. +---- + .. _class_Animation_method_track_set_imported: - void **track_set_imported** **(** :ref:`int` idx, :ref:`bool` imported **)** Set the given track as imported or not. +---- + .. _class_Animation_method_track_set_interpolation_loop_wrap: - void **track_set_interpolation_loop_wrap** **(** :ref:`int` idx, :ref:`bool` interpolation **)** If ``true``, the track at ``idx`` wraps the interpolation loop. +---- + .. _class_Animation_method_track_set_interpolation_type: - void **track_set_interpolation_type** **(** :ref:`int` idx, :ref:`InterpolationType` interpolation **)** Set the interpolation type of a given track, from the INTERPOLATION\_\* enum. +---- + .. _class_Animation_method_track_set_key_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_method_track_set_key_value: - void **track_set_key_value** **(** :ref:`int` idx, :ref:`int` key, :ref:`Variant` value **)** Set the value of an existing key. +---- + .. _class_Animation_method_track_set_path: - void **track_set_path** **(** :ref:`int` idx, :ref:`NodePath` path **)** @@ -550,34 +656,46 @@ Set the path of a track. Paths must be valid scene-tree paths to a node, and mus **Example:** "character/skeleton:ankle" or "character/mesh:transform/local". +---- + .. _class_Animation_method_track_swap: - void **track_swap** **(** :ref:`int` idx, :ref:`int` with_idx **)** +---- + .. _class_Animation_method_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 **)** Insert a transform key for a transform track. +---- + .. _class_Animation_method_transform_track_interpolate: - :ref:`Array` **transform_track_interpolate** **(** :ref:`int` idx, :ref:`float` time_sec **)** const Returns 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_method_value_track_get_key_indices: - :ref:`PoolIntArray` **value_track_get_key_indices** **(** :ref:`int` idx, :ref:`float` time_sec, :ref:`float` delta **)** const Returns all the key indices of a value track, given a position and delta time. +---- + .. _class_Animation_method_value_track_get_update_mode: - :ref:`UpdateMode` **value_track_get_update_mode** **(** :ref:`int` idx **)** const Returns the update mode of a value track. +---- + .. _class_Animation_method_value_track_set_update_mode: - void **value_track_set_update_mode** **(** :ref:`int` idx, :ref:`UpdateMode` mode **)** diff --git a/classes/class_animationnode.rst b/classes/class_animationnode.rst index f7cb31060..05fb1047d 100644 --- a/classes/class_animationnode.rst +++ b/classes/class_animationnode.rst @@ -77,6 +77,8 @@ Signals Called when the node was removed from the graph. +---- + .. _class_AnimationNode_signal_tree_changed: - **tree_changed** **(** **)** @@ -137,84 +139,112 @@ Method Descriptions Add an input to the node. This is only useful for nodes created for use in an :ref:`AnimationNodeBlendTree` +---- + .. _class_AnimationNode_method_blend_animation: - void **blend_animation** **(** :ref:`String` animation, :ref:`float` time, :ref:`float` delta, :ref:`bool` seeked, :ref:`float` blend **)** Blend an animation by "blend" amount (name must be valid in the linked :ref:`AnimationPlayer`). A time and delta mas be passed, as well as whether seek happened. +---- + .. _class_AnimationNode_method_blend_input: - :ref:`float` **blend_input** **(** :ref:`int` input_index, :ref:`float` time, :ref:`bool` seek, :ref:`float` blend, :ref:`FilterAction` filter=0, :ref:`bool` optimize=true **)** Blend an input. This is only useful for nodes created for an :ref:`AnimationNodeBlendTree`. Time is a delta, unless "seek" is ``true``, in which case it is absolute. A filter mode may be optionally passed. +---- + .. _class_AnimationNode_method_blend_node: - :ref:`float` **blend_node** **(** :ref:`String` name, :ref:`AnimationNode` node, :ref:`float` time, :ref:`bool` seek, :ref:`float` blend, :ref:`FilterAction` filter=0, :ref:`bool` optimize=true **)** Blend another animaiton node (in case this node contains children animation nodes). This function is only useful if you inherit from :ref:`AnimationRootNode` instead, else editors will not display your node for addition. +---- + .. _class_AnimationNode_method_get_caption: - :ref:`String` **get_caption** **(** **)** virtual Get the text caption for this node (used by some editors) +---- + .. _class_AnimationNode_method_get_child_by_name: - :ref:`Object` **get_child_by_name** **(** :ref:`String` name **)** virtual Get the a child node by index (used by editors inheriting from :ref:`AnimationRootNode`). +---- + .. _class_AnimationNode_method_get_child_nodes: - :ref:`Dictionary` **get_child_nodes** **(** **)** virtual Get all children nodes, in order as a name:node dictionary. Only useful when inheriting :ref:`AnimationRootNode`. +---- + .. _class_AnimationNode_method_get_input_count: - :ref:`int` **get_input_count** **(** **)** const Amount of inputs in this node, only useful for nodes that go into :ref:`AnimationNodeBlendTree`. +---- + .. _class_AnimationNode_method_get_input_name: - :ref:`String` **get_input_name** **(** :ref:`int` input **)** Get the name of an input by index. +---- + .. _class_AnimationNode_method_get_parameter: - :ref:`Variant` **get_parameter** **(** :ref:`String` name **)** const Get the value of a parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees. +---- + .. _class_AnimationNode_method_get_parameter_default_value: - :ref:`Variant` **get_parameter_default_value** **(** :ref:`String` name **)** virtual Get the default value of a parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees. +---- + .. _class_AnimationNode_method_get_parameter_list: - :ref:`Array` **get_parameter_list** **(** **)** virtual Get the property information for parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees. Format is similar to :ref:`Object.get_property_list`. +---- + .. _class_AnimationNode_method_has_filter: - :ref:`String` **has_filter** **(** **)** virtual Returns ``true`` whether you want the blend tree editor to display filter editing on this node. +---- + .. _class_AnimationNode_method_is_path_filtered: - :ref:`bool` **is_path_filtered** **(** :ref:`NodePath` path **)** const Returns ``true`` whether a given path is filtered. +---- + .. _class_AnimationNode_method_process: - void **process** **(** :ref:`float` time, :ref:`bool` seek **)** virtual @@ -227,18 +257,24 @@ You can also use :ref:`get_parameter` This function returns the time left for the current animation to finish (if unsure, just pass the value from the main blend being called). +---- + .. _class_AnimationNode_method_remove_input: - void **remove_input** **(** :ref:`int` index **)** Remove an input, call this only when inactive. +---- + .. _class_AnimationNode_method_set_filter_path: - void **set_filter_path** **(** :ref:`NodePath` path, :ref:`bool` enable **)** Add/Remove a path for the filter. +---- + .. _class_AnimationNode_method_set_parameter: - void **set_parameter** **(** :ref:`String` name, :ref:`Variant` value **)** diff --git a/classes/class_animationnodeblendspace1d.rst b/classes/class_animationnodeblendspace1d.rst index ebe1ab2e5..42654bf93 100644 --- a/classes/class_animationnodeblendspace1d.rst +++ b/classes/class_animationnodeblendspace1d.rst @@ -76,6 +76,8 @@ Property Descriptions The blend space's axis's upper limit for the points' position. See :ref:`add_blend_point`. +---- + .. _class_AnimationNodeBlendSpace1D_property_min_space: - :ref:`float` **min_space** @@ -88,6 +90,8 @@ The blend space's axis's upper limit for the points' position. See :ref:`add_ble The blend space's axis's lower limit for the points' position. See :ref:`add_blend_point`. +---- + .. _class_AnimationNodeBlendSpace1D_property_snap: - :ref:`float` **snap** @@ -100,6 +104,8 @@ The blend space's axis's lower limit for the points' position. See :ref:`add_ble Position increment to snap to when moving a point on the axis. +---- + .. _class_AnimationNodeBlendSpace1D_property_value_label: - :ref:`String` **value_label** @@ -121,36 +127,48 @@ Method Descriptions Add a new point that represents a ``node`` on the virtual axis at a given position set by ``pos``. You can insert it at a specific index using the ``at_index`` argument. If you use the default value for ``at_index`` , the point is inserted at the end of the blend points array. +---- + .. _class_AnimationNodeBlendSpace1D_method_get_blend_point_count: - :ref:`int` **get_blend_point_count** **(** **)** const Returns the number of points on the blend axis. +---- + .. _class_AnimationNodeBlendSpace1D_method_get_blend_point_node: - :ref:`AnimationRootNode` **get_blend_point_node** **(** :ref:`int` point **)** const Returns the ``AnimationNode`` referenced by the point at index ``point``. +---- + .. _class_AnimationNodeBlendSpace1D_method_get_blend_point_position: - :ref:`float` **get_blend_point_position** **(** :ref:`int` point **)** const Returns the position of the point at index ``point``. +---- + .. _class_AnimationNodeBlendSpace1D_method_remove_blend_point: - void **remove_blend_point** **(** :ref:`int` point **)** Removes the point at index ``point`` from the blend axis. +---- + .. _class_AnimationNodeBlendSpace1D_method_set_blend_point_node: - void **set_blend_point_node** **(** :ref:`int` point, :ref:`AnimationRootNode` node **)** Changes the AnimationNode referenced by the point at index ``point``. +---- + .. _class_AnimationNodeBlendSpace1D_method_set_blend_point_position: - void **set_blend_point_position** **(** :ref:`int` point, :ref:`float` pos **)** diff --git a/classes/class_animationnodeblendspace2d.rst b/classes/class_animationnodeblendspace2d.rst index c8ccb7759..27f77cc24 100644 --- a/classes/class_animationnodeblendspace2d.rst +++ b/classes/class_animationnodeblendspace2d.rst @@ -116,6 +116,8 @@ Property Descriptions If true, the blend space is triangulated automatically. The mesh updates every time you add or remove points with :ref:`add_blend_point` and :ref:`remove_blend_point`. +---- + .. _class_AnimationNodeBlendSpace2D_property_blend_mode: - :ref:`BlendMode` **blend_mode** @@ -128,6 +130,8 @@ If true, the blend space is triangulated automatically. The mesh updates every t Controls the interpolation between animations. See :ref:`BlendMode` constants. +---- + .. _class_AnimationNodeBlendSpace2D_property_max_space: - :ref:`Vector2` **max_space** @@ -140,6 +144,8 @@ Controls the interpolation between animations. See :ref:`BlendMode`. +---- + .. _class_AnimationNodeBlendSpace2D_property_min_space: - :ref:`Vector2` **min_space** @@ -152,6 +158,8 @@ The blend space's X and Y axes' upper limit for the points' position. See :ref:` The blend space's X and Y axes' lower limit for the points' position. See :ref:`add_blend_point`. +---- + .. _class_AnimationNodeBlendSpace2D_property_snap: - :ref:`Vector2` **snap** @@ -164,6 +172,8 @@ The blend space's X and Y axes' lower limit for the points' position. See :ref:` Position increment to snap to when moving a point. +---- + .. _class_AnimationNodeBlendSpace2D_property_x_label: - :ref:`String` **x_label** @@ -176,6 +186,8 @@ Position increment to snap to when moving a point. Name of the blend space's X axis. +---- + .. _class_AnimationNodeBlendSpace2D_property_y_label: - :ref:`String` **y_label** @@ -197,60 +209,80 @@ Method Descriptions Add a new point that represents a ``node`` at the position set by ``pos``. You can insert it at a specific index using the ``at_index`` argument. If you use the default value for ``at_index`` , the point is inserted at the end of the blend points array. +---- + .. _class_AnimationNodeBlendSpace2D_method_add_triangle: - void **add_triangle** **(** :ref:`int` x, :ref:`int` y, :ref:`int` z, :ref:`int` at_index=-1 **)** Creates a new triangle using three points ``x``, ``y``, and ``z``. Triangles can overlap. You can insert the triangle at a specific index using the ``at_index`` argument. If you use the default value for ``at_index`` , the point is inserted at the end of the blend points array. +---- + .. _class_AnimationNodeBlendSpace2D_method_get_blend_point_count: - :ref:`int` **get_blend_point_count** **(** **)** const Returns the number of points in the blend space. +---- + .. _class_AnimationNodeBlendSpace2D_method_get_blend_point_node: - :ref:`AnimationRootNode` **get_blend_point_node** **(** :ref:`int` point **)** const Returns the ``AnimationRootNode`` referenced by the point at index ``point``. +---- + .. _class_AnimationNodeBlendSpace2D_method_get_blend_point_position: - :ref:`Vector2` **get_blend_point_position** **(** :ref:`int` point **)** const Returns the position of the point at index ``point``. +---- + .. _class_AnimationNodeBlendSpace2D_method_get_triangle_count: - :ref:`int` **get_triangle_count** **(** **)** const Returns the number of triangles in the blend space. +---- + .. _class_AnimationNodeBlendSpace2D_method_get_triangle_point: - :ref:`int` **get_triangle_point** **(** :ref:`int` triangle, :ref:`int` point **)** Returns the position of the point at index ``point`` in the triangle of index ``triangle``. +---- + .. _class_AnimationNodeBlendSpace2D_method_remove_blend_point: - void **remove_blend_point** **(** :ref:`int` point **)** Removes the point at index ``point`` from the blend space. +---- + .. _class_AnimationNodeBlendSpace2D_method_remove_triangle: - void **remove_triangle** **(** :ref:`int` triangle **)** Removes the triangle at index ``triangle`` from the blend space. +---- + .. _class_AnimationNodeBlendSpace2D_method_set_blend_point_node: - void **set_blend_point_node** **(** :ref:`int` point, :ref:`AnimationRootNode` node **)** Changes the AnimationNode referenced by the point at index ``point``. +---- + .. _class_AnimationNodeBlendSpace2D_method_set_blend_point_position: - void **set_blend_point_position** **(** :ref:`int` point, :ref:`Vector2` pos **)** diff --git a/classes/class_animationnodeblendtree.rst b/classes/class_animationnodeblendtree.rst index f78e58c3b..981d40569 100644 --- a/classes/class_animationnodeblendtree.rst +++ b/classes/class_animationnodeblendtree.rst @@ -95,34 +95,50 @@ Method Descriptions - void **add_node** **(** :ref:`String` name, :ref:`AnimationNode` node, :ref:`Vector2` position=Vector2( 0, 0 ) **)** +---- + .. _class_AnimationNodeBlendTree_method_connect_node: - void **connect_node** **(** :ref:`String` input_node, :ref:`int` input_index, :ref:`String` output_node **)** +---- + .. _class_AnimationNodeBlendTree_method_disconnect_node: - void **disconnect_node** **(** :ref:`String` input_node, :ref:`int` input_index **)** +---- + .. _class_AnimationNodeBlendTree_method_get_node: - :ref:`AnimationNode` **get_node** **(** :ref:`String` name **)** const +---- + .. _class_AnimationNodeBlendTree_method_get_node_position: - :ref:`Vector2` **get_node_position** **(** :ref:`String` name **)** const +---- + .. _class_AnimationNodeBlendTree_method_has_node: - :ref:`bool` **has_node** **(** :ref:`String` name **)** const +---- + .. _class_AnimationNodeBlendTree_method_remove_node: - void **remove_node** **(** :ref:`String` name **)** +---- + .. _class_AnimationNodeBlendTree_method_rename_node: - void **rename_node** **(** :ref:`String` name, :ref:`String` new_name **)** +---- + .. _class_AnimationNodeBlendTree_method_set_node_position: - void **set_node_position** **(** :ref:`String` name, :ref:`Vector2` position **)** diff --git a/classes/class_animationnodeoneshot.rst b/classes/class_animationnodeoneshot.rst index 9025bd5fa..af1e463f2 100644 --- a/classes/class_animationnodeoneshot.rst +++ b/classes/class_animationnodeoneshot.rst @@ -72,6 +72,8 @@ Property Descriptions | *Getter* | has_autorestart() | +----------+------------------------+ +---- + .. _class_AnimationNodeOneShot_property_autorestart_delay: - :ref:`float` **autorestart_delay** @@ -82,6 +84,8 @@ Property Descriptions | *Getter* | get_autorestart_delay() | +----------+------------------------------+ +---- + .. _class_AnimationNodeOneShot_property_autorestart_random_delay: - :ref:`float` **autorestart_random_delay** @@ -92,6 +96,8 @@ Property Descriptions | *Getter* | get_autorestart_random_delay() | +----------+-------------------------------------+ +---- + .. _class_AnimationNodeOneShot_property_fadein_time: - :ref:`float` **fadein_time** @@ -102,6 +108,8 @@ Property Descriptions | *Getter* | get_fadein_time() | +----------+------------------------+ +---- + .. _class_AnimationNodeOneShot_property_fadeout_time: - :ref:`float` **fadeout_time** @@ -112,6 +120,8 @@ Property Descriptions | *Getter* | get_fadeout_time() | +----------+-------------------------+ +---- + .. _class_AnimationNodeOneShot_property_sync: - :ref:`bool` **sync** @@ -129,6 +139,8 @@ Method Descriptions - :ref:`MixMode` **get_mix_mode** **(** **)** const +---- + .. _class_AnimationNodeOneShot_method_set_mix_mode: - void **set_mix_mode** **(** :ref:`MixMode` mode **)** diff --git a/classes/class_animationnodestatemachine.rst b/classes/class_animationnodestatemachine.rst index 3d26607d7..2aa43dfa1 100644 --- a/classes/class_animationnodestatemachine.rst +++ b/classes/class_animationnodestatemachine.rst @@ -86,126 +86,168 @@ Method Descriptions Adds a new node to the graph. The ``position`` is used for display in the editor. +---- + .. _class_AnimationNodeStateMachine_method_add_transition: - void **add_transition** **(** :ref:`String` from, :ref:`String` to, :ref:`AnimationNodeStateMachineTransition` transition **)** Adds a transition between the given nodes. +---- + .. _class_AnimationNodeStateMachine_method_get_end_node: - :ref:`String` **get_end_node** **(** **)** const Returns the graph's end node. +---- + .. _class_AnimationNodeStateMachine_method_get_graph_offset: - :ref:`Vector2` **get_graph_offset** **(** **)** const Returns the draw offset of the graph. Used for display in the editor. +---- + .. _class_AnimationNodeStateMachine_method_get_node: - :ref:`AnimationNode` **get_node** **(** :ref:`String` name **)** const Returns the animation node with the given name. +---- + .. _class_AnimationNodeStateMachine_method_get_node_name: - :ref:`String` **get_node_name** **(** :ref:`AnimationNode` node **)** const Returns the given animation node's name. +---- + .. _class_AnimationNodeStateMachine_method_get_node_position: - :ref:`Vector2` **get_node_position** **(** :ref:`String` name **)** const Returns the given node's coordinates. Used for display in the editor. +---- + .. _class_AnimationNodeStateMachine_method_get_start_node: - :ref:`String` **get_start_node** **(** **)** const Returns the graph's end node. +---- + .. _class_AnimationNodeStateMachine_method_get_transition: - :ref:`AnimationNodeStateMachineTransition` **get_transition** **(** :ref:`int` idx **)** const Returns the given transition. +---- + .. _class_AnimationNodeStateMachine_method_get_transition_count: - :ref:`int` **get_transition_count** **(** **)** const Returns the number of connections in the graph. +---- + .. _class_AnimationNodeStateMachine_method_get_transition_from: - :ref:`String` **get_transition_from** **(** :ref:`int` idx **)** const Returns the given transition's start node. +---- + .. _class_AnimationNodeStateMachine_method_get_transition_to: - :ref:`String` **get_transition_to** **(** :ref:`int` idx **)** const Returns the given transition's end node. +---- + .. _class_AnimationNodeStateMachine_method_has_node: - :ref:`bool` **has_node** **(** :ref:`String` name **)** const Returns ``true`` if the graph contains the given node. +---- + .. _class_AnimationNodeStateMachine_method_has_transition: - :ref:`bool` **has_transition** **(** :ref:`String` from, :ref:`String` to **)** const Returns ``true`` if there is a transition between the given nodes. +---- + .. _class_AnimationNodeStateMachine_method_remove_node: - void **remove_node** **(** :ref:`String` name **)** Deletes the given node from the graph. +---- + .. _class_AnimationNodeStateMachine_method_remove_transition: - void **remove_transition** **(** :ref:`String` from, :ref:`String` to **)** Deletes the given transition. +---- + .. _class_AnimationNodeStateMachine_method_remove_transition_by_index: - void **remove_transition_by_index** **(** :ref:`int` idx **)** Deletes the given transition. +---- + .. _class_AnimationNodeStateMachine_method_rename_node: - void **rename_node** **(** :ref:`String` name, :ref:`String` new_name **)** Renames the given node. +---- + .. _class_AnimationNodeStateMachine_method_set_end_node: - void **set_end_node** **(** :ref:`String` name **)** Sets the given node as the graph end point. +---- + .. _class_AnimationNodeStateMachine_method_set_graph_offset: - void **set_graph_offset** **(** :ref:`Vector2` offset **)** Sets the draw offset of the graph. Used for display in the editor. +---- + .. _class_AnimationNodeStateMachine_method_set_node_position: - void **set_node_position** **(** :ref:`String` name, :ref:`Vector2` position **)** Sets the node's coordinates. Used for display in the editor. +---- + .. _class_AnimationNodeStateMachine_method_set_start_node: - void **set_start_node** **(** :ref:`String` name **)** diff --git a/classes/class_animationnodestatemachineplayback.rst b/classes/class_animationnodestatemachineplayback.rst index 59282c9b3..32de44ab3 100644 --- a/classes/class_animationnodestatemachineplayback.rst +++ b/classes/class_animationnodestatemachineplayback.rst @@ -54,28 +54,38 @@ Method Descriptions Returns the currently playing animation state. +---- + .. _class_AnimationNodeStateMachinePlayback_method_get_travel_path: - :ref:`PoolStringArray` **get_travel_path** **(** **)** const +---- + .. _class_AnimationNodeStateMachinePlayback_method_is_playing: - :ref:`bool` **is_playing** **(** **)** const Returns ``true`` if an animation is playing. +---- + .. _class_AnimationNodeStateMachinePlayback_method_start: - void **start** **(** :ref:`String` node **)** Starts playing the given animation. +---- + .. _class_AnimationNodeStateMachinePlayback_method_stop: - void **stop** **(** **)** Stops the currently playing animation. +---- + .. _class_AnimationNodeStateMachinePlayback_method_travel: - void **travel** **(** :ref:`String` to_node **)** diff --git a/classes/class_animationnodestatemachinetransition.rst b/classes/class_animationnodestatemachinetransition.rst index efa42047d..346f6ff2d 100644 --- a/classes/class_animationnodestatemachinetransition.rst +++ b/classes/class_animationnodestatemachinetransition.rst @@ -80,6 +80,8 @@ Turn on auto advance when this condition is set. The provided name will become a $animation_tree["parameters/conditions/idle"] = is_on_floor and linear_velocity.x == 0 +---- + .. _class_AnimationNodeStateMachineTransition_property_auto_advance: - :ref:`bool` **auto_advance** @@ -92,6 +94,8 @@ Turn on auto advance when this condition is set. The provided name will become a Turn on the transition automatically when this state is reached. This works best with :ref:`SWITCH_MODE_AT_END`. +---- + .. _class_AnimationNodeStateMachineTransition_property_disabled: - :ref:`bool` **disabled** @@ -104,6 +108,8 @@ Turn on the transition automatically when this state is reached. This works best Don't use this transition during :ref:`AnimationNodeStateMachinePlayback.travel` or :ref:`auto_advance`. +---- + .. _class_AnimationNodeStateMachineTransition_property_priority: - :ref:`int` **priority** @@ -116,6 +122,8 @@ Don't use this transition during :ref:`AnimationNodeStateMachinePlayback.travel< Lower priority transitions are preferred when travelling through the tree via :ref:`AnimationNodeStateMachinePlayback.travel` or :ref:`auto_advance`. +---- + .. _class_AnimationNodeStateMachineTransition_property_switch_mode: - :ref:`SwitchMode` **switch_mode** @@ -128,6 +136,8 @@ Lower priority transitions are preferred when travelling through the tree via :r The transition type. +---- + .. _class_AnimationNodeStateMachineTransition_property_xfade_time: - :ref:`float` **xfade_time** diff --git a/classes/class_animationnodetransition.rst b/classes/class_animationnodetransition.rst index 61010af98..01664c7a3 100644 --- a/classes/class_animationnodetransition.rst +++ b/classes/class_animationnodetransition.rst @@ -168,6 +168,8 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_0/name: - :ref:`String` **input_0/name** @@ -178,6 +180,8 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_1/auto_advance: - :ref:`bool` **input_1/auto_advance** @@ -188,6 +192,8 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_1/name: - :ref:`String` **input_1/name** @@ -198,6 +204,8 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_10/auto_advance: - :ref:`bool` **input_10/auto_advance** @@ -208,6 +216,8 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_10/name: - :ref:`String` **input_10/name** @@ -218,6 +228,8 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_11/auto_advance: - :ref:`bool` **input_11/auto_advance** @@ -228,6 +240,8 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_11/name: - :ref:`String` **input_11/name** @@ -238,6 +252,8 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_12/auto_advance: - :ref:`bool` **input_12/auto_advance** @@ -248,6 +264,8 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_12/name: - :ref:`String` **input_12/name** @@ -258,6 +276,8 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_13/auto_advance: - :ref:`bool` **input_13/auto_advance** @@ -268,6 +288,8 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_13/name: - :ref:`String` **input_13/name** @@ -278,6 +300,8 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_14/auto_advance: - :ref:`bool` **input_14/auto_advance** @@ -288,6 +312,8 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_14/name: - :ref:`String` **input_14/name** @@ -298,6 +324,8 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_15/auto_advance: - :ref:`bool` **input_15/auto_advance** @@ -308,6 +336,8 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_15/name: - :ref:`String` **input_15/name** @@ -318,6 +348,8 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_16/auto_advance: - :ref:`bool` **input_16/auto_advance** @@ -328,6 +360,8 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_16/name: - :ref:`String` **input_16/name** @@ -338,6 +372,8 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_17/auto_advance: - :ref:`bool` **input_17/auto_advance** @@ -348,6 +384,8 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_17/name: - :ref:`String` **input_17/name** @@ -358,6 +396,8 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_18/auto_advance: - :ref:`bool` **input_18/auto_advance** @@ -368,6 +408,8 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_18/name: - :ref:`String` **input_18/name** @@ -378,6 +420,8 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_19/auto_advance: - :ref:`bool` **input_19/auto_advance** @@ -388,6 +432,8 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_19/name: - :ref:`String` **input_19/name** @@ -398,6 +444,8 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_2/auto_advance: - :ref:`bool` **input_2/auto_advance** @@ -408,6 +456,8 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_2/name: - :ref:`String` **input_2/name** @@ -418,6 +468,8 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_20/auto_advance: - :ref:`bool` **input_20/auto_advance** @@ -428,6 +480,8 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_20/name: - :ref:`String` **input_20/name** @@ -438,6 +492,8 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_21/auto_advance: - :ref:`bool` **input_21/auto_advance** @@ -448,6 +504,8 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_21/name: - :ref:`String` **input_21/name** @@ -458,6 +516,8 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_22/auto_advance: - :ref:`bool` **input_22/auto_advance** @@ -468,6 +528,8 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_22/name: - :ref:`String` **input_22/name** @@ -478,6 +540,8 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_23/auto_advance: - :ref:`bool` **input_23/auto_advance** @@ -488,6 +552,8 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_23/name: - :ref:`String` **input_23/name** @@ -498,6 +564,8 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_24/auto_advance: - :ref:`bool` **input_24/auto_advance** @@ -508,6 +576,8 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_24/name: - :ref:`String` **input_24/name** @@ -518,6 +588,8 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_25/auto_advance: - :ref:`bool` **input_25/auto_advance** @@ -528,6 +600,8 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_25/name: - :ref:`String` **input_25/name** @@ -538,6 +612,8 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_26/auto_advance: - :ref:`bool` **input_26/auto_advance** @@ -548,6 +624,8 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_26/name: - :ref:`String` **input_26/name** @@ -558,6 +636,8 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_27/auto_advance: - :ref:`bool` **input_27/auto_advance** @@ -568,6 +648,8 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_27/name: - :ref:`String` **input_27/name** @@ -578,6 +660,8 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_28/auto_advance: - :ref:`bool` **input_28/auto_advance** @@ -588,6 +672,8 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_28/name: - :ref:`String` **input_28/name** @@ -598,6 +684,8 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_29/auto_advance: - :ref:`bool` **input_29/auto_advance** @@ -608,6 +696,8 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_29/name: - :ref:`String` **input_29/name** @@ -618,6 +708,8 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_3/auto_advance: - :ref:`bool` **input_3/auto_advance** @@ -628,6 +720,8 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_3/name: - :ref:`String` **input_3/name** @@ -638,6 +732,8 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_30/auto_advance: - :ref:`bool` **input_30/auto_advance** @@ -648,6 +744,8 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_30/name: - :ref:`String` **input_30/name** @@ -658,6 +756,8 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_31/auto_advance: - :ref:`bool` **input_31/auto_advance** @@ -668,6 +768,8 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_31/name: - :ref:`String` **input_31/name** @@ -678,6 +780,8 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_4/auto_advance: - :ref:`bool` **input_4/auto_advance** @@ -688,6 +792,8 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_4/name: - :ref:`String` **input_4/name** @@ -698,6 +804,8 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_5/auto_advance: - :ref:`bool` **input_5/auto_advance** @@ -708,6 +816,8 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_5/name: - :ref:`String` **input_5/name** @@ -718,6 +828,8 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_6/auto_advance: - :ref:`bool` **input_6/auto_advance** @@ -728,6 +840,8 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_6/name: - :ref:`String` **input_6/name** @@ -738,6 +852,8 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_7/auto_advance: - :ref:`bool` **input_7/auto_advance** @@ -748,6 +864,8 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_7/name: - :ref:`String` **input_7/name** @@ -758,6 +876,8 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_8/auto_advance: - :ref:`bool` **input_8/auto_advance** @@ -768,6 +888,8 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_8/name: - :ref:`String` **input_8/name** @@ -778,6 +900,8 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_9/auto_advance: - :ref:`bool` **input_9/auto_advance** @@ -788,6 +912,8 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_9/name: - :ref:`String` **input_9/name** @@ -798,6 +924,8 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ +---- + .. _class_AnimationNodeTransition_property_input_count: - :ref:`int` **input_count** @@ -808,6 +936,8 @@ Property Descriptions | *Getter* | get_enabled_inputs() | +----------+---------------------------+ +---- + .. _class_AnimationNodeTransition_property_xfade_time: - :ref:`float` **xfade_time** diff --git a/classes/class_animationplayer.rst b/classes/class_animationplayer.rst index 92cf69db5..5168a144f 100644 --- a/classes/class_animationplayer.rst +++ b/classes/class_animationplayer.rst @@ -101,18 +101,24 @@ Signals If the currently being played animation changes, this signal will notify of such change. +---- + .. _class_AnimationPlayer_signal_animation_finished: - **animation_finished** **(** :ref:`String` anim_name **)** Notifies when an animation finished playing. +---- + .. _class_AnimationPlayer_signal_animation_started: - **animation_started** **(** :ref:`String` anim_name **)** Notifies when an animation starts playing. +---- + .. _class_AnimationPlayer_signal_caches_cleared: - **caches_cleared** **(** **)** @@ -163,6 +169,8 @@ Property Descriptions If playing, the current animation; otherwise, the animation last played. When set, would change the animation, but would not play it unless currently playing. See also :ref:`current_animation`. +---- + .. _class_AnimationPlayer_property_autoplay: - :ref:`String` **autoplay** @@ -175,6 +183,8 @@ If playing, the current animation; otherwise, the animation last played. When se The name of the animation to play when the scene loads. Default value: ``""``. +---- + .. _class_AnimationPlayer_property_current_animation: - :ref:`String` **current_animation** @@ -187,6 +197,8 @@ The name of the animation to play when the scene loads. Default value: ``""``. The name of the current animation, "" if not playing anything. When being set, does not restart the animation. See also :ref:`play`. Default value: ``""``. +---- + .. _class_AnimationPlayer_property_current_animation_length: - :ref:`float` **current_animation_length** @@ -197,6 +209,8 @@ The name of the current animation, "" if not playing anything. When being set, d The length (in seconds) of the currently being played animation. +---- + .. _class_AnimationPlayer_property_current_animation_position: - :ref:`float` **current_animation_position** @@ -207,6 +221,8 @@ The length (in seconds) of the currently being played animation. The position (in seconds) of the currently playing animation. +---- + .. _class_AnimationPlayer_property_playback_active: - :ref:`bool` **playback_active** @@ -219,6 +235,8 @@ The position (in seconds) of the currently playing animation. If ``true``, updates animations in response to process-related notifications. Default value: ``true``. +---- + .. _class_AnimationPlayer_property_playback_default_blend_time: - :ref:`float` **playback_default_blend_time** @@ -231,6 +249,8 @@ If ``true``, updates animations in response to process-related notifications. De The default time in which to blend animations. Ranges from 0 to 4096 with 0.01 precision. Default value: ``0``. +---- + .. _class_AnimationPlayer_property_playback_process_mode: - :ref:`AnimationProcessMode` **playback_process_mode** @@ -243,6 +263,8 @@ The default time in which to blend animations. Ranges from 0 to 4096 with 0.01 p The process notification in which to update animations. Default value: :ref:`ANIMATION_PROCESS_IDLE`. +---- + .. _class_AnimationPlayer_property_playback_speed: - :ref:`float` **playback_speed** @@ -255,6 +277,8 @@ The process notification in which to update animations. Default value: :ref:`ANI The speed scaling ratio. For instance, if this value is 1 then the animation plays at normal speed. If it's 0.5 then it plays at half speed. If it's 2 then it plays at double speed. Default value: ``1``. +---- + .. _class_AnimationPlayer_property_root_node: - :ref:`NodePath` **root_node** @@ -276,82 +300,110 @@ Method Descriptions Adds ``animation`` to the player accessible with the key ``name``. +---- + .. _class_AnimationPlayer_method_advance: - void **advance** **(** :ref:`float` delta **)** Shifts position in the animation timeline. Delta is the time in seconds to shift. Events between the current frame and ``delta`` are handled. +---- + .. _class_AnimationPlayer_method_animation_get_next: - :ref:`String` **animation_get_next** **(** :ref:`String` anim_from **)** const Returns the name of the next animation in the queue. +---- + .. _class_AnimationPlayer_method_animation_set_next: - void **animation_set_next** **(** :ref:`String` anim_from, :ref:`String` anim_to **)** Triggers the ``anim_to`` animation when the ``anim_from`` animation completes. +---- + .. _class_AnimationPlayer_method_clear_caches: - void **clear_caches** **(** **)** ``AnimationPlayer`` caches animated nodes. It may not notice if a node disappears, so clear_caches forces it to update the cache again. +---- + .. _class_AnimationPlayer_method_clear_queue: - void **clear_queue** **(** **)** Clears all queued, unplayed animations. +---- + .. _class_AnimationPlayer_method_find_animation: - :ref:`String` **find_animation** **(** :ref:`Animation` animation **)** const Returns the name of ``animation`` or empty string if not found. +---- + .. _class_AnimationPlayer_method_get_animation: - :ref:`Animation` **get_animation** **(** :ref:`String` name **)** const Returns the :ref:`Animation` with key ``name`` or ``null`` if not found. +---- + .. _class_AnimationPlayer_method_get_animation_list: - :ref:`PoolStringArray` **get_animation_list** **(** **)** const Returns the list of stored animation names. +---- + .. _class_AnimationPlayer_method_get_blend_time: - :ref:`float` **get_blend_time** **(** :ref:`String` anim_from, :ref:`String` anim_to **)** const Get the blend time (in seconds) between two animations, referenced by their names. +---- + .. _class_AnimationPlayer_method_get_playing_speed: - :ref:`float` **get_playing_speed** **(** **)** const Get the actual playing speed of current animation or 0 if not playing. This speed is the ``playback_speed`` property multiplied by ``custom_speed`` argument specified when calling the ``play`` method. +---- + .. _class_AnimationPlayer_method_get_queue: - :ref:`PoolStringArray` **get_queue** **(** **)** +---- + .. _class_AnimationPlayer_method_has_animation: - :ref:`bool` **has_animation** **(** :ref:`String` name **)** const Returns ``true`` if the ``AnimationPlayer`` stores an :ref:`Animation` with key ``name``. +---- + .. _class_AnimationPlayer_method_is_playing: - :ref:`bool` **is_playing** **(** **)** const Returns ``true`` if playing an animation. +---- + .. _class_AnimationPlayer_method_play: - void **play** **(** :ref:`String` name="", :ref:`float` custom_blend=-1, :ref:`float` custom_speed=1.0, :ref:`bool` from_end=false **)** @@ -360,6 +412,8 @@ Play the animation with key ``name``. Custom speed and blend times can be set. I If the animation has been paused by ``stop(true)`` it will be resumed. Calling ``play()`` without arguments will also resume the animation. +---- + .. _class_AnimationPlayer_method_play_backwards: - void **play_backwards** **(** :ref:`String` name="", :ref:`float` custom_blend=-1 **)** @@ -368,36 +422,48 @@ Play the animation with key ``name`` in reverse. If the animation has been paused by ``stop(true)`` it will be resumed backwards. Calling ``play_backwards()`` without arguments will also resume the animation backwards. +---- + .. _class_AnimationPlayer_method_queue: - void **queue** **(** :ref:`String` name **)** Queue an animation for playback once the current one is done. +---- + .. _class_AnimationPlayer_method_remove_animation: - void **remove_animation** **(** :ref:`String` name **)** Remove the animation with key ``name``. +---- + .. _class_AnimationPlayer_method_rename_animation: - void **rename_animation** **(** :ref:`String` name, :ref:`String` newname **)** Rename an existing animation with key ``name`` to ``newname``. +---- + .. _class_AnimationPlayer_method_seek: - void **seek** **(** :ref:`float` seconds, :ref:`bool` update=false **)** Seek the animation to the ``seconds`` point in time (in seconds). If ``update`` is ``true``, the animation updates too, otherwise it updates at process time. Events between the current frame and ``seconds`` are skipped. +---- + .. _class_AnimationPlayer_method_set_blend_time: - 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_method_stop: - void **stop** **(** :ref:`bool` reset=true **)** diff --git a/classes/class_animationtree.rst b/classes/class_animationtree.rst index dcc238755..3a5b67e01 100644 --- a/classes/class_animationtree.rst +++ b/classes/class_animationtree.rst @@ -83,6 +83,8 @@ Property Descriptions | *Getter* | is_active() | +----------+-------------------+ +---- + .. _class_AnimationTree_property_anim_player: - :ref:`NodePath` **anim_player** @@ -93,6 +95,8 @@ Property Descriptions | *Getter* | get_animation_player() | +----------+-----------------------------+ +---- + .. _class_AnimationTree_property_process_mode: - :ref:`AnimationProcessMode` **process_mode** @@ -103,6 +107,8 @@ Property Descriptions | *Getter* | get_process_mode() | +----------+-------------------------+ +---- + .. _class_AnimationTree_property_root_motion_track: - :ref:`NodePath` **root_motion_track** @@ -113,6 +119,8 @@ Property Descriptions | *Getter* | get_root_motion_track() | +----------+------------------------------+ +---- + .. _class_AnimationTree_property_tree_root: - :ref:`AnimationNode` **tree_root** @@ -130,10 +138,14 @@ Method Descriptions - void **advance** **(** :ref:`float` delta **)** +---- + .. _class_AnimationTree_method_get_root_motion_transform: - :ref:`Transform` **get_root_motion_transform** **(** **)** const +---- + .. _class_AnimationTree_method_rename_parameter: - void **rename_parameter** **(** :ref:`String` old_name, :ref:`String` new_name **)** diff --git a/classes/class_animationtreeplayer.rst b/classes/class_animationtreeplayer.rst index c645d6de8..69983dbc2 100644 --- a/classes/class_animationtreeplayer.rst +++ b/classes/class_animationtreeplayer.rst @@ -197,6 +197,8 @@ enum **NodeType**: - **NODE_TRANSITION** = **9** --- Transition node. +---- + .. _enum_AnimationTreePlayer_AnimationProcessMode: .. _class_AnimationTreePlayer_constant_ANIMATION_PROCESS_PHYSICS: @@ -231,6 +233,8 @@ Property Descriptions If ``true``, the ``AnimationTreePlayer`` is able to play animations. Default value: ``false``. +---- + .. _class_AnimationTreePlayer_property_base_path: - :ref:`NodePath` **base_path** @@ -245,6 +249,8 @@ The node from which to relatively access other nodes. Default value: ``".."``. It accesses the Bones, so it should point to the same Node the AnimationPlayer would point its Root Node at. +---- + .. _class_AnimationTreePlayer_property_master_player: - :ref:`NodePath` **master_player** @@ -259,6 +265,8 @@ The path to the :ref:`AnimationPlayer` from which this `` Once set, Animation nodes can be added to the AnimationTreePlayer. +---- + .. _class_AnimationTreePlayer_property_playback_process_mode: - :ref:`AnimationProcessMode` **playback_process_mode** @@ -280,58 +288,78 @@ Method Descriptions Adds a ``type`` node to the graph with name ``id``. +---- + .. _class_AnimationTreePlayer_method_advance: - void **advance** **(** :ref:`float` delta **)** Shifts position in the animation timeline. Delta is the time in seconds to shift. Events between the current frame and ``delta`` are handled. +---- + .. _class_AnimationTreePlayer_method_animation_node_get_animation: - :ref:`Animation` **animation_node_get_animation** **(** :ref:`String` id **)** const Returns the :ref:`AnimationPlayer`'s :ref:`Animation` bound to the ``AnimationTreePlayer``'s animation node with name ``id``. +---- + .. _class_AnimationTreePlayer_method_animation_node_get_master_animation: - :ref:`String` **animation_node_get_master_animation** **(** :ref:`String` id **)** const Returns the name of the :ref:`master_player`'s :ref:`Animation` bound to this animation node. +---- + .. _class_AnimationTreePlayer_method_animation_node_get_position: - :ref:`float` **animation_node_get_position** **(** :ref:`String` id **)** const +---- + .. _class_AnimationTreePlayer_method_animation_node_set_animation: - void **animation_node_set_animation** **(** :ref:`String` id, :ref:`Animation` animation **)** Binds a new :ref:`Animation` from the :ref:`master_player` to the ``AnimationTreePlayer``'s animation node with name ``id``. +---- + .. _class_AnimationTreePlayer_method_animation_node_set_filter_path: - void **animation_node_set_filter_path** **(** :ref:`String` id, :ref:`NodePath` path, :ref:`bool` enable **)** If ``enable`` is ``true``, the animation node with ID ``id`` turns off the track modifying the property at ``path``. The modified node's children continue to animate. +---- + .. _class_AnimationTreePlayer_method_animation_node_set_master_animation: - void **animation_node_set_master_animation** **(** :ref:`String` id, :ref:`String` source **)** Binds the :ref:`Animation` named ``source`` from :ref:`master_player` to the animation node ``id``. Recalculates caches. +---- + .. _class_AnimationTreePlayer_method_are_nodes_connected: - :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_method_blend2_node_get_amount: - :ref:`float` **blend2_node_get_amount** **(** :ref:`String` id **)** const Returns the blend amount of a Blend2 node given its name. +---- + .. _class_AnimationTreePlayer_method_blend2_node_set_amount: - void **blend2_node_set_amount** **(** :ref:`String` id, :ref:`float` blend **)** @@ -346,18 +374,24 @@ Towards 1, the influence of a gets lessened, the influence of b gets raised. At 1, Output is input b. +---- + .. _class_AnimationTreePlayer_method_blend2_node_set_filter_path: - void **blend2_node_set_filter_path** **(** :ref:`String` id, :ref:`NodePath` path, :ref:`bool` enable **)** If ``enable`` is ``true``, the blend2 node with ID ``id`` turns off the track modifying the property at ``path``. The modified node's children continue to animate. +---- + .. _class_AnimationTreePlayer_method_blend3_node_get_amount: - :ref:`float` **blend3_node_get_amount** **(** :ref:`String` id **)** const Returns the blend amount of a Blend3 node given its name. +---- + .. _class_AnimationTreePlayer_method_blend3_node_set_amount: - void **blend3_node_set_amount** **(** :ref:`String` id, :ref:`float` blend **)** @@ -376,12 +410,16 @@ From 0 to 1, the influence of a gets lessened, the influence of b+ gets raised a At 1, Output is input b+. +---- + .. _class_AnimationTreePlayer_method_blend4_node_get_amount: - :ref:`Vector2` **blend4_node_get_amount** **(** :ref:`String` id **)** const Returns the blend amount of a Blend4 node given its name. +---- + .. _class_AnimationTreePlayer_method_blend4_node_set_amount: - void **blend4_node_set_amount** **(** :ref:`String` id, :ref:`Vector2` blend **)** @@ -392,30 +430,40 @@ A Blend4 Node blends two pairs of animations. The two pairs are blended like blend2 and then added together. +---- + .. _class_AnimationTreePlayer_method_connect_nodes: - :ref:`Error` **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_method_disconnect_nodes: - void **disconnect_nodes** **(** :ref:`String` id, :ref:`int` dst_input_idx **)** Disconnects nodes connected to ``id`` at the specified input slot. +---- + .. _class_AnimationTreePlayer_method_get_node_list: - :ref:`PoolStringArray` **get_node_list** **(** **)** Returns a :ref:`PoolStringArray` containing the name of all nodes. +---- + .. _class_AnimationTreePlayer_method_mix_node_get_amount: - :ref:`float` **mix_node_get_amount** **(** :ref:`String` id **)** const Returns mix amount of a Mix node given its name. +---- + .. _class_AnimationTreePlayer_method_mix_node_set_amount: - void **mix_node_set_amount** **(** :ref:`String` id, :ref:`float` ratio **)** @@ -424,156 +472,208 @@ Sets mix amount of a Mix node given its name and value. A Mix node adds input b to input a by a the amount given by ratio. +---- + .. _class_AnimationTreePlayer_method_node_exists: - :ref:`bool` **node_exists** **(** :ref:`String` node **)** const Check if a node exists (by name). +---- + .. _class_AnimationTreePlayer_method_node_get_input_count: - :ref:`int` **node_get_input_count** **(** :ref:`String` id **)** const Returns the input count for a given node. Different types of nodes have different amount of inputs. +---- + .. _class_AnimationTreePlayer_method_node_get_input_source: - :ref:`String` **node_get_input_source** **(** :ref:`String` id, :ref:`int` idx **)** const Returns the input source for a given node input. +---- + .. _class_AnimationTreePlayer_method_node_get_position: - :ref:`Vector2` **node_get_position** **(** :ref:`String` id **)** const Returns position of a node in the graph given its name. +---- + .. _class_AnimationTreePlayer_method_node_get_type: - :ref:`NodeType` **node_get_type** **(** :ref:`String` id **)** const Get the node type, will return from NODE\_\* enum. +---- + .. _class_AnimationTreePlayer_method_node_rename: - :ref:`Error` **node_rename** **(** :ref:`String` node, :ref:`String` new_name **)** Rename a node in the graph. +---- + .. _class_AnimationTreePlayer_method_node_set_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_method_oneshot_node_get_autorestart_delay: - :ref:`float` **oneshot_node_get_autorestart_delay** **(** :ref:`String` id **)** const Returns autostart delay of a OneShot node given its name. +---- + .. _class_AnimationTreePlayer_method_oneshot_node_get_autorestart_random_delay: - :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_method_oneshot_node_get_fadein_time: - :ref:`float` **oneshot_node_get_fadein_time** **(** :ref:`String` id **)** const Returns fade in time of a OneShot node given its name. +---- + .. _class_AnimationTreePlayer_method_oneshot_node_get_fadeout_time: - :ref:`float` **oneshot_node_get_fadeout_time** **(** :ref:`String` id **)** const Returns fade out time of a OneShot node given its name. +---- + .. _class_AnimationTreePlayer_method_oneshot_node_has_autorestart: - :ref:`bool` **oneshot_node_has_autorestart** **(** :ref:`String` id **)** const Returns whether a OneShot node will auto restart given its name. +---- + .. _class_AnimationTreePlayer_method_oneshot_node_is_active: - :ref:`bool` **oneshot_node_is_active** **(** :ref:`String` id **)** const Returns whether a OneShot node is active given its name. +---- + .. _class_AnimationTreePlayer_method_oneshot_node_set_autorestart: - 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_method_oneshot_node_set_autorestart_delay: - 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_method_oneshot_node_set_autorestart_random_delay: - 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_method_oneshot_node_set_fadein_time: - 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_method_oneshot_node_set_fadeout_time: - 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_method_oneshot_node_set_filter_path: - void **oneshot_node_set_filter_path** **(** :ref:`String` id, :ref:`NodePath` path, :ref:`bool` enable **)** If ``enable`` is ``true``, the oneshot node with ID ``id`` turns off the track modifying the property at ``path``. The modified node's children continue to animate. +---- + .. _class_AnimationTreePlayer_method_oneshot_node_start: - void **oneshot_node_start** **(** :ref:`String` id **)** Starts a OneShot node given its name. +---- + .. _class_AnimationTreePlayer_method_oneshot_node_stop: - void **oneshot_node_stop** **(** :ref:`String` id **)** Stops the OneShot node with name ``id``. +---- + .. _class_AnimationTreePlayer_method_recompute_caches: - void **recompute_caches** **(** **)** Manually recalculates the cache of track information generated from animation nodes. Needed when external sources modify the animation nodes' state. +---- + .. _class_AnimationTreePlayer_method_remove_node: - void **remove_node** **(** :ref:`String` id **)** Removes the animation node with name ``id``. +---- + .. _class_AnimationTreePlayer_method_reset: - void **reset** **(** **)** Resets this ``AnimationTreePlayer``. +---- + .. _class_AnimationTreePlayer_method_timescale_node_get_scale: - :ref:`float` **timescale_node_get_scale** **(** :ref:`String` id **)** const Returns time scale value of the TimeScale node with name ``id``. +---- + .. _class_AnimationTreePlayer_method_timescale_node_set_scale: - void **timescale_node_set_scale** **(** :ref:`String` id, :ref:`float` scale **)** @@ -584,6 +684,8 @@ The timescale node is used to speed :ref:`Animation`\ s up if t If applied after a blend or mix, affects all input animations to that blend or mix. +---- + .. _class_AnimationTreePlayer_method_timeseek_node_seek: - void **timeseek_node_seek** **(** :ref:`String` id, :ref:`float` seconds **)** @@ -592,54 +694,72 @@ Sets the time seek value of the TimeSeek node with name ``id`` to ``seconds`` This functions as a seek in the :ref:`Animation` or the blend or mix of :ref:`Animation`\ s input in it. +---- + .. _class_AnimationTreePlayer_method_transition_node_delete_input: - void **transition_node_delete_input** **(** :ref:`String` id, :ref:`int` input_idx **)** Deletes the input at ``input_idx`` for the transition node with name ``id``. +---- + .. _class_AnimationTreePlayer_method_transition_node_get_current: - :ref:`int` **transition_node_get_current** **(** :ref:`String` id **)** const Returns the index of the currently evaluated input for the transition node with name ``id``. +---- + .. _class_AnimationTreePlayer_method_transition_node_get_input_count: - :ref:`int` **transition_node_get_input_count** **(** :ref:`String` id **)** const Returns the number of inputs for the transition node with name ``id``. You can add inputs by rightclicking on the transition node. +---- + .. _class_AnimationTreePlayer_method_transition_node_get_xfade_time: - :ref:`float` **transition_node_get_xfade_time** **(** :ref:`String` id **)** const Returns the cross fade time for the transition node with name ``id``. +---- + .. _class_AnimationTreePlayer_method_transition_node_has_input_auto_advance: - :ref:`bool` **transition_node_has_input_auto_advance** **(** :ref:`String` id, :ref:`int` input_idx **)** const Returns ``true`` if the input at ``input_idx`` on transition node with name ``id`` is set to automatically advance to the next input upon completion. +---- + .. _class_AnimationTreePlayer_method_transition_node_set_current: - void **transition_node_set_current** **(** :ref:`String` id, :ref:`int` input_idx **)** The transition node with name ``id`` sets its current input at ``input_idx``. +---- + .. _class_AnimationTreePlayer_method_transition_node_set_input_auto_advance: - void **transition_node_set_input_auto_advance** **(** :ref:`String` id, :ref:`int` input_idx, :ref:`bool` enable **)** The transition node with name ``id`` advances to its next input automatically when the input at ``input_idx`` completes. +---- + .. _class_AnimationTreePlayer_method_transition_node_set_input_count: - void **transition_node_set_input_count** **(** :ref:`String` id, :ref:`int` count **)** Resizes the number of inputs available for the transition node with name ``id``. +---- + .. _class_AnimationTreePlayer_method_transition_node_set_xfade_time: - 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 da4a4ada8..0ff83cc04 100644 --- a/classes/class_area.rst +++ b/classes/class_area.rst @@ -89,42 +89,56 @@ Signals Emitted when another area enters. +---- + .. _class_Area_signal_area_exited: - **area_exited** **(** :ref:`Area` area **)** Emitted when another area exits. +---- + .. _class_Area_signal_area_shape_entered: - **area_shape_entered** **(** :ref:`int` area_id, :ref:`Area` area, :ref:`int` area_shape, :ref:`int` self_shape **)** Emitted when another area enters, reporting which areas overlapped. +---- + .. _class_Area_signal_area_shape_exited: - **area_shape_exited** **(** :ref:`int` area_id, :ref:`Area` area, :ref:`int` area_shape, :ref:`int` self_shape **)** Emitted when another area exits, reporting which areas were overlapping. +---- + .. _class_Area_signal_body_entered: - **body_entered** **(** :ref:`Node` body **)** Emitted when a :ref:`PhysicsBody` object enters. +---- + .. _class_Area_signal_body_exited: - **body_exited** **(** :ref:`Node` body **)** Emitted when a :ref:`PhysicsBody` object exits. +---- + .. _class_Area_signal_body_shape_entered: - **body_shape_entered** **(** :ref:`int` body_id, :ref:`Node` body, :ref:`int` body_shape, :ref:`int` area_shape **)** Emitted when a :ref:`PhysicsBody` object enters, reporting which shapes overlapped. +---- + .. _class_Area_signal_body_shape_exited: - **body_shape_exited** **(** :ref:`int` body_id, :ref:`Node` body, :ref:`int` body_shape, :ref:`int` area_shape **)** @@ -178,6 +192,8 @@ Property Descriptions The rate at which objects stop spinning in this area. Represents the angular velocity lost per second. Values range from ``0`` (no damping) to ``1`` (full damping). +---- + .. _class_Area_property_audio_bus_name: - :ref:`String` **audio_bus_name** @@ -190,6 +206,8 @@ The rate at which objects stop spinning in this area. Represents the angular vel The name of the area's audio bus. +---- + .. _class_Area_property_audio_bus_override: - :ref:`bool` **audio_bus_override** @@ -202,6 +220,8 @@ The name of the area's audio bus. If ``true``, the area's audio bus overrides the default audio bus. Default value: ``false``. +---- + .. _class_Area_property_collision_layer: - :ref:`int` **collision_layer** @@ -214,6 +234,8 @@ If ``true``, the area's audio bus overrides the default audio bus. Default value The area's physics layer(s). Collidable objects can exist in any of 32 different layers. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layers that object A scans. See also :ref:`collision_mask`. +---- + .. _class_Area_property_collision_mask: - :ref:`int` **collision_mask** @@ -226,6 +248,8 @@ The area's physics layer(s). Collidable objects can exist in any of 32 different The physics layers this area scans to determine collision detection. +---- + .. _class_Area_property_gravity: - :ref:`float` **gravity** @@ -238,6 +262,8 @@ The physics layers this area scans to determine collision detection. The area's gravity intensity (ranges from -1024 to 1024). This value multiplies the gravity vector. This is useful to alter the force of gravity without altering its direction. +---- + .. _class_Area_property_gravity_distance_scale: - :ref:`float` **gravity_distance_scale** @@ -250,6 +276,8 @@ The area's gravity intensity (ranges from -1024 to 1024). This value multiplies The falloff factor for point gravity. The greater the value, the faster gravity decreases with distance. +---- + .. _class_Area_property_gravity_point: - :ref:`bool` **gravity_point** @@ -262,6 +290,8 @@ The falloff factor for point gravity. The greater the value, the faster gravity If ``true``, gravity is calculated from a point (set via :ref:`gravity_vec`). Also see :ref:`space_override`. Default value: ``false``. +---- + .. _class_Area_property_gravity_vec: - :ref:`Vector3` **gravity_vec** @@ -274,6 +304,8 @@ If ``true``, gravity is calculated from a point (set via :ref:`gravity_vec`), this will be the point of attraction. +---- + .. _class_Area_property_linear_damp: - :ref:`float` **linear_damp** @@ -286,6 +318,8 @@ The area's gravity vector (not normalized). If gravity is a point (see :ref:`gra The rate at which objects stop moving in this area. Represents the linear velocity lost per second. Values range from ``0`` (no damping) to ``1`` (full damping). +---- + .. _class_Area_property_monitorable: - :ref:`bool` **monitorable** @@ -298,6 +332,8 @@ The rate at which objects stop moving in this area. Represents the linear veloci If ``true``, other monitoring areas can detect this area. Default value: ``true``. +---- + .. _class_Area_property_monitoring: - :ref:`bool` **monitoring** @@ -310,6 +346,8 @@ If ``true``, other monitoring areas can detect this area. Default value: ``true` If ``true``, the area detects bodies or areas entering and exiting it. Default value: ``true``. +---- + .. _class_Area_property_priority: - :ref:`float` **priority** @@ -322,6 +360,8 @@ If ``true``, the area detects bodies or areas entering and exiting it. Default v The area's priority. Higher priority areas are processed first. Default value: 0. +---- + .. _class_Area_property_reverb_bus_amount: - :ref:`float` **reverb_bus_amount** @@ -334,6 +374,8 @@ The area's priority. Higher priority areas are processed first. Default value: 0 The degree to which this area applies reverb to its associated audio. Ranges from ``0`` to ``1`` with ``0.1`` precision. +---- + .. _class_Area_property_reverb_bus_enable: - :ref:`bool` **reverb_bus_enable** @@ -346,6 +388,8 @@ The degree to which this area applies reverb to its associated audio. Ranges fro If ``true``, the area applies reverb to its associated audio. +---- + .. _class_Area_property_reverb_bus_name: - :ref:`String` **reverb_bus_name** @@ -358,6 +402,8 @@ If ``true``, the area applies reverb to its associated audio. The reverb bus name to use for this area's associated audio. +---- + .. _class_Area_property_reverb_bus_uniformity: - :ref:`float` **reverb_bus_uniformity** @@ -370,6 +416,8 @@ The reverb bus name to use for this area's associated audio. The degree to which this area's reverb is a uniform effect. Ranges from ``0`` to ``1`` with ``0.1`` precision. +---- + .. _class_Area_property_space_override: - :ref:`SpaceOverride` **space_override** @@ -391,42 +439,56 @@ Method Descriptions Returns an individual bit on the layer mask. +---- + .. _class_Area_method_get_collision_mask_bit: - :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const Returns an individual bit on the collision mask. +---- + .. _class_Area_method_get_overlapping_areas: - :ref:`Array` **get_overlapping_areas** **(** **)** const Returns a list of intersecting ``Area``\ s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. +---- + .. _class_Area_method_get_overlapping_bodies: - :ref:`Array` **get_overlapping_bodies** **(** **)** const Returns a list of intersecting :ref:`PhysicsBody`\ s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. +---- + .. _class_Area_method_overlaps_area: - :ref:`bool` **overlaps_area** **(** :ref:`Node` area **)** const If ``true``, the given area overlaps the Area. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. +---- + .. _class_Area_method_overlaps_body: - :ref:`bool` **overlaps_body** **(** :ref:`Node` body **)** const If ``true``, the given body overlaps the Area. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. +---- + .. _class_Area_method_set_collision_layer_bit: - void **set_collision_layer_bit** **(** :ref:`int` bit, :ref:`bool` value **)** Set/clear individual bits on the layer mask. This simplifies editing this ``Area``'s layers. +---- + .. _class_Area_method_set_collision_mask_bit: - void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** diff --git a/classes/class_area2d.rst b/classes/class_area2d.rst index 922e5fe9c..516e5ae8a 100644 --- a/classes/class_area2d.rst +++ b/classes/class_area2d.rst @@ -81,42 +81,56 @@ Signals Emitted when another area enters. +---- + .. _class_Area2D_signal_area_exited: - **area_exited** **(** :ref:`Area2D` area **)** Emitted when another area exits. +---- + .. _class_Area2D_signal_area_shape_entered: - **area_shape_entered** **(** :ref:`int` area_id, :ref:`Area2D` area, :ref:`int` area_shape, :ref:`int` self_shape **)** Emitted when another area enters, reporting which shapes overlapped. +---- + .. _class_Area2D_signal_area_shape_exited: - **area_shape_exited** **(** :ref:`int` area_id, :ref:`Area2D` area, :ref:`int` area_shape, :ref:`int` self_shape **)** Emitted when another area exits, reporting which shapes were overlapping. +---- + .. _class_Area2D_signal_body_entered: - **body_entered** **(** :ref:`PhysicsBody2D` body **)** Emitted when a :ref:`PhysicsBody2D` object enters. +---- + .. _class_Area2D_signal_body_exited: - **body_exited** **(** :ref:`PhysicsBody2D` body **)** Emitted when a :ref:`PhysicsBody2D` object exits. +---- + .. _class_Area2D_signal_body_shape_entered: - **body_shape_entered** **(** :ref:`int` body_id, :ref:`PhysicsBody2D` body, :ref:`int` body_shape, :ref:`int` area_shape **)** Emitted when a :ref:`PhysicsBody2D` object enters, reporting which shapes overlapped. +---- + .. _class_Area2D_signal_body_shape_exited: - **body_shape_exited** **(** :ref:`int` body_id, :ref:`PhysicsBody2D` body, :ref:`int` body_shape, :ref:`int` area_shape **)** @@ -170,6 +184,8 @@ Property Descriptions The rate at which objects stop spinning in this area. Represents the angular velocity lost per second. Values range from ``0`` (no damping) to ``1`` (full damping). +---- + .. _class_Area2D_property_audio_bus_name: - :ref:`String` **audio_bus_name** @@ -182,6 +198,8 @@ The rate at which objects stop spinning in this area. Represents the angular vel The name of the area's audio bus. +---- + .. _class_Area2D_property_audio_bus_override: - :ref:`bool` **audio_bus_override** @@ -194,6 +212,8 @@ The name of the area's audio bus. If ``true``, the area's audio bus overrides the default audio bus. Default value: ``false``. +---- + .. _class_Area2D_property_collision_layer: - :ref:`int` **collision_layer** @@ -206,6 +226,8 @@ If ``true``, the area's audio bus overrides the default audio bus. Default value The area's physics layer(s). Collidable objects can exist in any of 32 different layers. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layers that object A scans. See also :ref:`collision_mask`. +---- + .. _class_Area2D_property_collision_mask: - :ref:`int` **collision_mask** @@ -218,6 +240,8 @@ The area's physics layer(s). Collidable objects can exist in any of 32 different The physics layers this area scans to determine collision detection. +---- + .. _class_Area2D_property_gravity: - :ref:`float` **gravity** @@ -230,6 +254,8 @@ The physics layers this area scans to determine collision detection. The area's gravity intensity (ranges from -1024 to 1024). This value multiplies the gravity vector. This is useful to alter the force of gravity without altering its direction. +---- + .. _class_Area2D_property_gravity_distance_scale: - :ref:`float` **gravity_distance_scale** @@ -242,6 +268,8 @@ The area's gravity intensity (ranges from -1024 to 1024). This value multiplies The falloff factor for point gravity. The greater the value, the faster gravity decreases with distance. +---- + .. _class_Area2D_property_gravity_point: - :ref:`bool` **gravity_point** @@ -254,6 +282,8 @@ The falloff factor for point gravity. The greater the value, the faster gravity If ``true``, gravity is calculated from a point (set via :ref:`gravity_vec`). Also see :ref:`space_override`. Default value: ``false``. +---- + .. _class_Area2D_property_gravity_vec: - :ref:`Vector2` **gravity_vec** @@ -266,6 +296,8 @@ If ``true``, gravity is calculated from a point (set via :ref:`gravity_vec`), this will be the point of attraction. +---- + .. _class_Area2D_property_linear_damp: - :ref:`float` **linear_damp** @@ -278,6 +310,8 @@ The area's gravity vector (not normalized). If gravity is a point (see :ref:`gra The rate at which objects stop moving in this area. Represents the linear velocity lost per second. Values range from ``0`` (no damping) to ``1`` (full damping). +---- + .. _class_Area2D_property_monitorable: - :ref:`bool` **monitorable** @@ -290,6 +324,8 @@ The rate at which objects stop moving in this area. Represents the linear veloci If ``true``, other monitoring areas can detect this area. Default value: ``true``. +---- + .. _class_Area2D_property_monitoring: - :ref:`bool` **monitoring** @@ -302,6 +338,8 @@ If ``true``, other monitoring areas can detect this area. Default value: ``true` If ``true``, the area detects bodies or areas entering and exiting it. Default value: ``true``. +---- + .. _class_Area2D_property_priority: - :ref:`float` **priority** @@ -314,6 +352,8 @@ If ``true``, the area detects bodies or areas entering and exiting it. Default v The area's priority. Higher priority areas are processed first. Default value: 0. +---- + .. _class_Area2D_property_space_override: - :ref:`SpaceOverride` **space_override** @@ -335,42 +375,56 @@ Method Descriptions Returns an individual bit on the layer mask. Describes whether other areas will collide with this one on the given layer. +---- + .. _class_Area2D_method_get_collision_mask_bit: - :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const Returns an individual bit on the collision mask. Describes whether this area will collide with others on the given layer. +---- + .. _class_Area2D_method_get_overlapping_areas: - :ref:`Array` **get_overlapping_areas** **(** **)** const Returns a list of intersecting ``Area2D``\ s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. +---- + .. _class_Area2D_method_get_overlapping_bodies: - :ref:`Array` **get_overlapping_bodies** **(** **)** const Returns a list of intersecting :ref:`PhysicsBody2D`\ s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. +---- + .. _class_Area2D_method_overlaps_area: - :ref:`bool` **overlaps_area** **(** :ref:`Node` area **)** const If ``true``, the given area overlaps the Area2D. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. +---- + .. _class_Area2D_method_overlaps_body: - :ref:`bool` **overlaps_body** **(** :ref:`Node` body **)** const If ``true``, the given body overlaps the Area2D. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. +---- + .. _class_Area2D_method_set_collision_layer_bit: - 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_method_set_collision_mask_bit: - void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** diff --git a/classes/class_array.rst b/classes/class_array.rst index c7fc32bc9..b69fe0bb1 100644 --- a/classes/class_array.rst +++ b/classes/class_array.rst @@ -118,66 +118,92 @@ Method Descriptions Constructs an array from a :ref:`PoolColorArray`. +---- + - :ref:`Array` **Array** **(** :ref:`PoolVector3Array` from **)** Constructs an array from a :ref:`PoolVector3Array`. +---- + - :ref:`Array` **Array** **(** :ref:`PoolVector2Array` from **)** Constructs an array from a :ref:`PoolVector2Array`. +---- + - :ref:`Array` **Array** **(** :ref:`PoolStringArray` from **)** Constructs an array from a :ref:`PoolStringArray`. +---- + - :ref:`Array` **Array** **(** :ref:`PoolRealArray` from **)** Constructs an array from a :ref:`PoolRealArray`. +---- + - :ref:`Array` **Array** **(** :ref:`PoolIntArray` from **)** Constructs an array from a :ref:`PoolIntArray`. +---- + - :ref:`Array` **Array** **(** :ref:`PoolByteArray` from **)** Constructs an array from a :ref:`PoolByteArray`. +---- + .. _class_Array_method_append: - void **append** **(** :ref:`Variant` value **)** Appends an element at the end of the array (alias of :ref:`push_back`). +---- + .. _class_Array_method_back: - :ref:`Variant` **back** **(** **)** Returns the last element of the array if the array is not empty. +---- + .. _class_Array_method_bsearch: - :ref:`int` **bsearch** **(** :ref:`Variant` value, :ref:`bool` before=True **)** Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a before specifier can be passed. If ``false``, the returned index comes after all existing entries of the value in the array. Note that calling bsearch on an unsorted array results in unexpected behavior. +---- + .. _class_Array_method_bsearch_custom: - :ref:`int` **bsearch_custom** **(** :ref:`Variant` value, :ref:`Object` obj, :ref:`String` func, :ref:`bool` before=True **)** Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search and a custom comparison method. Optionally, a before specifier can be passed. If ``false``, the returned index comes after all existing entries of the value in the array. The custom method receives two arguments (an element from the array and the value searched for) and must return ``true`` if the first argument is less than the second, and return ``false`` otherwise. Note that calling bsearch on an unsorted array results in unexpected behavior. +---- + .. _class_Array_method_clear: - void **clear** **(** **)** Clears the array (resizes to 0). +---- + .. _class_Array_method_count: - :ref:`int` **count** **(** :ref:`Variant` value **)** Returns the number of times an element is in the array. +---- + .. _class_Array_method_duplicate: - :ref:`Array` **duplicate** **(** :ref:`bool` deep=False **)** @@ -186,36 +212,48 @@ Returns a copy of the array. If ``deep`` is ``true``, a deep copy is performed: all nested arrays and dictionaries are duplicated and will not be shared with the original array. If ``false``, a shallow copy is made and references to the original nested arrays and dictionaries are kept, so that modifying a sub-array or dictionary in the copy will also impact those referenced in the source array. +---- + .. _class_Array_method_empty: - :ref:`bool` **empty** **(** **)** Returns ``true`` if the array is empty. +---- + .. _class_Array_method_erase: - void **erase** **(** :ref:`Variant` value **)** Removes the first occurrence of a value from the array. +---- + .. _class_Array_method_find: - :ref:`int` **find** **(** :ref:`Variant` 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_method_find_last: - :ref:`int` **find_last** **(** :ref:`Variant` value **)** Searches the array in reverse order for a value and returns its index or -1 if not found. +---- + .. _class_Array_method_front: - :ref:`Variant` **front** **(** **)** Returns the first element of the array if the array is not empty. +---- + .. _class_Array_method_has: - :ref:`bool` **has** **(** :ref:`Variant` value **)** @@ -229,96 +267,128 @@ Returns ``true`` if the array contains the given value. ["inside", 7].has(7) == true ["inside", 7].has("7") == false +---- + .. _class_Array_method_hash: - :ref:`int` **hash** **(** **)** Returns a hashed integer value representing the array contents. +---- + .. _class_Array_method_insert: - void **insert** **(** :ref:`int` position, :ref:`Variant` value **)** Inserts 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_method_invert: - void **invert** **(** **)** Reverses the order of the elements in the array. +---- + .. _class_Array_method_max: - :ref:`Variant` **max** **(** **)** Returns the maximum value contained in the array if all elements are of comparable types. If the elements can't be compared, ``null`` is returned. +---- + .. _class_Array_method_min: - :ref:`Variant` **min** **(** **)** Returns the minimum value contained in the array if all elements are of comparable types. If the elements can't be compared, ``null`` is returned. +---- + .. _class_Array_method_pop_back: - :ref:`Variant` **pop_back** **(** **)** Removes the last element of the array. +---- + .. _class_Array_method_pop_front: - :ref:`Variant` **pop_front** **(** **)** Removes the first element of the array. +---- + .. _class_Array_method_push_back: - void **push_back** **(** :ref:`Variant` value **)** Appends an element at the end of the array. +---- + .. _class_Array_method_push_front: - void **push_front** **(** :ref:`Variant` value **)** Adds an element at the beginning of the array. +---- + .. _class_Array_method_remove: - void **remove** **(** :ref:`int` position **)** Removes an element from the array by index. +---- + .. _class_Array_method_resize: - void **resize** **(** :ref:`int` size **)** Resizes 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_method_rfind: - :ref:`int` **rfind** **(** :ref:`Variant` 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_method_shuffle: - void **shuffle** **(** **)** Shuffles the array such that the items will have a random order. This method uses the global random number generator common to methods such as :ref:`@GDScript.randi`. Call :ref:`@GDScript.randomize` to ensure that a new seed will be used each time if you want non-reproducible shuffling. +---- + .. _class_Array_method_size: - :ref:`int` **size** **(** **)** Returns the number of elements in the array. +---- + .. _class_Array_method_sort: - void **sort** **(** **)** Sorts the array. Note: strings are sorted in alphabetical, not natural order. +---- + .. _class_Array_method_sort_custom: - void **sort_custom** **(** :ref:`Object` obj, :ref:`String` func **)** diff --git a/classes/class_arraymesh.rst b/classes/class_arraymesh.rst index fcf85a4cc..76b82d228 100644 --- a/classes/class_arraymesh.rst +++ b/classes/class_arraymesh.rst @@ -115,6 +115,8 @@ For triangles, the index array is interpreted as triples, referring to the verti - **ARRAY_MAX** = **9** --- Represents the size of the :ref:`ArrayType` enum. +---- + .. _enum_ArrayMesh_ArrayFormat: .. _class_ArrayMesh_constant_ARRAY_FORMAT_VERTEX: @@ -202,6 +204,8 @@ Property Descriptions | *Getter* | get_blend_shape_mode() | +----------+-----------------------------+ +---- + .. _class_ArrayMesh_property_custom_aabb: - :ref:`AABB` **custom_aabb** @@ -223,6 +227,8 @@ Method Descriptions Add name for a blend shape that will be added with :ref:`add_surface_from_arrays`. Must be called before surface is added. +---- + .. _class_ArrayMesh_method_add_surface_from_arrays: - void **add_surface_from_arrays** **(** :ref:`PrimitiveType` primitive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[ ], :ref:`int` compress_flags=97280 **)** @@ -237,90 +243,120 @@ Adding an index array puts this function into "index mode" where the vertex and Godot uses clockwise winding order for front faces of triangle primitive modes. +---- + .. _class_ArrayMesh_method_clear_blend_shapes: - void **clear_blend_shapes** **(** **)** Remove all blend shapes from this ``ArrayMesh``. +---- + .. _class_ArrayMesh_method_get_blend_shape_count: - :ref:`int` **get_blend_shape_count** **(** **)** const Returns the number of blend shapes that the ``ArrayMesh`` holds. +---- + .. _class_ArrayMesh_method_get_blend_shape_name: - :ref:`String` **get_blend_shape_name** **(** :ref:`int` index **)** const Returns the name of the blend shape at this index. +---- + .. _class_ArrayMesh_method_lightmap_unwrap: - :ref:`Error` **lightmap_unwrap** **(** :ref:`Transform` transform, :ref:`float` texel_size **)** Will perform a UV unwrap on the ``ArrayMesh`` to prepare the mesh for lightmapping. +---- + .. _class_ArrayMesh_method_regen_normalmaps: - void **regen_normalmaps** **(** **)** Will regenerate normal maps for the ``ArrayMesh``. +---- + .. _class_ArrayMesh_method_surface_find_by_name: - :ref:`int` **surface_find_by_name** **(** :ref:`String` name **)** const Returns the index of the first surface with this name held within this ``ArrayMesh``. If none are found -1 is returned. +---- + .. _class_ArrayMesh_method_surface_get_array_index_len: - :ref:`int` **surface_get_array_index_len** **(** :ref:`int` surf_idx **)** const Returns the length in indices of the index array in the requested surface (see :ref:`add_surface_from_arrays`). +---- + .. _class_ArrayMesh_method_surface_get_array_len: - :ref:`int` **surface_get_array_len** **(** :ref:`int` surf_idx **)** const Returns the length in vertices of the vertex array in the requested surface (see :ref:`add_surface_from_arrays`). +---- + .. _class_ArrayMesh_method_surface_get_format: - :ref:`int` **surface_get_format** **(** :ref:`int` surf_idx **)** const Returns the format mask of the requested surface (see :ref:`add_surface_from_arrays`). +---- + .. _class_ArrayMesh_method_surface_get_name: - :ref:`String` **surface_get_name** **(** :ref:`int` surf_idx **)** const Get the name assigned to this surface. +---- + .. _class_ArrayMesh_method_surface_get_primitive_type: - :ref:`PrimitiveType` **surface_get_primitive_type** **(** :ref:`int` surf_idx **)** const Returns the primitive type of the requested surface (see :ref:`add_surface_from_arrays`). +---- + .. _class_ArrayMesh_method_surface_remove: - void **surface_remove** **(** :ref:`int` surf_idx **)** Remove a surface at position surf_idx, shifting greater surfaces one surf_idx slot down. +---- + .. _class_ArrayMesh_method_surface_set_material: - void **surface_set_material** **(** :ref:`int` surf_idx, :ref:`Material` material **)** Set a :ref:`Material` for a given surface. Surface will be rendered using this material. +---- + .. _class_ArrayMesh_method_surface_set_name: - void **surface_set_name** **(** :ref:`int` surf_idx, :ref:`String` name **)** Set a name for a given surface. +---- + .. _class_ArrayMesh_method_surface_update_region: - void **surface_update_region** **(** :ref:`int` surf_idx, :ref:`int` offset, :ref:`PoolByteArray` data **)** diff --git a/classes/class_arvranchor.rst b/classes/class_arvranchor.rst index ca93c2373..60291c71c 100644 --- a/classes/class_arvranchor.rst +++ b/classes/class_arvranchor.rst @@ -71,18 +71,24 @@ Method Descriptions Returns the name given to this anchor. +---- + .. _class_ARVRAnchor_method_get_is_active: - :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_method_get_plane: - :ref:`Plane` **get_plane** **(** **)** const Returns a plane aligned with our anchor; handy for intersection testing. +---- + .. _class_ARVRAnchor_method_get_size: - :ref:`Vector3` **get_size** **(** **)** const diff --git a/classes/class_arvrcontroller.rst b/classes/class_arvrcontroller.rst index 52f3cd7b1..cc4b8e166 100644 --- a/classes/class_arvrcontroller.rst +++ b/classes/class_arvrcontroller.rst @@ -53,6 +53,8 @@ Signals Emitted when a button on this controller is pressed. +---- + .. _class_ARVRController_signal_button_release: - **button_release** **(** :ref:`int` button **)** @@ -89,6 +91,8 @@ For any other controller that the :ref:`ARVRServer` detects, w When a controller is turned off, its slot is freed. This ensures controllers will keep the same id even when controllers with lower ids are turned off. +---- + .. _class_ARVRController_property_rumble: - :ref:`float` **rumble** @@ -110,30 +114,40 @@ Method Descriptions If active, returns the name of the associated controller if provided by the AR/VR SDK used. +---- + .. _class_ARVRController_method_get_hand: - :ref:`TrackerHand` **get_hand** **(** **)** const Returns the hand holding this controller, if known. See TRACKER\_\* constants in :ref:`ARVRPositionalTracker`. +---- + .. _class_ARVRController_method_get_is_active: - :ref:`bool` **get_is_active** **(** **)** const Returns ``true`` if the bound controller is active. ARVR systems attempt to track active controllers. +---- + .. _class_ARVRController_method_get_joystick_axis: - :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_method_get_joystick_id: - :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_method_is_button_pressed: - :ref:`int` **is_button_pressed** **(** :ref:`int` button **)** const diff --git a/classes/class_arvrinterface.rst b/classes/class_arvrinterface.rst index 6b52443df..2c61a809e 100644 --- a/classes/class_arvrinterface.rst +++ b/classes/class_arvrinterface.rst @@ -77,6 +77,8 @@ enum **Capabilities**: - **ARVR_EXTERNAL** = **8** --- This interface outputs to an external device, if the main viewport is used the on screen output is an unmodified buffer of either the left or right eye (stretched if the viewport size is not changed to the same aspect ratio of get_render_targetsize. Using a separate viewport node frees up the main viewport for other purposes. +---- + .. _enum_ARVRInterface_Eyes: .. _class_ARVRInterface_constant_EYE_MONO: @@ -93,6 +95,8 @@ enum **Eyes**: - **EYE_RIGHT** = **2** --- Right eye output, this is mostly used internally when rendering the image for the right eye and obtaining positioning and projection information. +---- + .. _enum_ARVRInterface_Tracking_status: .. _class_ARVRInterface_constant_ARVR_NORMAL_TRACKING: @@ -139,6 +143,8 @@ Property Descriptions On an AR interface, is our anchor detection enabled? +---- + .. _class_ARVRInterface_property_interface_is_initialized: - :ref:`bool` **interface_is_initialized** @@ -151,6 +157,8 @@ On an AR interface, is our anchor detection enabled? Has this interface been initialized? +---- + .. _class_ARVRInterface_property_interface_is_primary: - :ref:`bool` **interface_is_primary** @@ -172,24 +180,32 @@ Method Descriptions Returns a combination of flags providing information about the capabilities of this interface. +---- + .. _class_ARVRInterface_method_get_name: - :ref:`String` **get_name** **(** **)** const Returns the name of this interface (OpenVR, OpenHMD, ARKit, etc). +---- + .. _class_ARVRInterface_method_get_render_targetsize: - :ref:`Vector2` **get_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_method_get_tracking_status: - :ref:`Tracking_status` **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_method_initialize: - :ref:`bool` **initialize** **(** **)** @@ -204,12 +220,16 @@ If you do this for a platform that handles its own output (such as OpenVR) Godot While currently not used you can activate additional interfaces, you may wish to do this if you want to track controllers from other platforms. However at this point in time only one interface can render to an HMD. +---- + .. _class_ARVRInterface_method_is_stereo: - :ref:`bool` **is_stereo** **(** **)** Returns ``true`` if the current output of this interface is in stereo. +---- + .. _class_ARVRInterface_method_uninitialize: - void **uninitialize** **(** **)** diff --git a/classes/class_arvrpositionaltracker.rst b/classes/class_arvrpositionaltracker.rst index 70f5557e8..ea8716209 100644 --- a/classes/class_arvrpositionaltracker.rst +++ b/classes/class_arvrpositionaltracker.rst @@ -100,48 +100,64 @@ Method Descriptions Returns the hand holding this tracker, if known. See TRACKER\_\* constants. +---- + .. _class_ARVRPositionalTracker_method_get_joy_id: - :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_method_get_name: - :ref:`String` **get_name** **(** **)** const Returns the controller or anchor point's name if available. +---- + .. _class_ARVRPositionalTracker_method_get_orientation: - :ref:`Basis` **get_orientation** **(** **)** const Returns the controller's orientation matrix. +---- + .. _class_ARVRPositionalTracker_method_get_position: - :ref:`Vector3` **get_position** **(** **)** const Returns the world-space controller position. +---- + .. _class_ARVRPositionalTracker_method_get_tracks_orientation: - :ref:`bool` **get_tracks_orientation** **(** **)** const Returns ``true`` if this device tracks orientation. +---- + .. _class_ARVRPositionalTracker_method_get_tracks_position: - :ref:`bool` **get_tracks_position** **(** **)** const Returns ``true`` if this device tracks position. +---- + .. _class_ARVRPositionalTracker_method_get_transform: - :ref:`Transform` **get_transform** **(** :ref:`bool` adjust_by_reference_frame **)** const Returns the transform combining this device's orientation and position. +---- + .. _class_ARVRPositionalTracker_method_get_type: - :ref:`TrackerType` **get_type** **(** **)** const diff --git a/classes/class_arvrserver.rst b/classes/class_arvrserver.rst index f57925906..7ed0a25a5 100644 --- a/classes/class_arvrserver.rst +++ b/classes/class_arvrserver.rst @@ -65,18 +65,24 @@ Signals Signal send when a new interface has been added. +---- + .. _class_ARVRServer_signal_interface_removed: - **interface_removed** **(** :ref:`String` interface_name **)** Signal send when an interface is removed. +---- + .. _class_ARVRServer_signal_tracker_added: - **tracker_added** **(** :ref:`String` tracker_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_signal_tracker_removed: - **tracker_removed** **(** :ref:`String` tracker_name, :ref:`int` type, :ref:`int` id **)** @@ -114,6 +120,8 @@ enum **TrackerType**: - **TRACKER_ANY** = **255** --- Used internally to select all trackers. +---- + .. _enum_ARVRServer_RotationMode: .. _class_ARVRServer_constant_RESET_FULL_ROTATION: @@ -148,6 +156,8 @@ Property Descriptions | *Getter* | get_primary_interface() | +----------+------------------------------+ +---- + .. _class_ARVRServer_property_world_scale: - :ref:`float` **world_scale** @@ -179,60 +189,82 @@ For this method to produce usable results tracking information should be availab You should call this method after a few seconds have passed, when the user requests a realignment of the display holding a designated button on a controller for a short period of time, and when implementing a teleport mechanism. +---- + .. _class_ARVRServer_method_find_interface: - :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_method_get_hmd_transform: - :ref:`Transform` **get_hmd_transform** **(** **)** Returns the primary interface's transformation. +---- + .. _class_ARVRServer_method_get_interface: - :ref:`ARVRInterface` **get_interface** **(** :ref:`int` idx **)** const Get the interface registered at a given index in our list of interfaces. +---- + .. _class_ARVRServer_method_get_interface_count: - :ref:`int` **get_interface_count** **(** **)** const Get the number of interfaces currently registered with the AR/VR server. If your game supports multiple AR/VR platforms, you can look through 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_method_get_interfaces: - :ref:`Array` **get_interfaces** **(** **)** const Returns a list of available interfaces with both id and name of the interface. +---- + .. _class_ARVRServer_method_get_last_commit_usec: - :ref:`int` **get_last_commit_usec** **(** **)** +---- + .. _class_ARVRServer_method_get_last_frame_usec: - :ref:`int` **get_last_frame_usec** **(** **)** +---- + .. _class_ARVRServer_method_get_last_process_usec: - :ref:`int` **get_last_process_usec** **(** **)** +---- + .. _class_ARVRServer_method_get_reference_frame: - :ref:`Transform` **get_reference_frame** **(** **)** const Gets our reference frame transform, mostly used internally and exposed for GDNative build interfaces. +---- + .. _class_ARVRServer_method_get_tracker: - :ref:`ARVRPositionalTracker` **get_tracker** **(** :ref:`int` idx **)** const Get the positional tracker at the given ID. +---- + .. _class_ARVRServer_method_get_tracker_count: - :ref:`int` **get_tracker_count** **(** **)** const diff --git a/classes/class_astar.rst b/classes/class_astar.rst index fca323697..01bcb170f 100644 --- a/classes/class_astar.rst +++ b/classes/class_astar.rst @@ -83,12 +83,16 @@ Method Descriptions Called when computing the cost between two connected points. +---- + .. _class_AStar_method__estimate_cost: - :ref:`float` **_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_method_add_point: - void **add_point** **(** :ref:`int` id, :ref:`Vector3` position, :ref:`float` weight_scale=1.0 **)** @@ -102,18 +106,24 @@ Adds a new point at the given position with the given identifier. The algorithm If there already exists a point for the given id, its position and weight scale are updated to the given values. +---- + .. _class_AStar_method_are_points_connected: - :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_method_clear: - void **clear** **(** **)** Clears all the points and segments. +---- + .. _class_AStar_method_connect_points: - void **connect_points** **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** @@ -127,24 +137,32 @@ Creates a segment between the given points. If ``bidirectional`` is ``false``, o astar.add_point(2, Vector3(0, 5, 0)) astar.connect_points(1, 2, false) +---- + .. _class_AStar_method_disconnect_points: - void **disconnect_points** **(** :ref:`int` id, :ref:`int` to_id **)** Deletes the segment between the given points. +---- + .. _class_AStar_method_get_available_point_id: - :ref:`int` **get_available_point_id** **(** **)** const Returns the next available point id with no point associated to it. +---- + .. _class_AStar_method_get_closest_point: - :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_method_get_closest_position_in_segment: - :ref:`Vector3` **get_closest_position_in_segment** **(** :ref:`Vector3` to_position **)** const @@ -161,6 +179,8 @@ Returns the closest position to ``to_position`` that resides inside a segment be The result is in the segment that goes from ``y = 0`` to ``y = 5``. It's the closest position in the segment to the given point. +---- + .. _class_AStar_method_get_id_path: - :ref:`PoolIntArray` **get_id_path** **(** :ref:`int` from_id, :ref:`int` to_id **)** @@ -184,6 +204,8 @@ Returns an array with the ids of the points that form the path found by AStar be If you change the 2nd point's weight to 3, then the result will be ``[1, 4, 3]`` instead, because now even though the distance is longer, it's "easier" to get through point 4 than through point 2. +---- + .. _class_AStar_method_get_point_connections: - :ref:`PoolIntArray` **get_point_connections** **(** :ref:`int` id **)** @@ -203,60 +225,80 @@ Returns an array with the ids of the points that form the connect with the given var neighbors = astar.get_point_connections(1) # Returns [2, 3] +---- + .. _class_AStar_method_get_point_path: - :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_method_get_point_position: - :ref:`Vector3` **get_point_position** **(** :ref:`int` id **)** const Returns the position of the point associated with the given id. +---- + .. _class_AStar_method_get_point_weight_scale: - :ref:`float` **get_point_weight_scale** **(** :ref:`int` id **)** const Returns the weight scale of the point associated with the given id. +---- + .. _class_AStar_method_get_points: - :ref:`Array` **get_points** **(** **)** Returns an array of all points. +---- + .. _class_AStar_method_has_point: - :ref:`bool` **has_point** **(** :ref:`int` id **)** const Returns whether a point associated with the given id exists. +---- + .. _class_AStar_method_is_point_disabled: - :ref:`bool` **is_point_disabled** **(** :ref:`int` id **)** const Returns whether a point is disabled or not for pathfinding. By default, all points are enabled. +---- + .. _class_AStar_method_remove_point: - void **remove_point** **(** :ref:`int` id **)** Removes the point associated with the given id from the points pool. +---- + .. _class_AStar_method_set_point_disabled: - void **set_point_disabled** **(** :ref:`int` id, :ref:`bool` disabled=true **)** Disables or enables the specified point for pathfinding. Useful for making a temporary obstacle. +---- + .. _class_AStar_method_set_point_position: - void **set_point_position** **(** :ref:`int` id, :ref:`Vector3` position **)** Sets the position for the point with the given id. +---- + .. _class_AStar_method_set_point_weight_scale: - void **set_point_weight_scale** **(** :ref:`int` id, :ref:`float` weight_scale **)** diff --git a/classes/class_atlastexture.rst b/classes/class_atlastexture.rst index cf764e4dc..f2fbccde5 100644 --- a/classes/class_atlastexture.rst +++ b/classes/class_atlastexture.rst @@ -53,6 +53,8 @@ Property Descriptions The texture that contains the atlas. Can be any :ref:`Texture` subtype. +---- + .. _class_AtlasTexture_property_filter_clip: - :ref:`bool` **filter_clip** @@ -65,6 +67,8 @@ The texture that contains the atlas. Can be any :ref:`Texture` su If ``true``, clips the area outside of the region to avoid bleeding of the surrounding texture pixels. +---- + .. _class_AtlasTexture_property_margin: - :ref:`Rect2` **margin** @@ -77,6 +81,8 @@ If ``true``, clips the area outside of the region to avoid bleeding of the surro The margin around the region. The :ref:`Rect2`'s 'size' parameter ('w' and 'h' in the editor) resizes the texture so it fits within the margin. +---- + .. _class_AtlasTexture_property_region: - :ref:`Rect2` **region** diff --git a/classes/class_audioeffectchorus.rst b/classes/class_audioeffectchorus.rst index 2de249665..451739113 100644 --- a/classes/class_audioeffectchorus.rst +++ b/classes/class_audioeffectchorus.rst @@ -97,6 +97,8 @@ Property Descriptions The effect's raw signal. +---- + .. _class_AudioEffectChorus_property_voice/1/cutoff_hz: - :ref:`float` **voice/1/cutoff_hz** @@ -109,6 +111,8 @@ The effect's raw signal. The voice's cutoff frequency. +---- + .. _class_AudioEffectChorus_property_voice/1/delay_ms: - :ref:`float` **voice/1/delay_ms** @@ -121,6 +125,8 @@ The voice's cutoff frequency. The voice's signal delay. +---- + .. _class_AudioEffectChorus_property_voice/1/depth_ms: - :ref:`float` **voice/1/depth_ms** @@ -133,6 +139,8 @@ The voice's signal delay. The voice filter's depth. +---- + .. _class_AudioEffectChorus_property_voice/1/level_db: - :ref:`float` **voice/1/level_db** @@ -145,6 +153,8 @@ The voice filter's depth. The voice's volume. +---- + .. _class_AudioEffectChorus_property_voice/1/pan: - :ref:`float` **voice/1/pan** @@ -157,6 +167,8 @@ The voice's volume. The voice's pan level. +---- + .. _class_AudioEffectChorus_property_voice/1/rate_hz: - :ref:`float` **voice/1/rate_hz** @@ -169,6 +181,8 @@ The voice's pan level. The voice's filter rate. +---- + .. _class_AudioEffectChorus_property_voice/2/cutoff_hz: - :ref:`float` **voice/2/cutoff_hz** @@ -181,6 +195,8 @@ The voice's filter rate. The voice's cutoff frequency. +---- + .. _class_AudioEffectChorus_property_voice/2/delay_ms: - :ref:`float` **voice/2/delay_ms** @@ -193,6 +209,8 @@ The voice's cutoff frequency. The voice's signal delay. +---- + .. _class_AudioEffectChorus_property_voice/2/depth_ms: - :ref:`float` **voice/2/depth_ms** @@ -205,6 +223,8 @@ The voice's signal delay. The voice filter's depth. +---- + .. _class_AudioEffectChorus_property_voice/2/level_db: - :ref:`float` **voice/2/level_db** @@ -217,6 +237,8 @@ The voice filter's depth. The voice's volume. +---- + .. _class_AudioEffectChorus_property_voice/2/pan: - :ref:`float` **voice/2/pan** @@ -229,6 +251,8 @@ The voice's volume. The voice's pan level. +---- + .. _class_AudioEffectChorus_property_voice/2/rate_hz: - :ref:`float` **voice/2/rate_hz** @@ -241,6 +265,8 @@ The voice's pan level. The voice's filter rate. +---- + .. _class_AudioEffectChorus_property_voice/3/cutoff_hz: - :ref:`float` **voice/3/cutoff_hz** @@ -253,6 +279,8 @@ The voice's filter rate. The voice's cutoff frequency. +---- + .. _class_AudioEffectChorus_property_voice/3/delay_ms: - :ref:`float` **voice/3/delay_ms** @@ -265,6 +293,8 @@ The voice's cutoff frequency. The voice's signal delay. +---- + .. _class_AudioEffectChorus_property_voice/3/depth_ms: - :ref:`float` **voice/3/depth_ms** @@ -277,6 +307,8 @@ The voice's signal delay. The voice filter's depth. +---- + .. _class_AudioEffectChorus_property_voice/3/level_db: - :ref:`float` **voice/3/level_db** @@ -289,6 +321,8 @@ The voice filter's depth. The voice's volume. +---- + .. _class_AudioEffectChorus_property_voice/3/pan: - :ref:`float` **voice/3/pan** @@ -301,6 +335,8 @@ The voice's volume. The voice's pan level. +---- + .. _class_AudioEffectChorus_property_voice/3/rate_hz: - :ref:`float` **voice/3/rate_hz** @@ -313,6 +349,8 @@ The voice's pan level. The voice's filter rate. +---- + .. _class_AudioEffectChorus_property_voice/4/cutoff_hz: - :ref:`float` **voice/4/cutoff_hz** @@ -325,6 +363,8 @@ The voice's filter rate. The voice's cutoff frequency. +---- + .. _class_AudioEffectChorus_property_voice/4/delay_ms: - :ref:`float` **voice/4/delay_ms** @@ -337,6 +377,8 @@ The voice's cutoff frequency. The voice's signal delay. +---- + .. _class_AudioEffectChorus_property_voice/4/depth_ms: - :ref:`float` **voice/4/depth_ms** @@ -349,6 +391,8 @@ The voice's signal delay. The voice filter's depth. +---- + .. _class_AudioEffectChorus_property_voice/4/level_db: - :ref:`float` **voice/4/level_db** @@ -361,6 +405,8 @@ The voice filter's depth. The voice's volume. +---- + .. _class_AudioEffectChorus_property_voice/4/pan: - :ref:`float` **voice/4/pan** @@ -373,6 +419,8 @@ The voice's volume. The voice's pan level. +---- + .. _class_AudioEffectChorus_property_voice/4/rate_hz: - :ref:`float` **voice/4/rate_hz** @@ -385,6 +433,8 @@ The voice's pan level. The voice's filter rate. +---- + .. _class_AudioEffectChorus_property_voice_count: - :ref:`int` **voice_count** @@ -397,6 +447,8 @@ The voice's filter rate. The amount of voices in the effect. +---- + .. _class_AudioEffectChorus_property_wet: - :ref:`float` **wet** diff --git a/classes/class_audioeffectcompressor.rst b/classes/class_audioeffectcompressor.rst index d75d21197..072dd1b38 100644 --- a/classes/class_audioeffectcompressor.rst +++ b/classes/class_audioeffectcompressor.rst @@ -69,6 +69,8 @@ Property Descriptions Compressor's reaction time when the signal exceeds the threshold. Value can range from 20 to 2000. Default value: ``20ms``. +---- + .. _class_AudioEffectCompressor_property_gain: - :ref:`float` **gain** @@ -81,6 +83,8 @@ Compressor's reaction time when the signal exceeds the threshold. Value can rang Gain applied to the output signal. +---- + .. _class_AudioEffectCompressor_property_mix: - :ref:`float` **mix** @@ -93,6 +97,8 @@ Gain applied to the output signal. Balance between original signal and effect signal. Value can range from 0 (totally dry) to 1 (totally wet). Default value: ``1``. +---- + .. _class_AudioEffectCompressor_property_ratio: - :ref:`float` **ratio** @@ -105,6 +111,8 @@ Balance between original signal and effect signal. Value can range from 0 (total Amount of compression applied to the audio once it passes the threshold level. The higher the ratio the more the loud parts of the audio will be compressed. Value can range from 1 to 48. Default value: ``4``. +---- + .. _class_AudioEffectCompressor_property_release_ms: - :ref:`float` **release_ms** @@ -117,6 +125,8 @@ Amount of compression applied to the audio once it passes the threshold level. T Compressor's delay time to stop reducing the signal after the signal level falls below the threshold. Value can range from 20 to 2000. Default value: ``250ms``. +---- + .. _class_AudioEffectCompressor_property_sidechain: - :ref:`String` **sidechain** @@ -129,6 +139,8 @@ Compressor's delay time to stop reducing the signal after the signal level falls Reduce the sound level using another audio bus for threshold detection. +---- + .. _class_AudioEffectCompressor_property_threshold: - :ref:`float` **threshold** diff --git a/classes/class_audioeffectdelay.rst b/classes/class_audioeffectdelay.rst index f48449c28..618bce2d9 100644 --- a/classes/class_audioeffectdelay.rst +++ b/classes/class_audioeffectdelay.rst @@ -71,6 +71,8 @@ Property Descriptions Output percent of original sound. At 0, only delayed sounds are output. Value can range from 0 to 1. Default value: ``1``. +---- + .. _class_AudioEffectDelay_property_feedback/active: - :ref:`bool` **feedback/active** @@ -83,6 +85,8 @@ Output percent of original sound. At 0, only delayed sounds are output. Value ca If ``true``, feedback is enabled. Default value: ``false``. +---- + .. _class_AudioEffectDelay_property_feedback/delay_ms: - :ref:`float` **feedback/delay_ms** @@ -95,6 +99,8 @@ If ``true``, feedback is enabled. Default value: ``false``. Feedback delay time in milliseconds. Default value: ``340``. +---- + .. _class_AudioEffectDelay_property_feedback/level_db: - :ref:`float` **feedback/level_db** @@ -107,6 +113,8 @@ Feedback delay time in milliseconds. Default value: ``340``. Sound level for ``tap1``. Default value: ``-6 dB``. +---- + .. _class_AudioEffectDelay_property_feedback/lowpass: - :ref:`float` **feedback/lowpass** @@ -119,6 +127,8 @@ Sound level for ``tap1``. Default value: ``-6 dB``. Low-pass filter for feedback. Frequencies below the Low Cut value are filtered out of the source signal. Default value: ``16000``. +---- + .. _class_AudioEffectDelay_property_tap1/active: - :ref:`bool` **tap1/active** @@ -131,6 +141,8 @@ Low-pass filter for feedback. Frequencies below the Low Cut value are filtered o If ``true``, ``tap1`` will be enabled. Default value: ``true``. +---- + .. _class_AudioEffectDelay_property_tap1/delay_ms: - :ref:`float` **tap1/delay_ms** @@ -143,6 +155,8 @@ If ``true``, ``tap1`` will be enabled. Default value: ``true``. **Tap1** delay time in milliseconds. Default value: ``250ms``. +---- + .. _class_AudioEffectDelay_property_tap1/level_db: - :ref:`float` **tap1/level_db** @@ -155,6 +169,8 @@ If ``true``, ``tap1`` will be enabled. Default value: ``true``. Sound level for ``tap1``. Default value: ``-6 dB``. +---- + .. _class_AudioEffectDelay_property_tap1/pan: - :ref:`float` **tap1/pan** @@ -167,6 +183,8 @@ Sound level for ``tap1``. Default value: ``-6 dB``. Pan position for ``tap1``. Value can range from -1 (fully left) to 1 (fully right). Default value: ``0.2``. +---- + .. _class_AudioEffectDelay_property_tap2/active: - :ref:`bool` **tap2/active** @@ -179,6 +197,8 @@ Pan position for ``tap1``. Value can range from -1 (fully left) to 1 (fully righ If ``true``, ``tap2`` will be enabled. Default value: ``true``. +---- + .. _class_AudioEffectDelay_property_tap2/delay_ms: - :ref:`float` **tap2/delay_ms** @@ -191,6 +211,8 @@ If ``true``, ``tap2`` will be enabled. Default value: ``true``. **Tap2** delay time in milliseconds. Default value: ``500ms``. +---- + .. _class_AudioEffectDelay_property_tap2/level_db: - :ref:`float` **tap2/level_db** @@ -203,6 +225,8 @@ If ``true``, ``tap2`` will be enabled. Default value: ``true``. Sound level for ``tap2``. Default value: ``-12 dB``. +---- + .. _class_AudioEffectDelay_property_tap2/pan: - :ref:`float` **tap2/pan** diff --git a/classes/class_audioeffectdistortion.rst b/classes/class_audioeffectdistortion.rst index 4e116f996..567e02f87 100644 --- a/classes/class_audioeffectdistortion.rst +++ b/classes/class_audioeffectdistortion.rst @@ -84,6 +84,8 @@ Property Descriptions Distortion power. Value can range from 0 to 1. Default value: ``0``. +---- + .. _class_AudioEffectDistortion_property_keep_hf_hz: - :ref:`float` **keep_hf_hz** @@ -96,6 +98,8 @@ Distortion power. Value can range from 0 to 1. Default value: ``0``. High-pass filter. Frequencies higher than this value will not be affected by the distortion. Value can range from 1 to 20000. Default value: ``16000``. +---- + .. _class_AudioEffectDistortion_property_mode: - :ref:`Mode` **mode** @@ -108,6 +112,8 @@ High-pass filter. Frequencies higher than this value will not be affected by the Distortion type. Default value: :ref:`MODE_CLIP`. +---- + .. _class_AudioEffectDistortion_property_post_gain: - :ref:`float` **post_gain** @@ -120,6 +126,8 @@ Distortion type. Default value: :ref:`MODE_CLIP` **pre_gain** diff --git a/classes/class_audioeffecteq.rst b/classes/class_audioeffecteq.rst index 9431cad27..3c6f2e14d 100644 --- a/classes/class_audioeffecteq.rst +++ b/classes/class_audioeffecteq.rst @@ -47,12 +47,16 @@ Method Descriptions Returns the number of bands of the equalizer. +---- + .. _class_AudioEffectEQ_method_get_band_gain_db: - :ref:`float` **get_band_gain_db** **(** :ref:`int` band_idx **)** const Returns the band's gain at the specified index, in dB. +---- + .. _class_AudioEffectEQ_method_set_band_gain_db: - void **set_band_gain_db** **(** :ref:`int` band_idx, :ref:`float` volume_db **)** diff --git a/classes/class_audioeffectfilter.rst b/classes/class_audioeffectfilter.rst index c029a4292..35ebdc3c2 100644 --- a/classes/class_audioeffectfilter.rst +++ b/classes/class_audioeffectfilter.rst @@ -76,6 +76,8 @@ Property Descriptions Threshold frequency for the filter. +---- + .. _class_AudioEffectFilter_property_db: - :ref:`FilterDB` **db** @@ -86,6 +88,8 @@ Threshold frequency for the filter. | *Getter* | get_db() | +----------+---------------+ +---- + .. _class_AudioEffectFilter_property_gain: - :ref:`float` **gain** @@ -98,6 +102,8 @@ Threshold frequency for the filter. Gain amount of the frequencies after the filter. +---- + .. _class_AudioEffectFilter_property_resonance: - :ref:`float` **resonance** diff --git a/classes/class_audioeffectlimiter.rst b/classes/class_audioeffectlimiter.rst index e10caed9a..7a5df803a 100644 --- a/classes/class_audioeffectlimiter.rst +++ b/classes/class_audioeffectlimiter.rst @@ -53,6 +53,8 @@ Property Descriptions The waveform's maximum allowed value. Value can range from -20 to -0.1. Default value: ``-0.1dB``. +---- + .. _class_AudioEffectLimiter_property_soft_clip_db: - :ref:`float` **soft_clip_db** @@ -65,6 +67,8 @@ The waveform's maximum allowed value. Value can range from -20 to -0.1. Default Applies a gain to the limited waves. Value can range from 0 to 6. Default value: ``2dB``. +---- + .. _class_AudioEffectLimiter_property_soft_clip_ratio: - :ref:`float` **soft_clip_ratio** @@ -75,6 +79,8 @@ Applies a gain to the limited waves. Value can range from 0 to 6. Default value: | *Getter* | get_soft_clip_ratio() | +----------+----------------------------+ +---- + .. _class_AudioEffectLimiter_property_threshold_db: - :ref:`float` **threshold_db** diff --git a/classes/class_audioeffectphaser.rst b/classes/class_audioeffectphaser.rst index d212bd428..90dc89622 100644 --- a/classes/class_audioeffectphaser.rst +++ b/classes/class_audioeffectphaser.rst @@ -55,6 +55,8 @@ Property Descriptions Governs how high the filter frequencies sweep. Low value will primarily affect bass frequencies. High value can sweep high into the treble. Value can range from 0.1 to 4. Default value: ``1``. +---- + .. _class_AudioEffectPhaser_property_feedback: - :ref:`float` **feedback** @@ -67,6 +69,8 @@ Governs how high the filter frequencies sweep. Low value will primarily affect b Output percent of modified sound. Value can range from 0.1 to 0.9. Default value: ``0.7``. +---- + .. _class_AudioEffectPhaser_property_range_max_hz: - :ref:`float` **range_max_hz** @@ -79,6 +83,8 @@ Output percent of modified sound. Value can range from 0.1 to 0.9. Default value Determines the maximum frequency affected by the LFO modulations. Value can range from 10 to 10000. Default value: ``1600hz``. +---- + .. _class_AudioEffectPhaser_property_range_min_hz: - :ref:`float` **range_min_hz** @@ -91,6 +97,8 @@ Determines the maximum frequency affected by the LFO modulations. Value can rang Determines the minimum frequency affected by the LFO modulations. Value can range from 10 to 10000. Default value: ``440hz``. +---- + .. _class_AudioEffectPhaser_property_rate_hz: - :ref:`float` **rate_hz** diff --git a/classes/class_audioeffectrecord.rst b/classes/class_audioeffectrecord.rst index 2a0f5013e..2c5da8a61 100644 --- a/classes/class_audioeffectrecord.rst +++ b/classes/class_audioeffectrecord.rst @@ -56,10 +56,14 @@ Method Descriptions - :ref:`AudioStreamSample` **get_recording** **(** **)** const +---- + .. _class_AudioEffectRecord_method_is_recording_active: - :ref:`bool` **is_recording_active** **(** **)** const +---- + .. _class_AudioEffectRecord_method_set_recording_active: - void **set_recording_active** **(** :ref:`bool` record **)** diff --git a/classes/class_audioeffectreverb.rst b/classes/class_audioeffectreverb.rst index d709a508e..1a81e4965 100644 --- a/classes/class_audioeffectreverb.rst +++ b/classes/class_audioeffectreverb.rst @@ -61,6 +61,8 @@ Property Descriptions Defines how reflective the imaginary room's walls are. Value can range from 0 to 1. Default value: ``1``. +---- + .. _class_AudioEffectReverb_property_dry: - :ref:`float` **dry** @@ -73,6 +75,8 @@ Defines how reflective the imaginary room's walls are. Value can range from 0 to Output percent of original sound. At 0, only modified sound is outputted. Value can range from 0 to 1. Default value: ``1``. +---- + .. _class_AudioEffectReverb_property_hipass: - :ref:`float` **hipass** @@ -85,6 +89,8 @@ Output percent of original sound. At 0, only modified sound is outputted. Value High-pass filter passes signals with a frequency higher than a certain cutoff frequency and attenuates signals with frequencies lower than the cutoff frequency. Value can range from 0 to 1. Default value: ``0``. +---- + .. _class_AudioEffectReverb_property_predelay_feedback: - :ref:`float` **predelay_feedback** @@ -97,6 +103,8 @@ High-pass filter passes signals with a frequency higher than a certain cutoff fr Output percent of predelay. Value can range from 0 to 1. Default value: ``1``. +---- + .. _class_AudioEffectReverb_property_predelay_msec: - :ref:`float` **predelay_msec** @@ -109,6 +117,8 @@ Output percent of predelay. Value can range from 0 to 1. Default value: ``1``. Time between the original signal and the early reflections of the reverb signal. Default value: ``150ms``. +---- + .. _class_AudioEffectReverb_property_room_size: - :ref:`float` **room_size** @@ -121,6 +131,8 @@ Time between the original signal and the early reflections of the reverb signal. Dimensions of simulated room. Bigger means more echoes. Value can range from 0 to 1. Default value: ``0.8``. +---- + .. _class_AudioEffectReverb_property_spread: - :ref:`float` **spread** @@ -133,6 +145,8 @@ Dimensions of simulated room. Bigger means more echoes. Value can range from 0 t Widens or narrows the stereo image of the reverb tail. 1 means fully widens. Value can range from 0 to 1. Default value: ``1``. +---- + .. _class_AudioEffectReverb_property_wet: - :ref:`float` **wet** diff --git a/classes/class_audioeffectspectrumanalyzer.rst b/classes/class_audioeffectspectrumanalyzer.rst index cd2869ca2..4f60d1daf 100644 --- a/classes/class_audioeffectspectrumanalyzer.rst +++ b/classes/class_audioeffectspectrumanalyzer.rst @@ -73,6 +73,8 @@ Property Descriptions | *Getter* | get_buffer_length() | +----------+--------------------------+ +---- + .. _class_AudioEffectSpectrumAnalyzer_property_fft_size: - :ref:`FFT_Size` **fft_size** @@ -83,6 +85,8 @@ Property Descriptions | *Getter* | get_fft_size() | +----------+---------------------+ +---- + .. _class_AudioEffectSpectrumAnalyzer_property_tap_back_pos: - :ref:`float` **tap_back_pos** diff --git a/classes/class_audioeffectstereoenhance.rst b/classes/class_audioeffectstereoenhance.rst index 7b35e14f8..67802c536 100644 --- a/classes/class_audioeffectstereoenhance.rst +++ b/classes/class_audioeffectstereoenhance.rst @@ -42,6 +42,8 @@ Property Descriptions | *Getter* | get_pan_pullout() | +----------+------------------------+ +---- + .. _class_AudioEffectStereoEnhance_property_surround: - :ref:`float` **surround** @@ -52,6 +54,8 @@ Property Descriptions | *Getter* | get_surround() | +----------+---------------------+ +---- + .. _class_AudioEffectStereoEnhance_property_time_pullout_ms: - :ref:`float` **time_pullout_ms** diff --git a/classes/class_audioserver.rst b/classes/class_audioserver.rst index 834cabddb..b1b08c945 100644 --- a/classes/class_audioserver.rst +++ b/classes/class_audioserver.rst @@ -156,226 +156,306 @@ Method Descriptions Adds a bus at ``at_position``. +---- + .. _class_AudioServer_method_add_bus_effect: - 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_method_capture_get_device: - :ref:`String` **capture_get_device** **(** **)** +---- + .. _class_AudioServer_method_capture_get_device_list: - :ref:`Array` **capture_get_device_list** **(** **)** +---- + .. _class_AudioServer_method_capture_set_device: - void **capture_set_device** **(** :ref:`String` name **)** +---- + .. _class_AudioServer_method_generate_bus_layout: - :ref:`AudioBusLayout` **generate_bus_layout** **(** **)** const Generates an :ref:`AudioBusLayout` using the available buses and effects. +---- + .. _class_AudioServer_method_get_bus_channels: - :ref:`int` **get_bus_channels** **(** :ref:`int` bus_idx **)** const Returns the amount of channels of the bus at index ``bus_idx``. +---- + .. _class_AudioServer_method_get_bus_count: - :ref:`int` **get_bus_count** **(** **)** const Returns the number of available buses. +---- + .. _class_AudioServer_method_get_bus_effect: - :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_method_get_bus_effect_count: - :ref:`int` **get_bus_effect_count** **(** :ref:`int` bus_idx **)** Returns the number of effects on the bus at ``bus_idx``. +---- + .. _class_AudioServer_method_get_bus_effect_instance: - :ref:`AudioEffectInstance` **get_bus_effect_instance** **(** :ref:`int` bus_idx, :ref:`int` effect_idx, :ref:`int` channel=0 **)** +---- + .. _class_AudioServer_method_get_bus_index: - :ref:`int` **get_bus_index** **(** :ref:`String` bus_name **)** const Returns the index of the bus with the name ``bus_name``. +---- + .. _class_AudioServer_method_get_bus_name: - :ref:`String` **get_bus_name** **(** :ref:`int` bus_idx **)** const Returns the name of the bus with the index ``bus_idx``. +---- + .. _class_AudioServer_method_get_bus_peak_volume_left_db: - :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_method_get_bus_peak_volume_right_db: - :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_method_get_bus_send: - :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_method_get_bus_volume_db: - :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_method_get_device: - :ref:`String` **get_device** **(** **)** +---- + .. _class_AudioServer_method_get_device_list: - :ref:`Array` **get_device_list** **(** **)** +---- + .. _class_AudioServer_method_get_mix_rate: - :ref:`float` **get_mix_rate** **(** **)** const Returns the sample rate at the output of the audioserver. +---- + .. _class_AudioServer_method_get_speaker_mode: - :ref:`SpeakerMode` **get_speaker_mode** **(** **)** const Returns the speaker configuration. +---- + .. _class_AudioServer_method_is_bus_bypassing_effects: - :ref:`bool` **is_bus_bypassing_effects** **(** :ref:`int` bus_idx **)** const If ``true``, the bus at index ``bus_idx`` is bypassing effects. +---- + .. _class_AudioServer_method_is_bus_effect_enabled: - :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_method_is_bus_mute: - :ref:`bool` **is_bus_mute** **(** :ref:`int` bus_idx **)** const If ``true``, the bus at index ``bus_idx`` is muted. +---- + .. _class_AudioServer_method_is_bus_solo: - :ref:`bool` **is_bus_solo** **(** :ref:`int` bus_idx **)** const If ``true``, the bus at index ``bus_idx`` is in solo mode. +---- + .. _class_AudioServer_method_lock: - void **lock** **(** **)** Locks the audio drivers mainloop. Remember to unlock it afterwards. +---- + .. _class_AudioServer_method_move_bus: - void **move_bus** **(** :ref:`int` index, :ref:`int` to_index **)** Moves the bus from index ``index`` to index ``to_index``. +---- + .. _class_AudioServer_method_remove_bus: - void **remove_bus** **(** :ref:`int` index **)** Removes the bus at index ``index``. +---- + .. _class_AudioServer_method_remove_bus_effect: - 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_method_set_bus_bypass_effects: - 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_method_set_bus_count: - void **set_bus_count** **(** :ref:`int` amount **)** Adds and removes buses to make the number of buses match ``amount``. +---- + .. _class_AudioServer_method_set_bus_effect_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_method_set_bus_layout: - void **set_bus_layout** **(** :ref:`AudioBusLayout` bus_layout **)** Overwrites the currently used :ref:`AudioBusLayout`. +---- + .. _class_AudioServer_method_set_bus_mute: - void **set_bus_mute** **(** :ref:`int` bus_idx, :ref:`bool` enable **)** If ``true``, the bus at index ``bus_idx`` is muted. +---- + .. _class_AudioServer_method_set_bus_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_method_set_bus_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``. +---- + .. _class_AudioServer_method_set_bus_solo: - 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_method_set_bus_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_method_set_device: - void **set_device** **(** :ref:`String` device **)** +---- + .. _class_AudioServer_method_swap_bus_effects: - 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_method_unlock: - void **unlock** **(** **)** diff --git a/classes/class_audiostreamgenerator.rst b/classes/class_audiostreamgenerator.rst index 28e1b6abf..e5c6fe0ba 100644 --- a/classes/class_audiostreamgenerator.rst +++ b/classes/class_audiostreamgenerator.rst @@ -40,6 +40,8 @@ Property Descriptions | *Getter* | get_buffer_length() | +----------+--------------------------+ +---- + .. _class_AudioStreamGenerator_property_mix_rate: - :ref:`float` **mix_rate** diff --git a/classes/class_audiostreamgeneratorplayback.rst b/classes/class_audiostreamgeneratorplayback.rst index 052f3968c..ffe1d12e8 100644 --- a/classes/class_audiostreamgeneratorplayback.rst +++ b/classes/class_audiostreamgeneratorplayback.rst @@ -42,22 +42,32 @@ Method Descriptions - :ref:`bool` **can_push_buffer** **(** :ref:`int` amount **)** const +---- + .. _class_AudioStreamGeneratorPlayback_method_clear_buffer: - void **clear_buffer** **(** **)** +---- + .. _class_AudioStreamGeneratorPlayback_method_get_frames_available: - :ref:`int` **get_frames_available** **(** **)** const +---- + .. _class_AudioStreamGeneratorPlayback_method_get_skips: - :ref:`int` **get_skips** **(** **)** const +---- + .. _class_AudioStreamGeneratorPlayback_method_push_buffer: - :ref:`bool` **push_buffer** **(** :ref:`PoolVector2Array` frames **)** +---- + .. _class_AudioStreamGeneratorPlayback_method_push_frame: - :ref:`bool` **push_frame** **(** :ref:`Vector2` frame **)** diff --git a/classes/class_audiostreamoggvorbis.rst b/classes/class_audiostreamoggvorbis.rst index abd9c74fc..d23672aed 100644 --- a/classes/class_audiostreamoggvorbis.rst +++ b/classes/class_audiostreamoggvorbis.rst @@ -49,6 +49,8 @@ Property Descriptions Contains the audio data in bytes. +---- + .. _class_AudioStreamOGGVorbis_property_loop: - :ref:`bool` **loop** @@ -59,6 +61,8 @@ Contains the audio data in bytes. | *Getter* | has_loop() | +----------+-----------------+ +---- + .. _class_AudioStreamOGGVorbis_property_loop_offset: - :ref:`float` **loop_offset** diff --git a/classes/class_audiostreamplayer.rst b/classes/class_audiostreamplayer.rst index 68193a1f9..52dabccd5 100644 --- a/classes/class_audiostreamplayer.rst +++ b/classes/class_audiostreamplayer.rst @@ -107,6 +107,8 @@ Property Descriptions If ``true``, audio plays when added to scene tree. Default value: ``false``. +---- + .. _class_AudioStreamPlayer_property_bus: - :ref:`String` **bus** @@ -119,6 +121,8 @@ If ``true``, audio plays when added to scene tree. Default value: ``false``. Bus on which this audio is playing. +---- + .. _class_AudioStreamPlayer_property_mix_target: - :ref:`MixTarget` **mix_target** @@ -131,6 +135,8 @@ Bus on which this audio is playing. If the audio configuration has more than two speakers, this sets the target channels. See ``MIX_TARGET_*`` constants. +---- + .. _class_AudioStreamPlayer_property_pitch_scale: - :ref:`float` **pitch_scale** @@ -143,6 +149,8 @@ If the audio configuration has more than two speakers, this sets the target chan Changes the pitch and the tempo of the audio. +---- + .. _class_AudioStreamPlayer_property_playing: - :ref:`bool` **playing** @@ -153,6 +161,8 @@ Changes the pitch and the tempo of the audio. If ``true``, audio is playing. +---- + .. _class_AudioStreamPlayer_property_stream: - :ref:`AudioStream` **stream** @@ -165,6 +175,8 @@ If ``true``, audio is playing. The :ref:`AudioStream` object to be played. +---- + .. _class_AudioStreamPlayer_property_stream_paused: - :ref:`bool` **stream_paused** @@ -175,6 +187,8 @@ The :ref:`AudioStream` object to be played. | *Getter* | get_stream_paused() | +----------+--------------------------+ +---- + .. _class_AudioStreamPlayer_property_volume_db: - :ref:`float` **volume_db** @@ -196,22 +210,30 @@ Method Descriptions Returns the position in the :ref:`AudioStream` in seconds. +---- + .. _class_AudioStreamPlayer_method_get_stream_playback: - :ref:`AudioStreamPlayback` **get_stream_playback** **(** **)** +---- + .. _class_AudioStreamPlayer_method_play: - void **play** **(** :ref:`float` from_position=0.0 **)** Plays the audio from the given position 'from_position', in seconds. +---- + .. _class_AudioStreamPlayer_method_seek: - void **seek** **(** :ref:`float` to_position **)** Sets the position from which audio will be played, in seconds. +---- + .. _class_AudioStreamPlayer_method_stop: - void **stop** **(** **)** diff --git a/classes/class_audiostreamplayer2d.rst b/classes/class_audiostreamplayer2d.rst index 9e02cdcef..8f66bdc75 100644 --- a/classes/class_audiostreamplayer2d.rst +++ b/classes/class_audiostreamplayer2d.rst @@ -92,6 +92,8 @@ Property Descriptions Areas in which this sound plays. +---- + .. _class_AudioStreamPlayer2D_property_attenuation: - :ref:`float` **attenuation** @@ -104,6 +106,8 @@ Areas in which this sound plays. Dampens audio over distance with this as an exponent. +---- + .. _class_AudioStreamPlayer2D_property_autoplay: - :ref:`bool` **autoplay** @@ -116,6 +120,8 @@ Dampens audio over distance with this as an exponent. If ``true``, audio plays when added to scene tree. Default value: ``false``. +---- + .. _class_AudioStreamPlayer2D_property_bus: - :ref:`String` **bus** @@ -128,6 +134,8 @@ If ``true``, audio plays when added to scene tree. Default value: ``false``. Bus on which this audio is playing. +---- + .. _class_AudioStreamPlayer2D_property_max_distance: - :ref:`float` **max_distance** @@ -140,6 +148,8 @@ Bus on which this audio is playing. Maximum distance from which audio is still hearable. +---- + .. _class_AudioStreamPlayer2D_property_pitch_scale: - :ref:`float` **pitch_scale** @@ -152,6 +162,8 @@ Maximum distance from which audio is still hearable. Changes the pitch and the tempo of the audio. +---- + .. _class_AudioStreamPlayer2D_property_playing: - :ref:`bool` **playing** @@ -162,6 +174,8 @@ Changes the pitch and the tempo of the audio. If ``true``, audio is playing. +---- + .. _class_AudioStreamPlayer2D_property_stream: - :ref:`AudioStream` **stream** @@ -174,6 +188,8 @@ If ``true``, audio is playing. The :ref:`AudioStream` object to be played. +---- + .. _class_AudioStreamPlayer2D_property_stream_paused: - :ref:`bool` **stream_paused** @@ -184,6 +200,8 @@ The :ref:`AudioStream` object to be played. | *Getter* | get_stream_paused() | +----------+--------------------------+ +---- + .. _class_AudioStreamPlayer2D_property_volume_db: - :ref:`float` **volume_db** @@ -205,22 +223,30 @@ Method Descriptions Returns the position in the :ref:`AudioStream`. +---- + .. _class_AudioStreamPlayer2D_method_get_stream_playback: - :ref:`AudioStreamPlayback` **get_stream_playback** **(** **)** +---- + .. _class_AudioStreamPlayer2D_method_play: - void **play** **(** :ref:`float` from_position=0.0 **)** Plays the audio from the given position 'from_position', in seconds. +---- + .. _class_AudioStreamPlayer2D_method_seek: - void **seek** **(** :ref:`float` to_position **)** Sets the position from which audio will be played, in seconds. +---- + .. _class_AudioStreamPlayer2D_method_stop: - void **stop** **(** **)** diff --git a/classes/class_audiostreamplayer3d.rst b/classes/class_audiostreamplayer3d.rst index a129c0926..4e0e3e664 100644 --- a/classes/class_audiostreamplayer3d.rst +++ b/classes/class_audiostreamplayer3d.rst @@ -104,6 +104,8 @@ enum **AttenuationModel**: - **ATTENUATION_LOGARITHMIC** = **2** --- Logarithmic dampening of loudness according to distance. +---- + .. _enum_AudioStreamPlayer3D_OutOfRangeMode: .. _class_AudioStreamPlayer3D_constant_OUT_OF_RANGE_MIX: @@ -116,6 +118,8 @@ enum **OutOfRangeMode**: - **OUT_OF_RANGE_PAUSE** = **1** --- Pause this audio when it gets out of range. +---- + .. _enum_AudioStreamPlayer3D_DopplerTracking: .. _class_AudioStreamPlayer3D_constant_DOPPLER_TRACKING_DISABLED: @@ -157,6 +161,8 @@ Property Descriptions Areas in which this sound plays. +---- + .. _class_AudioStreamPlayer3D_property_attenuation_filter_cutoff_hz: - :ref:`float` **attenuation_filter_cutoff_hz** @@ -169,6 +175,8 @@ Areas in which this sound plays. Dampens audio above this frequency, in Hz. +---- + .. _class_AudioStreamPlayer3D_property_attenuation_filter_db: - :ref:`float` **attenuation_filter_db** @@ -181,6 +189,8 @@ Dampens audio above this frequency, in Hz. Amount how much the filter affects the loudness, in dB. +---- + .. _class_AudioStreamPlayer3D_property_attenuation_model: - :ref:`AttenuationModel` **attenuation_model** @@ -193,6 +203,8 @@ Amount how much the filter affects the loudness, in dB. Decides if audio should get quieter with distance linearly, quadratically or logarithmically. +---- + .. _class_AudioStreamPlayer3D_property_autoplay: - :ref:`bool` **autoplay** @@ -205,6 +217,8 @@ Decides if audio should get quieter with distance linearly, quadratically or log If ``true``, audio plays when added to scene tree. Default value: ``false``. +---- + .. _class_AudioStreamPlayer3D_property_bus: - :ref:`String` **bus** @@ -217,6 +231,8 @@ If ``true``, audio plays when added to scene tree. Default value: ``false``. Bus on which this audio is playing. +---- + .. _class_AudioStreamPlayer3D_property_doppler_tracking: - :ref:`DopplerTracking` **doppler_tracking** @@ -229,6 +245,8 @@ Bus on which this audio is playing. Decides in which step the Doppler effect should be calculated. +---- + .. _class_AudioStreamPlayer3D_property_emission_angle_degrees: - :ref:`float` **emission_angle_degrees** @@ -241,6 +259,8 @@ Decides in which step the Doppler effect should be calculated. The angle in which the audio reaches cameras undampened. +---- + .. _class_AudioStreamPlayer3D_property_emission_angle_enabled: - :ref:`bool` **emission_angle_enabled** @@ -253,6 +273,8 @@ The angle in which the audio reaches cameras undampened. If ``true``, the audio should be dampened according to the direction of the sound. +---- + .. _class_AudioStreamPlayer3D_property_emission_angle_filter_attenuation_db: - :ref:`float` **emission_angle_filter_attenuation_db** @@ -265,6 +287,8 @@ If ``true``, the audio should be dampened according to the direction of the soun dampens audio if camera is outside of 'emission_angle_degrees' and 'emission_angle_enabled' is set by this factor, in dB. +---- + .. _class_AudioStreamPlayer3D_property_max_db: - :ref:`float` **max_db** @@ -277,6 +301,8 @@ dampens audio if camera is outside of 'emission_angle_degrees' and 'emission_ang Sets the absolute maximum of the soundlevel, in dB. +---- + .. _class_AudioStreamPlayer3D_property_max_distance: - :ref:`float` **max_distance** @@ -289,6 +315,8 @@ Sets the absolute maximum of the soundlevel, in dB. Sets the distance from which the 'out_of_range_mode' takes effect. Has no effect if set to 0. +---- + .. _class_AudioStreamPlayer3D_property_out_of_range_mode: - :ref:`OutOfRangeMode` **out_of_range_mode** @@ -301,6 +329,8 @@ Sets the distance from which the 'out_of_range_mode' takes effect. Has no effect Decides if audio should pause when source is outside of 'max_distance' range. +---- + .. _class_AudioStreamPlayer3D_property_pitch_scale: - :ref:`float` **pitch_scale** @@ -313,6 +343,8 @@ Decides if audio should pause when source is outside of 'max_distance' range. Changes the pitch and the tempo of the audio. +---- + .. _class_AudioStreamPlayer3D_property_playing: - :ref:`bool` **playing** @@ -323,6 +355,8 @@ Changes the pitch and the tempo of the audio. If ``true``, audio is playing. +---- + .. _class_AudioStreamPlayer3D_property_stream: - :ref:`AudioStream` **stream** @@ -335,6 +369,8 @@ If ``true``, audio is playing. The :ref:`AudioStream` object to be played. +---- + .. _class_AudioStreamPlayer3D_property_stream_paused: - :ref:`bool` **stream_paused** @@ -345,6 +381,8 @@ The :ref:`AudioStream` object to be played. | *Getter* | get_stream_paused() | +----------+--------------------------+ +---- + .. _class_AudioStreamPlayer3D_property_unit_db: - :ref:`float` **unit_db** @@ -357,6 +395,8 @@ The :ref:`AudioStream` object to be played. Base sound level unaffected by dampening, in dB. +---- + .. _class_AudioStreamPlayer3D_property_unit_size: - :ref:`float` **unit_size** @@ -378,22 +418,30 @@ Method Descriptions Returns the position in the :ref:`AudioStream`. +---- + .. _class_AudioStreamPlayer3D_method_get_stream_playback: - :ref:`AudioStreamPlayback` **get_stream_playback** **(** **)** +---- + .. _class_AudioStreamPlayer3D_method_play: - void **play** **(** :ref:`float` from_position=0.0 **)** Plays the audio from the given position 'from_position', in seconds. +---- + .. _class_AudioStreamPlayer3D_method_seek: - void **seek** **(** :ref:`float` to_position **)** Sets the position from which audio will be played, in seconds. +---- + .. _class_AudioStreamPlayer3D_method_stop: - void **stop** **(** **)** diff --git a/classes/class_audiostreamrandompitch.rst b/classes/class_audiostreamrandompitch.rst index d15a7317e..5cc6c3463 100644 --- a/classes/class_audiostreamrandompitch.rst +++ b/classes/class_audiostreamrandompitch.rst @@ -47,6 +47,8 @@ Property Descriptions The current :ref:`AudioStream`. +---- + .. _class_AudioStreamRandomPitch_property_random_pitch: - :ref:`float` **random_pitch** diff --git a/classes/class_audiostreamsample.rst b/classes/class_audiostreamsample.rst index afb9b65ca..5dfe80676 100644 --- a/classes/class_audiostreamsample.rst +++ b/classes/class_audiostreamsample.rst @@ -63,6 +63,8 @@ enum **Format**: - **FORMAT_IMA_ADPCM** = **2** --- Audio codec IMA ADPCM. +---- + .. _enum_AudioStreamSample_LoopMode: .. _class_AudioStreamSample_constant_LOOP_DISABLED: @@ -105,6 +107,8 @@ Property Descriptions Contains the audio data in bytes. +---- + .. _class_AudioStreamSample_property_format: - :ref:`Format` **format** @@ -117,6 +121,8 @@ Contains the audio data in bytes. Audio format. See FORMAT\_\* constants for values. +---- + .. _class_AudioStreamSample_property_loop_begin: - :ref:`int` **loop_begin** @@ -129,6 +135,8 @@ Audio format. See FORMAT\_\* constants for values. Loop start in bytes. +---- + .. _class_AudioStreamSample_property_loop_end: - :ref:`int` **loop_end** @@ -141,6 +149,8 @@ Loop start in bytes. Loop end in bytes. +---- + .. _class_AudioStreamSample_property_loop_mode: - :ref:`LoopMode` **loop_mode** @@ -153,6 +163,8 @@ Loop end in bytes. Loop mode. See LOOP\_\* constants for values. +---- + .. _class_AudioStreamSample_property_mix_rate: - :ref:`int` **mix_rate** @@ -165,6 +177,8 @@ Loop mode. See LOOP\_\* constants for values. The sample rate for mixing this audio. +---- + .. _class_AudioStreamSample_property_stereo: - :ref:`bool` **stereo** diff --git a/classes/class_backbuffercopy.rst b/classes/class_backbuffercopy.rst index e544ddcbe..d197176d3 100644 --- a/classes/class_backbuffercopy.rst +++ b/classes/class_backbuffercopy.rst @@ -66,6 +66,8 @@ Property Descriptions Buffer mode. See :ref:`CopyMode` constants. +---- + .. _class_BackBufferCopy_property_rect: - :ref:`Rect2` **rect** diff --git a/classes/class_bakedlightmap.rst b/classes/class_bakedlightmap.rst index c1fce3a2b..0b58418ff 100644 --- a/classes/class_bakedlightmap.rst +++ b/classes/class_bakedlightmap.rst @@ -71,6 +71,8 @@ enum **BakeQuality**: - **BAKE_QUALITY_HIGH** = **2** --- Highest bake quality mode. Takes longer to calculate. +---- + .. _enum_BakedLightmap_BakeMode: .. _class_BakedLightmap_constant_BAKE_MODE_CONE_TRACE: @@ -83,6 +85,8 @@ enum **BakeMode**: - **BAKE_MODE_RAY_TRACE** = **1** --- More precise bake mode but can take considerably longer to bake. +---- + .. _enum_BakedLightmap_BakeError: .. _class_BakedLightmap_constant_BAKE_ERROR_OK: @@ -132,6 +136,8 @@ Property Descriptions Grid subdivision size for lightmapper calculation. Default value of ``0.25`` will work for most cases. Increase for better lighting on small details or if your scene is very large. +---- + .. _class_BakedLightmap_property_bake_energy: - :ref:`float` **bake_energy** @@ -144,6 +150,8 @@ Grid subdivision size for lightmapper calculation. Default value of ``0.25`` wil Multiplies the light sources' intensity by this value. For instance, if the value is set to 2, lights will be twice as bright. If the value is set to 0.5, lights will be half as bright. +---- + .. _class_BakedLightmap_property_bake_extents: - :ref:`Vector3` **bake_extents** @@ -154,6 +162,8 @@ Multiplies the light sources' intensity by this value. For instance, if the valu | *Getter* | get_extents() | +----------+--------------------+ +---- + .. _class_BakedLightmap_property_bake_hdr: - :ref:`bool` **bake_hdr** @@ -166,6 +176,8 @@ Multiplies the light sources' intensity by this value. For instance, if the valu If ``true``, lightmap can capture light values greater than ``1.0``. Turning this off will result in a smaller lightmap. Default value:``false``. +---- + .. _class_BakedLightmap_property_bake_mode: - :ref:`BakeMode` **bake_mode** @@ -178,6 +190,8 @@ If ``true``, lightmap can capture light values greater than ``1.0``. Turning thi Lightmapping mode. See :ref:`BakeMode`. +---- + .. _class_BakedLightmap_property_bake_propagation: - :ref:`float` **bake_propagation** @@ -190,6 +204,8 @@ Lightmapping mode. See :ref:`BakeMode`. Defines how far the light will travel before it is no longer effective. The higher the number, the farther the light will travel. For instance, if the value is set to 2, the light will go twice as far. If the value is set to 0.5, the light will only go half as far. +---- + .. _class_BakedLightmap_property_bake_quality: - :ref:`BakeQuality` **bake_quality** @@ -202,6 +218,8 @@ Defines how far the light will travel before it is no longer effective. The high Three quality modes are available. Higher quality requires more rendering time. See :ref:`BakeQuality`. +---- + .. _class_BakedLightmap_property_capture_cell_size: - :ref:`float` **capture_cell_size** @@ -214,6 +232,8 @@ Three quality modes are available. Higher quality requires more rendering time. Grid size used for real-time capture information on dynamic objects. Cannot be larger than :ref:`bake_cell_size`. +---- + .. _class_BakedLightmap_property_image_path: - :ref:`String` **image_path** @@ -226,6 +246,8 @@ Grid size used for real-time capture information on dynamic objects. Cannot be l Location where lightmaps will be saved. +---- + .. _class_BakedLightmap_property_light_data: - :ref:`BakedLightmapData` **light_data** @@ -247,6 +269,8 @@ Method Descriptions Bakes the lightmaps within the currently edited scene. +---- + .. _class_BakedLightmap_method_debug_bake: - void **debug_bake** **(** **)** diff --git a/classes/class_bakedlightmapdata.rst b/classes/class_bakedlightmapdata.rst index 3f9f6a67c..5b606616e 100644 --- a/classes/class_bakedlightmapdata.rst +++ b/classes/class_bakedlightmapdata.rst @@ -61,6 +61,8 @@ Property Descriptions | *Getter* | get_bounds() | +----------+-------------------+ +---- + .. _class_BakedLightmapData_property_cell_space_transform: - :ref:`Transform` **cell_space_transform** @@ -71,6 +73,8 @@ Property Descriptions | *Getter* | get_cell_space_transform() | +----------+---------------------------------+ +---- + .. _class_BakedLightmapData_property_cell_subdiv: - :ref:`int` **cell_subdiv** @@ -81,6 +85,8 @@ Property Descriptions | *Getter* | get_cell_subdiv() | +----------+------------------------+ +---- + .. _class_BakedLightmapData_property_energy: - :ref:`float` **energy** @@ -91,6 +97,8 @@ Property Descriptions | *Getter* | get_energy() | +----------+-------------------+ +---- + .. _class_BakedLightmapData_property_octree: - :ref:`PoolByteArray` **octree** @@ -108,18 +116,26 @@ Method Descriptions - void **add_user** **(** :ref:`NodePath` path, :ref:`Texture` lightmap, :ref:`int` instance **)** +---- + .. _class_BakedLightmapData_method_clear_users: - void **clear_users** **(** **)** +---- + .. _class_BakedLightmapData_method_get_user_count: - :ref:`int` **get_user_count** **(** **)** const +---- + .. _class_BakedLightmapData_method_get_user_lightmap: - :ref:`Texture` **get_user_lightmap** **(** :ref:`int` user_idx **)** const +---- + .. _class_BakedLightmapData_method_get_user_path: - :ref:`NodePath` **get_user_path** **(** :ref:`int` user_idx **)** const diff --git a/classes/class_basebutton.rst b/classes/class_basebutton.rst index 9db34602b..d9b10ecdb 100644 --- a/classes/class_basebutton.rst +++ b/classes/class_basebutton.rst @@ -65,18 +65,24 @@ Signals Emitted when the button starts being held down. +---- + .. _class_BaseButton_signal_button_up: - **button_up** **(** **)** Emitted when the button stops being held down. +---- + .. _class_BaseButton_signal_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_signal_toggled: - **toggled** **(** :ref:`bool` button_pressed **)** @@ -110,6 +116,8 @@ enum **DrawMode**: - **DRAW_HOVER_PRESSED** = **4** +---- + .. _enum_BaseButton_ActionMode: .. _class_BaseButton_constant_ACTION_MODE_BUTTON_PRESS: @@ -142,6 +150,8 @@ Property Descriptions Determines when the button is considered clicked, one of the ACTION_MODE\_\* constants. +---- + .. _class_BaseButton_property_button_mask: - :ref:`int` **button_mask** @@ -156,6 +166,8 @@ Binary mask to choose which mouse buttons this button will respond to. To allow both left-click and right-click, set this to 3, because it's BUTTON_MASK_LEFT | BUTTON_MASK_RIGHT. +---- + .. _class_BaseButton_property_disabled: - :ref:`bool` **disabled** @@ -168,6 +180,8 @@ To allow both left-click and right-click, set this to 3, because it's BUTTON_MAS If ``true``, the button is in disabled state and can't be clicked or toggled. +---- + .. _class_BaseButton_property_enabled_focus_mode: - :ref:`FocusMode` **enabled_focus_mode** @@ -180,6 +194,8 @@ If ``true``, the button is in disabled state and can't be clicked or toggled. Focus access mode to use when switching between enabled/disabled (see :ref:`Control.focus_mode` and :ref:`disabled`). +---- + .. _class_BaseButton_property_group: - :ref:`ButtonGroup` **group** @@ -192,6 +208,8 @@ Focus access mode to use when switching between enabled/disabled (see :ref:`Cont :ref:`ButtonGroup` associated to the button. +---- + .. _class_BaseButton_property_pressed: - :ref:`bool` **pressed** @@ -204,6 +222,8 @@ Focus access mode to use when switching between enabled/disabled (see :ref:`Cont If ``true``, the button's state is pressed. Means the button is pressed down or toggled (if toggle_mode is active). +---- + .. _class_BaseButton_property_shortcut: - :ref:`ShortCut` **shortcut** @@ -216,6 +236,8 @@ If ``true``, the button's state is pressed. Means the button is pressed down or :ref:`ShortCut` associated to the button. +---- + .. _class_BaseButton_property_shortcut_in_tooltip: - :ref:`bool` **shortcut_in_tooltip** @@ -228,6 +250,8 @@ If ``true``, the button's state is pressed. Means the button is pressed down or If ``true``, the button will add information about its shortcut in the tooltip. +---- + .. _class_BaseButton_property_toggle_mode: - :ref:`bool` **toggle_mode** @@ -249,18 +273,24 @@ Method Descriptions Called when the button is pressed. +---- + .. _class_BaseButton_method__toggled: - void **_toggled** **(** :ref:`bool` button_pressed **)** virtual Called when the button is toggled (only if toggle_mode is active). +---- + .. _class_BaseButton_method_get_draw_mode: - :ref:`DrawMode` **get_draw_mode** **(** **)** const Returns 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_method_is_hovered: - :ref:`bool` **is_hovered** **(** **)** const diff --git a/classes/class_basis.rst b/classes/class_basis.rst index 4b5b4dbda..0fd2d3dcb 100644 --- a/classes/class_basis.rst +++ b/classes/class_basis.rst @@ -95,12 +95,16 @@ Property Descriptions The basis matrix's x vector. +---- + .. _class_Basis_property_y: - :ref:`Vector3` **y** The basis matrix's y vector. +---- + .. _class_Basis_property_z: - :ref:`Vector3` **z** @@ -116,110 +120,150 @@ Method Descriptions Create a rotation matrix from the given quaternion. +---- + - :ref:`Basis` **Basis** **(** :ref:`Vector3` from **)** 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). +---- + - :ref:`Basis` **Basis** **(** :ref:`Vector3` axis, :ref:`float` phi **)** Create a rotation matrix which rotates around the given axis by the specified angle, in radians. The axis must be a normalized vector. +---- + - :ref:`Basis` **Basis** **(** :ref:`Vector3` x_axis, :ref:`Vector3` y_axis, :ref:`Vector3` z_axis **)** Create a matrix from 3 axis vectors. +---- + .. _class_Basis_method_determinant: - :ref:`float` **determinant** **(** **)** Returns the determinant of the matrix. +---- + .. _class_Basis_method_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_method_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_method_get_rotation_quat: - :ref:`Quat` **get_rotation_quat** **(** **)** +---- + .. _class_Basis_method_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_method_inverse: - :ref:`Basis` **inverse** **(** **)** Returns the inverse of the matrix. +---- + .. _class_Basis_method_is_equal_approx: - :ref:`bool` **is_equal_approx** **(** :ref:`Basis` b, :ref:`float` epsilon=0.00001 **)** +---- + .. _class_Basis_method_orthonormalized: - :ref:`Basis` **orthonormalized** **(** **)** Returns 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_method_rotated: - :ref:`Basis` **rotated** **(** :ref:`Vector3` axis, :ref:`float` phi **)** Introduce an additional rotation around the given axis by phi (radians). The axis must be a normalized vector. +---- + .. _class_Basis_method_scaled: - :ref:`Basis` **scaled** **(** :ref:`Vector3` scale **)** Introduce an additional scaling specified by the given 3D scaling factor. +---- + .. _class_Basis_method_slerp: - :ref:`Basis` **slerp** **(** :ref:`Basis` b, :ref:`float` t **)** Assuming that the matrix is a proper rotation matrix, slerp performs a spherical-linear interpolation with another rotation matrix. +---- + .. _class_Basis_method_tdotx: - :ref:`float` **tdotx** **(** :ref:`Vector3` with **)** Transposed dot product with the x axis of the matrix. +---- + .. _class_Basis_method_tdoty: - :ref:`float` **tdoty** **(** :ref:`Vector3` with **)** Transposed dot product with the y axis of the matrix. +---- + .. _class_Basis_method_tdotz: - :ref:`float` **tdotz** **(** :ref:`Vector3` with **)** Transposed dot product with the z axis of the matrix. +---- + .. _class_Basis_method_transposed: - :ref:`Basis` **transposed** **(** **)** Returns the transposed version of the matrix. +---- + .. _class_Basis_method_xform: - :ref:`Vector3` **xform** **(** :ref:`Vector3` v **)** Returns a vector transformed (multiplied) by the matrix. +---- + .. _class_Basis_method_xform_inv: - :ref:`Vector3` **xform_inv** **(** :ref:`Vector3` v **)** diff --git a/classes/class_bitmap.rst b/classes/class_bitmap.rst index 8238dc83d..e3933a5ca 100644 --- a/classes/class_bitmap.rst +++ b/classes/class_bitmap.rst @@ -55,44 +55,60 @@ Method Descriptions Creates a bitmap with the specified size, filled with ``false``. +---- + .. _class_BitMap_method_create_from_image_alpha: - void **create_from_image_alpha** **(** :ref:`Image` image, :ref:`float` threshold=0.1 **)** 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 equal to ``threshold`` or less, and ``true`` in other case. +---- + .. _class_BitMap_method_get_bit: - :ref:`bool` **get_bit** **(** :ref:`Vector2` position **)** const Returns bitmap's value at the specified position. +---- + .. _class_BitMap_method_get_size: - :ref:`Vector2` **get_size** **(** **)** const Returns bitmap's dimensions. +---- + .. _class_BitMap_method_get_true_bit_count: - :ref:`int` **get_true_bit_count** **(** **)** const Returns the amount of bitmap elements that are set to ``true``. +---- + .. _class_BitMap_method_grow_mask: - void **grow_mask** **(** :ref:`int` pixels, :ref:`Rect2` rect **)** +---- + .. _class_BitMap_method_opaque_to_polygons: - :ref:`Array` **opaque_to_polygons** **(** :ref:`Rect2` rect, :ref:`float` epsilon=2.0 **)** const +---- + .. _class_BitMap_method_set_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_method_set_bit_rect: - void **set_bit_rect** **(** :ref:`Rect2` rect, :ref:`bool` bit **)** diff --git a/classes/class_bitmapfont.rst b/classes/class_bitmapfont.rst index 758febd34..36b2f59a9 100644 --- a/classes/class_bitmapfont.rst +++ b/classes/class_bitmapfont.rst @@ -74,6 +74,8 @@ Property Descriptions Ascent (number of pixels above the baseline). +---- + .. _class_BitmapFont_property_distance_field: - :ref:`bool` **distance_field** @@ -86,6 +88,8 @@ Ascent (number of pixels above the baseline). If ``true``, distance field hint is enabled. +---- + .. _class_BitmapFont_property_fallback: - :ref:`BitmapFont` **fallback** @@ -98,6 +102,8 @@ If ``true``, distance field hint is enabled. The fallback font. +---- + .. _class_BitmapFont_property_height: - :ref:`float` **height** @@ -119,48 +125,64 @@ Method Descriptions 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_method_add_kerning_pair: - void **add_kerning_pair** **(** :ref:`int` char_a, :ref:`int` char_b, :ref:`int` kerning **)** Adds a kerning pair to the ``BitmapFont`` as a difference. Kerning pairs are special cases where a typeface advance is determined by the next character. +---- + .. _class_BitmapFont_method_add_texture: - void **add_texture** **(** :ref:`Texture` texture **)** Adds a texture to the ``BitmapFont``. +---- + .. _class_BitmapFont_method_clear: - void **clear** **(** **)** Clears all the font data and settings. +---- + .. _class_BitmapFont_method_create_from_fnt: - :ref:`Error` **create_from_fnt** **(** :ref:`String` path **)** Creates a BitmapFont from the ``*.fnt`` file at ``path``. +---- + .. _class_BitmapFont_method_get_char_size: - :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_method_get_kerning_pair: - :ref:`int` **get_kerning_pair** **(** :ref:`int` char_a, :ref:`int` char_b **)** const Returns a kerning pair as a difference. +---- + .. _class_BitmapFont_method_get_texture: - :ref:`Texture` **get_texture** **(** :ref:`int` idx **)** const Returns the font atlas texture at index ``idx``. +---- + .. _class_BitmapFont_method_get_texture_count: - :ref:`int` **get_texture_count** **(** **)** const diff --git a/classes/class_bone2d.rst b/classes/class_bone2d.rst index a61f02351..aea8ac71f 100644 --- a/classes/class_bone2d.rst +++ b/classes/class_bone2d.rst @@ -64,6 +64,8 @@ Property Descriptions Length of the bone's representation drawn in the editor's viewport in pixels. +---- + .. _class_Bone2D_property_rest: - :ref:`Transform2D` **rest** @@ -85,12 +87,16 @@ Method Descriptions Stores the node's current transforms in :ref:`rest`. +---- + .. _class_Bone2D_method_get_index_in_skeleton: - :ref:`int` **get_index_in_skeleton** **(** **)** const Returns the node's index as part of the entire skeleton. See :ref:`Skeleton2D`. +---- + .. _class_Bone2D_method_get_skeleton_rest: - :ref:`Transform2D` **get_skeleton_rest** **(** **)** const diff --git a/classes/class_bool.rst b/classes/class_bool.rst index 8325c98c1..7d5a6a0d3 100644 --- a/classes/class_bool.rst +++ b/classes/class_bool.rst @@ -41,10 +41,14 @@ Method Descriptions 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. +---- + - :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. +---- + - :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_button.rst b/classes/class_button.rst index afd70988c..27b1d17ce 100644 --- a/classes/class_button.rst +++ b/classes/class_button.rst @@ -101,6 +101,8 @@ Property Descriptions Text alignment policy for the button's text, use one of the ALIGN\_\* constants. +---- + .. _class_Button_property_clip_text: - :ref:`bool` **clip_text** @@ -113,6 +115,8 @@ Text alignment policy for the button's text, use one of the ALIGN\_\* constants. When this property is enabled, text that is too large to fit the button is clipped, when disabled the Button will always be wide enough to hold the text. This property is disabled by default. +---- + .. _class_Button_property_flat: - :ref:`bool` **flat** @@ -125,6 +129,8 @@ When this property is enabled, text that is too large to fit the button is clipp Flat buttons don't display decoration. +---- + .. _class_Button_property_icon: - :ref:`Texture` **icon** @@ -137,6 +143,8 @@ Flat buttons don't display decoration. Button's icon, if text is present the icon will be placed before the text. +---- + .. _class_Button_property_text: - :ref:`String` **text** diff --git a/classes/class_buttongroup.rst b/classes/class_buttongroup.rst index f11bb98da..c1eb69f74 100644 --- a/classes/class_buttongroup.rst +++ b/classes/class_buttongroup.rst @@ -43,6 +43,8 @@ Method Descriptions Returns an :ref:`Array` of :ref:`Button`\ s who have this as their ``ButtonGroup`` (see :ref:`BaseButton.group`). +---- + .. _class_ButtonGroup_method_get_pressed_button: - :ref:`BaseButton` **get_pressed_button** **(** **)** diff --git a/classes/class_camera.rst b/classes/class_camera.rst index 54a8491d3..f976be191 100644 --- a/classes/class_camera.rst +++ b/classes/class_camera.rst @@ -97,6 +97,8 @@ enum **Projection**: - **PROJECTION_ORTHOGONAL** = **1** --- Orthogonal Projection (objects remain the same size on the screen no matter how far away they are; also known as orthographic projection). +---- + .. _enum_Camera_KeepAspect: .. _class_Camera_constant_KEEP_WIDTH: @@ -109,6 +111,8 @@ enum **KeepAspect**: - **KEEP_HEIGHT** = **1** --- Preserves the vertical aspect ratio. +---- + .. _enum_Camera_DopplerTracking: .. _class_Camera_constant_DOPPLER_TRACKING_DISABLED: @@ -145,6 +149,8 @@ Property Descriptions The culling mask that describes which 3D render layers are rendered by this camera. +---- + .. _class_Camera_property_current: - :ref:`bool` **current** @@ -157,6 +163,8 @@ The culling mask that describes which 3D render layers are rendered by this came If ``true``, the ancestor :ref:`Viewport` is currently using this Camera. Default value: ``false``. +---- + .. _class_Camera_property_doppler_tracking: - :ref:`DopplerTracking` **doppler_tracking** @@ -169,6 +177,8 @@ If ``true``, the ancestor :ref:`Viewport` is currently using thi If not :ref:`DOPPLER_TRACKING_DISABLED` this Camera will simulate the Doppler effect for objects changed in particular ``_process`` methods. Default value: :ref:`DOPPLER_TRACKING_DISABLED`. +---- + .. _class_Camera_property_environment: - :ref:`Environment` **environment** @@ -181,6 +191,8 @@ If not :ref:`DOPPLER_TRACKING_DISABLED` to use for this Camera. +---- + .. _class_Camera_property_far: - :ref:`float` **far** @@ -193,6 +205,8 @@ The :ref:`Environment` to use for this Camera. The distance to the far culling boundary for this Camera relative to its local z-axis. +---- + .. _class_Camera_property_fov: - :ref:`float` **fov** @@ -205,6 +219,8 @@ The distance to the far culling boundary for this Camera relative to its local z The camera's field of view angle (in degrees). Only applicable in perspective mode. Since :ref:`keep_aspect` locks one axis, ``fov`` sets the other axis' field of view angle. +---- + .. _class_Camera_property_h_offset: - :ref:`float` **h_offset** @@ -217,6 +233,8 @@ The camera's field of view angle (in degrees). Only applicable in perspective mo The horizontal (X) offset of the Camera viewport. +---- + .. _class_Camera_property_keep_aspect: - :ref:`KeepAspect` **keep_aspect** @@ -229,6 +247,8 @@ The horizontal (X) offset of the Camera viewport. The axis to lock during :ref:`fov`/:ref:`size` adjustments. Can be either :ref:`KEEP_WIDTH` or :ref:`KEEP_HEIGHT`. +---- + .. _class_Camera_property_near: - :ref:`float` **near** @@ -241,6 +261,8 @@ The axis to lock during :ref:`fov`/:ref:`size` **projection** @@ -253,6 +275,8 @@ The distance to the near culling boundary for this Camera relative to its local The camera's projection mode. In :ref:`PROJECTION_PERSPECTIVE` mode, objects' z-distance from the camera's local space scales their perceived size. +---- + .. _class_Camera_property_size: - :ref:`float` **size** @@ -265,6 +289,8 @@ The camera's projection mode. In :ref:`PROJECTION_PERSPECTIVE` locks on axis, ``size`` sets the other axis' size length. +---- + .. _class_Camera_property_v_offset: - :ref:`float` **v_offset** @@ -286,72 +312,98 @@ Method Descriptions If this is the current Camera, remove it from being current. If ``enable_next`` is ``true``, request to make the next Camera current, if any. +---- + .. _class_Camera_method_get_camera_transform: - :ref:`Transform` **get_camera_transform** **(** **)** const Gets the camera transform. Subclassed cameras (such as CharacterCamera) may provide different transforms than the :ref:`Node` transform. +---- + .. _class_Camera_method_get_cull_mask_bit: - :ref:`bool` **get_cull_mask_bit** **(** :ref:`int` layer **)** const +---- + .. _class_Camera_method_get_frustum: - :ref:`Array` **get_frustum** **(** **)** const +---- + .. _class_Camera_method_is_position_behind: - :ref:`bool` **is_position_behind** **(** :ref:`Vector3` world_point **)** const Returns ``true`` if the given position is behind the Camera. Note that a position which returns ``false`` may still be outside the Camera's field of view. +---- + .. _class_Camera_method_make_current: - void **make_current** **(** **)** Makes 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_method_project_local_ray_normal: - :ref:`Vector3` **project_local_ray_normal** **(** :ref:`Vector2` screen_point **)** const Returns a normal vector from the screen point location directed along the camera. Orthogonal cameras are normalized. Perspective cameras account for perspective, screen width/height, etc. +---- + .. _class_Camera_method_project_position: - :ref:`Vector3` **project_position** **(** :ref:`Vector2` screen_point **)** const Returns the 3D point in worldspace that maps to the given 2D coordinate in the :ref:`Viewport` rectangle. +---- + .. _class_Camera_method_project_ray_normal: - :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_method_project_ray_origin: - :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_method_set_cull_mask_bit: - void **set_cull_mask_bit** **(** :ref:`int` layer, :ref:`bool` enable **)** +---- + .. _class_Camera_method_set_orthogonal: - void **set_orthogonal** **(** :ref:`float` size, :ref:`float` z_near, :ref:`float` z_far **)** Sets 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_method_set_perspective: - void **set_perspective** **(** :ref:`float` fov, :ref:`float` z_near, :ref:`float` z_far **)** Sets 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_method_unproject_position: - :ref:`Vector2` **unproject_position** **(** :ref:`Vector3` world_point **)** const diff --git a/classes/class_camera2d.rst b/classes/class_camera2d.rst index 9e6ce41e3..8da21893c 100644 --- a/classes/class_camera2d.rst +++ b/classes/class_camera2d.rst @@ -107,6 +107,8 @@ enum **AnchorMode**: - **ANCHOR_MODE_DRAG_CENTER** = **1** --- The camera's position takes into account vertical/horizontal offsets and the screen size. +---- + .. _enum_Camera2D_Camera2DProcessMode: .. _class_Camera2D_constant_CAMERA2D_PROCESS_PHYSICS: @@ -141,6 +143,8 @@ Property Descriptions The Camera2D's anchor point. See ``ANCHOR_MODE_*`` constants. +---- + .. _class_Camera2D_property_current: - :ref:`bool` **current** @@ -151,6 +155,8 @@ The Camera2D's anchor point. See ``ANCHOR_MODE_*`` constants. If ``true``, the camera is the active camera for the current scene. Only one camera can be current, so setting a different camera ``current`` will disable this one. +---- + .. _class_Camera2D_property_custom_viewport: - :ref:`Node` **custom_viewport** @@ -163,6 +169,8 @@ If ``true``, the camera is the active camera for the current scene. Only one cam The custom :ref:`Viewport` node attached to the ``Camera2D``. If null or not a :ref:`Viewport`, uses the default viewport instead. +---- + .. _class_Camera2D_property_drag_margin_bottom: - :ref:`float` **drag_margin_bottom** @@ -175,6 +183,8 @@ The custom :ref:`Viewport` node attached to the ``Camera2D``. If Bottom margin needed to drag the camera. A value of ``1`` makes the camera move only when reaching the edge of the screen. +---- + .. _class_Camera2D_property_drag_margin_h_enabled: - :ref:`bool` **drag_margin_h_enabled** @@ -187,6 +197,8 @@ Bottom margin needed to drag the camera. A value of ``1`` makes the camera move If ``true``, the camera only moves when reaching the horizontal drag margins. If ``false``, the camera moves horizontally regardless of margins. Default value: ``true``. +---- + .. _class_Camera2D_property_drag_margin_left: - :ref:`float` **drag_margin_left** @@ -199,6 +211,8 @@ If ``true``, the camera only moves when reaching the horizontal drag margins. If Left margin needed to drag the camera. A value of ``1`` makes the camera move only when reaching the edge of the screen. +---- + .. _class_Camera2D_property_drag_margin_right: - :ref:`float` **drag_margin_right** @@ -211,6 +225,8 @@ Left margin needed to drag the camera. A value of ``1`` makes the camera move on Right margin needed to drag the camera. A value of ``1`` makes the camera move only when reaching the edge of the screen. +---- + .. _class_Camera2D_property_drag_margin_top: - :ref:`float` **drag_margin_top** @@ -223,6 +239,8 @@ Right margin needed to drag the camera. A value of ``1`` makes the camera move o Top margin needed to drag the camera. A value of ``1`` makes the camera move only when reaching the edge of the screen. +---- + .. _class_Camera2D_property_drag_margin_v_enabled: - :ref:`bool` **drag_margin_v_enabled** @@ -235,6 +253,8 @@ Top margin needed to drag the camera. A value of ``1`` makes the camera move onl If ``true``, the camera only moves when reaching the vertical drag margins. If ``false``, the camera moves vertically regardless of margins. Default value: ``true``. +---- + .. _class_Camera2D_property_editor_draw_drag_margin: - :ref:`bool` **editor_draw_drag_margin** @@ -247,6 +267,8 @@ If ``true``, the camera only moves when reaching the vertical drag margins. If ` If ``true``, draws the camera's drag margin rectangle in the editor. Default value: ``false`` +---- + .. _class_Camera2D_property_editor_draw_limits: - :ref:`bool` **editor_draw_limits** @@ -259,6 +281,8 @@ If ``true``, draws the camera's drag margin rectangle in the editor. Default val If ``true``, draws the camera's limits rectangle in the editor. Default value: ``true`` +---- + .. _class_Camera2D_property_editor_draw_screen: - :ref:`bool` **editor_draw_screen** @@ -271,6 +295,8 @@ If ``true``, draws the camera's limits rectangle in the editor. Default value: ` If ``true``, draws the camera's screen rectangle in the editor. Default value: ``false`` +---- + .. _class_Camera2D_property_limit_bottom: - :ref:`int` **limit_bottom** @@ -283,6 +309,8 @@ If ``true``, draws the camera's screen rectangle in the editor. Default value: ` Bottom scroll limit in pixels. The camera stops moving when reaching this value. +---- + .. _class_Camera2D_property_limit_left: - :ref:`int` **limit_left** @@ -295,6 +323,8 @@ Bottom scroll limit in pixels. The camera stops moving when reaching this value. Left scroll limit in pixels. The camera stops moving when reaching this value. +---- + .. _class_Camera2D_property_limit_right: - :ref:`int` **limit_right** @@ -307,6 +337,8 @@ Left scroll limit in pixels. The camera stops moving when reaching this value. Right scroll limit in pixels. The camera stops moving when reaching this value. +---- + .. _class_Camera2D_property_limit_smoothed: - :ref:`bool` **limit_smoothed** @@ -319,6 +351,8 @@ Right scroll limit in pixels. The camera stops moving when reaching this value. If ``true``, the camera smoothly stops when reaches its limits. Default value: ``false`` +---- + .. _class_Camera2D_property_limit_top: - :ref:`int` **limit_top** @@ -331,6 +365,8 @@ If ``true``, the camera smoothly stops when reaches its limits. Default value: ` Top scroll limit in pixels. The camera stops moving when reaching this value. +---- + .. _class_Camera2D_property_offset: - :ref:`Vector2` **offset** @@ -343,6 +379,8 @@ Top scroll limit in pixels. The camera stops moving when reaching this value. The camera's offset, useful for looking around or camera shake animations. +---- + .. _class_Camera2D_property_offset_h: - :ref:`float` **offset_h** @@ -355,6 +393,8 @@ The camera's offset, useful for looking around or camera shake animations. The horizontal offset of the camera, relative to the drag margins. Default value: ``0`` +---- + .. _class_Camera2D_property_offset_v: - :ref:`float` **offset_v** @@ -367,6 +407,8 @@ The horizontal offset of the camera, relative to the drag margins. Default value The vertical offset of the camera, relative to the drag margins. Default value: ``0`` +---- + .. _class_Camera2D_property_process_mode: - :ref:`Camera2DProcessMode` **process_mode** @@ -377,6 +419,8 @@ The vertical offset of the camera, relative to the drag margins. Default value: | *Getter* | get_process_mode() | +----------+-------------------------+ +---- + .. _class_Camera2D_property_rotating: - :ref:`bool` **rotating** @@ -389,6 +433,8 @@ The vertical offset of the camera, relative to the drag margins. Default value: If ``true``, the camera rotates with the target. Default value: ``false`` +---- + .. _class_Camera2D_property_smoothing_enabled: - :ref:`bool` **smoothing_enabled** @@ -401,6 +447,8 @@ If ``true``, the camera rotates with the target. Default value: ``false`` If ``true``, the camera smoothly moves towards the target at :ref:`smoothing_speed`. Default value: ``false`` +---- + .. _class_Camera2D_property_smoothing_speed: - :ref:`float` **smoothing_speed** @@ -413,6 +461,8 @@ If ``true``, the camera smoothly moves towards the target at :ref:`smoothing_spe Speed in pixels per second of the camera's smoothing effect when :ref:`smoothing_enabled` is ``true`` +---- + .. _class_Camera2D_property_zoom: - :ref:`Vector2` **zoom** @@ -434,36 +484,48 @@ Method Descriptions Align the camera to the tracked node +---- + .. _class_Camera2D_method_clear_current: - void **clear_current** **(** **)** Removes any ``Camera2D`` from the ancestor :ref:`Viewport`'s internal currently-assigned camera. +---- + .. _class_Camera2D_method_force_update_scroll: - void **force_update_scroll** **(** **)** Force the camera to update scroll immediately. +---- + .. _class_Camera2D_method_get_camera_position: - :ref:`Vector2` **get_camera_position** **(** **)** const Returns the camera position. +---- + .. _class_Camera2D_method_get_camera_screen_center: - :ref:`Vector2` **get_camera_screen_center** **(** **)** const Returns the location of the ``Camera2D``'s screen-center, relative to the origin. +---- + .. _class_Camera2D_method_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_method_reset_smoothing: - void **reset_smoothing** **(** **)** diff --git a/classes/class_canvasitem.rst b/classes/class_canvasitem.rst index 3c7b7bab0..3831943e2 100644 --- a/classes/class_canvasitem.rst +++ b/classes/class_canvasitem.rst @@ -145,18 +145,24 @@ Signals Emitted when the CanvasItem must redraw. This can only be connected realtime, as deferred will not allow drawing. +---- + .. _class_CanvasItem_signal_hide: - **hide** **(** **)** Emitted when becoming hidden. +---- + .. _class_CanvasItem_signal_item_rect_changed: - **item_rect_changed** **(** **)** Emitted when the item rect has changed. +---- + .. _class_CanvasItem_signal_visibility_changed: - **visibility_changed** **(** **)** @@ -252,6 +258,8 @@ Property Descriptions The rendering layers in which this ``CanvasItem`` responds to :ref:`Light2D` nodes. Default value: ``1``. +---- + .. _class_CanvasItem_property_material: - :ref:`Material` **material** @@ -264,6 +272,8 @@ The rendering layers in which this ``CanvasItem`` responds to :ref:`Light2D` **modulate** @@ -276,6 +286,8 @@ The material applied to textures on this ``CanvasItem``. Default value: ``null`` The color applied to textures on this ``CanvasItem``. Default value: ``Color(1, 1, 1, 1)`` (opaque "white"). +---- + .. _class_CanvasItem_property_self_modulate: - :ref:`Color` **self_modulate** @@ -288,6 +300,8 @@ The color applied to textures on this ``CanvasItem``. Default value: ``Color(1, The color applied to textures on this ``CanvasItem``. This is not inherited by children ``CanvasItem``\ s. Default value: ``Color(1, 1, 1, 1)`` (opaque "white").. +---- + .. _class_CanvasItem_property_show_behind_parent: - :ref:`bool` **show_behind_parent** @@ -300,12 +314,16 @@ The color applied to textures on this ``CanvasItem``. This is not inherited by c If ``true``, the object draws behind its parent. Default value: ``false``. +---- + .. _class_CanvasItem_property_show_on_top: - :ref:`bool` **show_on_top** If ``true``, the object draws on top of its parent. Default value: ``true``. +---- + .. _class_CanvasItem_property_use_parent_material: - :ref:`bool` **use_parent_material** @@ -318,6 +336,8 @@ If ``true``, the object draws on top of its parent. Default value: ``true``. If ``true``, the parent ``CanvasItem``'s :ref:`material` property is used as this one's material. Default value: ``false``. +---- + .. _class_CanvasItem_property_visible: - :ref:`bool` **visible** @@ -339,258 +359,346 @@ Method Descriptions Called (if exists) to draw the canvas item. +---- + .. _class_CanvasItem_method_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 ) **)** Draws a string character using a custom font. Returns the advance, depending on the character width and kerning with an optional next character. +---- + .. _class_CanvasItem_method_draw_circle: - void **draw_circle** **(** :ref:`Vector2` position, :ref:`float` radius, :ref:`Color` color **)** Draws a colored circle. +---- + .. _class_CanvasItem_method_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 **)** Draws a colored polygon of any amount of points, convex or concave. +---- + .. _class_CanvasItem_method_draw_line: - void **draw_line** **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** Draws a line from a 2D point to another, with a given color and width. It can be optionally antialiased. +---- + .. _class_CanvasItem_method_draw_mesh: - void **draw_mesh** **(** :ref:`Mesh` mesh, :ref:`Texture` texture, :ref:`Texture` normal_map=null **)** +---- + .. _class_CanvasItem_method_draw_multiline: - void **draw_multiline** **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** Draws multiple, parallel lines with a uniform ``color``. ``width`` and ``antialiased`` are currently not implemented and have no effect. +---- + .. _class_CanvasItem_method_draw_multiline_colors: - void **draw_multiline_colors** **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** Draws multiple, parallel lines with a uniform ``width``, segment-by-segment coloring, and optional antialiasing. Colors assigned to line segments match by index between ``points`` and ``colors``. +---- + .. _class_CanvasItem_method_draw_multimesh: - void **draw_multimesh** **(** :ref:`MultiMesh` multimesh, :ref:`Texture` texture, :ref:`Texture` normal_map=null **)** +---- + .. _class_CanvasItem_method_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 **)** Draws a polygon of any amount of points, convex or concave. +---- + .. _class_CanvasItem_method_draw_polyline: - void **draw_polyline** **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** Draws interconnected line segments with a uniform ``color`` and ``width`` and optional antialiasing. +---- + .. _class_CanvasItem_method_draw_polyline_colors: - void **draw_polyline_colors** **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** Draws interconnected line segments with a uniform ``width``, segment-by-segment coloring, and optional antialiasing. Colors assigned to line segments match by index between ``points`` and ``colors``. +---- + .. _class_CanvasItem_method_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 **)** Draws 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_method_draw_rect: - void **draw_rect** **(** :ref:`Rect2` rect, :ref:`Color` color, :ref:`bool` filled=true **)** Draws a colored rectangle. +---- + .. _class_CanvasItem_method_draw_set_transform: - void **draw_set_transform** **(** :ref:`Vector2` position, :ref:`float` rotation, :ref:`Vector2` scale **)** Sets a custom transform for drawing via components. Anything drawn afterwards will be transformed by this. +---- + .. _class_CanvasItem_method_draw_set_transform_matrix: - void **draw_set_transform_matrix** **(** :ref:`Transform2D` xform **)** Sets a custom transform for drawing via matrix. Anything drawn afterwards will be transformed by this. +---- + .. _class_CanvasItem_method_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 **)** Draws a string using a custom font. +---- + .. _class_CanvasItem_method_draw_style_box: - void **draw_style_box** **(** :ref:`StyleBox` style_box, :ref:`Rect2` rect **)** Draws a styled rectangle. +---- + .. _class_CanvasItem_method_draw_texture: - void **draw_texture** **(** :ref:`Texture` texture, :ref:`Vector2` position, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`Texture` normal_map=null **)** Draws a texture at a given position. +---- + .. _class_CanvasItem_method_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 **)** Draws a textured rectangle at a given position, optionally modulated by a color. If ``transpose`` is ``true``, the texture will have its X and Y coordinates swapped. +---- + .. _class_CanvasItem_method_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 **)** Draws a textured rectangle region at a given position, optionally modulated by a color. If ``transpose`` is ``true``, the texture will have its X and Y coordinates swapped. +---- + .. _class_CanvasItem_method_force_update_transform: - void **force_update_transform** **(** **)** +---- + .. _class_CanvasItem_method_get_canvas: - :ref:`RID` **get_canvas** **(** **)** const Returns the :ref:`RID` of the :ref:`World2D` canvas where this item is in. +---- + .. _class_CanvasItem_method_get_canvas_item: - :ref:`RID` **get_canvas_item** **(** **)** const Returns the canvas item RID used by :ref:`VisualServer` for this item. +---- + .. _class_CanvasItem_method_get_canvas_transform: - :ref:`Transform2D` **get_canvas_transform** **(** **)** const Get the transform matrix of this item's canvas. +---- + .. _class_CanvasItem_method_get_global_mouse_position: - :ref:`Vector2` **get_global_mouse_position** **(** **)** const Get the global position of the mouse. +---- + .. _class_CanvasItem_method_get_global_transform: - :ref:`Transform2D` **get_global_transform** **(** **)** const Get the global transform matrix of this item. +---- + .. _class_CanvasItem_method_get_global_transform_with_canvas: - :ref:`Transform2D` **get_global_transform_with_canvas** **(** **)** const Get the global transform matrix of this item in relation to the canvas. +---- + .. _class_CanvasItem_method_get_local_mouse_position: - :ref:`Vector2` **get_local_mouse_position** **(** **)** const Get the mouse position relative to this item's position. +---- + .. _class_CanvasItem_method_get_transform: - :ref:`Transform2D` **get_transform** **(** **)** const Get the transform matrix of this item. +---- + .. _class_CanvasItem_method_get_viewport_rect: - :ref:`Rect2` **get_viewport_rect** **(** **)** const Get the viewport's boundaries as a :ref:`Rect2`. +---- + .. _class_CanvasItem_method_get_viewport_transform: - :ref:`Transform2D` **get_viewport_transform** **(** **)** const Get this item's transform in relation to the viewport. +---- + .. _class_CanvasItem_method_get_world_2d: - :ref:`World2D` **get_world_2d** **(** **)** const Get the :ref:`World2D` where this item is in. +---- + .. _class_CanvasItem_method_hide: - void **hide** **(** **)** Hide the CanvasItem if it's currently visible. +---- + .. _class_CanvasItem_method_is_local_transform_notification_enabled: - :ref:`bool` **is_local_transform_notification_enabled** **(** **)** const Returns ``true`` if local transform notifications are communicated to children. +---- + .. _class_CanvasItem_method_is_set_as_toplevel: - :ref:`bool` **is_set_as_toplevel** **(** **)** const Returns ``true`` if the node is set as top-level. See :ref:`set_as_toplevel`. +---- + .. _class_CanvasItem_method_is_transform_notification_enabled: - :ref:`bool` **is_transform_notification_enabled** **(** **)** const Returns ``true`` if global transform notifications are communicated to children. +---- + .. _class_CanvasItem_method_is_visible_in_tree: - :ref:`bool` **is_visible_in_tree** **(** **)** const Returns ``true`` if the node is present in the :ref:`SceneTree`, its :ref:`visible` property is ``true`` and its inherited visibility is also ``true``. +---- + .. _class_CanvasItem_method_make_canvas_position_local: - :ref:`Vector2` **make_canvas_position_local** **(** :ref:`Vector2` screen_point **)** const Assigns ``screen_point`` as this node's new local transform. +---- + .. _class_CanvasItem_method_make_input_local: - :ref:`InputEvent` **make_input_local** **(** :ref:`InputEvent` event **)** const Transformations issued by ``event``'s inputs are applied in local space instead of global space. +---- + .. _class_CanvasItem_method_set_as_toplevel: - void **set_as_toplevel** **(** :ref:`bool` enable **)** If ``enable`` is ``true``, the node won't inherit its transform from parent canvas items. +---- + .. _class_CanvasItem_method_set_notify_local_transform: - void **set_notify_local_transform** **(** :ref:`bool` enable **)** If ``enable`` is ``true``, children will be updated with local transform data. +---- + .. _class_CanvasItem_method_set_notify_transform: - void **set_notify_transform** **(** :ref:`bool` enable **)** If ``enable`` is ``true``, children will be updated with global transform data. +---- + .. _class_CanvasItem_method_show: - void **show** **(** **)** Show the CanvasItem if it's currently hidden. For controls that inherit :ref:`Popup`, the correct way to make them visible is to call one of the multiple ``popup*()`` functions instead. +---- + .. _class_CanvasItem_method_update: - void **update** **(** **)** diff --git a/classes/class_canvasitemmaterial.rst b/classes/class_canvasitemmaterial.rst index e022ee1ea..83cec325e 100644 --- a/classes/class_canvasitemmaterial.rst +++ b/classes/class_canvasitemmaterial.rst @@ -62,6 +62,8 @@ enum **BlendMode**: - **BLEND_MODE_PREMULT_ALPHA** = **4** --- Mix blending mode. Colors are assumed to be premultiplied by the alpha (opacity) value. +---- + .. _enum_CanvasItemMaterial_LightMode: .. _class_CanvasItemMaterial_constant_LIGHT_MODE_NORMAL: @@ -98,6 +100,8 @@ Property Descriptions The manner in which a material's rendering is applied to underlying textures. +---- + .. _class_CanvasItemMaterial_property_light_mode: - :ref:`LightMode` **light_mode** @@ -110,6 +114,8 @@ The manner in which a material's rendering is applied to underlying textures. The manner in which material reacts to lighting. +---- + .. _class_CanvasItemMaterial_property_particles_anim_h_frames: - :ref:`int` **particles_anim_h_frames** @@ -120,6 +126,8 @@ The manner in which material reacts to lighting. | *Getter* | get_particles_anim_h_frames() | +----------+------------------------------------+ +---- + .. _class_CanvasItemMaterial_property_particles_anim_loop: - :ref:`bool` **particles_anim_loop** @@ -130,6 +138,8 @@ The manner in which material reacts to lighting. | *Getter* | get_particles_anim_loop() | +----------+--------------------------------+ +---- + .. _class_CanvasItemMaterial_property_particles_anim_v_frames: - :ref:`int` **particles_anim_v_frames** @@ -140,6 +150,8 @@ The manner in which material reacts to lighting. | *Getter* | get_particles_anim_v_frames() | +----------+------------------------------------+ +---- + .. _class_CanvasItemMaterial_property_particles_animation: - :ref:`bool` **particles_animation** diff --git a/classes/class_canvaslayer.rst b/classes/class_canvaslayer.rst index 77a79ff6d..78913a8d7 100644 --- a/classes/class_canvaslayer.rst +++ b/classes/class_canvaslayer.rst @@ -73,6 +73,8 @@ Property Descriptions The custom :ref:`Viewport` node assigned to the ``CanvasLayer``. If null, uses the default viewport instead. +---- + .. _class_CanvasLayer_property_layer: - :ref:`int` **layer** @@ -85,6 +87,8 @@ The custom :ref:`Viewport` node assigned to the ``CanvasLayer``. Layer index for draw order. Lower values are drawn first. Default value: ``1``. +---- + .. _class_CanvasLayer_property_offset: - :ref:`Vector2` **offset** @@ -97,6 +101,8 @@ Layer index for draw order. Lower values are drawn first. Default value: ``1``. The layer's base offset. +---- + .. _class_CanvasLayer_property_rotation: - :ref:`float` **rotation** @@ -109,6 +115,8 @@ The layer's base offset. The layer's rotation in radians. +---- + .. _class_CanvasLayer_property_rotation_degrees: - :ref:`float` **rotation_degrees** @@ -121,6 +129,8 @@ The layer's rotation in radians. The layer's rotation in degrees. +---- + .. _class_CanvasLayer_property_scale: - :ref:`Vector2` **scale** @@ -133,6 +143,8 @@ The layer's rotation in degrees. The layer's scale. +---- + .. _class_CanvasLayer_property_transform: - :ref:`Transform2D` **transform** diff --git a/classes/class_capsulemesh.rst b/classes/class_capsulemesh.rst index ea4157fe8..6d3fbac42 100644 --- a/classes/class_capsulemesh.rst +++ b/classes/class_capsulemesh.rst @@ -51,6 +51,8 @@ Property Descriptions Height of the capsule mesh from the center point. Defaults to 1.0. +---- + .. _class_CapsuleMesh_property_radial_segments: - :ref:`int` **radial_segments** @@ -63,6 +65,8 @@ Height of the capsule mesh from the center point. Defaults to 1.0. Number of radial segments on the capsule mesh. Defaults to 64. +---- + .. _class_CapsuleMesh_property_radius: - :ref:`float` **radius** @@ -75,6 +79,8 @@ Number of radial segments on the capsule mesh. Defaults to 64. Radius of the capsule mesh. Defaults to 1.0. +---- + .. _class_CapsuleMesh_property_rings: - :ref:`int` **rings** diff --git a/classes/class_capsuleshape.rst b/classes/class_capsuleshape.rst index 37bcb12b0..6938ee75d 100644 --- a/classes/class_capsuleshape.rst +++ b/classes/class_capsuleshape.rst @@ -47,6 +47,8 @@ Property Descriptions The capsule's height. +---- + .. _class_CapsuleShape_property_radius: - :ref:`float` **radius** diff --git a/classes/class_capsuleshape2d.rst b/classes/class_capsuleshape2d.rst index 50100fcad..289042f13 100644 --- a/classes/class_capsuleshape2d.rst +++ b/classes/class_capsuleshape2d.rst @@ -47,6 +47,8 @@ Property Descriptions The capsule's height. +---- + .. _class_CapsuleShape2D_property_radius: - :ref:`float` **radius** diff --git a/classes/class_classdb.rst b/classes/class_classdb.rst index 00c18205a..eeaa8888c 100644 --- a/classes/class_classdb.rst +++ b/classes/class_classdb.rst @@ -77,114 +77,152 @@ Method Descriptions Returns ``true`` if you can instance objects from the specified 'class', ``false`` in other case. +---- + .. _class_ClassDB_method_class_exists: - :ref:`bool` **class_exists** **(** :ref:`String` class **)** const Returns whether the specified 'class' is available or not. +---- + .. _class_ClassDB_method_class_get_category: - :ref:`String` **class_get_category** **(** :ref:`String` class **)** const Returns a category associated with the class for use in documentation and the Asset Library. Debug mode required. +---- + .. _class_ClassDB_method_class_get_integer_constant: - :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_method_class_get_integer_constant_list: - :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_method_class_get_method_list: - :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_method_class_get_property: - :ref:`Variant` **class_get_property** **(** :ref:`Object` object, :ref:`String` property **)** const Returns the value of 'property' of 'class' or its ancestry. +---- + .. _class_ClassDB_method_class_get_property_list: - :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_method_class_get_signal: - :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_method_class_get_signal_list: - :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 :ref:`class_get_signal`. +---- + .. _class_ClassDB_method_class_has_integer_constant: - :ref:`bool` **class_has_integer_constant** **(** :ref:`String` class, :ref:`String` name **)** const Returns whether 'class' or its ancestry has an integer constant called 'name' or not. +---- + .. _class_ClassDB_method_class_has_method: - :ref:`bool` **class_has_method** **(** :ref:`String` class, :ref:`String` method, :ref:`bool` no_inheritance=false **)** const Returns whether 'class' (or its ancestry if 'no_inheritance' is false) has a method called 'method' or not. +---- + .. _class_ClassDB_method_class_has_signal: - :ref:`bool` **class_has_signal** **(** :ref:`String` class, :ref:`String` signal **)** const Returns whether 'class' or its ancestry has a signal called 'signal' or not. +---- + .. _class_ClassDB_method_class_set_property: - :ref:`Error` **class_set_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** const Sets 'property' value of 'class' to 'value'. +---- + .. _class_ClassDB_method_get_class_list: - :ref:`PoolStringArray` **get_class_list** **(** **)** const Returns the names of all the classes available. +---- + .. _class_ClassDB_method_get_inheriters_from_class: - :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_method_get_parent_class: - :ref:`String` **get_parent_class** **(** :ref:`String` class **)** const Returns the parent class of 'class'. +---- + .. _class_ClassDB_method_instance: - :ref:`Variant` **instance** **(** :ref:`String` class **)** const Creates an instance of 'class'. +---- + .. _class_ClassDB_method_is_class_enabled: - :ref:`bool` **is_class_enabled** **(** :ref:`String` class **)** const Returns whether this class is enabled or not. +---- + .. _class_ClassDB_method_is_parent_class: - :ref:`bool` **is_parent_class** **(** :ref:`String` class, :ref:`String` inherits **)** const diff --git a/classes/class_clippedcamera.rst b/classes/class_clippedcamera.rst index b3df0e6e6..9de1c0465 100644 --- a/classes/class_clippedcamera.rst +++ b/classes/class_clippedcamera.rst @@ -80,6 +80,8 @@ Property Descriptions | *Getter* | is_clip_to_areas_enabled() | +----------+----------------------------+ +---- + .. _class_ClippedCamera_property_clip_to_bodies: - :ref:`bool` **clip_to_bodies** @@ -90,6 +92,8 @@ Property Descriptions | *Getter* | is_clip_to_bodies_enabled() | +----------+-----------------------------+ +---- + .. _class_ClippedCamera_property_collision_mask: - :ref:`int` **collision_mask** @@ -100,6 +104,8 @@ Property Descriptions | *Getter* | get_collision_mask() | +----------+---------------------------+ +---- + .. _class_ClippedCamera_property_margin: - :ref:`float` **margin** @@ -110,6 +116,8 @@ Property Descriptions | *Getter* | get_margin() | +----------+-------------------+ +---- + .. _class_ClippedCamera_property_process_mode: - :ref:`ProcessMode` **process_mode** @@ -127,26 +135,38 @@ Method Descriptions - void **add_exception** **(** :ref:`Object` node **)** +---- + .. _class_ClippedCamera_method_add_exception_rid: - void **add_exception_rid** **(** :ref:`RID` rid **)** +---- + .. _class_ClippedCamera_method_clear_exceptions: - void **clear_exceptions** **(** **)** +---- + .. _class_ClippedCamera_method_get_collision_mask_bit: - :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const +---- + .. _class_ClippedCamera_method_remove_exception: - void **remove_exception** **(** :ref:`Object` node **)** +---- + .. _class_ClippedCamera_method_remove_exception_rid: - void **remove_exception_rid** **(** :ref:`RID` rid **)** +---- + .. _class_ClippedCamera_method_set_collision_mask_bit: - void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** diff --git a/classes/class_collisionobject.rst b/classes/class_collisionobject.rst index 6b6569aa5..bcff4a4a1 100644 --- a/classes/class_collisionobject.rst +++ b/classes/class_collisionobject.rst @@ -77,12 +77,16 @@ Signals Emitted when :ref:`_input_event` receives an event. See its description for details. +---- + .. _class_CollisionObject_signal_mouse_entered: - **mouse_entered** **(** **)** Emitted when the mouse pointer enters any of this object's shapes. +---- + .. _class_CollisionObject_signal_mouse_exited: - **mouse_exited** **(** **)** @@ -109,6 +113,8 @@ Property Descriptions If ``true``, the ``CollisionObject`` will continue to receive input events as the mouse is dragged across its shapes. Default value: ``false``. +---- + .. _class_CollisionObject_property_input_ray_pickable: - :ref:`bool` **input_ray_pickable** @@ -130,96 +136,128 @@ Method Descriptions Accepts unhandled :ref:`InputEvent`\ s. ``click_position`` is the clicked location in world space and ``click_normal`` is the normal vector extending from the clicked surface of the :ref:`Shape` at ``shape_idx``. Connect to the ``input_event`` signal to easily pick up these events. +---- + .. _class_CollisionObject_method_create_shape_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_method_get_rid: - :ref:`RID` **get_rid** **(** **)** const Returns the object's :ref:`RID`. +---- + .. _class_CollisionObject_method_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_method_is_shape_owner_disabled: - :ref:`bool` **is_shape_owner_disabled** **(** :ref:`int` owner_id **)** const If ``true``, the shape owner and its shapes are disabled. +---- + .. _class_CollisionObject_method_remove_shape_owner: - void **remove_shape_owner** **(** :ref:`int` owner_id **)** Removes the given shape owner. +---- + .. _class_CollisionObject_method_shape_find_owner: - :ref:`int` **shape_find_owner** **(** :ref:`int` shape_index **)** const Returns the ``owner_id`` of the given shape. +---- + .. _class_CollisionObject_method_shape_owner_add_shape: - void **shape_owner_add_shape** **(** :ref:`int` owner_id, :ref:`Shape` shape **)** Adds a :ref:`Shape` to the shape owner. +---- + .. _class_CollisionObject_method_shape_owner_clear_shapes: - void **shape_owner_clear_shapes** **(** :ref:`int` owner_id **)** Removes all shapes from the shape owner. +---- + .. _class_CollisionObject_method_shape_owner_get_owner: - :ref:`Object` **shape_owner_get_owner** **(** :ref:`int` owner_id **)** const Returns the parent object of the given shape owner. +---- + .. _class_CollisionObject_method_shape_owner_get_shape: - :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_method_shape_owner_get_shape_count: - :ref:`int` **shape_owner_get_shape_count** **(** :ref:`int` owner_id **)** const Returns the number of shapes the given shape owner contains. +---- + .. _class_CollisionObject_method_shape_owner_get_shape_index: - :ref:`int` **shape_owner_get_shape_index** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const Returns the child index of the :ref:`Shape` with the given id from the given shape owner. +---- + .. _class_CollisionObject_method_shape_owner_get_transform: - :ref:`Transform` **shape_owner_get_transform** **(** :ref:`int` owner_id **)** const Returns the shape owner's :ref:`Transform`. +---- + .. _class_CollisionObject_method_shape_owner_remove_shape: - void **shape_owner_remove_shape** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** Removes a shape from the given shape owner. +---- + .. _class_CollisionObject_method_shape_owner_set_disabled: - void **shape_owner_set_disabled** **(** :ref:`int` owner_id, :ref:`bool` disabled **)** If ``true``, disables the given shape owner. +---- + .. _class_CollisionObject_method_shape_owner_set_transform: - void **shape_owner_set_transform** **(** :ref:`int` owner_id, :ref:`Transform` transform **)** diff --git a/classes/class_collisionobject2d.rst b/classes/class_collisionobject2d.rst index 664588872..b625bd85f 100644 --- a/classes/class_collisionobject2d.rst +++ b/classes/class_collisionobject2d.rst @@ -83,12 +83,16 @@ Signals Emitted when an input event occurs. Requires :ref:`input_pickable` to be ``true`` and at least one ``collision_layer`` bit to be set. See :ref:`_input_event` for details. +---- + .. _class_CollisionObject2D_signal_mouse_entered: - **mouse_entered** **(** **)** Emitted when the mouse pointer enters any of this object's shapes. Requires :ref:`input_pickable` to be ``true`` and at least one ``collision_layer`` bit to be set. +---- + .. _class_CollisionObject2D_signal_mouse_exited: - **mouse_exited** **(** **)** @@ -124,116 +128,156 @@ Method Descriptions Accepts unhandled :ref:`InputEvent`\ s. Requires :ref:`input_pickable` to be ``true``. ``shape_idx`` is the child index of the clicked :ref:`Shape2D`. Connect to the ``input_event`` signal to easily pick up these events. +---- + .. _class_CollisionObject2D_method_create_shape_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_method_get_rid: - :ref:`RID` **get_rid** **(** **)** const Returns the object's :ref:`RID`. +---- + .. _class_CollisionObject2D_method_get_shape_owner_one_way_collision_margin: - :ref:`float` **get_shape_owner_one_way_collision_margin** **(** :ref:`int` owner_id **)** const +---- + .. _class_CollisionObject2D_method_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_method_is_shape_owner_disabled: - :ref:`bool` **is_shape_owner_disabled** **(** :ref:`int` owner_id **)** const If ``true``, the shape owner and its shapes are disabled. +---- + .. _class_CollisionObject2D_method_is_shape_owner_one_way_collision_enabled: - :ref:`bool` **is_shape_owner_one_way_collision_enabled** **(** :ref:`int` owner_id **)** const Returns ``true`` if collisions for the shape owner originating from this ``CollisionObject2D`` will not be reported to collided with ``CollisionObject2D``\ s. +---- + .. _class_CollisionObject2D_method_remove_shape_owner: - void **remove_shape_owner** **(** :ref:`int` owner_id **)** Removes the given shape owner. +---- + .. _class_CollisionObject2D_method_shape_find_owner: - :ref:`int` **shape_find_owner** **(** :ref:`int` shape_index **)** const Returns the ``owner_id`` of the given shape. +---- + .. _class_CollisionObject2D_method_shape_owner_add_shape: - void **shape_owner_add_shape** **(** :ref:`int` owner_id, :ref:`Shape2D` shape **)** Adds a :ref:`Shape2D` to the shape owner. +---- + .. _class_CollisionObject2D_method_shape_owner_clear_shapes: - void **shape_owner_clear_shapes** **(** :ref:`int` owner_id **)** Removes all shapes from the shape owner. +---- + .. _class_CollisionObject2D_method_shape_owner_get_owner: - :ref:`Object` **shape_owner_get_owner** **(** :ref:`int` owner_id **)** const Returns the parent object of the given shape owner. +---- + .. _class_CollisionObject2D_method_shape_owner_get_shape: - :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_method_shape_owner_get_shape_count: - :ref:`int` **shape_owner_get_shape_count** **(** :ref:`int` owner_id **)** const Returns the number of shapes the given shape owner contains. +---- + .. _class_CollisionObject2D_method_shape_owner_get_shape_index: - :ref:`int` **shape_owner_get_shape_index** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const Returns the child index of the :ref:`Shape2D` with the given id from the given shape owner. +---- + .. _class_CollisionObject2D_method_shape_owner_get_transform: - :ref:`Transform2D` **shape_owner_get_transform** **(** :ref:`int` owner_id **)** const Returns the shape owner's :ref:`Transform2D`. +---- + .. _class_CollisionObject2D_method_shape_owner_remove_shape: - void **shape_owner_remove_shape** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** Removes a shape from the given shape owner. +---- + .. _class_CollisionObject2D_method_shape_owner_set_disabled: - void **shape_owner_set_disabled** **(** :ref:`int` owner_id, :ref:`bool` disabled **)** If ``true``, disables the given shape owner. +---- + .. _class_CollisionObject2D_method_shape_owner_set_one_way_collision: - void **shape_owner_set_one_way_collision** **(** :ref:`int` owner_id, :ref:`bool` enable **)** If ``enable`` is ``true``, collisions for the shape owner originating from this ``CollisionObject2D`` will not be reported to collided with ``CollisionObject2D``\ s. +---- + .. _class_CollisionObject2D_method_shape_owner_set_one_way_collision_margin: - void **shape_owner_set_one_way_collision_margin** **(** :ref:`int` owner_id, :ref:`float` margin **)** +---- + .. _class_CollisionObject2D_method_shape_owner_set_transform: - void **shape_owner_set_transform** **(** :ref:`int` owner_id, :ref:`Transform2D` transform **)** diff --git a/classes/class_collisionpolygon.rst b/classes/class_collisionpolygon.rst index 1c0ab7ce4..53767d065 100644 --- a/classes/class_collisionpolygon.rst +++ b/classes/class_collisionpolygon.rst @@ -49,6 +49,8 @@ Property Descriptions Length that the resulting collision extends in either direction perpendicular to its polygon. +---- + .. _class_CollisionPolygon_property_disabled: - :ref:`bool` **disabled** @@ -61,6 +63,8 @@ Length that the resulting collision extends in either direction perpendicular to If ``true``, no collision will be produced. +---- + .. _class_CollisionPolygon_property_polygon: - :ref:`PoolVector2Array` **polygon** diff --git a/classes/class_collisionpolygon2d.rst b/classes/class_collisionpolygon2d.rst index 3a42457a3..8abd17da1 100644 --- a/classes/class_collisionpolygon2d.rst +++ b/classes/class_collisionpolygon2d.rst @@ -68,6 +68,8 @@ Property Descriptions Collision build mode. Use one of the ``BUILD_*`` constants. Default value: :ref:`BUILD_SOLIDS`. +---- + .. _class_CollisionPolygon2D_property_disabled: - :ref:`bool` **disabled** @@ -80,6 +82,8 @@ Collision build mode. Use one of the ``BUILD_*`` constants. Default value: :ref: If ``true``, no collisions will be detected. +---- + .. _class_CollisionPolygon2D_property_one_way_collision: - :ref:`bool` **one_way_collision** @@ -92,6 +96,8 @@ If ``true``, no collisions will be detected. If ``true``, only edges that face up, relative to CollisionPolygon2D's rotation, will collide with other objects. +---- + .. _class_CollisionPolygon2D_property_one_way_collision_margin: - :ref:`float` **one_way_collision_margin** @@ -102,6 +108,8 @@ If ``true``, only edges that face up, relative to CollisionPolygon2D's rotation, | *Getter* | get_one_way_collision_margin() | +----------+-------------------------------------+ +---- + .. _class_CollisionPolygon2D_property_polygon: - :ref:`PoolVector2Array` **polygon** diff --git a/classes/class_collisionshape.rst b/classes/class_collisionshape.rst index d0c058748..8b1ad1e1c 100644 --- a/classes/class_collisionshape.rst +++ b/classes/class_collisionshape.rst @@ -61,6 +61,8 @@ Property Descriptions A disabled collision shape has no effect in the world. +---- + .. _class_CollisionShape_property_shape: - :ref:`Shape` **shape** @@ -82,6 +84,8 @@ Method Descriptions Sets the collision shape's shape to the addition of all its convexed :ref:`MeshInstance` siblings geometry. +---- + .. _class_CollisionShape_method_resource_changed: - void **resource_changed** **(** :ref:`Resource` resource **)** diff --git a/classes/class_collisionshape2d.rst b/classes/class_collisionshape2d.rst index a0f9b6b5d..b9c0af761 100644 --- a/classes/class_collisionshape2d.rst +++ b/classes/class_collisionshape2d.rst @@ -56,6 +56,8 @@ Property Descriptions A disabled collision shape has no effect in the world. +---- + .. _class_CollisionShape2D_property_one_way_collision: - :ref:`bool` **one_way_collision** @@ -68,6 +70,8 @@ A disabled collision shape has no effect in the world. Sets whether this collision shape should only detect collision on one side (top or bottom). +---- + .. _class_CollisionShape2D_property_one_way_collision_margin: - :ref:`float` **one_way_collision_margin** @@ -78,6 +82,8 @@ Sets whether this collision shape should only detect collision on one side (top | *Getter* | get_one_way_collision_margin() | +----------+-------------------------------------+ +---- + .. _class_CollisionShape2D_property_shape: - :ref:`Shape2D` **shape** diff --git a/classes/class_color.rst b/classes/class_color.rst index a51eb6a27..2a7cccaad 100644 --- a/classes/class_color.rst +++ b/classes/class_color.rst @@ -685,60 +685,80 @@ Property Descriptions Alpha value (range 0 to 1). +---- + .. _class_Color_property_a8: - :ref:`int` **a8** Alpha value (range 0 to 255). +---- + .. _class_Color_property_b: - :ref:`float` **b** Blue value (range 0 to 1). +---- + .. _class_Color_property_b8: - :ref:`int` **b8** Blue value (range 0 to 255). +---- + .. _class_Color_property_g: - :ref:`float` **g** Green value (range 0 to 1). +---- + .. _class_Color_property_g8: - :ref:`int` **g8** Green value (range 0 to 255). +---- + .. _class_Color_property_h: - :ref:`float` **h** HSV hue value (range 0 to 1). +---- + .. _class_Color_property_r: - :ref:`float` **r** Red value (range 0 to 1). +---- + .. _class_Color_property_r8: - :ref:`int` **r8** Red value (range 0 to 255). +---- + .. _class_Color_property_s: - :ref:`float` **s** HSV saturation value (range 0 to 1). +---- + .. _class_Color_property_v: - :ref:`float` **v** @@ -762,6 +782,8 @@ Constructs a color from an HTML hexadecimal color string in ARGB or RGB format. var c3 = Color("#b2d90a") # RGB format with '#' var c4 = Color("b2d90a") # RGB format +---- + - :ref:`Color` **Color** **(** :ref:`int` from **)** Constructs a color from a 32-bit integer (each byte represents a component of the RGBA profile). @@ -770,6 +792,8 @@ Constructs a color from a 32-bit integer (each byte represents a component of th var c = Color(274) # Equivalent to RGBA(0, 0, 1, 18) +---- + - :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. Alpha will always be 1. @@ -778,6 +802,8 @@ Constructs a color from an RGB profile using values between 0 and 1. Alpha will var c = Color(0.2, 1.0, 0.7) # Equivalent to RGBA(51, 255, 178, 255) +---- + - :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. @@ -786,6 +812,8 @@ Constructs a color from an RGBA profile using values between 0 and 1. var c = Color(0.2, 1.0, 0.7, 0.8) # Equivalent to RGBA(51, 255, 178, 204) +---- + .. _class_Color_method_blend: - :ref:`Color` **blend** **(** :ref:`Color` over **)** @@ -798,6 +826,8 @@ Returns a new color resulting from blending this color over another. If the colo var fg = Color(1.0, 0.0, 0.0, 0.5) # Red with alpha of 50% var blended_color = bg.blend(fg) # Brown with alpha of 75% +---- + .. _class_Color_method_contrasted: - :ref:`Color` **contrasted** **(** **)** @@ -809,6 +839,8 @@ Returns the most contrasting color. var c = Color(0.3, 0.4, 0.9) var contrasted_color = c.contrasted() # Equivalent to RGBA(204, 229, 102, 255) +---- + .. _class_Color_method_darkened: - :ref:`Color` **darkened** **(** :ref:`float` amount **)** @@ -820,6 +852,8 @@ Returns a new color resulting from making this color darker by the specified per var green = Color(0.0, 1.0, 0.0) var darkgreen = green.darkened(0.2) # 20% darker than regular green +---- + .. _class_Color_method_from_hsv: - :ref:`Color` **from_hsv** **(** :ref:`float` h, :ref:`float` s, :ref:`float` v, :ref:`float` a=1 **)** @@ -830,6 +864,8 @@ Constructs a color from an HSV profile. ``h``, ``s``, and ``v`` are values betwe var c = Color.from_hsv(0.58, 0.5, 0.79, 0.8) # Equivalent to HSV(210, 50, 79, 0.8) or Color8(100, 151, 201, 0.8) +---- + .. _class_Color_method_gray: - :ref:`float` **gray** **(** **)** @@ -843,6 +879,8 @@ The gray value is calculated as ``(r + g + b) / 3``. var c = Color(0.2, 0.45, 0.82) var gray = c.gray() # a value of 0.466667 +---- + .. _class_Color_method_inverted: - :ref:`Color` **inverted** **(** **)** @@ -854,6 +892,8 @@ Returns the inverted color ``(1 - r, 1 - g, 1 - b, a)``. var c = Color(0.3, 0.4, 0.9) var inverted_color = c.inverted() # a color of an RGBA(178, 153, 26, 255) +---- + .. _class_Color_method_lightened: - :ref:`Color` **lightened** **(** :ref:`float` amount **)** @@ -865,6 +905,8 @@ Returns a new color resulting from making this color lighter by the specified pe var green = Color(0.0, 1.0, 0.0) var lightgreen = green.lightened(0.2) # 20% lighter than regular green +---- + .. _class_Color_method_linear_interpolate: - :ref:`Color` **linear_interpolate** **(** :ref:`Color` b, :ref:`float` t **)** @@ -877,6 +919,8 @@ Returns the linear interpolation with another color. The interpolation factor `` var c2 = Color(0.0, 1.0, 0.0) var li_c = c1.linear_interpolate(c2, 0.5) # a color of an RGBA(128, 128, 0, 255) +---- + .. _class_Color_method_to_abgr32: - :ref:`int` **to_abgr32** **(** **)** @@ -888,6 +932,8 @@ Returns the color's 32-bit integer in ABGR format (each byte represents a compon var c = Color(1, 0.5, 0.2) print(c.to_abgr32()) # Prints 4281565439 +---- + .. _class_Color_method_to_abgr64: - :ref:`int` **to_abgr64** **(** **)** @@ -899,6 +945,8 @@ Returns the color's 64-bit integer in ABGR format (each word represents a compon var c = Color(1, 0.5, 0.2) print(c.to_abgr64()) # Prints -225178692812801 +---- + .. _class_Color_method_to_argb32: - :ref:`int` **to_argb32** **(** **)** @@ -910,6 +958,8 @@ Returns the color's 32-bit integer in ARGB format (each byte represents a compon var c = Color(1, 0.5, 0.2) print(c.to_argb32()) # Prints 4294934323 +---- + .. _class_Color_method_to_argb64: - :ref:`int` **to_argb64** **(** **)** @@ -921,6 +971,8 @@ Returns the color's 64-bit integer in ARGB format (each word represents a compon var c = Color(1, 0.5, 0.2) print(c.to_argb64()) # Prints -2147470541 +---- + .. _class_Color_method_to_html: - :ref:`String` **to_html** **(** :ref:`bool` with_alpha=True **)** @@ -935,6 +987,8 @@ Setting ``with_alpha`` to ``false`` excludes alpha from the hexadecimal string. var s1 = c.to_html() # Results "7fffffff" var s2 = c.to_html(false) # Results 'ffffff' +---- + .. _class_Color_method_to_rgba32: - :ref:`int` **to_rgba32** **(** **)** @@ -946,6 +1000,8 @@ Returns the color's 32-bit integer in RGBA format (each byte represents a compon var c = Color(1, 0.5, 0.2) print(c.to_rgba32()) # Prints 4286526463 +---- + .. _class_Color_method_to_rgba64: - :ref:`int` **to_rgba64** **(** **)** diff --git a/classes/class_colorpicker.rst b/classes/class_colorpicker.rst index 2fd6f4e05..6c2f31a47 100644 --- a/classes/class_colorpicker.rst +++ b/classes/class_colorpicker.rst @@ -76,12 +76,16 @@ Signals Emitted when the color is changed. +---- + .. _class_ColorPicker_signal_preset_added: - **preset_added** **(** :ref:`Color` color **)** Emitted when a preset is added. +---- + .. _class_ColorPicker_signal_preset_removed: - **preset_removed** **(** :ref:`Color` color **)** @@ -108,6 +112,8 @@ Property Descriptions The currently selected color. +---- + .. _class_ColorPicker_property_deferred_mode: - :ref:`bool` **deferred_mode** @@ -120,6 +126,8 @@ The currently selected color. If ``true``, the color will apply only after the user releases the mouse button, otherwise it will apply immediately even in mouse motion event (which can cause performance issues). +---- + .. _class_ColorPicker_property_edit_alpha: - :ref:`bool` **edit_alpha** @@ -132,6 +140,8 @@ If ``true``, the color will apply only after the user releases the mouse button, If ``true``, shows an alpha channel slider (transparency). +---- + .. _class_ColorPicker_property_raw_mode: - :ref:`bool` **raw_mode** @@ -153,12 +163,16 @@ Method Descriptions Adds the given color to a list of color presets. The presets are displayed in the color picker and the user will be able to select them. Note: the presets list is only for *this* color picker. +---- + .. _class_ColorPicker_method_erase_preset: - void **erase_preset** **(** :ref:`Color` color **)** Remove the given color from the list of color presets of this color picker. +---- + .. _class_ColorPicker_method_get_presets: - :ref:`PoolColorArray` **get_presets** **(** **)** const diff --git a/classes/class_colorpickerbutton.rst b/classes/class_colorpickerbutton.rst index ba952aeb0..e77d6169d 100644 --- a/classes/class_colorpickerbutton.rst +++ b/classes/class_colorpickerbutton.rst @@ -74,6 +74,8 @@ Signals Emitted when the color changes. +---- + .. _class_ColorPickerButton_signal_popup_closed: - **popup_closed** **(** **)** @@ -98,6 +100,8 @@ Property Descriptions The currently selected color. +---- + .. _class_ColorPickerButton_property_edit_alpha: - :ref:`bool` **edit_alpha** @@ -119,6 +123,8 @@ Method Descriptions Returns the :ref:`ColorPicker` that this node toggles. +---- + .. _class_ColorPickerButton_method_get_popup: - :ref:`PopupPanel` **get_popup** **(** **)** diff --git a/classes/class_concavepolygonshape.rst b/classes/class_concavepolygonshape.rst index 3ac5f88a8..8231319e5 100644 --- a/classes/class_concavepolygonshape.rst +++ b/classes/class_concavepolygonshape.rst @@ -41,6 +41,8 @@ Method Descriptions Returns the faces (an array of triangles). +---- + .. _class_ConcavePolygonShape_method_set_faces: - void **set_faces** **(** :ref:`PoolVector3Array` faces **)** diff --git a/classes/class_conetwistjoint.rst b/classes/class_conetwistjoint.rst index 8babb577f..549ac786c 100644 --- a/classes/class_conetwistjoint.rst +++ b/classes/class_conetwistjoint.rst @@ -100,6 +100,8 @@ The speed with which the swing or twist will take place. The higher, the faster. +---- + .. _class_ConeTwistJoint_property_relaxation: - :ref:`float` **relaxation** @@ -112,6 +114,8 @@ The higher, the faster. Defines, how fast the swing- and twist-speed-difference on both sides gets synced. +---- + .. _class_ConeTwistJoint_property_softness: - :ref:`float` **softness** @@ -124,6 +128,8 @@ Defines, how fast the swing- and twist-speed-difference on both sides gets synce The ease with which the joint starts to twist. If it's too low, it takes more force to start twisting the joint. +---- + .. _class_ConeTwistJoint_property_swing_span: - :ref:`float` **swing_span** @@ -136,6 +142,8 @@ Could be defined as looseness in the ``ConeTwistJoint``. If below 0.05, this behavior is locked. Default value: ``PI/4``. +---- + .. _class_ConeTwistJoint_property_twist_span: - :ref:`float` **twist_span** diff --git a/classes/class_configfile.rst b/classes/class_configfile.rst index 294844f79..6a2bc48e5 100644 --- a/classes/class_configfile.rst +++ b/classes/class_configfile.rst @@ -81,48 +81,64 @@ Method Descriptions Deletes the specified section along with all the key-value pairs inside. +---- + .. _class_ConfigFile_method_get_section_keys: - :ref:`PoolStringArray` **get_section_keys** **(** :ref:`String` section **)** const Returns an array of all defined key identifiers in the specified section. +---- + .. _class_ConfigFile_method_get_sections: - :ref:`PoolStringArray` **get_sections** **(** **)** const Returns an array of all defined section identifiers. +---- + .. _class_ConfigFile_method_get_value: - :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_method_has_section: - :ref:`bool` **has_section** **(** :ref:`String` section **)** const Returns ``true`` if the specified section exists. +---- + .. _class_ConfigFile_method_has_section_key: - :ref:`bool` **has_section_key** **(** :ref:`String` section, :ref:`String` key **)** const Returns ``true`` if the specified section-key pair exists. +---- + .. _class_ConfigFile_method_load: - :ref:`Error` **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 :ref:`@GlobalScope.OK`, :ref:`@GlobalScope.FAILED` or ``ERR_*`` constants listed in :ref:`@GlobalScope`. If the load was successful, the return value is :ref:`@GlobalScope.OK`. +---- + .. _class_ConfigFile_method_save: - :ref:`Error` **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 :ref:`@GlobalScope.OK`, :ref:`@GlobalScope.FAILED` or ``ERR_*`` constants listed in :ref:`@GlobalScope`. If the load was successful, the return value is :ref:`@GlobalScope.OK`. +---- + .. _class_ConfigFile_method_set_value: - void **set_value** **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` value **)** diff --git a/classes/class_container.rst b/classes/class_container.rst index 00edb38cf..e29bca000 100644 --- a/classes/class_container.rst +++ b/classes/class_container.rst @@ -61,6 +61,8 @@ Method Descriptions Fit a child control in a given rect. This is mainly a helper for creating custom container classes. +---- + .. _class_Container_method_queue_sort: - void **queue_sort** **(** **)** diff --git a/classes/class_control.rst b/classes/class_control.rst index 385036519..481de18ff 100644 --- a/classes/class_control.rst +++ b/classes/class_control.rst @@ -225,48 +225,64 @@ Signals Emitted when the node gains keyboard focus. +---- + .. _class_Control_signal_focus_exited: - **focus_exited** **(** **)** Emitted when the node loses keyboard focus. +---- + .. _class_Control_signal_gui_input: - **gui_input** **(** :ref:`InputEvent` event **)** Emitted when the node receives an :ref:`InputEvent`. +---- + .. _class_Control_signal_minimum_size_changed: - **minimum_size_changed** **(** **)** Emitted when the node's minimum size changes. +---- + .. _class_Control_signal_modal_closed: - **modal_closed** **(** **)** Emitted when a modal ``Control`` is closed. See :ref:`show_modal`. +---- + .. _class_Control_signal_mouse_entered: - **mouse_entered** **(** **)** Emitted when the mouse enters the control's ``Rect`` area, provided its :ref:`mouse_filter` lets the event reach it. +---- + .. _class_Control_signal_mouse_exited: - **mouse_exited** **(** **)** Emitted when the mouse leaves the control's ``Rect`` area, provided its :ref:`mouse_filter` lets the event reach it. +---- + .. _class_Control_signal_resized: - **resized** **(** **)** Emitted when the control changes size. +---- + .. _class_Control_signal_size_flags_changed: - **size_flags_changed** **(** **)** @@ -292,6 +308,8 @@ enum **FocusMode**: - **FOCUS_ALL** = **2** --- The node can grab focus on mouse click or using the arrows and the Tab keys on the keyboard. Use with :ref:`focus_mode`. +---- + .. _enum_Control_CursorShape: .. _class_Control_constant_CURSOR_ARROW: @@ -364,6 +382,8 @@ enum **CursorShape**: - **CURSOR_HELP** = **16** --- Show the system's help mouse cursor when the user hovers the node, a question mark. +---- + .. _enum_Control_LayoutPreset: .. _class_Control_constant_PRESET_TOP_LEFT: @@ -432,6 +452,8 @@ enum **LayoutPreset**: - **PRESET_WIDE** = **15** --- Snap all 4 anchors to the respective corners of the parent control. Set all 4 margins to 0 after you applied this preset and the ``Control`` will fit its parent control. This is equivalent to to the "Full Rect" layout option in the editor. Use with :ref:`set_anchors_preset`. +---- + .. _enum_Control_LayoutPresetMode: .. _class_Control_constant_PRESET_MODE_MINSIZE: @@ -452,6 +474,8 @@ enum **LayoutPresetMode**: - **PRESET_MODE_KEEP_SIZE** = **3** +---- + .. _enum_Control_SizeFlags: .. _class_Control_constant_SIZE_FILL: @@ -476,6 +500,8 @@ enum **SizeFlags**: - **SIZE_SHRINK_END** = **8** --- Tells the parent :ref:`Container` to align the node with its end, either the bottom or the right edge. It doesn't work with the fill or expand size flags. Use with :ref:`size_flags_horizontal` and :ref:`size_flags_vertical`. +---- + .. _enum_Control_MouseFilter: .. _class_Control_constant_MOUSE_FILTER_STOP: @@ -492,6 +518,8 @@ enum **MouseFilter**: - **MOUSE_FILTER_IGNORE** = **2** --- The control will not receive mouse button input events through :ref:`_gui_input`. Also the control will not receive the :ref:`mouse_entered` nor :ref:`mouse_exited` signals. This will not block other controls from receiving these events or firing the signals. Ignored events will not be handled automatically. +---- + .. _enum_Control_GrowDirection: .. _class_Control_constant_GROW_DIRECTION_BEGIN: @@ -508,6 +536,8 @@ enum **GrowDirection**: - **GROW_DIRECTION_BOTH** = **2** --- The control will grow in both directions equally to make up if its minimum size is changed to be greater than its current size. +---- + .. _enum_Control_Anchor: .. _class_Control_constant_ANCHOR_BEGIN: @@ -596,6 +626,8 @@ Property Descriptions Anchors the bottom edge of the node to the origin, the center, or the end of its parent control. It changes how the bottom margin updates when the node moves or changes size. You can use one of the ``ANCHOR_*`` constants for convenience. Default value: :ref:`ANCHOR_BEGIN`. +---- + .. _class_Control_property_anchor_left: - :ref:`float` **anchor_left** @@ -606,6 +638,8 @@ Anchors the bottom edge of the node to the origin, the center, or the end of its Anchors the left edge of the node to the origin, the center or the end of its parent control. It changes how the left margin updates when the node moves or changes size. You can use one of the ``ANCHOR_*`` constants for convenience.Default value: :ref:`ANCHOR_BEGIN`. +---- + .. _class_Control_property_anchor_right: - :ref:`float` **anchor_right** @@ -616,6 +650,8 @@ Anchors the left edge of the node to the origin, the center or the end of its pa Anchors the right edge of the node to the origin, the center or the end of its parent control. It changes how the right margin updates when the node moves or changes size. You can use one of the ``ANCHOR_*`` constants for convenience. Default value: :ref:`ANCHOR_BEGIN`. +---- + .. _class_Control_property_anchor_top: - :ref:`float` **anchor_top** @@ -626,6 +662,8 @@ Anchors the right edge of the node to the origin, the center or the end of its p Anchors the top edge of the node to the origin, the center or the end of its parent control. It changes how the top margin updates when the node moves or changes size. You can use one of the ``ANCHOR_*`` constants for convenience. Default value: :ref:`ANCHOR_BEGIN`. +---- + .. _class_Control_property_focus_mode: - :ref:`FocusMode` **focus_mode** @@ -638,6 +676,8 @@ Anchors the top edge of the node to the origin, the center or the end of its par The focus access mode for the control (None, Click or All). Only one Control can be focused at the same time, and it will receive keyboard signals. +---- + .. _class_Control_property_focus_neighbour_bottom: - :ref:`NodePath` **focus_neighbour_bottom** @@ -650,6 +690,8 @@ The focus access mode for the control (None, Click or All). Only one Control can Tells Godot which node it should give keyboard focus to if the user presses the down arrow on the keyboard or down on a gamepad by default. You can change the key by editing the ``ui_down`` input action. The node must be a ``Control``. If this property is not set, Godot will give focus to the closest ``Control`` to the bottom of this one. +---- + .. _class_Control_property_focus_neighbour_left: - :ref:`NodePath` **focus_neighbour_left** @@ -662,6 +704,8 @@ Tells Godot which node it should give keyboard focus to if the user presses the Tells Godot which node it should give keyboard focus to if the user presses the left arrow on the keyboard or left on a gamepad by default. You can change the key by editing the ``ui_left`` input action. The node must be a ``Control``. If this property is not set, Godot will give focus to the closest ``Control`` to the left of this one. +---- + .. _class_Control_property_focus_neighbour_right: - :ref:`NodePath` **focus_neighbour_right** @@ -674,6 +718,8 @@ Tells Godot which node it should give keyboard focus to if the user presses the Tells Godot which node it should give keyboard focus to if the user presses the right arrow on the keyboard or right on a gamepad by default. You can change the key by editing the ``ui_right`` input action. The node must be a ``Control``. If this property is not set, Godot will give focus to the closest ``Control`` to the bottom of this one. +---- + .. _class_Control_property_focus_neighbour_top: - :ref:`NodePath` **focus_neighbour_top** @@ -686,6 +732,8 @@ Tells Godot which node it should give keyboard focus to if the user presses the Tells Godot which node it should give keyboard focus to if the user presses the top arrow on the keyboard or top on a gamepad by default. You can change the key by editing the ``ui_top`` input action. The node must be a ``Control``. If this property is not set, Godot will give focus to the closest ``Control`` to the bottom of this one. +---- + .. _class_Control_property_focus_next: - :ref:`NodePath` **focus_next** @@ -700,6 +748,8 @@ Tells Godot which node it should give keyboard focus to if the user presses Tab If this property is not set, Godot will select a "best guess" based on surrounding nodes in the scene tree. +---- + .. _class_Control_property_focus_previous: - :ref:`NodePath` **focus_previous** @@ -714,6 +764,8 @@ Tells Godot which node it should give keyboard focus to if the user presses Shif If this property is not set, Godot will select a "best guess" based on surrounding nodes in the scene tree. +---- + .. _class_Control_property_grow_horizontal: - :ref:`GrowDirection` **grow_horizontal** @@ -726,6 +778,8 @@ If this property is not set, Godot will select a "best guess" based on surroundi Controls the direction on the horizontal axis in which the control should grow if its horizontal minimum size is changed to be greater than its current size, as the control always has to be at least the minimum size. +---- + .. _class_Control_property_grow_vertical: - :ref:`GrowDirection` **grow_vertical** @@ -738,6 +792,8 @@ Controls the direction on the horizontal axis in which the control should grow i Controls the direction on the vertical axis in which the control should grow if its vertical minimum size is changed to be greater than its current size, as the control always has to be at least the minimum size. +---- + .. _class_Control_property_hint_tooltip: - :ref:`String` **hint_tooltip** @@ -748,6 +804,8 @@ Controls the direction on the vertical axis in which the control should grow if Changes the tooltip text. The tooltip appears when the user's mouse cursor stays idle over this control for a few moments, provided that the :ref:`mouse_filter` property is not :ref:`MOUSE_FILTER_IGNORE`. +---- + .. _class_Control_property_margin_bottom: - :ref:`float` **margin_bottom** @@ -762,6 +820,8 @@ Distance between the node's bottom edge and its parent control, based on :ref:`a Margins are often controlled by one or multiple parent :ref:`Container` nodes, so you should not modify them manually if your node is a direct child of a :ref:`Container`. Margins update automatically when you move or resize the node. +---- + .. _class_Control_property_margin_left: - :ref:`float` **margin_left** @@ -776,6 +836,8 @@ Distance between the node's left edge and its parent control, based on :ref:`anc Margins are often controlled by one or multiple parent :ref:`Container` nodes, so you should not modify them manually if your node is a direct child of a :ref:`Container`. Margins update automatically when you move or resize the node. +---- + .. _class_Control_property_margin_right: - :ref:`float` **margin_right** @@ -790,6 +852,8 @@ Distance between the node's right edge and its parent control, based on :ref:`an Margins are often controlled by one or multiple parent :ref:`Container` nodes, so you should not modify them manually if your node is a direct child of a :ref:`Container`. Margins update automatically when you move or resize the node. +---- + .. _class_Control_property_margin_top: - :ref:`float` **margin_top** @@ -804,6 +868,8 @@ Distance between the node's top edge and its parent control, based on :ref:`anch Margins are often controlled by one or multiple parent :ref:`Container` nodes, so you should not modify them manually if your node is a direct child of a :ref:`Container`. Margins update automatically when you move or resize the node. +---- + .. _class_Control_property_mouse_default_cursor_shape: - :ref:`CursorShape` **mouse_default_cursor_shape** @@ -818,6 +884,8 @@ The default cursor shape for this control. Useful for Godot plugins and applicat **Note:** On Linux, shapes may vary depending on the cursor theme of the system. +---- + .. _class_Control_property_mouse_filter: - :ref:`MouseFilter` **mouse_filter** @@ -830,6 +898,8 @@ The default cursor shape for this control. Useful for Godot plugins and applicat Controls whether the control will be able to receive mouse button input events through :ref:`_gui_input` and how these events should be handled. Also controls whether the control can receive the :ref:`mouse_entered`, and :ref:`mouse_exited` signals. See the constants to learn what each does. +---- + .. _class_Control_property_rect_clip_content: - :ref:`bool` **rect_clip_content** @@ -842,6 +912,8 @@ Controls whether the control will be able to receive mouse button input events t Enables whether rendering of children should be clipped to this control's rectangle. If ``true``, parts of a child which would be visibly outside of this control's rectangle will not be rendered. +---- + .. _class_Control_property_rect_global_position: - :ref:`Vector2` **rect_global_position** @@ -854,6 +926,8 @@ Enables whether rendering of children should be clipped to this control's rectan The node's global position, relative to the world (usually to the top-left corner of the window). +---- + .. _class_Control_property_rect_min_size: - :ref:`Vector2` **rect_min_size** @@ -866,6 +940,8 @@ The node's global position, relative to the world (usually to the top-left corne The minimum size of the node's bounding rectangle. If you set it to a value greater than (0, 0), the node's bounding rectangle will always have at least this size, even if its content is smaller. If it's set to (0, 0), the node sizes automatically to fit its content, be it a texture or child nodes. +---- + .. _class_Control_property_rect_pivot_offset: - :ref:`Vector2` **rect_pivot_offset** @@ -878,6 +954,8 @@ The minimum size of the node's bounding rectangle. If you set it to a value grea By default, the node's pivot is its top-left corner. When you change its :ref:`rect_scale`, it will scale around this pivot. Set this property to :ref:`rect_size` / 2 to center the pivot in the node's rectangle. +---- + .. _class_Control_property_rect_position: - :ref:`Vector2` **rect_position** @@ -890,6 +968,8 @@ By default, the node's pivot is its top-left corner. When you change its :ref:`r The node's position, relative to its parent. It corresponds to the rectangle's top-left corner. The property is not affected by :ref:`rect_pivot_offset`. +---- + .. _class_Control_property_rect_rotation: - :ref:`float` **rect_rotation** @@ -902,6 +982,8 @@ The node's position, relative to its parent. It corresponds to the rectangle's t The node's rotation around its pivot, in degrees. See :ref:`rect_pivot_offset` to change the pivot's position. +---- + .. _class_Control_property_rect_scale: - :ref:`Vector2` **rect_scale** @@ -914,6 +996,8 @@ The node's rotation around its pivot, in degrees. See :ref:`rect_pivot_offset`. Change this property to scale the node around its :ref:`rect_pivot_offset`. +---- + .. _class_Control_property_rect_size: - :ref:`Vector2` **rect_size** @@ -926,6 +1010,8 @@ The node's scale, relative to its :ref:`rect_size` nodes update this property automatically. +---- + .. _class_Control_property_size_flags_horizontal: - :ref:`int` **size_flags_horizontal** @@ -938,6 +1024,8 @@ The size of the node's bounding rectangle, in pixels. :ref:`Container` nodes how they should resize and place the node on the X axis. Use one of the ``SIZE_*`` constants to change the flags. See the constants to learn what each does. +---- + .. _class_Control_property_size_flags_stretch_ratio: - :ref:`float` **size_flags_stretch_ratio** @@ -950,6 +1038,8 @@ Tells the parent :ref:`Container` nodes how they should resize If the node and at least one of its neighbours uses the :ref:`SIZE_EXPAND` size flag, the parent :ref:`Container` will let it take more or less space depending on this property. If this node has a stretch ratio of 2 and its neighbour a ratio of 1, this node will take two thirds of the available space. +---- + .. _class_Control_property_size_flags_vertical: - :ref:`int` **size_flags_vertical** @@ -962,6 +1052,8 @@ If the node and at least one of its neighbours uses the :ref:`SIZE_EXPAND` nodes how they should resize and place the node on the Y axis. Use one of the ``SIZE_*`` constants to change the flags. See the constants to learn what each does. +---- + .. _class_Control_property_theme: - :ref:`Theme` **theme** @@ -981,12 +1073,16 @@ Method Descriptions - :ref:`bool` **_clips_input** **(** **)** virtual +---- + .. _class_Control_method__get_minimum_size: - :ref:`Vector2` **_get_minimum_size** **(** **)** virtual Returns the minimum size for this control. See :ref:`rect_min_size`. +---- + .. _class_Control_method__gui_input: - void **_gui_input** **(** :ref:`InputEvent` event **)** virtual @@ -995,52 +1091,70 @@ Use this method to process and accept inputs on UI elements. See :ref:`accept_ev Replaces Godot 2's ``_input_event``. +---- + .. _class_Control_method__make_custom_tooltip: - :ref:`Object` **_make_custom_tooltip** **(** :ref:`String` for_text **)** virtual +---- + .. _class_Control_method_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_method_add_color_override: - void **add_color_override** **(** :ref:`String` name, :ref:`Color` color **)** Overrides the color in the :ref:`theme` resource the node uses. +---- + .. _class_Control_method_add_constant_override: - void **add_constant_override** **(** :ref:`String` name, :ref:`int` constant **)** Overrides an integer constant in the :ref:`theme` resource the node uses. If the ``constant`` is invalid, Godot clears the override. +---- + .. _class_Control_method_add_font_override: - void **add_font_override** **(** :ref:`String` name, :ref:`Font` font **)** Overrides the ``name`` font in the :ref:`theme` resource the node uses. If ``font`` is empty, Godot clears the override. +---- + .. _class_Control_method_add_icon_override: - void **add_icon_override** **(** :ref:`String` name, :ref:`Texture` texture **)** Overrides the ``name`` icon in the :ref:`theme` resource the node uses. If ``icon`` is empty, Godot clears the override. +---- + .. _class_Control_method_add_shader_override: - void **add_shader_override** **(** :ref:`String` name, :ref:`Shader` shader **)** Overrides the ``name`` shader in the :ref:`theme` resource the node uses. If ``shader`` is empty, Godot clears the override. +---- + .. _class_Control_method_add_stylebox_override: - void **add_stylebox_override** **(** :ref:`String` name, :ref:`StyleBox` stylebox **)** Overrides the ``name`` :ref:`StyleBox` in the :ref:`theme` resource the node uses. If ``stylebox`` is empty, Godot clears the override. +---- + .. _class_Control_method_can_drop_data: - :ref:`bool` **can_drop_data** **(** :ref:`Vector2` position, :ref:`Variant` data **)** virtual @@ -1058,6 +1172,8 @@ This method should only be used to test the data. Process the data in :ref:`drop # otherwise just check data return typeof(data) == TYPE_DICTIONARY and data.has('expected') +---- + .. _class_Control_method_drop_data: - void **drop_data** **(** :ref:`Vector2` position, :ref:`Variant` data **)** virtual @@ -1074,6 +1190,8 @@ Godot calls this method to pass you the ``data`` from a control's :ref:`get_drag func drop_data(position, data): color = data['color'] +---- + .. _class_Control_method_force_drag: - void **force_drag** **(** :ref:`Variant` data, :ref:`Control` preview **)** @@ -1082,30 +1200,42 @@ Forces drag and bypasses :ref:`get_drag_data The methods :ref:`can_drop_data` and :ref:`drop_data` must be implemented on controls that want to receive drop data. +---- + .. _class_Control_method_get_begin: - :ref:`Vector2` **get_begin** **(** **)** const Returns :ref:`margin_left` and :ref:`margin_top`. See also :ref:`rect_position`. +---- + .. _class_Control_method_get_color: - :ref:`Color` **get_color** **(** :ref:`String` name, :ref:`String` type="" **)** const +---- + .. _class_Control_method_get_combined_minimum_size: - :ref:`Vector2` **get_combined_minimum_size** **(** **)** const +---- + .. _class_Control_method_get_constant: - :ref:`int` **get_constant** **(** :ref:`String` name, :ref:`String` type="" **)** const +---- + .. _class_Control_method_get_cursor_shape: - :ref:`CursorShape` **get_cursor_shape** **(** :ref:`Vector2` position=Vector2( 0, 0 ) **)** const Returns the mouse cursor shape the control displays on mouse hover. See :ref:`CursorShape`. +---- + .. _class_Control_method_get_drag_data: - :ref:`Object` **get_drag_data** **(** :ref:`Vector2` position **)** virtual @@ -1123,168 +1253,238 @@ A preview that will follow the mouse that should represent the data can be set w set_drag_preview(make_preview(mydata)) return mydata +---- + .. _class_Control_method_get_end: - :ref:`Vector2` **get_end** **(** **)** const Returns :ref:`margin_right` and :ref:`margin_bottom`. +---- + .. _class_Control_method_get_focus_owner: - :ref:`Control` **get_focus_owner** **(** **)** const Returns the control that has the keyboard focus or ``null`` if none. +---- + .. _class_Control_method_get_font: - :ref:`Font` **get_font** **(** :ref:`String` name, :ref:`String` type="" **)** const +---- + .. _class_Control_method_get_global_rect: - :ref:`Rect2` **get_global_rect** **(** **)** const Returns the position and size of the control relative to the top-left corner of the screen. See :ref:`rect_position` and :ref:`rect_size`. +---- + .. _class_Control_method_get_icon: - :ref:`Texture` **get_icon** **(** :ref:`String` name, :ref:`String` type="" **)** const +---- + .. _class_Control_method_get_minimum_size: - :ref:`Vector2` **get_minimum_size** **(** **)** const Returns the minimum size for this control. See :ref:`rect_min_size`. +---- + .. _class_Control_method_get_parent_area_size: - :ref:`Vector2` **get_parent_area_size** **(** **)** const Returns the width/height occupied in the parent control. +---- + .. _class_Control_method_get_parent_control: - :ref:`Control` **get_parent_control** **(** **)** const Returns the parent control node. +---- + .. _class_Control_method_get_rect: - :ref:`Rect2` **get_rect** **(** **)** const Returns the position and size of the control relative to the top-left corner of the parent Control. See :ref:`rect_position` and :ref:`rect_size`. +---- + .. _class_Control_method_get_rotation: - :ref:`float` **get_rotation** **(** **)** const Returns the rotation (in radians). +---- + .. _class_Control_method_get_stylebox: - :ref:`StyleBox` **get_stylebox** **(** :ref:`String` name, :ref:`String` type="" **)** const +---- + .. _class_Control_method_get_tooltip: - :ref:`String` **get_tooltip** **(** :ref:`Vector2` at_position=Vector2( 0, 0 ) **)** const Returns the tooltip, which will appear when the cursor is resting over this control. +---- + .. _class_Control_method_grab_click_focus: - void **grab_click_focus** **(** **)** +---- + .. _class_Control_method_grab_focus: - void **grab_focus** **(** **)** Steal the focus from another control and become the focused control (see :ref:`focus_mode`). +---- + .. _class_Control_method_has_color: - :ref:`bool` **has_color** **(** :ref:`String` name, :ref:`String` type="" **)** const +---- + .. _class_Control_method_has_color_override: - :ref:`bool` **has_color_override** **(** :ref:`String` name **)** const +---- + .. _class_Control_method_has_constant: - :ref:`bool` **has_constant** **(** :ref:`String` name, :ref:`String` type="" **)** const +---- + .. _class_Control_method_has_constant_override: - :ref:`bool` **has_constant_override** **(** :ref:`String` name **)** const +---- + .. _class_Control_method_has_focus: - :ref:`bool` **has_focus** **(** **)** const Returns ``true`` if this is the current focused control. See :ref:`focus_mode`. +---- + .. _class_Control_method_has_font: - :ref:`bool` **has_font** **(** :ref:`String` name, :ref:`String` type="" **)** const +---- + .. _class_Control_method_has_font_override: - :ref:`bool` **has_font_override** **(** :ref:`String` name **)** const +---- + .. _class_Control_method_has_icon: - :ref:`bool` **has_icon** **(** :ref:`String` name, :ref:`String` type="" **)** const +---- + .. _class_Control_method_has_icon_override: - :ref:`bool` **has_icon_override** **(** :ref:`String` name **)** const +---- + .. _class_Control_method_has_point: - :ref:`bool` **has_point** **(** :ref:`Vector2` point **)** virtual +---- + .. _class_Control_method_has_shader_override: - :ref:`bool` **has_shader_override** **(** :ref:`String` name **)** const +---- + .. _class_Control_method_has_stylebox: - :ref:`bool` **has_stylebox** **(** :ref:`String` name, :ref:`String` type="" **)** const +---- + .. _class_Control_method_has_stylebox_override: - :ref:`bool` **has_stylebox_override** **(** :ref:`String` name **)** const +---- + .. _class_Control_method_minimum_size_changed: - void **minimum_size_changed** **(** **)** +---- + .. _class_Control_method_release_focus: - void **release_focus** **(** **)** Give up the focus. No other control will be able to receive keyboard input. +---- + .. _class_Control_method_set_anchor: - void **set_anchor** **(** :ref:`Margin` margin, :ref:`float` anchor, :ref:`bool` keep_margin=false, :ref:`bool` push_opposite_anchor=true **)** +---- + .. _class_Control_method_set_anchor_and_margin: - void **set_anchor_and_margin** **(** :ref:`Margin` margin, :ref:`float` anchor, :ref:`float` offset, :ref:`bool` push_opposite_anchor=false **)** +---- + .. _class_Control_method_set_anchors_and_margins_preset: - void **set_anchors_and_margins_preset** **(** :ref:`LayoutPreset` preset, :ref:`LayoutPresetMode` resize_mode=0, :ref:`int` margin=0 **)** +---- + .. _class_Control_method_set_anchors_preset: - void **set_anchors_preset** **(** :ref:`LayoutPreset` preset, :ref:`bool` keep_margin=false **)** +---- + .. _class_Control_method_set_begin: - void **set_begin** **(** :ref:`Vector2` position **)** Sets :ref:`margin_left` and :ref:`margin_top` at the same time. +---- + .. _class_Control_method_set_drag_forwarding: - void **set_drag_forwarding** **(** :ref:`Control` target **)** @@ -1316,34 +1516,46 @@ Forwarding can be implemented in the target control similar to the methods :ref: set_drag_preview(my_preview) return my_data() +---- + .. _class_Control_method_set_drag_preview: - void **set_drag_preview** **(** :ref:`Control` control **)** Shows the given control at the mouse pointer. A good time to call this method is in :ref:`get_drag_data`. +---- + .. _class_Control_method_set_end: - void **set_end** **(** :ref:`Vector2` position **)** Sets :ref:`margin_right` and :ref:`margin_bottom` at the same time. +---- + .. _class_Control_method_set_margins_preset: - void **set_margins_preset** **(** :ref:`LayoutPreset` preset, :ref:`LayoutPresetMode` resize_mode=0, :ref:`int` margin=0 **)** +---- + .. _class_Control_method_set_rotation: - void **set_rotation** **(** :ref:`float` radians **)** Sets the rotation (in radians). +---- + .. _class_Control_method_show_modal: - void **show_modal** **(** :ref:`bool` exclusive=false **)** Displays 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_method_warp_mouse: - void **warp_mouse** **(** :ref:`Vector2` to_position **)** diff --git a/classes/class_cpuparticles.rst b/classes/class_cpuparticles.rst index fae48677d..f9737017f 100644 --- a/classes/class_cpuparticles.rst +++ b/classes/class_cpuparticles.rst @@ -169,6 +169,8 @@ enum **DrawOrder**: - **DRAW_ORDER_VIEW_DEPTH** = **2** --- Particles are drawn in order of depth. +---- + .. _enum_CPUParticles_Parameter: .. _class_CPUParticles_constant_PARAM_INITIAL_LINEAR_VELOCITY: @@ -221,6 +223,8 @@ enum **Parameter**: - **PARAM_MAX** = **11** --- Represents the size of the :ref:`Parameter` enum. +---- + .. _enum_CPUParticles_Flags: .. _class_CPUParticles_constant_FLAG_ALIGN_Y_TO_VELOCITY: @@ -237,6 +241,8 @@ enum **Flags**: - **FLAG_MAX** = **3** --- Represents the size of the :ref:`Flags` enum. +---- + .. _enum_CPUParticles_EmissionShape: .. _class_CPUParticles_constant_EMISSION_SHAPE_POINT: @@ -283,6 +289,8 @@ Property Descriptions Number of particles emitted in one emission cycle. +---- + .. _class_CPUParticles_property_angle: - :ref:`float` **angle** @@ -295,6 +303,8 @@ Number of particles emitted in one emission cycle. Initial rotation applied to each particle, in degrees. +---- + .. _class_CPUParticles_property_angle_curve: - :ref:`Curve` **angle_curve** @@ -307,6 +317,8 @@ Initial rotation applied to each particle, in degrees. Each particle's rotation will be animated along this :ref:`Curve`. +---- + .. _class_CPUParticles_property_angle_random: - :ref:`float` **angle_random** @@ -319,6 +331,8 @@ Each particle's rotation will be animated along this :ref:`Curve`. Rotation randomness ratio. Default value: ``0``. +---- + .. _class_CPUParticles_property_angular_velocity: - :ref:`float` **angular_velocity** @@ -331,6 +345,8 @@ Rotation randomness ratio. Default value: ``0``. Initial angular velocity applied to each particle. Sets the speed of rotation of the particle. +---- + .. _class_CPUParticles_property_angular_velocity_curve: - :ref:`Curve` **angular_velocity_curve** @@ -343,6 +359,8 @@ Initial angular velocity applied to each particle. Sets the speed of rotation of Each particle's angular velocity will vary along this :ref:`Curve`. +---- + .. _class_CPUParticles_property_angular_velocity_random: - :ref:`float` **angular_velocity_random** @@ -355,6 +373,8 @@ Each particle's angular velocity will vary along this :ref:`Curve`. Angular velocity randomness ratio. Default value: ``0``. +---- + .. _class_CPUParticles_property_anim_offset: - :ref:`float` **anim_offset** @@ -367,6 +387,8 @@ Angular velocity randomness ratio. Default value: ``0``. Particle animation offset. +---- + .. _class_CPUParticles_property_anim_offset_curve: - :ref:`Curve` **anim_offset_curve** @@ -379,6 +401,8 @@ Particle animation offset. Each particle's animation offset will vary along this :ref:`Curve`. +---- + .. _class_CPUParticles_property_anim_offset_random: - :ref:`float` **anim_offset_random** @@ -391,6 +415,8 @@ Each particle's animation offset will vary along this :ref:`Curve`. Animation offset randomness ratio. Default value: ``0``. +---- + .. _class_CPUParticles_property_anim_speed: - :ref:`float` **anim_speed** @@ -403,6 +429,8 @@ Animation offset randomness ratio. Default value: ``0``. Particle animation speed. +---- + .. _class_CPUParticles_property_anim_speed_curve: - :ref:`Curve` **anim_speed_curve** @@ -415,6 +443,8 @@ Particle animation speed. Each particle's animation speed will vary along this :ref:`Curve`. +---- + .. _class_CPUParticles_property_anim_speed_random: - :ref:`float` **anim_speed_random** @@ -427,6 +457,8 @@ Each particle's animation speed will vary along this :ref:`Curve`. Animation speed randomness ratio. Default value: ``0``. +---- + .. _class_CPUParticles_property_color: - :ref:`Color` **color** @@ -439,6 +471,8 @@ Animation speed randomness ratio. Default value: ``0``. Unused for 3D particles. +---- + .. _class_CPUParticles_property_color_ramp: - :ref:`Gradient` **color_ramp** @@ -451,6 +485,8 @@ Unused for 3D particles. Unused for 3D particles. +---- + .. _class_CPUParticles_property_damping: - :ref:`float` **damping** @@ -463,6 +499,8 @@ Unused for 3D particles. The rate at which particles lose velocity. +---- + .. _class_CPUParticles_property_damping_curve: - :ref:`Curve` **damping_curve** @@ -475,6 +513,8 @@ The rate at which particles lose velocity. Damping will vary along this :ref:`Curve`. +---- + .. _class_CPUParticles_property_damping_random: - :ref:`float` **damping_random** @@ -487,6 +527,8 @@ Damping will vary along this :ref:`Curve`. Damping randomness ratio. Default value: ``0``. +---- + .. _class_CPUParticles_property_draw_order: - :ref:`DrawOrder` **draw_order** @@ -499,6 +541,8 @@ Damping randomness ratio. Default value: ``0``. Particle draw order. Uses :ref:`DrawOrder` values. Default value: :ref:`DRAW_ORDER_INDEX`. +---- + .. _class_CPUParticles_property_emission_box_extents: - :ref:`Vector3` **emission_box_extents** @@ -511,6 +555,8 @@ Particle draw order. Uses :ref:`DrawOrder` values. The rectangle's extents if :ref:`emission_shape` is set to :ref:`EMISSION_SHAPE_BOX`. +---- + .. _class_CPUParticles_property_emission_colors: - :ref:`PoolColorArray` **emission_colors** @@ -521,6 +567,8 @@ The rectangle's extents if :ref:`emission_shape` **emission_normals** @@ -531,6 +579,8 @@ The rectangle's extents if :ref:`emission_shape` **emission_points** @@ -541,6 +591,8 @@ The rectangle's extents if :ref:`emission_shape` **emission_shape** @@ -553,6 +605,8 @@ The rectangle's extents if :ref:`emission_shape` for values. Default value: :ref:`EMISSION_SHAPE_POINT`. +---- + .. _class_CPUParticles_property_emission_sphere_radius: - :ref:`float` **emission_sphere_radius** @@ -565,6 +619,8 @@ Particles will be emitted inside this region. Use :ref:`EmissionShape` is set to :ref:`EMISSION_SHAPE_SPHERE`. +---- + .. _class_CPUParticles_property_emitting: - :ref:`bool` **emitting** @@ -577,6 +633,8 @@ The sphere's radius if :ref:`EmissionShape` is If ``true``, particles are being emitted. Default value: ``true``. +---- + .. _class_CPUParticles_property_explosiveness: - :ref:`float` **explosiveness** @@ -589,6 +647,8 @@ If ``true``, particles are being emitted. Default value: ``true``. How rapidly particles in an emission cycle are emitted. If greater than ``0``, there will be a gap in emissions before the next cycle begins. Default value: ``0``. +---- + .. _class_CPUParticles_property_fixed_fps: - :ref:`int` **fixed_fps** @@ -601,6 +661,8 @@ How rapidly particles in an emission cycle are emitted. If greater than ``0``, t The particle system's frame rate is fixed to a value. For instance, changing the value to 2 will make the particles render at 2 frames per second. Note this does not slow down the particle system itself. +---- + .. _class_CPUParticles_property_flag_align_y: - :ref:`bool` **flag_align_y** @@ -613,6 +675,8 @@ The particle system's frame rate is fixed to a value. For instance, changing the Align y-axis of particle with the direction of its velocity. +---- + .. _class_CPUParticles_property_flag_disable_z: - :ref:`bool` **flag_disable_z** @@ -625,6 +689,8 @@ Align y-axis of particle with the direction of its velocity. If ``true``, particles will not move on the z axis. Default value: ``false``. +---- + .. _class_CPUParticles_property_flag_rotate_y: - :ref:`bool` **flag_rotate_y** @@ -637,6 +703,8 @@ If ``true``, particles will not move on the z axis. Default value: ``false``. If ``true``, particles rotate around y-axis by :ref:`angle`. +---- + .. _class_CPUParticles_property_flatness: - :ref:`float` **flatness** @@ -649,6 +717,8 @@ If ``true``, particles rotate around y-axis by :ref:`angle` in Y/Z plane. A value of ``1`` restricts particles to X/Z plane. Default ``0``. +---- + .. _class_CPUParticles_property_fract_delta: - :ref:`bool` **fract_delta** @@ -661,6 +731,8 @@ Amount of :ref:`spread` in Y/Z plane. A valu If ``true``, results in fractional delta calculation which has a smoother particles display effect. Default value: ``true`` +---- + .. _class_CPUParticles_property_gravity: - :ref:`Vector3` **gravity** @@ -673,6 +745,8 @@ If ``true``, results in fractional delta calculation which has a smoother partic Gravity applied to every particle. Default value: ``(0, -9.8, 0)``. +---- + .. _class_CPUParticles_property_hue_variation: - :ref:`float` **hue_variation** @@ -685,6 +759,8 @@ Gravity applied to every particle. Default value: ``(0, -9.8, 0)``. Initial hue variation applied to each particle. +---- + .. _class_CPUParticles_property_hue_variation_curve: - :ref:`Curve` **hue_variation_curve** @@ -697,6 +773,8 @@ Initial hue variation applied to each particle. Each particle's hue will vary along this :ref:`Curve`. +---- + .. _class_CPUParticles_property_hue_variation_random: - :ref:`float` **hue_variation_random** @@ -709,6 +787,8 @@ Each particle's hue will vary along this :ref:`Curve`. Hue variation randomness ratio. Default value: ``0``. +---- + .. _class_CPUParticles_property_initial_velocity: - :ref:`float` **initial_velocity** @@ -721,6 +801,8 @@ Hue variation randomness ratio. Default value: ``0``. Initial velocity magnitude for each particle. Direction comes from :ref:`spread` and the node's orientation. +---- + .. _class_CPUParticles_property_initial_velocity_random: - :ref:`float` **initial_velocity_random** @@ -733,6 +815,8 @@ Initial velocity magnitude for each particle. Direction comes from :ref:`spread< Initial velocity randomness ratio. Default value: ``0``. +---- + .. _class_CPUParticles_property_lifetime: - :ref:`float` **lifetime** @@ -745,6 +829,8 @@ Initial velocity randomness ratio. Default value: ``0``. Amount of time each particle will exist. Default value: ``1``. +---- + .. _class_CPUParticles_property_linear_accel: - :ref:`float` **linear_accel** @@ -757,6 +843,8 @@ Amount of time each particle will exist. Default value: ``1``. Linear acceleration applied to each particle in the direction of motion. +---- + .. _class_CPUParticles_property_linear_accel_curve: - :ref:`Curve` **linear_accel_curve** @@ -769,6 +857,8 @@ Linear acceleration applied to each particle in the direction of motion. Each particle's linear acceleration will vary along this :ref:`Curve`. +---- + .. _class_CPUParticles_property_linear_accel_random: - :ref:`float` **linear_accel_random** @@ -781,6 +871,8 @@ Each particle's linear acceleration will vary along this :ref:`Curve` **local_coords** @@ -793,6 +885,8 @@ Linear acceleration randomness ratio. Default value: ``0``. If ``true``, particles use the parent node's coordinate space. If ``false``, they use global coordinates. Default value: ``true``. +---- + .. _class_CPUParticles_property_mesh: - :ref:`Mesh` **mesh** @@ -805,6 +899,8 @@ If ``true``, particles use the parent node's coordinate space. If ``false``, the The :ref:`Mesh` used for each particle. If ``null``, particles will be spheres. +---- + .. _class_CPUParticles_property_one_shot: - :ref:`bool` **one_shot** @@ -817,6 +913,8 @@ The :ref:`Mesh` used for each particle. If ``null``, particles will If ``true``, only one emission cycle occurs. If set ``true`` during a cycle, emission will stop at the cycle's end. Default value: ``false``. +---- + .. _class_CPUParticles_property_preprocess: - :ref:`float` **preprocess** @@ -829,6 +927,8 @@ If ``true``, only one emission cycle occurs. If set ``true`` during a cycle, emi Particle system starts as if it had already run for this many seconds. +---- + .. _class_CPUParticles_property_radial_accel: - :ref:`float` **radial_accel** @@ -841,6 +941,8 @@ Particle system starts as if it had already run for this many seconds. Radial acceleration applied to each particle. Makes particle accelerate away from origin. +---- + .. _class_CPUParticles_property_radial_accel_curve: - :ref:`Curve` **radial_accel_curve** @@ -853,6 +955,8 @@ Radial acceleration applied to each particle. Makes particle accelerate away fro Each particle's radial acceleration will vary along this :ref:`Curve`. +---- + .. _class_CPUParticles_property_radial_accel_random: - :ref:`float` **radial_accel_random** @@ -865,6 +969,8 @@ Each particle's radial acceleration will vary along this :ref:`Curve` **randomness** @@ -877,6 +983,8 @@ Radial acceleration randomness ratio. Default value: ``0``. Emission lifetime randomness ratio. Default value: ``0``. +---- + .. _class_CPUParticles_property_scale_amount: - :ref:`float` **scale_amount** @@ -889,6 +997,8 @@ Emission lifetime randomness ratio. Default value: ``0``. Initial scale applied to each particle. +---- + .. _class_CPUParticles_property_scale_amount_curve: - :ref:`Curve` **scale_amount_curve** @@ -901,6 +1011,8 @@ Initial scale applied to each particle. Each particle's scale will vary along this :ref:`Curve`. +---- + .. _class_CPUParticles_property_scale_amount_random: - :ref:`float` **scale_amount_random** @@ -913,6 +1025,8 @@ Each particle's scale will vary along this :ref:`Curve`. Scale randomness ratio. Default value: ``0``. +---- + .. _class_CPUParticles_property_speed_scale: - :ref:`float` **speed_scale** @@ -925,6 +1039,8 @@ Scale randomness ratio. Default value: ``0``. Particle system's running speed scaling ratio. Default value: ``1``. A value of ``0`` can be used to pause the particles. +---- + .. _class_CPUParticles_property_spread: - :ref:`float` **spread** @@ -937,6 +1053,8 @@ Particle system's running speed scaling ratio. Default value: ``1``. A value of Each particle's initial direction range from ``+spread`` to ``-spread`` degrees. Default value: ``45``. +---- + .. _class_CPUParticles_property_tangential_accel: - :ref:`float` **tangential_accel** @@ -949,6 +1067,8 @@ Each particle's initial direction range from ``+spread`` to ``-spread`` degrees. Tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity giving the particles a swirling motion. +---- + .. _class_CPUParticles_property_tangential_accel_curve: - :ref:`Curve` **tangential_accel_curve** @@ -961,6 +1081,8 @@ Tangential acceleration applied to each particle. Tangential acceleration is per Each particle's tangential acceleration will vary along this :ref:`Curve`. +---- + .. _class_CPUParticles_property_tangential_accel_random: - :ref:`float` **tangential_accel_random** @@ -982,6 +1104,8 @@ Method Descriptions Sets this node's properties to match a given :ref:`Particles` node with an assigned :ref:`ParticlesMaterial`. +---- + .. _class_CPUParticles_method_restart: - void **restart** **(** **)** diff --git a/classes/class_cpuparticles2d.rst b/classes/class_cpuparticles2d.rst index f6e119b07..519fc6b5d 100644 --- a/classes/class_cpuparticles2d.rst +++ b/classes/class_cpuparticles2d.rst @@ -163,6 +163,8 @@ enum **DrawOrder**: - **DRAW_ORDER_LIFETIME** = **1** --- Particles are drawn in order of remaining lifetime. +---- + .. _enum_CPUParticles2D_Parameter: .. _class_CPUParticles2D_constant_PARAM_INITIAL_LINEAR_VELOCITY: @@ -219,6 +221,8 @@ enum **Parameter**: - **PARAM_MAX** = **12** --- Represents the size of the :ref:`Parameter` enum. +---- + .. _enum_CPUParticles2D_Flags: .. _class_CPUParticles2D_constant_FLAG_ALIGN_Y_TO_VELOCITY: @@ -231,6 +235,8 @@ enum **Flags**: - **FLAG_MAX** = **1** +---- + .. _enum_CPUParticles2D_EmissionShape: .. _class_CPUParticles2D_constant_EMISSION_SHAPE_POINT: @@ -282,6 +288,8 @@ Property Descriptions Number of particles emitted in one emission cycle. +---- + .. _class_CPUParticles2D_property_angle: - :ref:`float` **angle** @@ -294,6 +302,8 @@ Number of particles emitted in one emission cycle. Initial rotation applied to each particle, in degrees. +---- + .. _class_CPUParticles2D_property_angle_curve: - :ref:`Curve` **angle_curve** @@ -306,6 +316,8 @@ Initial rotation applied to each particle, in degrees. Each particle's rotation will be animated along this :ref:`Curve`. +---- + .. _class_CPUParticles2D_property_angle_random: - :ref:`float` **angle_random** @@ -318,6 +330,8 @@ Each particle's rotation will be animated along this :ref:`Curve`. Rotation randomness ratio. Default value: ``0``. +---- + .. _class_CPUParticles2D_property_angular_velocity: - :ref:`float` **angular_velocity** @@ -330,6 +344,8 @@ Rotation randomness ratio. Default value: ``0``. Initial angular velocity applied to each particle. Sets the speed of rotation of the particle. +---- + .. _class_CPUParticles2D_property_angular_velocity_curve: - :ref:`Curve` **angular_velocity_curve** @@ -342,6 +358,8 @@ Initial angular velocity applied to each particle. Sets the speed of rotation of Each particle's angular velocity will vary along this :ref:`Curve`. +---- + .. _class_CPUParticles2D_property_angular_velocity_random: - :ref:`float` **angular_velocity_random** @@ -354,6 +372,8 @@ Each particle's angular velocity will vary along this :ref:`Curve`. Angular velocity randomness ratio. Default value: ``0``. +---- + .. _class_CPUParticles2D_property_anim_offset: - :ref:`float` **anim_offset** @@ -366,6 +386,8 @@ Angular velocity randomness ratio. Default value: ``0``. Particle animation offset. +---- + .. _class_CPUParticles2D_property_anim_offset_curve: - :ref:`Curve` **anim_offset_curve** @@ -378,6 +400,8 @@ Particle animation offset. Each particle's animation offset will vary along this :ref:`Curve`. +---- + .. _class_CPUParticles2D_property_anim_offset_random: - :ref:`float` **anim_offset_random** @@ -390,6 +414,8 @@ Each particle's animation offset will vary along this :ref:`Curve`. Animation offset randomness ratio. Default value: ``0``. +---- + .. _class_CPUParticles2D_property_anim_speed: - :ref:`float` **anim_speed** @@ -402,6 +428,8 @@ Animation offset randomness ratio. Default value: ``0``. Particle animation speed. +---- + .. _class_CPUParticles2D_property_anim_speed_curve: - :ref:`Curve` **anim_speed_curve** @@ -414,6 +442,8 @@ Particle animation speed. Each particle's animation speed will vary along this :ref:`Curve`. +---- + .. _class_CPUParticles2D_property_anim_speed_random: - :ref:`float` **anim_speed_random** @@ -426,6 +456,8 @@ Each particle's animation speed will vary along this :ref:`Curve`. Animation speed randomness ratio. Default value: ``0``. +---- + .. _class_CPUParticles2D_property_color: - :ref:`Color` **color** @@ -438,6 +470,8 @@ Animation speed randomness ratio. Default value: ``0``. Each particle's initial color. If :ref:`texture` is defined, it will be multiplied by this color. +---- + .. _class_CPUParticles2D_property_color_ramp: - :ref:`Gradient` **color_ramp** @@ -450,6 +484,8 @@ Each particle's initial color. If :ref:`texture`. +---- + .. _class_CPUParticles2D_property_damping: - :ref:`float` **damping** @@ -462,6 +498,8 @@ Each particle's color will vary along this :ref:`Gradient`. The rate at which particles lose velocity. +---- + .. _class_CPUParticles2D_property_damping_curve: - :ref:`Curve` **damping_curve** @@ -474,6 +512,8 @@ The rate at which particles lose velocity. Damping will vary along this :ref:`Curve`. +---- + .. _class_CPUParticles2D_property_damping_random: - :ref:`float` **damping_random** @@ -486,6 +526,8 @@ Damping will vary along this :ref:`Curve`. Damping randomness ratio. Default value: ``0``. +---- + .. _class_CPUParticles2D_property_draw_order: - :ref:`DrawOrder` **draw_order** @@ -498,6 +540,8 @@ Damping randomness ratio. Default value: ``0``. Particle draw order. Uses :ref:`DrawOrder` values. Default value: :ref:`DRAW_ORDER_INDEX`. +---- + .. _class_CPUParticles2D_property_emission_colors: - :ref:`PoolColorArray` **emission_colors** @@ -508,6 +552,8 @@ Particle draw order. Uses :ref:`DrawOrder` values | *Getter* | get_emission_colors() | +----------+----------------------------+ +---- + .. _class_CPUParticles2D_property_emission_normals: - :ref:`PoolVector2Array` **emission_normals** @@ -518,6 +564,8 @@ Particle draw order. Uses :ref:`DrawOrder` values | *Getter* | get_emission_normals() | +----------+-----------------------------+ +---- + .. _class_CPUParticles2D_property_emission_points: - :ref:`PoolVector2Array` **emission_points** @@ -528,6 +576,8 @@ Particle draw order. Uses :ref:`DrawOrder` values | *Getter* | get_emission_points() | +----------+----------------------------+ +---- + .. _class_CPUParticles2D_property_emission_rect_extents: - :ref:`Vector2` **emission_rect_extents** @@ -540,6 +590,8 @@ Particle draw order. Uses :ref:`DrawOrder` values The rectangle's extents if :ref:`emission_shape` is set to :ref:`EMISSION_SHAPE_RECTANGLE`. +---- + .. _class_CPUParticles2D_property_emission_shape: - :ref:`EmissionShape` **emission_shape** @@ -552,6 +604,8 @@ The rectangle's extents if :ref:`emission_shape` for values. Default value: :ref:`EMISSION_SHAPE_POINT`. +---- + .. _class_CPUParticles2D_property_emission_sphere_radius: - :ref:`float` **emission_sphere_radius** @@ -564,6 +618,8 @@ Particles will be emitted inside this region. Use :ref:`EmissionShape` is set to :ref:`EMISSION_SHAPE_CIRCLE`. +---- + .. _class_CPUParticles2D_property_emitting: - :ref:`bool` **emitting** @@ -576,6 +632,8 @@ The circle's radius if :ref:`emission_shape` **explosiveness** @@ -588,6 +646,8 @@ If ``true``, particles are being emitted. Default value: ``true``. How rapidly particles in an emission cycle are emitted. If greater than ``0``, there will be a gap in emissions before the next cycle begins. Default value: ``0``. +---- + .. _class_CPUParticles2D_property_fixed_fps: - :ref:`int` **fixed_fps** @@ -600,6 +660,8 @@ How rapidly particles in an emission cycle are emitted. If greater than ``0``, t The particle system's frame rate is fixed to a value. For instance, changing the value to 2 will make the particles render at 2 frames per second. Note this does not slow down the simulation of the particle system itself. +---- + .. _class_CPUParticles2D_property_flag_align_y: - :ref:`bool` **flag_align_y** @@ -612,6 +674,8 @@ The particle system's frame rate is fixed to a value. For instance, changing the Align y-axis of particle with the direction of its velocity. +---- + .. _class_CPUParticles2D_property_flatness: - :ref:`float` **flatness** @@ -622,6 +686,8 @@ Align y-axis of particle with the direction of its velocity. | *Getter* | get_flatness() | +----------+---------------------+ +---- + .. _class_CPUParticles2D_property_fract_delta: - :ref:`bool` **fract_delta** @@ -634,6 +700,8 @@ Align y-axis of particle with the direction of its velocity. If ``true``, results in fractional delta calculation which has a smoother particles display effect. Default value: ``true`` +---- + .. _class_CPUParticles2D_property_gravity: - :ref:`Vector2` **gravity** @@ -646,6 +714,8 @@ If ``true``, results in fractional delta calculation which has a smoother partic Gravity applied to every particle. Default value: ``(0, 98)``. +---- + .. _class_CPUParticles2D_property_hue_variation: - :ref:`float` **hue_variation** @@ -658,6 +728,8 @@ Gravity applied to every particle. Default value: ``(0, 98)``. Initial hue variation applied to each particle. +---- + .. _class_CPUParticles2D_property_hue_variation_curve: - :ref:`Curve` **hue_variation_curve** @@ -670,6 +742,8 @@ Initial hue variation applied to each particle. Each particle's hue will vary along this :ref:`Curve`. +---- + .. _class_CPUParticles2D_property_hue_variation_random: - :ref:`float` **hue_variation_random** @@ -682,6 +756,8 @@ Each particle's hue will vary along this :ref:`Curve`. Hue variation randomness ratio. Default value: ``0``. +---- + .. _class_CPUParticles2D_property_initial_velocity: - :ref:`float` **initial_velocity** @@ -694,6 +770,8 @@ Hue variation randomness ratio. Default value: ``0``. Initial velocity magnitude for each particle. Direction comes from :ref:`spread` and the node's orientation. +---- + .. _class_CPUParticles2D_property_initial_velocity_random: - :ref:`float` **initial_velocity_random** @@ -706,6 +784,8 @@ Initial velocity magnitude for each particle. Direction comes from :ref:`spread< Initial velocity randomness ratio. Default value: ``0``. +---- + .. _class_CPUParticles2D_property_lifetime: - :ref:`float` **lifetime** @@ -718,6 +798,8 @@ Initial velocity randomness ratio. Default value: ``0``. Amount of time each particle will exist. Default value: ``1``. +---- + .. _class_CPUParticles2D_property_linear_accel: - :ref:`float` **linear_accel** @@ -730,6 +812,8 @@ Amount of time each particle will exist. Default value: ``1``. Linear acceleration applied to each particle in the direction of motion. +---- + .. _class_CPUParticles2D_property_linear_accel_curve: - :ref:`Curve` **linear_accel_curve** @@ -742,6 +826,8 @@ Linear acceleration applied to each particle in the direction of motion. Each particle's linear acceleration will vary along this :ref:`Curve`. +---- + .. _class_CPUParticles2D_property_linear_accel_random: - :ref:`float` **linear_accel_random** @@ -754,6 +840,8 @@ Each particle's linear acceleration will vary along this :ref:`Curve` **local_coords** @@ -766,6 +854,8 @@ Linear acceleration randomness ratio. Default value: ``0``. If ``true``, particles use the parent node's coordinate space. If ``false``, they use global coordinates. Default value: ``true``. +---- + .. _class_CPUParticles2D_property_normalmap: - :ref:`Texture` **normalmap** @@ -778,6 +868,8 @@ If ``true``, particles use the parent node's coordinate space. If ``false``, the Normal map to be used for the :ref:`texture` property. +---- + .. _class_CPUParticles2D_property_one_shot: - :ref:`bool` **one_shot** @@ -790,6 +882,8 @@ Normal map to be used for the :ref:`texture` **preprocess** @@ -802,6 +896,8 @@ If ``true``, only one emission cycle occurs. If set ``true`` during a cycle, emi Particle system starts as if it had already run for this many seconds. +---- + .. _class_CPUParticles2D_property_radial_accel: - :ref:`float` **radial_accel** @@ -814,6 +910,8 @@ Particle system starts as if it had already run for this many seconds. Radial acceleration applied to each particle. Makes particle accelerate away from origin. +---- + .. _class_CPUParticles2D_property_radial_accel_curve: - :ref:`Curve` **radial_accel_curve** @@ -826,6 +924,8 @@ Radial acceleration applied to each particle. Makes particle accelerate away fro Each particle's radial acceleration will vary along this :ref:`Curve`. +---- + .. _class_CPUParticles2D_property_radial_accel_random: - :ref:`float` **radial_accel_random** @@ -838,6 +938,8 @@ Each particle's radial acceleration will vary along this :ref:`Curve` **randomness** @@ -850,6 +952,8 @@ Radial acceleration randomness ratio. Default value: ``0``. Emission lifetime randomness ratio. Default value: ``0``. +---- + .. _class_CPUParticles2D_property_scale_amount: - :ref:`float` **scale_amount** @@ -862,6 +966,8 @@ Emission lifetime randomness ratio. Default value: ``0``. Initial scale applied to each particle. +---- + .. _class_CPUParticles2D_property_scale_amount_curve: - :ref:`Curve` **scale_amount_curve** @@ -874,6 +980,8 @@ Initial scale applied to each particle. Each particle's scale will vary along this :ref:`Curve`. +---- + .. _class_CPUParticles2D_property_scale_amount_random: - :ref:`float` **scale_amount_random** @@ -886,6 +994,8 @@ Each particle's scale will vary along this :ref:`Curve`. Scale randomness ratio. Default value: ``0``. +---- + .. _class_CPUParticles2D_property_speed_scale: - :ref:`float` **speed_scale** @@ -898,6 +1008,8 @@ Scale randomness ratio. Default value: ``0``. Particle system's running speed scaling ratio. Default value: ``1``. A value of ``0`` can be used to pause the particles. +---- + .. _class_CPUParticles2D_property_spread: - :ref:`float` **spread** @@ -910,6 +1022,8 @@ Particle system's running speed scaling ratio. Default value: ``1``. A value of Each particle's initial direction range from ``+spread`` to ``-spread`` degrees. Default value: ``45``. +---- + .. _class_CPUParticles2D_property_tangential_accel: - :ref:`float` **tangential_accel** @@ -922,6 +1036,8 @@ Each particle's initial direction range from ``+spread`` to ``-spread`` degrees. Tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity giving the particles a swirling motion. +---- + .. _class_CPUParticles2D_property_tangential_accel_curve: - :ref:`Curve` **tangential_accel_curve** @@ -934,6 +1050,8 @@ Tangential acceleration applied to each particle. Tangential acceleration is per Each particle's tangential acceleration will vary along this :ref:`Curve`. +---- + .. _class_CPUParticles2D_property_tangential_accel_random: - :ref:`float` **tangential_accel_random** @@ -946,6 +1064,8 @@ Each particle's tangential acceleration will vary along this :ref:`Curve` **texture** @@ -967,6 +1087,8 @@ Method Descriptions Sets this node's properties to match a given :ref:`Particles2D` node with an assigned :ref:`ParticlesMaterial`. +---- + .. _class_CPUParticles2D_method_restart: - void **restart** **(** **)** diff --git a/classes/class_csgbox.rst b/classes/class_csgbox.rst index 6013689f4..a8ab5b56c 100644 --- a/classes/class_csgbox.rst +++ b/classes/class_csgbox.rst @@ -51,6 +51,8 @@ Property Descriptions Depth of the box measured from the center of the box. +---- + .. _class_CSGBox_property_height: - :ref:`float` **height** @@ -63,6 +65,8 @@ Depth of the box measured from the center of the box. Height of the box measured from the center of the box. +---- + .. _class_CSGBox_property_material: - :ref:`Material` **material** @@ -75,6 +79,8 @@ Height of the box measured from the center of the box. The material used to render the box. +---- + .. _class_CSGBox_property_width: - :ref:`float` **width** diff --git a/classes/class_csgcylinder.rst b/classes/class_csgcylinder.rst index 21ef6cc47..221a78f47 100644 --- a/classes/class_csgcylinder.rst +++ b/classes/class_csgcylinder.rst @@ -55,6 +55,8 @@ Property Descriptions If ``true`` a cone is created, the :ref:`radius` will only apply to one side. +---- + .. _class_CSGCylinder_property_height: - :ref:`float` **height** @@ -67,6 +69,8 @@ If ``true`` a cone is created, the :ref:`radius` **material** @@ -79,6 +83,8 @@ The height of the cylinder. The material used to render the cylinder. +---- + .. _class_CSGCylinder_property_radius: - :ref:`float` **radius** @@ -91,6 +97,8 @@ The material used to render the cylinder. The radius of the cylinder. +---- + .. _class_CSGCylinder_property_sides: - :ref:`int` **sides** @@ -103,6 +111,8 @@ The radius of the cylinder. The number of sides of the cylinder, the higher this number the more detail there will be in the cylinder. +---- + .. _class_CSGCylinder_property_smooth_faces: - :ref:`bool` **smooth_faces** diff --git a/classes/class_csgpolygon.rst b/classes/class_csgpolygon.rst index 8041640fd..49cfe321f 100644 --- a/classes/class_csgpolygon.rst +++ b/classes/class_csgpolygon.rst @@ -68,6 +68,8 @@ enum **Mode**: - **MODE_PATH** = **2** --- Shape is extruded along a path set by a :ref:`Shape` set in :ref:`path_node`. +---- + .. _enum_CSGPolygon_PathRotation: .. _class_CSGPolygon_constant_PATH_ROTATION_POLYGON: @@ -104,6 +106,8 @@ Property Descriptions Extrusion depth when :ref:`mode` is :ref:`MODE_DEPTH`. +---- + .. _class_CSGPolygon_property_material: - :ref:`Material` **material** @@ -116,6 +120,8 @@ Extrusion depth when :ref:`mode` is :ref:`MODE_D Material to use for the resulting mesh. +---- + .. _class_CSGPolygon_property_mode: - :ref:`Mode` **mode** @@ -128,6 +134,8 @@ Material to use for the resulting mesh. Extrusion mode. +---- + .. _class_CSGPolygon_property_path_continuous_u: - :ref:`bool` **path_continuous_u** @@ -140,6 +148,8 @@ Extrusion mode. If ``true`` the u component of our uv will continuously increase in unison with the distance traveled along our path when :ref:`mode` is :ref:`MODE_PATH`. +---- + .. _class_CSGPolygon_property_path_interval: - :ref:`float` **path_interval** @@ -152,6 +162,8 @@ If ``true`` the u component of our uv will continuously increase in unison with Interval at which a new extrusion slice is added along the path when :ref:`mode` is :ref:`MODE_PATH`. +---- + .. _class_CSGPolygon_property_path_joined: - :ref:`bool` **path_joined** @@ -164,6 +176,8 @@ Interval at which a new extrusion slice is added along the path when :ref:`mode< If ``true`` the start and end of our path are joined together ensuring there is no seam when :ref:`mode` is :ref:`MODE_PATH`. +---- + .. _class_CSGPolygon_property_path_local: - :ref:`bool` **path_local** @@ -176,6 +190,8 @@ If ``true`` the start and end of our path are joined together ensuring there is If ``false`` we extrude centered on our path, if ``true`` we extrude in relation to the position of our CSGPolygon when :ref:`mode` is :ref:`MODE_PATH`. +---- + .. _class_CSGPolygon_property_path_node: - :ref:`NodePath` **path_node** @@ -188,6 +204,8 @@ If ``false`` we extrude centered on our path, if ``true`` we extrude in relation The :ref:`Shape` object containing the path along which we extrude when :ref:`mode` is :ref:`MODE_PATH`. +---- + .. _class_CSGPolygon_property_path_rotation: - :ref:`PathRotation` **path_rotation** @@ -200,6 +218,8 @@ The :ref:`Shape` object containing the path along which we extrude The method by which each slice is rotated along the path when :ref:`mode` is :ref:`MODE_PATH`. +---- + .. _class_CSGPolygon_property_polygon: - :ref:`PoolVector2Array` **polygon** @@ -212,6 +232,8 @@ The method by which each slice is rotated along the path when :ref:`mode` **smooth_faces** @@ -224,6 +246,8 @@ Point array that defines the shape that we'll extrude. Generates smooth normals so smooth shading is applied to our mesh. +---- + .. _class_CSGPolygon_property_spin_degrees: - :ref:`float` **spin_degrees** @@ -236,6 +260,8 @@ Generates smooth normals so smooth shading is applied to our mesh. Degrees to rotate our extrusion for each slice when :ref:`mode` is :ref:`MODE_SPIN`. +---- + .. _class_CSGPolygon_property_spin_sides: - :ref:`int` **spin_sides** diff --git a/classes/class_csgshape.rst b/classes/class_csgshape.rst index b271717c8..250ea5b28 100644 --- a/classes/class_csgshape.rst +++ b/classes/class_csgshape.rst @@ -93,6 +93,8 @@ Property Descriptions Calculate tangents for the CSG shape which allows the use of normal maps. This is only applied on the root shape, this setting is ignored on any child. +---- + .. _class_CSGShape_property_collision_layer: - :ref:`int` **collision_layer** @@ -109,6 +111,8 @@ Collidable objects can exist in any of 32 different layers. These layers work li A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. +---- + .. _class_CSGShape_property_collision_mask: - :ref:`int` **collision_mask** @@ -121,6 +125,8 @@ A contact is detected if object A is in any of the layers that object B scans, o The physics layers this CSG shape scans for collisions. +---- + .. _class_CSGShape_property_operation: - :ref:`Operation` **operation** @@ -133,6 +139,8 @@ The physics layers this CSG shape scans for collisions. The operation that is performed on this shape. This is ignored for the first CSG child node as the operation is between this node and the previous child of this nodes parent. +---- + .. _class_CSGShape_property_snap: - :ref:`float` **snap** @@ -143,6 +151,8 @@ The operation that is performed on this shape. This is ignored for the first CSG | *Getter* | get_snap() | +----------+-----------------+ +---- + .. _class_CSGShape_property_use_collision: - :ref:`bool` **use_collision** @@ -164,28 +174,38 @@ Method Descriptions Returns an individual bit on the collision mask. +---- + .. _class_CSGShape_method_get_collision_mask_bit: - :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const Returns an individual bit on the collision mask. +---- + .. _class_CSGShape_method_get_meshes: - :ref:`Array` **get_meshes** **(** **)** const +---- + .. _class_CSGShape_method_is_root_shape: - :ref:`bool` **is_root_shape** **(** **)** const Returns ``true`` if this is a root shape and is thus the object that is rendered. +---- + .. _class_CSGShape_method_set_collision_layer_bit: - void **set_collision_layer_bit** **(** :ref:`int` bit, :ref:`bool` value **)** Sets individual bits on the layer mask. Use this if you only need to change one layer's value. +---- + .. _class_CSGShape_method_set_collision_mask_bit: - void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** diff --git a/classes/class_csgsphere.rst b/classes/class_csgsphere.rst index c46ab0fb0..92530a86e 100644 --- a/classes/class_csgsphere.rst +++ b/classes/class_csgsphere.rst @@ -53,6 +53,8 @@ Property Descriptions The material used to render the sphere. +---- + .. _class_CSGSphere_property_radial_segments: - :ref:`int` **radial_segments** @@ -65,6 +67,8 @@ The material used to render the sphere. Number of vertical slices for the sphere. +---- + .. _class_CSGSphere_property_radius: - :ref:`float` **radius** @@ -77,6 +81,8 @@ Number of vertical slices for the sphere. Radius of the sphere. +---- + .. _class_CSGSphere_property_rings: - :ref:`int` **rings** @@ -89,6 +95,8 @@ Radius of the sphere. Number of horizontal slices for the sphere. +---- + .. _class_CSGSphere_property_smooth_faces: - :ref:`bool` **smooth_faces** diff --git a/classes/class_csgtorus.rst b/classes/class_csgtorus.rst index bd51bff14..ae0ec524f 100644 --- a/classes/class_csgtorus.rst +++ b/classes/class_csgtorus.rst @@ -55,6 +55,8 @@ Property Descriptions The inner radius of the torus. +---- + .. _class_CSGTorus_property_material: - :ref:`Material` **material** @@ -67,6 +69,8 @@ The inner radius of the torus. The material used to render the torus. +---- + .. _class_CSGTorus_property_outer_radius: - :ref:`float` **outer_radius** @@ -79,6 +83,8 @@ The material used to render the torus. The outer radius of the torus. +---- + .. _class_CSGTorus_property_ring_sides: - :ref:`int` **ring_sides** @@ -91,6 +97,8 @@ The outer radius of the torus. The number of edges each ring of the torus is constructed of. +---- + .. _class_CSGTorus_property_sides: - :ref:`int` **sides** @@ -103,6 +111,8 @@ The number of edges each ring of the torus is constructed of. The number of slices the torus is constructed of. +---- + .. _class_CSGTorus_property_smooth_faces: - :ref:`bool` **smooth_faces** diff --git a/classes/class_cubemap.rst b/classes/class_cubemap.rst index 81cb196b9..974985a40 100644 --- a/classes/class_cubemap.rst +++ b/classes/class_cubemap.rst @@ -61,6 +61,8 @@ enum **Storage**: - **STORAGE_COMPRESS_LOSSLESS** = **2** --- Store the ``CubeMap`` with moderate compression that doesn't reduce image quality. +---- + .. _enum_CubeMap_Side: .. _class_CubeMap_constant_SIDE_LEFT: @@ -89,6 +91,8 @@ enum **Side**: - **SIDE_BACK** = **5** --- Identifier for the back face of the ``CubeMap``. +---- + .. _enum_CubeMap_Flags: .. _class_CubeMap_constant_FLAG_MIPMAPS: @@ -129,6 +133,8 @@ Property Descriptions The render flags for the ``CubeMap``. See the ``FLAG_*`` constants for details. +---- + .. _class_CubeMap_property_lossy_storage_quality: - :ref:`float` **lossy_storage_quality** @@ -141,6 +147,8 @@ The render flags for the ``CubeMap``. See the ``FLAG_*`` constants for details. The lossy storage quality of the ``CubeMap`` if the storage mode is set to STORAGE_COMPRESS_LOSSY. +---- + .. _class_CubeMap_property_storage_mode: - :ref:`Storage` **storage_mode** @@ -162,18 +170,24 @@ Method Descriptions Returns the ``CubeMap``'s height. +---- + .. _class_CubeMap_method_get_side: - :ref:`Image` **get_side** **(** :ref:`Side` side **)** const Returns an :ref:`Image` for a side of the ``CubeMap`` using one of the ``SIDE_*`` constants or an integer 0-5. +---- + .. _class_CubeMap_method_get_width: - :ref:`int` **get_width** **(** **)** const Returns the ``CubeMap``'s width. +---- + .. _class_CubeMap_method_set_side: - void **set_side** **(** :ref:`Side` side, :ref:`Image` image **)** diff --git a/classes/class_cubemesh.rst b/classes/class_cubemesh.rst index a9d71378c..32c2b997a 100644 --- a/classes/class_cubemesh.rst +++ b/classes/class_cubemesh.rst @@ -53,6 +53,8 @@ Property Descriptions Size of the cuboid mesh. Defaults to (2, 2, 2). +---- + .. _class_CubeMesh_property_subdivide_depth: - :ref:`int` **subdivide_depth** @@ -65,6 +67,8 @@ Size of the cuboid mesh. Defaults to (2, 2, 2). Number of extra edge loops inserted along the z-axis. Defaults to 0. +---- + .. _class_CubeMesh_property_subdivide_height: - :ref:`int` **subdivide_height** @@ -77,6 +81,8 @@ Number of extra edge loops inserted along the z-axis. Defaults to 0. Number of extra edge loops inserted along the y-axis. Defaults to 0. +---- + .. _class_CubeMesh_property_subdivide_width: - :ref:`int` **subdivide_width** diff --git a/classes/class_curve.rst b/classes/class_curve.rst index bd6b33ef0..86bf8df6d 100644 --- a/classes/class_curve.rst +++ b/classes/class_curve.rst @@ -120,6 +120,8 @@ Property Descriptions The number of points to include in the baked (i.e. cached) curve data. +---- + .. _class_Curve_property_max_value: - :ref:`float` **max_value** @@ -132,6 +134,8 @@ The number of points to include in the baked (i.e. cached) curve data. The maximum value the curve can reach. Default value: ``1``. +---- + .. _class_Curve_property_min_value: - :ref:`float` **min_value** @@ -153,108 +157,144 @@ Method Descriptions Adds a point to the curve. For each side, if the ``*_mode`` is :ref:`TANGENT_LINEAR`, the ``*_tangent`` angle (in degrees) uses the slope of the curve halfway to the adjacent point. Allows custom assignments to the ``*_tangent`` angle if ``*_mode`` is set to :ref:`TANGENT_FREE`. +---- + .. _class_Curve_method_bake: - void **bake** **(** **)** Recomputes the baked cache of points for the curve. +---- + .. _class_Curve_method_clean_dupes: - void **clean_dupes** **(** **)** Removes points that are closer than ``CMP_EPSILON`` (0.00001) units to their neighbor on the curve. +---- + .. _class_Curve_method_clear_points: - void **clear_points** **(** **)** Removes all points from the curve. +---- + .. _class_Curve_method_get_point_count: - :ref:`int` **get_point_count** **(** **)** const Returns the number of points describing the curve. +---- + .. _class_Curve_method_get_point_left_mode: - :ref:`TangentMode` **get_point_left_mode** **(** :ref:`int` index **)** const Returns the left ``TangentMode`` for the point at ``index``. +---- + .. _class_Curve_method_get_point_left_tangent: - :ref:`float` **get_point_left_tangent** **(** :ref:`int` index **)** const Returns the left tangent angle (in degrees) for the point at ``index``. +---- + .. _class_Curve_method_get_point_position: - :ref:`Vector2` **get_point_position** **(** :ref:`int` index **)** const Returns the curve coordinates for the point at ``index``. +---- + .. _class_Curve_method_get_point_right_mode: - :ref:`TangentMode` **get_point_right_mode** **(** :ref:`int` index **)** const Returns the right ``TangentMode`` for the point at ``index``. +---- + .. _class_Curve_method_get_point_right_tangent: - :ref:`float` **get_point_right_tangent** **(** :ref:`int` index **)** const Returns the right tangent angle (in degrees) for the point at ``index``. +---- + .. _class_Curve_method_interpolate: - :ref:`float` **interpolate** **(** :ref:`float` offset **)** const Returns the y value for the point that would exist at x-position ``offset`` along the curve. +---- + .. _class_Curve_method_interpolate_baked: - :ref:`float` **interpolate_baked** **(** :ref:`float` offset **)** Returns the y value for the point that would exist at x-position ``offset`` along the curve using the baked cache. Bakes the curve's points if not already baked. +---- + .. _class_Curve_method_remove_point: - void **remove_point** **(** :ref:`int` index **)** Removes the point at ``index`` from the curve. +---- + .. _class_Curve_method_set_point_left_mode: - void **set_point_left_mode** **(** :ref:`int` index, :ref:`TangentMode` mode **)** Sets the left ``TangentMode`` for the point at ``index`` to ``mode``. +---- + .. _class_Curve_method_set_point_left_tangent: - void **set_point_left_tangent** **(** :ref:`int` index, :ref:`float` tangent **)** Sets the left tangent angle for the point at ``index`` to ``tangent``. +---- + .. _class_Curve_method_set_point_offset: - :ref:`int` **set_point_offset** **(** :ref:`int` index, :ref:`float` offset **)** Sets the offset from ``0.5`` +---- + .. _class_Curve_method_set_point_right_mode: - void **set_point_right_mode** **(** :ref:`int` index, :ref:`TangentMode` mode **)** Sets the right ``TangentMode`` for the point at ``index`` to ``mode``. +---- + .. _class_Curve_method_set_point_right_tangent: - void **set_point_right_tangent** **(** :ref:`int` index, :ref:`float` tangent **)** Sets the right tangent angle for the point at ``index`` to ``tangent``. +---- + .. _class_Curve_method_set_point_value: - void **set_point_value** **(** :ref:`int` index, :ref:`float` y **)** diff --git a/classes/class_curve2d.rst b/classes/class_curve2d.rst index 6c111766a..3333a7449 100644 --- a/classes/class_curve2d.rst +++ b/classes/class_curve2d.rst @@ -99,24 +99,32 @@ Adds a point to a curve, at ``position``, with control points ``in`` and ``out`` If ``at_position`` is given, the point is inserted before the point number ``at_position``, moving that point (and every point after) after the inserted point. If ``at_position`` is not given, or is an illegal value (``at_position <0`` or ``at_position >= [method get_point_count]``), the point will be appended at the end of the point list. +---- + .. _class_Curve2D_method_clear_points: - void **clear_points** **(** **)** Removes all points from the curve. +---- + .. _class_Curve2D_method_get_baked_length: - :ref:`float` **get_baked_length** **(** **)** const Returns the total length of the curve, based on the cached points. Given enough density (see :ref:`bake_interval`), it should be approximate enough. +---- + .. _class_Curve2D_method_get_baked_points: - :ref:`PoolVector2Array` **get_baked_points** **(** **)** const Returns the cache of points as a :ref:`PoolVector2Array`. +---- + .. _class_Curve2D_method_get_closest_offset: - :ref:`float` **get_closest_offset** **(** :ref:`Vector2` to_point **)** const @@ -125,6 +133,8 @@ Returns the closest offset to ``to_point``. This offset is meant to be used in : ``to_point`` must be in this curve's local space. +---- + .. _class_Curve2D_method_get_closest_point: - :ref:`Vector2` **get_closest_point** **(** :ref:`Vector2` to_point **)** const @@ -133,30 +143,40 @@ Returns the closest point (in curve's local space) to ``to_point``. ``to_point`` must be in this curve's local space. +---- + .. _class_Curve2D_method_get_point_count: - :ref:`int` **get_point_count** **(** **)** const Returns the number of points describing the curve. +---- + .. _class_Curve2D_method_get_point_in: - :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_method_get_point_out: - :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_method_get_point_position: - :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_method_interpolate: - :ref:`Vector2` **interpolate** **(** :ref:`int` idx, :ref:`float` t **)** const @@ -165,6 +185,8 @@ Returns the position between the vertex ``idx`` and the vertex ``idx + 1``, wher If ``idx`` is out of bounds it is truncated to the first or last vertex, and ``t`` is ignored. If the curve has no points, the function sends an error to the console, and returns ``(0, 0)``. +---- + .. _class_Curve2D_method_interpolate_baked: - :ref:`Vector2` **interpolate_baked** **(** :ref:`float` offset, :ref:`bool` cubic=false **)** const @@ -175,36 +197,48 @@ To do that, it finds the two cached points where the ``offset`` lies between, th Cubic interpolation tends to follow the curves better, but linear is faster (and often, precise enough). +---- + .. _class_Curve2D_method_interpolatef: - :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_method_remove_point: - 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_method_set_point_in: - 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_method_set_point_out: - 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_method_set_point_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_method_tessellate: - :ref:`PoolVector2Array` **tessellate** **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const diff --git a/classes/class_curve3d.rst b/classes/class_curve3d.rst index 465ced291..248a60fda 100644 --- a/classes/class_curve3d.rst +++ b/classes/class_curve3d.rst @@ -100,6 +100,8 @@ Property Descriptions The distance in meters between two adjacent cached points. Changing it forces the cache to be recomputed the next time the :ref:`get_baked_points` or :ref:`get_baked_length` function is called. The smaller the distance, the more points in the cache and the more memory it will consume, so use with care. +---- + .. _class_Curve3D_property_up_vector_enabled: - :ref:`bool` **up_vector_enabled** @@ -123,30 +125,40 @@ Adds a point to a curve, at ``position``, with control points ``in`` and ``out`` If ``at_position`` is given, the point is inserted before the point number ``at_position``, moving that point (and every point after) after the inserted point. If ``at_position`` is not given, or is an illegal value (``at_position <0`` or ``at_position >= [method get_point_count]``), the point will be appended at the end of the point list. +---- + .. _class_Curve3D_method_clear_points: - void **clear_points** **(** **)** Removes all points from the curve. +---- + .. _class_Curve3D_method_get_baked_length: - :ref:`float` **get_baked_length** **(** **)** const Returns the total length of the curve, based on the cached points. Given enough density (see :ref:`bake_interval`), it should be approximate enough. +---- + .. _class_Curve3D_method_get_baked_points: - :ref:`PoolVector3Array` **get_baked_points** **(** **)** const Returns the cache of points as a :ref:`PoolVector3Array`. +---- + .. _class_Curve3D_method_get_baked_tilts: - :ref:`PoolRealArray` **get_baked_tilts** **(** **)** const Returns the cache of tilts as a :ref:`PoolRealArray`. +---- + .. _class_Curve3D_method_get_baked_up_vectors: - :ref:`PoolVector3Array` **get_baked_up_vectors** **(** **)** const @@ -155,6 +167,8 @@ Returns the cache of up vectors as a :ref:`PoolVector3Array` is ``false``, the cache will be empty. +---- + .. _class_Curve3D_method_get_closest_offset: - :ref:`float` **get_closest_offset** **(** :ref:`Vector3` to_point **)** const @@ -163,6 +177,8 @@ Returns the closest offset to ``to_point``. This offset is meant to be used in : ``to_point`` must be in this curve's local space. +---- + .. _class_Curve3D_method_get_closest_point: - :ref:`Vector3` **get_closest_point** **(** :ref:`Vector3` to_point **)** const @@ -171,36 +187,48 @@ Returns the closest point (in curve's local space) to ``to_point``. ``to_point`` must be in this curve's local space. +---- + .. _class_Curve3D_method_get_point_count: - :ref:`int` **get_point_count** **(** **)** const Returns the number of points describing the curve. +---- + .. _class_Curve3D_method_get_point_in: - :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_method_get_point_out: - :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_method_get_point_position: - :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_method_get_point_tilt: - :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_method_interpolate: - :ref:`Vector3` **interpolate** **(** :ref:`int` idx, :ref:`float` t **)** const @@ -209,6 +237,8 @@ Returns the position between the vertex ``idx`` and the vertex ``idx + 1``, wher If ``idx`` is out of bounds it is truncated to the first or last vertex, and ``t`` is ignored. If the curve has no points, the function sends an error to the console, and returns ``(0, 0, 0)``. +---- + .. _class_Curve3D_method_interpolate_baked: - :ref:`Vector3` **interpolate_baked** **(** :ref:`float` offset, :ref:`bool` cubic=false **)** const @@ -219,6 +249,8 @@ To do that, it finds the two cached points where the ``offset`` lies between, th Cubic interpolation tends to follow the curves better, but linear is faster (and often, precise enough). +---- + .. _class_Curve3D_method_interpolate_baked_up_vector: - :ref:`Vector3` **interpolate_baked_up_vector** **(** :ref:`float` offset, :ref:`bool` apply_tilt=false **)** const @@ -229,36 +261,48 @@ To do that, it finds the two cached up vectors where the ``offset`` lies between If the curve has no up vectors, the function sends an error to the console, and returns ``(0, 1, 0)``. +---- + .. _class_Curve3D_method_interpolatef: - :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_method_remove_point: - 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_method_set_point_in: - 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_method_set_point_out: - 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_method_set_point_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_method_set_point_tilt: - void **set_point_tilt** **(** :ref:`int` idx, :ref:`float` tilt **)** @@ -267,6 +311,8 @@ Sets the tilt angle in radians for the point ``idx``. If the index is out of bou The tilt controls the rotation along the look-at axis an object traveling the path would have. In the case of a curve controlling a :ref:`PathFollow`, this tilt is an offset over the natural tilt the :ref:`PathFollow` calculates. +---- + .. _class_Curve3D_method_tessellate: - :ref:`PoolVector3Array` **tessellate** **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const diff --git a/classes/class_curvetexture.rst b/classes/class_curvetexture.rst index 6421bbd1a..5b89f30b5 100644 --- a/classes/class_curvetexture.rst +++ b/classes/class_curvetexture.rst @@ -47,6 +47,8 @@ Property Descriptions The ``curve`` rendered onto the texture. +---- + .. _class_CurveTexture_property_width: - :ref:`int` **width** diff --git a/classes/class_cylindermesh.rst b/classes/class_cylindermesh.rst index 8e8e26208..f68af0760 100644 --- a/classes/class_cylindermesh.rst +++ b/classes/class_cylindermesh.rst @@ -53,6 +53,8 @@ Property Descriptions Bottom radius of the cylinder. Defaults to 1.0. +---- + .. _class_CylinderMesh_property_height: - :ref:`float` **height** @@ -65,6 +67,8 @@ Bottom radius of the cylinder. Defaults to 1.0. Full height of the cylinder. Defaults to 2.0. +---- + .. _class_CylinderMesh_property_radial_segments: - :ref:`int` **radial_segments** @@ -77,6 +81,8 @@ Full height of the cylinder. Defaults to 2.0. Number of radial segments on the cylinder. Defaults to 64. +---- + .. _class_CylinderMesh_property_rings: - :ref:`int` **rings** @@ -89,6 +95,8 @@ Number of radial segments on the cylinder. Defaults to 64. Number of edge rings along the height of the cylinder. Defaults to 4. +---- + .. _class_CylinderMesh_property_top_radius: - :ref:`float` **top_radius** diff --git a/classes/class_cylindershape.rst b/classes/class_cylindershape.rst index f8cf66ce2..2430b6d7f 100644 --- a/classes/class_cylindershape.rst +++ b/classes/class_cylindershape.rst @@ -47,6 +47,8 @@ Property Descriptions The cylinder's height. +---- + .. _class_CylinderShape_property_radius: - :ref:`float` **radius** diff --git a/classes/class_dampedspringjoint2d.rst b/classes/class_dampedspringjoint2d.rst index 7fc21fd0e..bc2afb4f5 100644 --- a/classes/class_dampedspringjoint2d.rst +++ b/classes/class_dampedspringjoint2d.rst @@ -51,6 +51,8 @@ Property Descriptions The spring joint's damping ratio. A value between ``0`` and ``1``. When the two bodies move into different directions the system tries to align them to the spring axis again. A high ``damping`` value forces the attached bodies to align faster. Default value: ``1`` +---- + .. _class_DampedSpringJoint2D_property_length: - :ref:`float` **length** @@ -63,6 +65,8 @@ The spring joint's damping ratio. A value between ``0`` and ``1``. When the two The spring joint's maximum length. The two attached bodies cannot stretch it past this value. Default value: ``50`` +---- + .. _class_DampedSpringJoint2D_property_rest_length: - :ref:`float` **rest_length** @@ -75,6 +79,8 @@ The spring joint's maximum length. The two attached bodies cannot stretch it pas When the bodies attached to the spring joint move they stretch or squash it. The joint always tries to resize towards this length. Default value: ``0`` +---- + .. _class_DampedSpringJoint2D_property_stiffness: - :ref:`float` **stiffness** diff --git a/classes/class_dictionary.rst b/classes/class_dictionary.rst index 4e29b8072..806f57b97 100644 --- a/classes/class_dictionary.rst +++ b/classes/class_dictionary.rst @@ -77,60 +77,80 @@ Method Descriptions Clear the dictionary, removing all key/value pairs. +---- + .. _class_Dictionary_method_duplicate: - :ref:`Dictionary` **duplicate** **(** :ref:`bool` deep=False **)** Creates a copy of the dictionary, and returns it. +---- + .. _class_Dictionary_method_empty: - :ref:`bool` **empty** **(** **)** Returns ``true`` if the dictionary is empty. +---- + .. _class_Dictionary_method_erase: - :ref:`bool` **erase** **(** :ref:`Variant` key **)** Erase a dictionary key/value pair by key. Returns ``true`` if the given key was present in the dictionary, ``false`` otherwise. Do not erase elements while iterating over the dictionary. +---- + .. _class_Dictionary_method_get: - :ref:`Variant` **get** **(** :ref:`Variant` key, :ref:`Variant` default=Null **)** Returns the current value for the specified key in the ``Dictionary``. If the key does not exist, the method returns the value of the optional default argument, or Null if it is omitted. +---- + .. _class_Dictionary_method_has: - :ref:`bool` **has** **(** :ref:`Variant` key **)** Returns ``true`` if the dictionary has a given key. +---- + .. _class_Dictionary_method_has_all: - :ref:`bool` **has_all** **(** :ref:`Array` keys **)** Returns ``true`` if the dictionary has all of the keys in the given array. +---- + .. _class_Dictionary_method_hash: - :ref:`int` **hash** **(** **)** Returns a hashed integer value representing the dictionary contents. +---- + .. _class_Dictionary_method_keys: - :ref:`Array` **keys** **(** **)** Returns the list of keys in the ``Dictionary``. +---- + .. _class_Dictionary_method_size: - :ref:`int` **size** **(** **)** Returns the size of the dictionary (in pairs). +---- + .. _class_Dictionary_method_values: - :ref:`Array` **values** **(** **)** diff --git a/classes/class_directionallight.rst b/classes/class_directionallight.rst index eb6ae97e2..5174e0dc7 100644 --- a/classes/class_directionallight.rst +++ b/classes/class_directionallight.rst @@ -60,6 +60,8 @@ enum **ShadowMode**: - **SHADOW_PARALLEL_4_SPLITS** = **2** --- Splits the view frustum in 4 areas, each with its own shadow map. +---- + .. _enum_DirectionalLight_ShadowDepthRange: .. _class_DirectionalLight_constant_SHADOW_DEPTH_RANGE_STABLE: @@ -97,6 +99,8 @@ Property Descriptions Amount of extra bias for shadow splits that are far away. If self shadowing occurs only on the splits far away, this value can fix them. +---- + .. _class_DirectionalLight_property_directional_shadow_blend_splits: - :ref:`bool` **directional_shadow_blend_splits** @@ -109,6 +113,8 @@ Amount of extra bias for shadow splits that are far away. If self shadowing occu If ``true``, shadow detail is sacrificed in exchange for smoother transitions between splits. Default value:``false``. +---- + .. _class_DirectionalLight_property_directional_shadow_depth_range: - :ref:`ShadowDepthRange` **directional_shadow_depth_range** @@ -121,6 +127,8 @@ If ``true``, shadow detail is sacrificed in exchange for smoother transitions be Optimizes shadow rendering for detail versus movement. See :ref:`ShadowDepthRange`. +---- + .. _class_DirectionalLight_property_directional_shadow_max_distance: - :ref:`float` **directional_shadow_max_distance** @@ -133,6 +141,8 @@ Optimizes shadow rendering for detail versus movement. See :ref:`ShadowDepthRang The maximum distance for shadow splits. +---- + .. _class_DirectionalLight_property_directional_shadow_mode: - :ref:`ShadowMode` **directional_shadow_mode** @@ -145,6 +155,8 @@ The maximum distance for shadow splits. The light's shadow rendering algorithm. See :ref:`ShadowMode`. +---- + .. _class_DirectionalLight_property_directional_shadow_normal_bias: - :ref:`float` **directional_shadow_normal_bias** @@ -157,6 +169,8 @@ The light's shadow rendering algorithm. See :ref:`ShadowMode` **directional_shadow_split_1** @@ -169,6 +183,8 @@ Can be used to fix special cases of self shadowing when objects are perpendicula The distance from camera to shadow split 1. Relative to :ref:`directional_shadow_max_distance`. Only used when :ref:`directional_shadow_mode` is one of the ``SHADOW_PARALLEL_*_SPLITS`` constants. +---- + .. _class_DirectionalLight_property_directional_shadow_split_2: - :ref:`float` **directional_shadow_split_2** @@ -181,6 +197,8 @@ The distance from camera to shadow split 1. Relative to :ref:`directional_shadow The distance from shadow split 1 to split 2. Relative to :ref:`directional_shadow_max_distance`. Only used when :ref:`directional_shadow_mode` is ``SHADOW_PARALLEL_3_SPLITS`` or ``SHADOW_PARALLEL_4_SPLITS``. +---- + .. _class_DirectionalLight_property_directional_shadow_split_3: - :ref:`float` **directional_shadow_split_3** diff --git a/classes/class_directory.rst b/classes/class_directory.rst index f77da8c7d..54bc52650 100644 --- a/classes/class_directory.rst +++ b/classes/class_directory.rst @@ -98,6 +98,8 @@ Change the currently opened directory to the one passed as an argument. The argu The method returns one of the error code constants defined in :ref:`@GlobalScope` (OK or ERR\_\*). +---- + .. _class_Directory_method_copy: - :ref:`Error` **copy** **(** :ref:`String` from, :ref:`String` to **)** @@ -106,48 +108,64 @@ Copy the *from* file to the *to* destination. Both arguments should be paths to Returns one of the error code constants defined in :ref:`@GlobalScope` (OK, FAILED or ERR\_\*). +---- + .. _class_Directory_method_current_is_dir: - :ref:`bool` **current_is_dir** **(** **)** const Returns whether the current item processed with the last :ref:`get_next` call is a directory (``.`` and ``..`` are considered directories). +---- + .. _class_Directory_method_dir_exists: - :ref:`bool` **dir_exists** **(** :ref:`String` path **)** Returns whether the target directory exists. The argument can be relative to the current directory, or an absolute path. +---- + .. _class_Directory_method_file_exists: - :ref:`bool` **file_exists** **(** :ref:`String` path **)** Returns whether the target file exists. The argument can be relative to the current directory, or an absolute path. +---- + .. _class_Directory_method_get_current_dir: - :ref:`String` **get_current_dir** **(** **)** Returns the absolute path to the currently opened directory (e.g. ``res://folder`` or ``C:\tmp\folder``). +---- + .. _class_Directory_method_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_method_get_drive: - :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_method_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_method_get_next: - :ref:`String` **get_next** **(** **)** @@ -156,12 +174,16 @@ Returns the next element (file or directory) in the current directory (including The name of the file or directory is returned (and not its full path). Once the stream has been fully processed, the method returns an empty String and closes the stream automatically (i.e. :ref:`list_dir_end` would not be mandatory in such a case). +---- + .. _class_Directory_method_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_method_list_dir_begin: - :ref:`Error` **list_dir_begin** **(** :ref:`bool` skip_navigational=false, :ref:`bool` skip_hidden=false **)** @@ -172,12 +194,16 @@ If you pass ``skip_navigational``, then ``.`` and ``..`` would be filtered out. If you pass ``skip_hidden``, then hidden files would be filtered out. +---- + .. _class_Directory_method_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_method_make_dir: - :ref:`Error` **make_dir** **(** :ref:`String` path **)** @@ -186,6 +212,8 @@ Create a directory. The argument can be relative to the current directory, or an The method returns one of the error code constants defined in :ref:`@GlobalScope` (OK, FAILED or ERR\_\*). +---- + .. _class_Directory_method_make_dir_recursive: - :ref:`Error` **make_dir_recursive** **(** :ref:`String` path **)** @@ -194,6 +222,8 @@ Create a target directory and all necessary intermediate directories in its path Returns one of the error code constants defined in :ref:`@GlobalScope` (OK, FAILED or ERR\_\*). +---- + .. _class_Directory_method_open: - :ref:`Error` **open** **(** :ref:`String` path **)** @@ -202,6 +232,8 @@ Open an existing directory of the filesystem. The *path* argument can be within The method returns one of the error code constants defined in :ref:`@GlobalScope` (OK or ERR\_\*). +---- + .. _class_Directory_method_remove: - :ref:`Error` **remove** **(** :ref:`String` path **)** @@ -210,6 +242,8 @@ Delete the target file or an empty directory. The argument can be relative to th Returns one of the error code constants defined in :ref:`@GlobalScope` (OK or FAILED). +---- + .. _class_Directory_method_rename: - :ref:`Error` **rename** **(** :ref:`String` from, :ref:`String` to **)** diff --git a/classes/class_dynamicfont.rst b/classes/class_dynamicfont.rst index df4102794..d2fc8d92f 100644 --- a/classes/class_dynamicfont.rst +++ b/classes/class_dynamicfont.rst @@ -108,6 +108,8 @@ Property Descriptions Extra spacing at the bottom in pixels. +---- + .. _class_DynamicFont_property_extra_spacing_char: - :ref:`int` **extra_spacing_char** @@ -120,6 +122,8 @@ Extra spacing at the bottom in pixels. Extra character spacing in pixels. +---- + .. _class_DynamicFont_property_extra_spacing_space: - :ref:`int` **extra_spacing_space** @@ -132,6 +136,8 @@ Extra character spacing in pixels. Extra space spacing in pixels. +---- + .. _class_DynamicFont_property_extra_spacing_top: - :ref:`int` **extra_spacing_top** @@ -144,6 +150,8 @@ Extra space spacing in pixels. Extra spacing at the top in pixels. +---- + .. _class_DynamicFont_property_font_data: - :ref:`DynamicFontData` **font_data** @@ -156,6 +164,8 @@ Extra spacing at the top in pixels. The font data. +---- + .. _class_DynamicFont_property_outline_color: - :ref:`Color` **outline_color** @@ -166,6 +176,8 @@ The font data. | *Getter* | get_outline_color() | +----------+--------------------------+ +---- + .. _class_DynamicFont_property_outline_size: - :ref:`int` **outline_size** @@ -176,6 +188,8 @@ The font data. | *Getter* | get_outline_size() | +----------+-------------------------+ +---- + .. _class_DynamicFont_property_size: - :ref:`int` **size** @@ -188,6 +202,8 @@ The font data. The font size. +---- + .. _class_DynamicFont_property_use_filter: - :ref:`bool` **use_filter** @@ -200,6 +216,8 @@ The font size. If ``true``, filtering is used. +---- + .. _class_DynamicFont_property_use_mipmaps: - :ref:`bool` **use_mipmaps** @@ -221,24 +239,32 @@ Method Descriptions Adds a fallback font. +---- + .. _class_DynamicFont_method_get_fallback: - :ref:`DynamicFontData` **get_fallback** **(** :ref:`int` idx **)** const Returns the fallback font at index ``idx``. +---- + .. _class_DynamicFont_method_get_fallback_count: - :ref:`int` **get_fallback_count** **(** **)** const Returns the number of fallback fonts. +---- + .. _class_DynamicFont_method_remove_fallback: - void **remove_fallback** **(** :ref:`int` idx **)** Removes the fallback font at index ``idx``. +---- + .. _class_DynamicFont_method_set_fallback: - void **set_fallback** **(** :ref:`int` idx, :ref:`DynamicFontData` data **)** diff --git a/classes/class_dynamicfontdata.rst b/classes/class_dynamicfontdata.rst index cc8b3f860..7e464dd64 100644 --- a/classes/class_dynamicfontdata.rst +++ b/classes/class_dynamicfontdata.rst @@ -68,6 +68,8 @@ Property Descriptions Controls whether the font should be rendered with anti-aliasing. +---- + .. _class_DynamicFontData_property_font_path: - :ref:`String` **font_path** @@ -80,6 +82,8 @@ Controls whether the font should be rendered with anti-aliasing. The path to the vector font file. +---- + .. _class_DynamicFontData_property_hinting: - :ref:`Hinting` **hinting** diff --git a/classes/class_editorexportplugin.rst b/classes/class_editorexportplugin.rst index 02ca1e0fa..7e94edff4 100644 --- a/classes/class_editorexportplugin.rst +++ b/classes/class_editorexportplugin.rst @@ -24,6 +24,8 @@ Methods +------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_export_begin` **(** :ref:`PoolStringArray` features, :ref:`bool` is_debug, :ref:`String` path, :ref:`int` flags **)** virtual | +------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_export_end` **(** **)** 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 **)** | @@ -50,38 +52,62 @@ Method Descriptions - void **_export_begin** **(** :ref:`PoolStringArray` features, :ref:`bool` is_debug, :ref:`String` path, :ref:`int` flags **)** virtual +---- + +.. _class_EditorExportPlugin_method__export_end: + +- void **_export_end** **(** **)** virtual + +---- + .. _class_EditorExportPlugin_method__export_file: - void **_export_file** **(** :ref:`String` path, :ref:`String` type, :ref:`PoolStringArray` features **)** virtual +---- + .. _class_EditorExportPlugin_method_add_file: - void **add_file** **(** :ref:`String` path, :ref:`PoolByteArray` file, :ref:`bool` remap **)** +---- + .. _class_EditorExportPlugin_method_add_ios_bundle_file: - void **add_ios_bundle_file** **(** :ref:`String` path **)** +---- + .. _class_EditorExportPlugin_method_add_ios_cpp_code: - void **add_ios_cpp_code** **(** :ref:`String` code **)** +---- + .. _class_EditorExportPlugin_method_add_ios_framework: - void **add_ios_framework** **(** :ref:`String` path **)** +---- + .. _class_EditorExportPlugin_method_add_ios_linker_flags: - void **add_ios_linker_flags** **(** :ref:`String` flags **)** +---- + .. _class_EditorExportPlugin_method_add_ios_plist_content: - void **add_ios_plist_content** **(** :ref:`String` plist_content **)** +---- + .. _class_EditorExportPlugin_method_add_shared_object: - void **add_shared_object** **(** :ref:`String` path, :ref:`PoolStringArray` tags **)** +---- + .. _class_EditorExportPlugin_method_skip: - void **skip** **(** **)** diff --git a/classes/class_editorfiledialog.rst b/classes/class_editorfiledialog.rst index aaaa7d53f..47baf4c9d 100644 --- a/classes/class_editorfiledialog.rst +++ b/classes/class_editorfiledialog.rst @@ -61,12 +61,16 @@ Signals Emitted when a directory is selected. +---- + .. _class_EditorFileDialog_signal_file_selected: - **file_selected** **(** :ref:`String` path **)** Emitted when a file is selected. +---- + .. _class_EditorFileDialog_signal_files_selected: - **files_selected** **(** :ref:`PoolStringArray` paths **)** @@ -100,6 +104,8 @@ enum **Mode**: - **MODE_SAVE_FILE** = **4** --- The ``EditorFileDialog`` can select only one file. Accepting the window will save the file. +---- + .. _enum_EditorFileDialog_Access: .. _class_EditorFileDialog_constant_ACCESS_RESOURCES: @@ -116,6 +122,8 @@ enum **Access**: - **ACCESS_FILESYSTEM** = **2** --- The ``EditorFileDialog`` can view the entire local file system. +---- + .. _enum_EditorFileDialog_DisplayMode: .. _class_EditorFileDialog_constant_DISPLAY_THUMBNAILS: @@ -143,6 +151,8 @@ Property Descriptions The location from which the user may select a file, including ``res://``, ``user://``, and the local file system. +---- + .. _class_EditorFileDialog_property_current_dir: - :ref:`String` **current_dir** @@ -155,6 +165,8 @@ The location from which the user may select a file, including ``res://``, ``user The currently occupied directory. +---- + .. _class_EditorFileDialog_property_current_file: - :ref:`String` **current_file** @@ -167,6 +179,8 @@ The currently occupied directory. The currently selected file. +---- + .. _class_EditorFileDialog_property_current_path: - :ref:`String` **current_path** @@ -179,6 +193,8 @@ The currently selected file. The file system path in the address bar. +---- + .. _class_EditorFileDialog_property_disable_overwrite_warning: - :ref:`bool` **disable_overwrite_warning** @@ -191,6 +207,8 @@ The file system path in the address bar. If ``true``, the ``EditorFileDialog`` will not warn the user before overwriting files. +---- + .. _class_EditorFileDialog_property_display_mode: - :ref:`DisplayMode` **display_mode** @@ -203,6 +221,8 @@ If ``true``, the ``EditorFileDialog`` will not warn the user before overwriting The view format in which the ``EditorFileDialog`` displays resources to the user. +---- + .. _class_EditorFileDialog_property_mode: - :ref:`Mode` **mode** @@ -215,6 +235,8 @@ The view format in which the ``EditorFileDialog`` displays resources to the user The purpose of the ``EditorFileDialog``. Changes allowed behaviors. +---- + .. _class_EditorFileDialog_property_show_hidden_files: - :ref:`bool` **show_hidden_files** @@ -238,18 +260,24 @@ Adds a comma-delimited file extension filter option to the ``EditorFileDialog`` Example: "\*.tscn, \*.scn; Scenes", results in filter text "Scenes (\*.tscn, \*.scn)". +---- + .. _class_EditorFileDialog_method_clear_filters: - void **clear_filters** **(** **)** Removes all filters except for "All Files (\*)". +---- + .. _class_EditorFileDialog_method_get_vbox: - :ref:`VBoxContainer` **get_vbox** **(** **)** Returns the ``VBoxContainer`` used to display the file system. +---- + .. _class_EditorFileDialog_method_invalidate: - void **invalidate** **(** **)** diff --git a/classes/class_editorfilesystem.rst b/classes/class_editorfilesystem.rst index 9b66bc75f..5cd282f7c 100644 --- a/classes/class_editorfilesystem.rst +++ b/classes/class_editorfilesystem.rst @@ -50,16 +50,22 @@ Signals Emitted if the filesystem changed. +---- + .. _class_EditorFileSystem_signal_resources_reimported: - **resources_reimported** **(** :ref:`PoolStringArray` resources **)** Remitted if a resource is reimported. +---- + .. _class_EditorFileSystem_signal_resources_reload: - **resources_reload** **(** :ref:`PoolStringArray` resources **)** +---- + .. _class_EditorFileSystem_signal_sources_changed: - **sources_changed** **(** :ref:`bool` exist **)** @@ -80,48 +86,64 @@ Method Descriptions Get the type of the file, given the full path. +---- + .. _class_EditorFileSystem_method_get_filesystem: - :ref:`EditorFileSystemDirectory` **get_filesystem** **(** **)** Get the root directory object. +---- + .. _class_EditorFileSystem_method_get_filesystem_path: - :ref:`EditorFileSystemDirectory` **get_filesystem_path** **(** :ref:`String` path **)** Returns a view into the filesystem at ``path``. +---- + .. _class_EditorFileSystem_method_get_scanning_progress: - :ref:`float` **get_scanning_progress** **(** **)** const Returns the scan progress for 0 to 1 if the FS is being scanned. +---- + .. _class_EditorFileSystem_method_is_scanning: - :ref:`bool` **is_scanning** **(** **)** const Returns ``true`` of the filesystem is being scanned. +---- + .. _class_EditorFileSystem_method_scan: - void **scan** **(** **)** Scan the filesystem for changes. +---- + .. _class_EditorFileSystem_method_scan_sources: - void **scan_sources** **(** **)** Check if the source of any imported resource changed. +---- + .. _class_EditorFileSystem_method_update_file: - void **update_file** **(** :ref:`String` path **)** Update a file information. Call this if an external program (not Godot) modified the file. +---- + .. _class_EditorFileSystem_method_update_script_classes: - void **update_script_classes** **(** **)** diff --git a/classes/class_editorfilesystemdirectory.rst b/classes/class_editorfilesystemdirectory.rst index c35389ec8..6c16c5050 100644 --- a/classes/class_editorfilesystemdirectory.rst +++ b/classes/class_editorfilesystemdirectory.rst @@ -65,74 +65,100 @@ Method Descriptions Returns the index of the directory with name ``name`` or ``-1`` if not found. +---- + .. _class_EditorFileSystemDirectory_method_find_file_index: - :ref:`int` **find_file_index** **(** :ref:`String` name **)** const Returns the index of the file with name ``name`` or ``-1`` if not found. +---- + .. _class_EditorFileSystemDirectory_method_get_file: - :ref:`String` **get_file** **(** :ref:`int` idx **)** const Returns the name of the file at index ``idx``. +---- + .. _class_EditorFileSystemDirectory_method_get_file_count: - :ref:`int` **get_file_count** **(** **)** const Returns the number of files in this directory. +---- + .. _class_EditorFileSystemDirectory_method_get_file_import_is_valid: - :ref:`bool` **get_file_import_is_valid** **(** :ref:`int` idx **)** const Returns ``true`` if the file at index ``idx`` imported properly. +---- + .. _class_EditorFileSystemDirectory_method_get_file_path: - :ref:`String` **get_file_path** **(** :ref:`int` idx **)** const Returns the path to the file at index ``idx``. +---- + .. _class_EditorFileSystemDirectory_method_get_file_script_class_extends: - :ref:`String` **get_file_script_class_extends** **(** :ref:`int` idx **)** const +---- + .. _class_EditorFileSystemDirectory_method_get_file_script_class_name: - :ref:`String` **get_file_script_class_name** **(** :ref:`int` idx **)** const +---- + .. _class_EditorFileSystemDirectory_method_get_file_type: - :ref:`String` **get_file_type** **(** :ref:`int` idx **)** const Returns the file extension of the file at index ``idx``. +---- + .. _class_EditorFileSystemDirectory_method_get_name: - :ref:`String` **get_name** **(** **)** Returns the name of this directory. +---- + .. _class_EditorFileSystemDirectory_method_get_parent: - :ref:`EditorFileSystemDirectory` **get_parent** **(** **)** Returns the parent directory for this directory or null if called on a directory at ``res://`` or ``user://``. +---- + .. _class_EditorFileSystemDirectory_method_get_path: - :ref:`String` **get_path** **(** **)** const Returns the path to this directory. +---- + .. _class_EditorFileSystemDirectory_method_get_subdir: - :ref:`EditorFileSystemDirectory` **get_subdir** **(** :ref:`int` idx **)** Returns the subdirectory at index ``idx``. +---- + .. _class_EditorFileSystemDirectory_method_get_subdir_count: - :ref:`int` **get_subdir_count** **(** **)** const diff --git a/classes/class_editorimportplugin.rst b/classes/class_editorimportplugin.rst index b62842b07..e9f4b7803 100644 --- a/classes/class_editorimportplugin.rst +++ b/classes/class_editorimportplugin.rst @@ -111,64 +111,86 @@ Method Descriptions 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_method_get_import_order: - :ref:`int` **get_import_order** **(** **)** virtual Get the order of this importer to be run when importing resources. Higher values will be called later. Use this to ensure the importer runs after the dependencies are already imported. +---- + .. _class_EditorImportPlugin_method_get_importer_name: - :ref:`String` **get_importer_name** **(** **)** virtual Get the unique name of the importer. +---- + .. _class_EditorImportPlugin_method_get_option_visibility: - :ref:`bool` **get_option_visibility** **(** :ref:`String` option, :ref:`Dictionary` options **)** virtual +---- + .. _class_EditorImportPlugin_method_get_preset_count: - :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_method_get_preset_name: - :ref:`String` **get_preset_name** **(** :ref:`int` preset **)** virtual Get the name of the options preset at this index. +---- + .. _class_EditorImportPlugin_method_get_priority: - :ref:`float` **get_priority** **(** **)** virtual Get the priority of this plugin for the recognized extension. Higher priority plugins will be preferred. Default value is 1.0. +---- + .. _class_EditorImportPlugin_method_get_recognized_extensions: - :ref:`Array` **get_recognized_extensions** **(** **)** virtual Get the list of file extensions to associate with this loader (case insensitive). e.g. ``["obj"]``. +---- + .. _class_EditorImportPlugin_method_get_resource_type: - :ref:`String` **get_resource_type** **(** **)** virtual Get the Godot resource type associated with this loader. e.g. ``"Mesh"`` or ``"Animation"``. +---- + .. _class_EditorImportPlugin_method_get_save_extension: - :ref:`String` **get_save_extension** **(** **)** virtual Get the extension used to save this resource in the ``.import`` directory. +---- + .. _class_EditorImportPlugin_method_get_visible_name: - :ref:`String` **get_visible_name** **(** **)** virtual Get the name to display in the import window. +---- + .. _class_EditorImportPlugin_method_import: - :ref:`int` **import** **(** :ref:`String` source_file, :ref:`String` save_path, :ref:`Dictionary` options, :ref:`Array` platform_variants, :ref:`Array` gen_files **)** virtual diff --git a/classes/class_editorinspector.rst b/classes/class_editorinspector.rst index 965190779..4fe975177 100644 --- a/classes/class_editorinspector.rst +++ b/classes/class_editorinspector.rst @@ -32,26 +32,38 @@ Signals - **object_id_selected** **(** :ref:`int` id **)** +---- + .. _class_EditorInspector_signal_property_edited: - **property_edited** **(** :ref:`String` property **)** +---- + .. _class_EditorInspector_signal_property_keyed: - **property_keyed** **(** :ref:`String` property **)** +---- + .. _class_EditorInspector_signal_property_selected: - **property_selected** **(** :ref:`String` property **)** +---- + .. _class_EditorInspector_signal_property_toggled: - **property_toggled** **(** :ref:`String` property, :ref:`bool` checked **)** +---- + .. _class_EditorInspector_signal_resource_selected: - **resource_selected** **(** :ref:`Object` res, :ref:`String` prop **)** +---- + .. _class_EditorInspector_signal_restart_requested: - **restart_requested** **(** **)** diff --git a/classes/class_editorinspectorplugin.rst b/classes/class_editorinspectorplugin.rst index c684e884d..968b1dbe6 100644 --- a/classes/class_editorinspectorplugin.rst +++ b/classes/class_editorinspectorplugin.rst @@ -46,30 +46,44 @@ Method Descriptions - void **add_custom_control** **(** :ref:`Control` control **)** +---- + .. _class_EditorInspectorPlugin_method_add_property_editor: - void **add_property_editor** **(** :ref:`String` property, :ref:`Control` editor **)** +---- + .. _class_EditorInspectorPlugin_method_add_property_editor_for_multiple_properties: - void **add_property_editor_for_multiple_properties** **(** :ref:`String` label, :ref:`PoolStringArray` properties, :ref:`Control` editor **)** +---- + .. _class_EditorInspectorPlugin_method_can_handle: - :ref:`bool` **can_handle** **(** :ref:`Object` object **)** virtual +---- + .. _class_EditorInspectorPlugin_method_parse_begin: - void **parse_begin** **(** :ref:`Object` object **)** virtual +---- + .. _class_EditorInspectorPlugin_method_parse_category: - void **parse_category** **(** :ref:`Object` object, :ref:`String` category **)** virtual +---- + .. _class_EditorInspectorPlugin_method_parse_end: - void **parse_end** **(** **)** virtual +---- + .. _class_EditorInspectorPlugin_method_parse_property: - :ref:`bool` **parse_property** **(** :ref:`Object` object, :ref:`int` type, :ref:`String` path, :ref:`int` hint, :ref:`String` hint_text, :ref:`int` usage **)** virtual diff --git a/classes/class_editorinterface.rst b/classes/class_editorinterface.rst index d36d87760..f63f74ed0 100644 --- a/classes/class_editorinterface.rst +++ b/classes/class_editorinterface.rst @@ -79,114 +79,154 @@ Method Descriptions Edits the given :ref:`Resource`. +---- + .. _class_EditorInterface_method_get_base_control: - :ref:`Control` **get_base_control** **(** **)** Returns the main container of Godot editor's window. You can use it, for example, to retrieve the size of the container and place your controls accordingly. +---- + .. _class_EditorInterface_method_get_edited_scene_root: - :ref:`Node` **get_edited_scene_root** **(** **)** Returns the edited (current) scene's root :ref:`Node`. +---- + .. _class_EditorInterface_method_get_editor_settings: - :ref:`EditorSettings` **get_editor_settings** **(** **)** Returns the :ref:`EditorSettings`. +---- + .. _class_EditorInterface_method_get_editor_viewport: - :ref:`Control` **get_editor_viewport** **(** **)** Returns the editor :ref:`Viewport`. +---- + .. _class_EditorInterface_method_get_inspector: - :ref:`EditorInspector` **get_inspector** **(** **)** const +---- + .. _class_EditorInterface_method_get_open_scenes: - :ref:`Array` **get_open_scenes** **(** **)** const Returns an :ref:`Array` with the file paths of the currently opened scenes. +---- + .. _class_EditorInterface_method_get_resource_filesystem: - :ref:`EditorFileSystem` **get_resource_filesystem** **(** **)** Returns the :ref:`EditorFileSystem`. +---- + .. _class_EditorInterface_method_get_resource_previewer: - :ref:`EditorResourcePreview` **get_resource_previewer** **(** **)** Returns the :ref:`EditorResourcePreview`. +---- + .. _class_EditorInterface_method_get_script_editor: - :ref:`ScriptEditor` **get_script_editor** **(** **)** Returns the :ref:`ScriptEditor`. +---- + .. _class_EditorInterface_method_get_selected_path: - :ref:`String` **get_selected_path** **(** **)** const +---- + .. _class_EditorInterface_method_get_selection: - :ref:`EditorSelection` **get_selection** **(** **)** Returns the :ref:`EditorSelection`. +---- + .. _class_EditorInterface_method_inspect_object: - 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_method_is_plugin_enabled: - :ref:`bool` **is_plugin_enabled** **(** :ref:`String` plugin **)** const Returns the enabled status of a plugin. The plugin name is the same as its directory name. +---- + .. _class_EditorInterface_method_make_mesh_previews: - :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_method_open_scene_from_path: - void **open_scene_from_path** **(** :ref:`String` scene_filepath **)** Opens the scene at the given path. +---- + .. _class_EditorInterface_method_reload_scene_from_path: - void **reload_scene_from_path** **(** :ref:`String` scene_filepath **)** Reloads the scene at the given path. +---- + .. _class_EditorInterface_method_save_scene: - :ref:`Error` **save_scene** **(** **)** Saves the scene. Returns either OK or ERR_CANT_CREATE. See :ref:`@GlobalScope` constants. +---- + .. _class_EditorInterface_method_save_scene_as: - void **save_scene_as** **(** :ref:`String` path, :ref:`bool` with_preview=true **)** Saves the scene as a file at ``path``. +---- + .. _class_EditorInterface_method_select_file: - void **select_file** **(** :ref:`String` file **)** +---- + .. _class_EditorInterface_method_set_plugin_enabled: - void **set_plugin_enabled** **(** :ref:`String` plugin, :ref:`bool` enabled **)** diff --git a/classes/class_editorplugin.rst b/classes/class_editorplugin.rst index 9fa50d858..cff4bec76 100644 --- a/classes/class_editorplugin.rst +++ b/classes/class_editorplugin.rst @@ -138,16 +138,22 @@ Signals Emitted when user changes the workspace (2D, 3D, Script, AssetLib). Also works with custom screens defined by plugins. +---- + .. _class_EditorPlugin_signal_resource_saved: - **resource_saved** **(** :ref:`Resource` resource **)** +---- + .. _class_EditorPlugin_signal_scene_changed: - **scene_changed** **(** :ref:`Node` scene_root **)** Emitted when the scene is changed in the editor. The argument will return the root node of the scene that has just become active. If this scene is new and empty, the argument will be null. +---- + .. _class_EditorPlugin_signal_scene_closed: - **scene_closed** **(** :ref:`String` filepath **)** @@ -201,6 +207,8 @@ enum **CustomControlContainer**: - **CONTAINER_PROPERTY_EDITOR_BOTTOM** = **9** +---- + .. _enum_EditorPlugin_DockSlot: .. _class_EditorPlugin_constant_DOCK_SLOT_LEFT_UL: @@ -260,12 +268,16 @@ Method Descriptions Add a script at ``path`` to the Autoload list as ``name``. +---- + .. _class_EditorPlugin_method_add_control_to_bottom_panel: - :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. When your plugin is deactivated, make sure to remove your custom control with :ref:`remove_control_from_bottom_panel` and free it with ``queue_free()``. +---- + .. _class_EditorPlugin_method_add_control_to_container: - void **add_control_to_container** **(** :ref:`CustomControlContainer` container, :ref:`Control` control **)** @@ -276,6 +288,8 @@ Please remember that you have to manage the visibility of your custom controls y When your plugin is deactivated, make sure to remove your custom control with :ref:`remove_control_from_container` and free it with ``queue_free()``. +---- + .. _class_EditorPlugin_method_add_control_to_dock: - void **add_control_to_dock** **(** :ref:`DockSlot` slot, :ref:`Control` control **)** @@ -286,6 +300,8 @@ If the dock is repositioned and as long as the plugin is active, the editor will When your plugin is deactivated, make sure to remove your custom control with :ref:`remove_control_from_docks` and free it with ``queue_free()``. +---- + .. _class_EditorPlugin_method_add_custom_type: - void **add_custom_type** **(** :ref:`String` type, :ref:`String` base, :ref:`Script` script, :ref:`Texture` icon **)** @@ -298,37 +314,53 @@ You can use the virtual method :ref:`handles` During run-time, this will be a simple object with a script so this function does not need to be called then. +---- + .. _class_EditorPlugin_method_add_export_plugin: - void **add_export_plugin** **(** :ref:`EditorExportPlugin` plugin **)** +---- + .. _class_EditorPlugin_method_add_import_plugin: - void **add_import_plugin** **(** :ref:`EditorImportPlugin` importer **)** +---- + .. _class_EditorPlugin_method_add_inspector_plugin: - void **add_inspector_plugin** **(** :ref:`EditorInspectorPlugin` plugin **)** +---- + .. _class_EditorPlugin_method_add_scene_import_plugin: - void **add_scene_import_plugin** **(** :ref:`EditorSceneImporter` scene_importer **)** +---- + .. _class_EditorPlugin_method_add_spatial_gizmo_plugin: - void **add_spatial_gizmo_plugin** **(** :ref:`EditorSpatialGizmoPlugin` plugin **)** +---- + .. _class_EditorPlugin_method_add_tool_menu_item: - void **add_tool_menu_item** **(** :ref:`String` name, :ref:`Object` handler, :ref:`String` callback, :ref:`Variant` ud=null **)** -Add a custom menu to 'Project > Tools' as ``name`` that calls ``callback`` on an instance of ``handler`` with a parameter ``ud`` when user activates it. +Adds a custom menu item to **Project > Tools** as ``name`` that calls ``callback`` on an instance of ``handler`` with a parameter ``ud`` when user activates it. + +---- .. _class_EditorPlugin_method_add_tool_submenu_item: - void **add_tool_submenu_item** **(** :ref:`String` name, :ref:`Object` submenu **)** -Like :ref:`add_tool_menu_item` but adds the ``submenu`` item inside the ``name`` menu. +Adds a custom submenu under **Project > Tools >** ``name``. ``submenu`` should be an object of class :ref:`PopupMenu`. This submenu should be cleaned up using ``remove_tool_menu_item(name)``. + +---- .. _class_EditorPlugin_method_apply_changes: @@ -338,30 +370,42 @@ This method is called when the editor is about to save the project, switch to an This is used, for example, in shader editors to let the plugin know that it must apply the shader code being written by the user to the object. +---- + .. _class_EditorPlugin_method_build: - :ref:`bool` **build** **(** **)** virtual +---- + .. _class_EditorPlugin_method_clear: - 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_method_disable_plugin: - void **disable_plugin** **(** **)** virtual +---- + .. _class_EditorPlugin_method_edit: - 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_method_enable_plugin: - void **enable_plugin** **(** **)** virtual +---- + .. _class_EditorPlugin_method_forward_canvas_draw_over_viewport: - void **forward_canvas_draw_over_viewport** **(** :ref:`Control` overlay **)** virtual @@ -375,14 +419,20 @@ This method is called when there is an input event in the 2D viewport, e.g. the Also note that the edited scene must have a root node. +---- + .. _class_EditorPlugin_method_forward_canvas_force_draw_over_viewport: - void **forward_canvas_force_draw_over_viewport** **(** :ref:`Control` overlay **)** virtual +---- + .. _class_EditorPlugin_method_forward_canvas_gui_input: - :ref:`bool` **forward_canvas_gui_input** **(** :ref:`InputEvent` event **)** virtual +---- + .. _class_EditorPlugin_method_forward_spatial_gui_input: - :ref:`bool` **forward_spatial_gui_input** **(** :ref:`Camera` camera, :ref:`InputEvent` event **)** virtual @@ -396,70 +446,96 @@ This method is called when there is an input event in the 3D viewport, e.g. the Also note that the edited scene must have a root node. +---- + .. _class_EditorPlugin_method_get_breakpoints: - :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_method_get_editor_interface: - :ref:`EditorInterface` **get_editor_interface** **(** **)** Returns the :ref:`EditorInterface` object that gives you control over Godot editor's window and its functionalities. +---- + .. _class_EditorPlugin_method_get_plugin_icon: - :ref:`Object` **get_plugin_icon** **(** **)** virtual +---- + .. _class_EditorPlugin_method_get_plugin_name: - :ref:`String` **get_plugin_name** **(** **)** virtual +---- + .. _class_EditorPlugin_method_get_script_create_dialog: - :ref:`ScriptCreateDialog` **get_script_create_dialog** **(** **)** Gets the Editor's dialogue used for making scripts. Note that users can configure it before use. +---- + .. _class_EditorPlugin_method_get_state: - :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_method_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_method_get_window_layout: - 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 :ref:`queue_save_layout` is called or the editor layout was changed(For example changing the position of a dock). +---- + .. _class_EditorPlugin_method_handles: - :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:`edit` and :ref:`make_visible` called when the editor requests them. If you have declared the methods :ref:`forward_canvas_gui_input` and :ref:`forward_spatial_gui_input` these will be called too. +---- + .. _class_EditorPlugin_method_has_main_screen: - :ref:`bool` **has_main_screen** **(** **)** virtual Returns ``true`` if this is a main screen editor plugin (it goes in the workspaces selector together with '2D', '3D', and 'Script'). +---- + .. _class_EditorPlugin_method_hide_bottom_panel: - void **hide_bottom_panel** **(** **)** +---- + .. _class_EditorPlugin_method_make_bottom_panel_item_visible: - void **make_bottom_panel_item_visible** **(** :ref:`Control` item **)** +---- + .. _class_EditorPlugin_method_make_visible: - void **make_visible** **(** :ref:`bool` visible **)** virtual @@ -468,96 +544,132 @@ This function will be called when the editor is requested to become visible. It Remember that you have to manage the visibility of all your editor controls manually. +---- + .. _class_EditorPlugin_method_queue_save_layout: - void **queue_save_layout** **(** **)** const Queue save the project's editor layout. +---- + .. _class_EditorPlugin_method_remove_autoload_singleton: - void **remove_autoload_singleton** **(** :ref:`String` name **)** Remove an Autoload ``name`` from the list. +---- + .. _class_EditorPlugin_method_remove_control_from_bottom_panel: - void **remove_control_from_bottom_panel** **(** :ref:`Control` control **)** Remove the control from the bottom panel. You have to manually ``queue_free()`` the control. +---- + .. _class_EditorPlugin_method_remove_control_from_container: - void **remove_control_from_container** **(** :ref:`CustomControlContainer` container, :ref:`Control` control **)** Remove the control from the specified container. You have to manually ``queue_free()`` the control. +---- + .. _class_EditorPlugin_method_remove_control_from_docks: - void **remove_control_from_docks** **(** :ref:`Control` control **)** Remove the control from the dock. You have to manually ``queue_free()`` the control. +---- + .. _class_EditorPlugin_method_remove_custom_type: - void **remove_custom_type** **(** :ref:`String` type **)** Remove a custom type added by :ref:`add_custom_type` +---- + .. _class_EditorPlugin_method_remove_export_plugin: - void **remove_export_plugin** **(** :ref:`EditorExportPlugin` plugin **)** +---- + .. _class_EditorPlugin_method_remove_import_plugin: - void **remove_import_plugin** **(** :ref:`EditorImportPlugin` importer **)** +---- + .. _class_EditorPlugin_method_remove_inspector_plugin: - void **remove_inspector_plugin** **(** :ref:`EditorInspectorPlugin` plugin **)** +---- + .. _class_EditorPlugin_method_remove_scene_import_plugin: - void **remove_scene_import_plugin** **(** :ref:`EditorSceneImporter` scene_importer **)** +---- + .. _class_EditorPlugin_method_remove_spatial_gizmo_plugin: - void **remove_spatial_gizmo_plugin** **(** :ref:`EditorSpatialGizmoPlugin` plugin **)** +---- + .. _class_EditorPlugin_method_remove_tool_menu_item: - void **remove_tool_menu_item** **(** :ref:`String` name **)** Removes a menu ``name`` from 'Project > Tools'. +---- + .. _class_EditorPlugin_method_save_external_data: - 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_method_set_force_draw_over_forwarding_enabled: - void **set_force_draw_over_forwarding_enabled** **(** **)** +---- + .. _class_EditorPlugin_method_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_method_set_state: - void **set_state** **(** :ref:`Dictionary` state **)** virtual Restore the state saved by :ref:`get_state`. +---- + .. _class_EditorPlugin_method_set_window_layout: - void **set_window_layout** **(** :ref:`ConfigFile` layout **)** virtual Restore the plugin GUI layout saved by :ref:`get_window_layout`. +---- + .. _class_EditorPlugin_method_update_overlays: - :ref:`int` **update_overlays** **(** **)** const diff --git a/classes/class_editorproperty.rst b/classes/class_editorproperty.rst index 64ce57f77..dcac51aac 100644 --- a/classes/class_editorproperty.rst +++ b/classes/class_editorproperty.rst @@ -57,30 +57,44 @@ Signals - **multiple_properties_changed** **(** :ref:`PoolStringArray` properties, :ref:`Array` value **)** +---- + .. _class_EditorProperty_signal_object_id_selected: - **object_id_selected** **(** :ref:`String` property, :ref:`int` id **)** +---- + .. _class_EditorProperty_signal_property_changed: - **property_changed** **(** :ref:`String` property, :ref:`Nil` value **)** +---- + .. _class_EditorProperty_signal_property_checked: - **property_checked** **(** :ref:`String` property, :ref:`String` bool **)** +---- + .. _class_EditorProperty_signal_property_keyed: - **property_keyed** **(** :ref:`String` property **)** +---- + .. _class_EditorProperty_signal_property_keyed_with_value: - **property_keyed_with_value** **(** :ref:`String` property, :ref:`Nil` value **)** +---- + .. _class_EditorProperty_signal_resource_selected: - **resource_selected** **(** :ref:`String` path, :ref:`Resource` resource **)** +---- + .. _class_EditorProperty_signal_selected: - **selected** **(** :ref:`String` path, :ref:`int` focusable_idx **)** @@ -98,6 +112,8 @@ Property Descriptions | *Getter* | is_checkable() | +----------+----------------------+ +---- + .. _class_EditorProperty_property_checked: - :ref:`bool` **checked** @@ -108,6 +124,8 @@ Property Descriptions | *Getter* | is_checked() | +----------+--------------------+ +---- + .. _class_EditorProperty_property_draw_red: - :ref:`bool` **draw_red** @@ -118,6 +136,8 @@ Property Descriptions | *Getter* | is_draw_red() | +----------+---------------------+ +---- + .. _class_EditorProperty_property_keying: - :ref:`bool` **keying** @@ -128,6 +148,8 @@ Property Descriptions | *Getter* | is_keying() | +----------+-------------------+ +---- + .. _class_EditorProperty_property_label: - :ref:`String` **label** @@ -138,6 +160,8 @@ Property Descriptions | *Getter* | get_label() | +----------+------------------+ +---- + .. _class_EditorProperty_property_read_only: - :ref:`bool` **read_only** @@ -155,18 +179,26 @@ Method Descriptions - void **emit_changed** **(** :ref:`String` property, :ref:`Variant` value, :ref:`String` field="", :ref:`bool` changing=false **)** +---- + .. _class_EditorProperty_method_get_edited_object: - :ref:`Object` **get_edited_object** **(** **)** +---- + .. _class_EditorProperty_method_get_edited_property: - :ref:`String` **get_edited_property** **(** **)** +---- + .. _class_EditorProperty_method_get_tooltip_text: - :ref:`String` **get_tooltip_text** **(** **)** const +---- + .. _class_EditorProperty_method_update_property: - void **update_property** **(** **)** virtual diff --git a/classes/class_editorresourceconversionplugin.rst b/classes/class_editorresourceconversionplugin.rst index dfcc53af5..01498f4ca 100644 --- a/classes/class_editorresourceconversionplugin.rst +++ b/classes/class_editorresourceconversionplugin.rst @@ -34,6 +34,8 @@ Method Descriptions - :ref:`Resource` **_convert** **(** :ref:`Resource` resource **)** virtual +---- + .. _class_EditorResourceConversionPlugin_method__converts_to: - :ref:`String` **_converts_to** **(** **)** virtual diff --git a/classes/class_editorresourcepreview.rst b/classes/class_editorresourcepreview.rst index 7383d4ff5..b38c8aa1d 100644 --- a/classes/class_editorresourcepreview.rst +++ b/classes/class_editorresourcepreview.rst @@ -56,24 +56,32 @@ Method Descriptions Create an own, custom preview generator. +---- + .. _class_EditorResourcePreview_method_check_for_invalidation: - 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_method_queue_edited_resource_preview: - 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_method_queue_resource_preview: - 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_method_remove_preview_generator: - void **remove_preview_generator** **(** :ref:`EditorResourcePreviewGenerator` generator **)** diff --git a/classes/class_editorresourcepreviewgenerator.rst b/classes/class_editorresourcepreviewgenerator.rst index 77f6bd028..788b19e2b 100644 --- a/classes/class_editorresourcepreviewgenerator.rst +++ b/classes/class_editorresourcepreviewgenerator.rst @@ -47,6 +47,8 @@ Returning an empty texture is an OK way to fail and let another generator take c Care must be taken because this function is always called from a thread (not the main thread). +---- + .. _class_EditorResourcePreviewGenerator_method_generate_from_path: - :ref:`Texture` **generate_from_path** **(** :ref:`String` path, :ref:`Vector2` size **)** virtual @@ -57,6 +59,8 @@ Returning an empty texture is an OK way to fail and let another generator take c Care must be taken because this function is always called from a thread (not the main thread). +---- + .. _class_EditorResourcePreviewGenerator_method_handles: - :ref:`bool` **handles** **(** :ref:`String` type **)** virtual diff --git a/classes/class_editorsceneimporter.rst b/classes/class_editorsceneimporter.rst index 0807bad23..29fbab73b 100644 --- a/classes/class_editorsceneimporter.rst +++ b/classes/class_editorsceneimporter.rst @@ -85,22 +85,32 @@ Method Descriptions - :ref:`Array` **_get_extensions** **(** **)** virtual +---- + .. _class_EditorSceneImporter_method__get_import_flags: - :ref:`int` **_get_import_flags** **(** **)** virtual +---- + .. _class_EditorSceneImporter_method__import_animation: - :ref:`Animation` **_import_animation** **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** virtual +---- + .. _class_EditorSceneImporter_method__import_scene: - :ref:`Node` **_import_scene** **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** virtual +---- + .. _class_EditorSceneImporter_method_import_animation_from_other_importer: - :ref:`Animation` **import_animation_from_other_importer** **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** +---- + .. _class_EditorSceneImporter_method_import_scene_from_other_importer: - :ref:`Node` **import_scene_from_other_importer** **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** diff --git a/classes/class_editorscenepostimport.rst b/classes/class_editorscenepostimport.rst index 9783460d5..3eceee82f 100644 --- a/classes/class_editorscenepostimport.rst +++ b/classes/class_editorscenepostimport.rst @@ -69,12 +69,16 @@ Method Descriptions Returns the source file path which got imported (e.g. ``res://scene.dae``). +---- + .. _class_EditorScenePostImport_method_get_source_folder: - :ref:`String` **get_source_folder** **(** **)** const Returns the resource folder the imported scene file is located in. +---- + .. _class_EditorScenePostImport_method_post_import: - :ref:`Object` **post_import** **(** :ref:`Object` scene **)** virtual diff --git a/classes/class_editorscript.rst b/classes/class_editorscript.rst index 50adf86d8..55a6ac4d3 100644 --- a/classes/class_editorscript.rst +++ b/classes/class_editorscript.rst @@ -57,6 +57,8 @@ Method Descriptions This method is executed by the Editor when ``File -> Run`` is used. +---- + .. _class_EditorScript_method_add_root_node: - void **add_root_node** **(** :ref:`Node` node **)** @@ -65,12 +67,16 @@ Adds ``node`` as a child of the root node in the editor context. WARNING: The implementation of this method is currently disabled. +---- + .. _class_EditorScript_method_get_editor_interface: - :ref:`EditorInterface` **get_editor_interface** **(** **)** Returns the :ref:`EditorInterface` singleton instance. +---- + .. _class_EditorScript_method_get_scene: - :ref:`Node` **get_scene** **(** **)** diff --git a/classes/class_editorselection.rst b/classes/class_editorselection.rst index 0df985801..d8aef0bb5 100644 --- a/classes/class_editorselection.rst +++ b/classes/class_editorselection.rst @@ -56,24 +56,32 @@ Method Descriptions Add a node to the selection. +---- + .. _class_EditorSelection_method_clear: - void **clear** **(** **)** Clear the selection. +---- + .. _class_EditorSelection_method_get_selected_nodes: - :ref:`Array` **get_selected_nodes** **(** **)** Get the list of selected nodes. +---- + .. _class_EditorSelection_method_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_method_remove_node: - void **remove_node** **(** :ref:`Node` node **)** diff --git a/classes/class_editorsettings.rst b/classes/class_editorsettings.rst index 0b5f4ff62..f81efb931 100644 --- a/classes/class_editorsettings.rst +++ b/classes/class_editorsettings.rst @@ -99,38 +99,52 @@ Example: editor_settings.add_property_info(property_info) +---- + .. _class_EditorSettings_method_erase: - void **erase** **(** :ref:`String` property **)** Erase a given setting (pass full property path). +---- + .. _class_EditorSettings_method_get_favorites: - :ref:`PoolStringArray` **get_favorites** **(** **)** const Get the list of favorite files and directories for this project. +---- + .. _class_EditorSettings_method_get_project_metadata: - :ref:`Variant` **get_project_metadata** **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` default=null **)** const +---- + .. _class_EditorSettings_method_get_project_settings_dir: - :ref:`String` **get_project_settings_dir** **(** **)** 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_method_get_recent_dirs: - :ref:`PoolStringArray` **get_recent_dirs** **(** **)** const Get the list of recently visited folders in the file dialog for this project. +---- + .. _class_EditorSettings_method_get_setting: - :ref:`Variant` **get_setting** **(** :ref:`String` name **)** const +---- + .. _class_EditorSettings_method_get_settings_dir: - :ref:`String` **get_settings_dir** **(** **)** const @@ -141,38 +155,54 @@ settings/tmp - used for temporary storage of files settings/templates - where export templates are located +---- + .. _class_EditorSettings_method_has_setting: - :ref:`bool` **has_setting** **(** :ref:`String` name **)** const +---- + .. _class_EditorSettings_method_property_can_revert: - :ref:`bool` **property_can_revert** **(** :ref:`String` name **)** +---- + .. _class_EditorSettings_method_property_get_revert: - :ref:`Variant` **property_get_revert** **(** :ref:`String` name **)** +---- + .. _class_EditorSettings_method_set_favorites: - void **set_favorites** **(** :ref:`PoolStringArray` dirs **)** Set the list of favorite files and directories for this project. +---- + .. _class_EditorSettings_method_set_initial_value: - void **set_initial_value** **(** :ref:`String` name, :ref:`Variant` value, :ref:`bool` update_current **)** +---- + .. _class_EditorSettings_method_set_project_metadata: - void **set_project_metadata** **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` data **)** +---- + .. _class_EditorSettings_method_set_recent_dirs: - void **set_recent_dirs** **(** :ref:`PoolStringArray` dirs **)** Set the list of recently visited folders in the file dialog for this project. +---- + .. _class_EditorSettings_method_set_setting: - void **set_setting** **(** :ref:`String` name, :ref:`Variant` value **)** diff --git a/classes/class_editorspatialgizmo.rst b/classes/class_editorspatialgizmo.rst index a4b3fb7a7..81faca121 100644 --- a/classes/class_editorspatialgizmo.rst +++ b/classes/class_editorspatialgizmo.rst @@ -69,12 +69,16 @@ Method Descriptions - void **add_collision_segments** **(** :ref:`PoolVector3Array` segments **)** +---- + .. _class_EditorSpatialGizmo_method_add_collision_triangles: - void **add_collision_triangles** **(** :ref:`TriangleMesh` triangles **)** 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_method_add_handles: - void **add_handles** **(** :ref:`PoolVector3Array` handles, :ref:`Material` material, :ref:`bool` billboard=false, :ref:`bool` secondary=false **)** @@ -83,26 +87,36 @@ Add a list of handles (points) which can be used to deform the object being edit There are virtual functions which will be called upon editing of these handles. Call this function during :ref:`redraw`. +---- + .. _class_EditorSpatialGizmo_method_add_lines: - 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_method_add_mesh: - void **add_mesh** **(** :ref:`ArrayMesh` mesh, :ref:`bool` billboard=false, :ref:`RID` skeleton, :ref:`Material` material=null **)** +---- + .. _class_EditorSpatialGizmo_method_add_unscaled_billboard: - 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_method_clear: - void **clear** **(** **)** +---- + .. _class_EditorSpatialGizmo_method_commit_handle: - void **commit_handle** **(** :ref:`int` index, :ref:`Variant` restore, :ref:`bool` cancel=false **)** virtual @@ -111,6 +125,8 @@ Commit a handle being edited (handles must have been previously added by :ref:`a If the cancel parameter is ``true``, an option to restore the edited value to the original is provided. +---- + .. _class_EditorSpatialGizmo_method_get_handle_name: - :ref:`String` **get_handle_name** **(** :ref:`int` index **)** virtual @@ -119,36 +135,48 @@ Get the name of an edited handle (handles must have been previously added by :re Handles can be named for reference to the user when editing. +---- + .. _class_EditorSpatialGizmo_method_get_handle_value: - :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_method_get_plugin: - :ref:`EditorSpatialGizmoPlugin` **get_plugin** **(** **)** const Returns the :ref:`EditorSpatialGizmoPlugin` that owns this gizmo. It's useful to retrieve materials using :ref:`EditorSpatialGizmoPlugin.get_material`. +---- + .. _class_EditorSpatialGizmo_method_get_spatial_node: - :ref:`Spatial` **get_spatial_node** **(** **)** const Returns the Spatial node associated with this gizmo. +---- + .. _class_EditorSpatialGizmo_method_is_handle_highlighted: - :ref:`bool` **is_handle_highlighted** **(** :ref:`int` index **)** virtual Get whether a handle is highlighted or not. +---- + .. _class_EditorSpatialGizmo_method_redraw: - void **redraw** **(** **)** virtual This function is called when the Spatial this gizmo refers to changes (the :ref:`Spatial.update_gizmo` is called). +---- + .. _class_EditorSpatialGizmo_method_set_handle: - void **set_handle** **(** :ref:`int` index, :ref:`Camera` camera, :ref:`Vector2` point **)** virtual @@ -157,10 +185,14 @@ This function is used when the user drags a gizmo handle (previously added with The :ref:`Camera` is also provided so screen coordinates can be converted to raycasts. +---- + .. _class_EditorSpatialGizmo_method_set_hidden: - void **set_hidden** **(** :ref:`bool` hidden **)** +---- + .. _class_EditorSpatialGizmo_method_set_spatial_node: - void **set_spatial_node** **(** :ref:`Node` node **)** diff --git a/classes/class_editorspatialgizmoplugin.rst b/classes/class_editorspatialgizmoplugin.rst index 5e443c88d..1b5863796 100644 --- a/classes/class_editorspatialgizmoplugin.rst +++ b/classes/class_editorspatialgizmoplugin.rst @@ -76,94 +76,126 @@ Method Descriptions Adds a new material to the internal material list for the plugin. It can then be accessed with :ref:`get_material`. Should not be overridden. +---- + .. _class_EditorSpatialGizmoPlugin_method_can_be_hidden: - :ref:`bool` **can_be_hidden** **(** **)** virtual Override this method to define whether the gizmo can be hidden or not. Defaults to ``true``. +---- + .. _class_EditorSpatialGizmoPlugin_method_commit_handle: - void **commit_handle** **(** :ref:`EditorSpatialGizmo` gizmo, :ref:`int` index, :ref:`Variant` restore, :ref:`bool` cancel=false **)** virtual Override this method to commit gizmo handles. Called for this plugin's active gizmos. +---- + .. _class_EditorSpatialGizmoPlugin_method_create_gizmo: - :ref:`EditorSpatialGizmo` **create_gizmo** **(** :ref:`Spatial` spatial **)** virtual Override this method to return a custom :ref:`EditorSpatialGizmo` for the spatial nodes of your choice, return ``null`` for the rest of nodes. (See also :ref:`has_gizmo`) +---- + .. _class_EditorSpatialGizmoPlugin_method_create_handle_material: - void **create_handle_material** **(** :ref:`String` name, :ref:`bool` billboard=false **)** Creates a handle material with its variants (selected and/or editable) and adds them to the internal material list. They can then be accessed with :ref:`get_material` and used in :ref:`EditorSpatialGizmo.add_handles`. Should not be overridden. +---- + .. _class_EditorSpatialGizmoPlugin_method_create_icon_material: - void **create_icon_material** **(** :ref:`String` name, :ref:`Texture` texture, :ref:`bool` on_top=false, :ref:`Color` color=Color( 1, 1, 1, 1 ) **)** Creates an icon material with its variants (selected and/or editable) and adds them to the internal material list. They can then be accessed with :ref:`get_material` and used in :ref:`EditorSpatialGizmo.add_unscaled_billboard`. Should not be overridden. +---- + .. _class_EditorSpatialGizmoPlugin_method_create_material: - void **create_material** **(** :ref:`String` name, :ref:`Color` color, :ref:`bool` billboard=false, :ref:`bool` on_top=false, :ref:`bool` use_vertex_color=false **)** Creates an unshaded material with its variants (selected and/or editable) and adds them to the internal material list. They can then be accessed with :ref:`get_material` and used in :ref:`EditorSpatialGizmo.add_mesh` and :ref:`EditorSpatialGizmo.add_lines`. Should not be overridden. +---- + .. _class_EditorSpatialGizmoPlugin_method_get_handle_name: - :ref:`String` **get_handle_name** **(** :ref:`EditorSpatialGizmo` gizmo, :ref:`int` index **)** virtual Override this method to provide gizmo's handle names. Called for this plugin's active gizmos. +---- + .. _class_EditorSpatialGizmoPlugin_method_get_handle_value: - :ref:`Variant` **get_handle_value** **(** :ref:`EditorSpatialGizmo` gizmo, :ref:`int` index **)** virtual Get actual value of a handle from gizmo. Called for this plugin's active gizmos. +---- + .. _class_EditorSpatialGizmoPlugin_method_get_material: - :ref:`SpatialMaterial` **get_material** **(** :ref:`String` name, :ref:`EditorSpatialGizmo` gizmo **)** Get material from the internal list of materials. If an :ref:`EditorSpatialGizmo` is provided it will try to get the corresponding variant (selected and/or editable). +---- + .. _class_EditorSpatialGizmoPlugin_method_get_name: - :ref:`String` **get_name** **(** **)** virtual Override this method to provide the name that will appear in the gizmo visibility menu. +---- + .. _class_EditorSpatialGizmoPlugin_method_get_priority: - :ref:`String` **get_priority** **(** **)** virtual +---- + .. _class_EditorSpatialGizmoPlugin_method_has_gizmo: - :ref:`bool` **has_gizmo** **(** :ref:`Spatial` spatial **)** virtual Override this method to define which Spatial nodes have a gizmo from this plugin. Whenever a :ref:`Spatial` node is added to a scene this method is called, if it returns ``true`` the node gets a generic :ref:`EditorSpatialGizmo` assigned and is added to this plugin's list of active gizmos. +---- + .. _class_EditorSpatialGizmoPlugin_method_is_handle_highlighted: - :ref:`bool` **is_handle_highlighted** **(** :ref:`EditorSpatialGizmo` gizmo, :ref:`int` index **)** virtual Get whether a handle is highlighted or not. Called for this plugin's active gizmos. +---- + .. _class_EditorSpatialGizmoPlugin_method_is_selectable_when_hidden: - :ref:`bool` **is_selectable_when_hidden** **(** **)** virtual Override this method to define whether Spatial with this gizmo should be selecteble even when the gizmo is hidden. +---- + .. _class_EditorSpatialGizmoPlugin_method_redraw: - void **redraw** **(** :ref:`EditorSpatialGizmo` gizmo **)** virtual Callback to redraw the provided gizmo. Called for this plugin's active gizmos. +---- + .. _class_EditorSpatialGizmoPlugin_method_set_handle: - void **set_handle** **(** :ref:`EditorSpatialGizmo` gizmo, :ref:`int` index, :ref:`Camera` camera, :ref:`Vector2` point **)** virtual diff --git a/classes/class_engine.rst b/classes/class_engine.rst index 2398d70a1..789762912 100644 --- a/classes/class_engine.rst +++ b/classes/class_engine.rst @@ -82,6 +82,8 @@ Property Descriptions If ``true``, it is running inside the editor. Useful for tool scripts. +---- + .. _class_Engine_property_iterations_per_second: - :ref:`int` **iterations_per_second** @@ -94,6 +96,8 @@ If ``true``, it is running inside the editor. Useful for tool scripts. The number of fixed iterations per second (for fixed process and physics). +---- + .. _class_Engine_property_physics_jitter_fix: - :ref:`float` **physics_jitter_fix** @@ -104,6 +108,8 @@ The number of fixed iterations per second (for fixed process and physics). | *Getter* | get_physics_jitter_fix() | +----------+-------------------------------+ +---- + .. _class_Engine_property_target_fps: - :ref:`int` **target_fps** @@ -116,6 +122,8 @@ The number of fixed iterations per second (for fixed process and physics). The desired frames per second. If the hardware cannot keep up, this setting may not be respected. Defaults to 0, which indicates no limit. +---- + .. _class_Engine_property_time_scale: - :ref:`float` **time_scale** @@ -145,6 +153,8 @@ Returns engine author information in a Dictionary. "developers" - Array of Strings, developer names +---- + .. _class_Engine_method_get_copyright_info: - :ref:`Array` **get_copyright_info** **(** **)** const @@ -155,6 +165,8 @@ Returns an Array of copyright information Dictionaries. "parts" - Array of Dictionaries {"files", "copyright", "license"} describing subsections of the component +---- + .. _class_Engine_method_get_donor_info: - :ref:`Dictionary` **get_donor_info** **(** **)** const @@ -163,40 +175,54 @@ Returns a Dictionary of Arrays of donor names. {"platinum_sponsors", "gold_sponsors", "mini_sponsors", "gold_donors", "silver_donors", "bronze_donors"} +---- + .. _class_Engine_method_get_frames_drawn: - :ref:`int` **get_frames_drawn** **(** **)** Returns the total number of frames drawn. +---- + .. _class_Engine_method_get_frames_per_second: - :ref:`float` **get_frames_per_second** **(** **)** const Returns the frames per second of the running game. +---- + .. _class_Engine_method_get_license_info: - :ref:`Dictionary` **get_license_info** **(** **)** const Returns Dictionary of licenses used by Godot and included third party components. +---- + .. _class_Engine_method_get_license_text: - :ref:`String` **get_license_text** **(** **)** const Returns Godot license text. +---- + .. _class_Engine_method_get_main_loop: - :ref:`MainLoop` **get_main_loop** **(** **)** const Returns the main loop object (see :ref:`MainLoop` and :ref:`SceneTree`). +---- + .. _class_Engine_method_get_singleton: - :ref:`Object` **get_singleton** **(** :ref:`String` name **)** const +---- + .. _class_Engine_method_get_version_info: - :ref:`Dictionary` **get_version_info** **(** **)** const @@ -230,10 +256,14 @@ The ``hex`` value is encoded as follows, from left to right: one byte for the ma else: # do things specific to versions before 3.2 +---- + .. _class_Engine_method_has_singleton: - :ref:`bool` **has_singleton** **(** :ref:`String` name **)** const +---- + .. _class_Engine_method_is_in_physics_frame: - :ref:`bool` **is_in_physics_frame** **(** **)** const diff --git a/classes/class_environment.rst b/classes/class_environment.rst index 8e6a17fc4..fedbea43a 100644 --- a/classes/class_environment.rst +++ b/classes/class_environment.rst @@ -224,6 +224,8 @@ enum **BGMode**: - **BG_MAX** = **6** --- Represents the size of the :ref:`BGMode` enum. +---- + .. _enum_Environment_GlowBlendMode: .. _class_Environment_constant_GLOW_BLEND_MODE_ADDITIVE: @@ -244,6 +246,8 @@ enum **GlowBlendMode**: - **GLOW_BLEND_MODE_REPLACE** = **3** --- Replace glow blending mode. Replaces all pixels' color by the glow value. +---- + .. _enum_Environment_ToneMapper: .. _class_Environment_constant_TONE_MAPPER_LINEAR: @@ -264,6 +268,8 @@ enum **ToneMapper**: - **TONE_MAPPER_ACES** = **3** --- Academy Color Encoding System tonemapper operator. +---- + .. _enum_Environment_DOFBlurQuality: .. _class_Environment_constant_DOF_BLUR_QUALITY_LOW: @@ -280,6 +286,8 @@ enum **DOFBlurQuality**: - **DOF_BLUR_QUALITY_HIGH** = **2** --- High depth-of-field blur quality. +---- + .. _enum_Environment_SSAOBlur: .. _class_Environment_constant_SSAO_BLUR_DISABLED: @@ -300,6 +308,8 @@ enum **SSAOBlur**: - **SSAO_BLUR_3x3** = **3** +---- + .. _enum_Environment_SSAOQuality: .. _class_Environment_constant_SSAO_QUALITY_LOW: @@ -353,6 +363,8 @@ Property Descriptions Global brightness value of the rendered scene (default value is 1). +---- + .. _class_Environment_property_adjustment_color_correction: - :ref:`Texture` **adjustment_color_correction** @@ -365,6 +377,8 @@ Global brightness value of the rendered scene (default value is 1). Applies the provided :ref:`Texture` resource to affect the global color aspect of the rendered scene. +---- + .. _class_Environment_property_adjustment_contrast: - :ref:`float` **adjustment_contrast** @@ -377,6 +391,8 @@ Applies the provided :ref:`Texture` resource to affect the global Global contrast value of the rendered scene (default value is 1). +---- + .. _class_Environment_property_adjustment_enabled: - :ref:`bool` **adjustment_enabled** @@ -389,6 +405,8 @@ Global contrast value of the rendered scene (default value is 1). Enables the adjustment\_\* options provided by this resource. If ``false``, adjustments modifications will have no effect on the rendered scene. +---- + .. _class_Environment_property_adjustment_saturation: - :ref:`float` **adjustment_saturation** @@ -401,6 +419,8 @@ Enables the adjustment\_\* options provided by this resource. If ``false``, adju Global color saturation value of the rendered scene (default value is 1). +---- + .. _class_Environment_property_ambient_light_color: - :ref:`Color` **ambient_light_color** @@ -413,6 +433,8 @@ Global color saturation value of the rendered scene (default value is 1). :ref:`Color` of the ambient light. +---- + .. _class_Environment_property_ambient_light_energy: - :ref:`float` **ambient_light_energy** @@ -425,6 +447,8 @@ Global color saturation value of the rendered scene (default value is 1). Energy of the ambient light. The higher the value, the stronger the light. +---- + .. _class_Environment_property_ambient_light_sky_contribution: - :ref:`float` **ambient_light_sky_contribution** @@ -437,6 +461,8 @@ Energy of the ambient light. The higher the value, the stronger the light. Defines the amount of light that the sky brings on the scene. A value of 0 means that the sky's light emission has no effect on the scene illumination, thus all ambient illumination is provided by the ambient light. On the contrary, a value of 1 means that all the light that affects the scene is provided by the sky, thus the ambient light parameter has no effect on the scene. +---- + .. _class_Environment_property_auto_exposure_enabled: - :ref:`bool` **auto_exposure_enabled** @@ -449,6 +475,8 @@ Defines the amount of light that the sky brings on the scene. A value of 0 means Enables the tonemapping auto exposure mode of the scene renderer. If activated, the renderer will automatically determine the exposure setting to adapt to the illumination of the scene and the observed light. +---- + .. _class_Environment_property_auto_exposure_max_luma: - :ref:`float` **auto_exposure_max_luma** @@ -461,6 +489,8 @@ Enables the tonemapping auto exposure mode of the scene renderer. If activated, Maximum luminance value for the auto exposure. +---- + .. _class_Environment_property_auto_exposure_min_luma: - :ref:`float` **auto_exposure_min_luma** @@ -473,6 +503,8 @@ Maximum luminance value for the auto exposure. Minimum luminance value for the auto exposure. +---- + .. _class_Environment_property_auto_exposure_scale: - :ref:`float` **auto_exposure_scale** @@ -485,6 +517,8 @@ Minimum luminance value for the auto exposure. Scale of the auto exposure effect. Affects the intensity of auto exposure. +---- + .. _class_Environment_property_auto_exposure_speed: - :ref:`float` **auto_exposure_speed** @@ -497,6 +531,8 @@ Scale of the auto exposure effect. Affects the intensity of auto exposure. Speed of the auto exposure effect. Affects the time needed for the camera to perform auto exposure. +---- + .. _class_Environment_property_background_canvas_max_layer: - :ref:`int` **background_canvas_max_layer** @@ -509,6 +545,8 @@ Speed of the auto exposure effect. Affects the time needed for the camera to per Maximum layer id (if using Layer background mode). +---- + .. _class_Environment_property_background_color: - :ref:`Color` **background_color** @@ -521,6 +559,8 @@ Maximum layer id (if using Layer background mode). Color displayed for clear areas of the scene (if using Custom color or Color+Sky background modes). +---- + .. _class_Environment_property_background_energy: - :ref:`float` **background_energy** @@ -533,6 +573,8 @@ Color displayed for clear areas of the scene (if using Custom color or Color+Sky Power of light emitted by the background. +---- + .. _class_Environment_property_background_mode: - :ref:`BGMode` **background_mode** @@ -545,6 +587,8 @@ Power of light emitted by the background. Defines the mode of background. +---- + .. _class_Environment_property_background_sky: - :ref:`Sky` **background_sky** @@ -557,6 +601,8 @@ Defines the mode of background. :ref:`Sky` resource defined as background. +---- + .. _class_Environment_property_background_sky_custom_fov: - :ref:`float` **background_sky_custom_fov** @@ -569,6 +615,8 @@ Defines the mode of background. :ref:`Sky` resource's custom field of view. +---- + .. _class_Environment_property_background_sky_orientation: - :ref:`Basis` **background_sky_orientation** @@ -581,6 +629,8 @@ Defines the mode of background. :ref:`Sky` resource's rotation expressed as a :ref:`Basis` +---- + .. _class_Environment_property_background_sky_rotation: - :ref:`Vector3` **background_sky_rotation** @@ -593,6 +643,8 @@ Defines the mode of background. :ref:`Sky` resource's rotation expressed as euler angles in radians +---- + .. _class_Environment_property_background_sky_rotation_degrees: - :ref:`Vector3` **background_sky_rotation_degrees** @@ -605,6 +657,8 @@ Defines the mode of background. :ref:`Sky` resource's rotation expressed as euler angles in degrees +---- + .. _class_Environment_property_dof_blur_far_amount: - :ref:`float` **dof_blur_far_amount** @@ -617,6 +671,8 @@ Defines the mode of background. Amount of far blur. +---- + .. _class_Environment_property_dof_blur_far_distance: - :ref:`float` **dof_blur_far_distance** @@ -629,6 +685,8 @@ Amount of far blur. Distance from the camera where the far blur effect affects the rendering. +---- + .. _class_Environment_property_dof_blur_far_enabled: - :ref:`bool` **dof_blur_far_enabled** @@ -641,6 +699,8 @@ Distance from the camera where the far blur effect affects the rendering. Enables the far blur effect. +---- + .. _class_Environment_property_dof_blur_far_quality: - :ref:`DOFBlurQuality` **dof_blur_far_quality** @@ -653,6 +713,8 @@ Enables the far blur effect. Quality of the far blur quality. +---- + .. _class_Environment_property_dof_blur_far_transition: - :ref:`float` **dof_blur_far_transition** @@ -665,6 +727,8 @@ Quality of the far blur quality. Transition between no-blur area and far blur. +---- + .. _class_Environment_property_dof_blur_near_amount: - :ref:`float` **dof_blur_near_amount** @@ -677,6 +741,8 @@ Transition between no-blur area and far blur. Amount of near blur. +---- + .. _class_Environment_property_dof_blur_near_distance: - :ref:`float` **dof_blur_near_distance** @@ -689,6 +755,8 @@ Amount of near blur. Distance from the camera where the near blur effect affects the rendering. +---- + .. _class_Environment_property_dof_blur_near_enabled: - :ref:`bool` **dof_blur_near_enabled** @@ -701,6 +769,8 @@ Distance from the camera where the near blur effect affects the rendering. Enables the near blur effect. +---- + .. _class_Environment_property_dof_blur_near_quality: - :ref:`DOFBlurQuality` **dof_blur_near_quality** @@ -713,6 +783,8 @@ Enables the near blur effect. Quality of the near blur quality. +---- + .. _class_Environment_property_dof_blur_near_transition: - :ref:`float` **dof_blur_near_transition** @@ -725,6 +797,8 @@ Quality of the near blur quality. Transition between near blur and no-blur area. +---- + .. _class_Environment_property_fog_color: - :ref:`Color` **fog_color** @@ -737,6 +811,8 @@ Transition between near blur and no-blur area. Fog's :ref:`Color`. +---- + .. _class_Environment_property_fog_depth_begin: - :ref:`float` **fog_depth_begin** @@ -749,6 +825,8 @@ Fog's :ref:`Color`. Fog's depth starting distance from the camera. +---- + .. _class_Environment_property_fog_depth_curve: - :ref:`float` **fog_depth_curve** @@ -761,6 +839,8 @@ Fog's depth starting distance from the camera. Value defining the fog depth intensity. +---- + .. _class_Environment_property_fog_depth_enabled: - :ref:`bool` **fog_depth_enabled** @@ -773,6 +853,8 @@ Value defining the fog depth intensity. Enables the fog depth. +---- + .. _class_Environment_property_fog_depth_end: - :ref:`float` **fog_depth_end** @@ -783,6 +865,8 @@ Enables the fog depth. | *Getter* | get_fog_depth_end() | +----------+--------------------------+ +---- + .. _class_Environment_property_fog_enabled: - :ref:`bool` **fog_enabled** @@ -795,6 +879,8 @@ Enables the fog depth. Enables the fog. Needs fog_height_enabled and/or for_depth_enabled to actually display fog. +---- + .. _class_Environment_property_fog_height_curve: - :ref:`float` **fog_height_curve** @@ -807,6 +893,8 @@ Enables the fog. Needs fog_height_enabled and/or for_depth_enabled to actually d Value defining the fog height intensity. +---- + .. _class_Environment_property_fog_height_enabled: - :ref:`bool` **fog_height_enabled** @@ -819,6 +907,8 @@ Value defining the fog height intensity. Enables the fog height. +---- + .. _class_Environment_property_fog_height_max: - :ref:`float` **fog_height_max** @@ -831,6 +921,8 @@ Enables the fog height. Maximum height of fog. +---- + .. _class_Environment_property_fog_height_min: - :ref:`float` **fog_height_min** @@ -843,6 +935,8 @@ Maximum height of fog. Minimum height of fog. +---- + .. _class_Environment_property_fog_sun_amount: - :ref:`float` **fog_sun_amount** @@ -855,6 +949,8 @@ Minimum height of fog. Amount of sun that affects the fog rendering. +---- + .. _class_Environment_property_fog_sun_color: - :ref:`Color` **fog_sun_color** @@ -867,6 +963,8 @@ Amount of sun that affects the fog rendering. Sun :ref:`Color`. +---- + .. _class_Environment_property_fog_transmit_curve: - :ref:`float` **fog_transmit_curve** @@ -879,6 +977,8 @@ Sun :ref:`Color`. Amount of light that the fog transmits. +---- + .. _class_Environment_property_fog_transmit_enabled: - :ref:`bool` **fog_transmit_enabled** @@ -891,6 +991,8 @@ Amount of light that the fog transmits. Enables fog's light transmission. If enabled, lets reflections light to be transmitted by the fog. +---- + .. _class_Environment_property_glow_bicubic_upscale: - :ref:`bool` **glow_bicubic_upscale** @@ -901,6 +1003,8 @@ Enables fog's light transmission. If enabled, lets reflections light to be trans | *Getter* | is_glow_bicubic_upscale_enabled() | +----------+-----------------------------------+ +---- + .. _class_Environment_property_glow_blend_mode: - :ref:`GlowBlendMode` **glow_blend_mode** @@ -913,6 +1017,8 @@ Enables fog's light transmission. If enabled, lets reflections light to be trans Glow blending mode. +---- + .. _class_Environment_property_glow_bloom: - :ref:`float` **glow_bloom** @@ -925,6 +1031,8 @@ Glow blending mode. Bloom value (global glow). +---- + .. _class_Environment_property_glow_enabled: - :ref:`bool` **glow_enabled** @@ -937,6 +1045,8 @@ Bloom value (global glow). Enables glow rendering. +---- + .. _class_Environment_property_glow_hdr_luminance_cap: - :ref:`float` **glow_hdr_luminance_cap** @@ -947,6 +1057,8 @@ Enables glow rendering. | *Getter* | get_glow_hdr_luminance_cap() | +----------+-----------------------------------+ +---- + .. _class_Environment_property_glow_hdr_scale: - :ref:`float` **glow_hdr_scale** @@ -959,6 +1071,8 @@ Enables glow rendering. Bleed scale of the HDR glow. +---- + .. _class_Environment_property_glow_hdr_threshold: - :ref:`float` **glow_hdr_threshold** @@ -971,6 +1085,8 @@ Bleed scale of the HDR glow. Bleed threshold of the HDR glow. +---- + .. _class_Environment_property_glow_intensity: - :ref:`float` **glow_intensity** @@ -983,6 +1099,8 @@ Bleed threshold of the HDR glow. Glow intensity. +---- + .. _class_Environment_property_glow_levels/1: - :ref:`bool` **glow_levels/1** @@ -995,6 +1113,8 @@ Glow intensity. First level of glow (most local). +---- + .. _class_Environment_property_glow_levels/2: - :ref:`bool` **glow_levels/2** @@ -1007,6 +1127,8 @@ First level of glow (most local). Second level of glow. +---- + .. _class_Environment_property_glow_levels/3: - :ref:`bool` **glow_levels/3** @@ -1019,6 +1141,8 @@ Second level of glow. Third level of glow. +---- + .. _class_Environment_property_glow_levels/4: - :ref:`bool` **glow_levels/4** @@ -1031,6 +1155,8 @@ Third level of glow. Fourth level of glow. +---- + .. _class_Environment_property_glow_levels/5: - :ref:`bool` **glow_levels/5** @@ -1043,6 +1169,8 @@ Fourth level of glow. Fifth level of glow. +---- + .. _class_Environment_property_glow_levels/6: - :ref:`bool` **glow_levels/6** @@ -1055,6 +1183,8 @@ Fifth level of glow. Sixth level of glow. +---- + .. _class_Environment_property_glow_levels/7: - :ref:`bool` **glow_levels/7** @@ -1067,6 +1197,8 @@ Sixth level of glow. Seventh level of glow (most global). +---- + .. _class_Environment_property_glow_strength: - :ref:`float` **glow_strength** @@ -1079,6 +1211,8 @@ Seventh level of glow (most global). Glow strength. +---- + .. _class_Environment_property_ss_reflections_depth_tolerance: - :ref:`float` **ss_reflections_depth_tolerance** @@ -1089,6 +1223,8 @@ Glow strength. | *Getter* | get_ssr_depth_tolerance() | +----------+--------------------------------+ +---- + .. _class_Environment_property_ss_reflections_enabled: - :ref:`bool` **ss_reflections_enabled** @@ -1099,6 +1235,8 @@ Glow strength. | *Getter* | is_ssr_enabled() | +----------+------------------------+ +---- + .. _class_Environment_property_ss_reflections_fade_in: - :ref:`float` **ss_reflections_fade_in** @@ -1109,6 +1247,8 @@ Glow strength. | *Getter* | get_ssr_fade_in() | +----------+------------------------+ +---- + .. _class_Environment_property_ss_reflections_fade_out: - :ref:`float` **ss_reflections_fade_out** @@ -1119,6 +1259,8 @@ Glow strength. | *Getter* | get_ssr_fade_out() | +----------+-------------------------+ +---- + .. _class_Environment_property_ss_reflections_max_steps: - :ref:`int` **ss_reflections_max_steps** @@ -1129,6 +1271,8 @@ Glow strength. | *Getter* | get_ssr_max_steps() | +----------+--------------------------+ +---- + .. _class_Environment_property_ss_reflections_roughness: - :ref:`bool` **ss_reflections_roughness** @@ -1139,6 +1283,8 @@ Glow strength. | *Getter* | is_ssr_rough() | +----------+----------------------+ +---- + .. _class_Environment_property_ssao_ao_channel_affect: - :ref:`float` **ssao_ao_channel_affect** @@ -1149,6 +1295,8 @@ Glow strength. | *Getter* | get_ssao_ao_channel_affect() | +----------+-----------------------------------+ +---- + .. _class_Environment_property_ssao_bias: - :ref:`float` **ssao_bias** @@ -1159,6 +1307,8 @@ Glow strength. | *Getter* | get_ssao_bias() | +----------+----------------------+ +---- + .. _class_Environment_property_ssao_blur: - :ref:`SSAOBlur` **ssao_blur** @@ -1169,6 +1319,8 @@ Glow strength. | *Getter* | get_ssao_blur() | +----------+----------------------+ +---- + .. _class_Environment_property_ssao_color: - :ref:`Color` **ssao_color** @@ -1179,6 +1331,8 @@ Glow strength. | *Getter* | get_ssao_color() | +----------+-----------------------+ +---- + .. _class_Environment_property_ssao_edge_sharpness: - :ref:`float` **ssao_edge_sharpness** @@ -1189,6 +1343,8 @@ Glow strength. | *Getter* | get_ssao_edge_sharpness() | +----------+--------------------------------+ +---- + .. _class_Environment_property_ssao_enabled: - :ref:`bool` **ssao_enabled** @@ -1199,6 +1355,8 @@ Glow strength. | *Getter* | is_ssao_enabled() | +----------+-------------------------+ +---- + .. _class_Environment_property_ssao_intensity: - :ref:`float` **ssao_intensity** @@ -1209,6 +1367,8 @@ Glow strength. | *Getter* | get_ssao_intensity() | +----------+---------------------------+ +---- + .. _class_Environment_property_ssao_intensity2: - :ref:`float` **ssao_intensity2** @@ -1219,6 +1379,8 @@ Glow strength. | *Getter* | get_ssao_intensity2() | +----------+----------------------------+ +---- + .. _class_Environment_property_ssao_light_affect: - :ref:`float` **ssao_light_affect** @@ -1229,6 +1391,8 @@ Glow strength. | *Getter* | get_ssao_direct_light_affect() | +----------+-------------------------------------+ +---- + .. _class_Environment_property_ssao_quality: - :ref:`SSAOQuality` **ssao_quality** @@ -1239,6 +1403,8 @@ Glow strength. | *Getter* | get_ssao_quality() | +----------+-------------------------+ +---- + .. _class_Environment_property_ssao_radius: - :ref:`float` **ssao_radius** @@ -1249,6 +1415,8 @@ Glow strength. | *Getter* | get_ssao_radius() | +----------+------------------------+ +---- + .. _class_Environment_property_ssao_radius2: - :ref:`float` **ssao_radius2** @@ -1259,6 +1427,8 @@ Glow strength. | *Getter* | get_ssao_radius2() | +----------+-------------------------+ +---- + .. _class_Environment_property_tonemap_exposure: - :ref:`float` **tonemap_exposure** @@ -1271,6 +1441,8 @@ Glow strength. Default exposure for tonemap. +---- + .. _class_Environment_property_tonemap_mode: - :ref:`ToneMapper` **tonemap_mode** @@ -1283,6 +1455,8 @@ Default exposure for tonemap. Tonemapping mode. +---- + .. _class_Environment_property_tonemap_white: - :ref:`float` **tonemap_white** diff --git a/classes/class_expression.rst b/classes/class_expression.rst index 4b390ab19..21781f072 100644 --- a/classes/class_expression.rst +++ b/classes/class_expression.rst @@ -67,18 +67,24 @@ Executes the expression that was previously parsed by :ref:`parse`, you can specify their values in the inputs array, in the same order. +---- + .. _class_Expression_method_get_error_text: - :ref:`String` **get_error_text** **(** **)** const Returns the error text if :ref:`parse` has failed. +---- + .. _class_Expression_method_has_execute_failed: - :ref:`bool` **has_execute_failed** **(** **)** const Returns ``true`` if :ref:`execute` has failed. +---- + .. _class_Expression_method_parse: - :ref:`Error` **parse** **(** :ref:`String` expression, :ref:`PoolStringArray` input_names=PoolStringArray( ) **)** diff --git a/classes/class_file.rst b/classes/class_file.rst index 1550075d0..c8962ee97 100644 --- a/classes/class_file.rst +++ b/classes/class_file.rst @@ -141,6 +141,8 @@ enum **ModeFlags**: - **WRITE_READ** = **7** --- Opens the file for read and write operations. Create it if the file does not exist and truncate if it exists. +---- + .. _enum_File_CompressionMode: .. _class_File_constant_COMPRESSION_FASTLZ: @@ -214,12 +216,16 @@ Method Descriptions Closes the currently opened file. +---- + .. _class_File_method_eof_reached: - :ref:`bool` **eof_reached** **(** **)** const Returns ``true`` if the file cursor has read past the end of the file. Note that this function will still return ``false`` while at the end of the file and only activates when reading past it. This can be confusing but it conforms to how low level file access works in all operating systems. There is always :ref:`get_len` and :ref:`get_position` to implement a custom logic. +---- + .. _class_File_method_file_exists: - :ref:`bool` **file_exists** **(** :ref:`String` path **)** const @@ -228,30 +234,40 @@ Returns ``true`` if the file exists in the given path. Note that many resources types are imported (e.g. textures or sound files), and that their source asset will not be included in the exported game, as only the imported version is used (in the ``res://.import`` folder). To check for the existence of such resources while taking into account the remapping to their imported location, use :ref:`ResourceLoader.exists`. Typically, using ``File.file_exists`` on an imported resource would work while you are developing in the editor (the source asset is present in ``res://``, but fail when exported). +---- + .. _class_File_method_get_16: - :ref:`int` **get_16** **(** **)** const Returns the next 16 bits from the file as an integer. +---- + .. _class_File_method_get_32: - :ref:`int` **get_32** **(** **)** const Returns the next 32 bits from the file as an integer. +---- + .. _class_File_method_get_64: - :ref:`int` **get_64** **(** **)** const Returns the next 64 bits from the file as an integer. +---- + .. _class_File_method_get_8: - :ref:`int` **get_8** **(** **)** const Returns the next 8 bits from the file as an integer. +---- + .. _class_File_method_get_as_text: - :ref:`String` **get_as_text** **(** **)** const @@ -260,12 +276,16 @@ Returns the whole file as a :ref:`String`. Text is interpreted as being UTF-8 encoded. +---- + .. _class_File_method_get_buffer: - :ref:`PoolByteArray` **get_buffer** **(** :ref:`int` len **)** const Returns next ``len`` bytes of the file as a :ref:`PoolByteArray`. +---- + .. _class_File_method_get_csv_line: - :ref:`PoolStringArray` **get_csv_line** **(** :ref:`String` delim="," **)** const @@ -274,30 +294,40 @@ Returns the next value of the file in CSV (Comma Separated Values) format. You c Text is interpreted as being UTF-8 encoded. +---- + .. _class_File_method_get_double: - :ref:`float` **get_double** **(** **)** const Returns the next 64 bits from the file as a floating point number. +---- + .. _class_File_method_get_error: - :ref:`Error` **get_error** **(** **)** const Returns the last error that happened when trying to perform operations. Compare with the ``ERR_FILE_*`` constants from :ref:`Error`. +---- + .. _class_File_method_get_float: - :ref:`float` **get_float** **(** **)** const Returns the next 32 bits from the file as a floating point number. +---- + .. _class_File_method_get_len: - :ref:`int` **get_len** **(** **)** const Returns the size of the file in bytes. +---- + .. _class_File_method_get_line: - :ref:`String` **get_line** **(** **)** const @@ -306,18 +336,24 @@ Returns the next line of the file as a :ref:`String`. Text is interpreted as being UTF-8 encoded. +---- + .. _class_File_method_get_md5: - :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_method_get_modified_time: - :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_method_get_pascal_string: - :ref:`String` **get_pascal_string** **(** **)** @@ -326,36 +362,48 @@ Returns a :ref:`String` saved in Pascal format from the file. Text is interpreted as being UTF-8 encoded. +---- + .. _class_File_method_get_path: - :ref:`String` **get_path** **(** **)** const Returns the path as a :ref:`String` for the current open file. +---- + .. _class_File_method_get_path_absolute: - :ref:`String` **get_path_absolute** **(** **)** const Returns the absolute path as a :ref:`String` for the current open file. +---- + .. _class_File_method_get_position: - :ref:`int` **get_position** **(** **)** const Returns the file cursor's position. +---- + .. _class_File_method_get_real: - :ref:`float` **get_real** **(** **)** const Returns the next bits from the file as a floating point number. +---- + .. _class_File_method_get_sha256: - :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_method_get_var: - :ref:`Variant` **get_var** **(** :ref:`bool` allow_objects=false **)** const @@ -364,78 +412,104 @@ Returns the next :ref:`Variant` value from the file. When ``allow **WARNING:** Deserialized object can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats (remote code execution). +---- + .. _class_File_method_is_open: - :ref:`bool` **is_open** **(** **)** const Returns ``true`` if the file is currently opened. +---- + .. _class_File_method_open: - :ref:`Error` **open** **(** :ref:`String` path, :ref:`int` flags **)** Opens the file for writing or reading, depending on the flags. +---- + .. _class_File_method_open_compressed: - :ref:`Error` **open_compressed** **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`int` compression_mode=0 **)** Opens a compressed file for reading or writing. Use :ref:`CompressionMode` constants to set ``compression_mode``. +---- + .. _class_File_method_open_encrypted: - :ref:`Error` **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_method_open_encrypted_with_pass: - :ref:`Error` **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_method_seek: - 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_method_seek_end: - 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_method_store_16: - void **store_16** **(** :ref:`int` value **)** Stores an integer as 16 bits in the file. +---- + .. _class_File_method_store_32: - void **store_32** **(** :ref:`int` value **)** Stores an integer as 32 bits in the file. +---- + .. _class_File_method_store_64: - void **store_64** **(** :ref:`int` value **)** Stores an integer as 64 bits in the file. +---- + .. _class_File_method_store_8: - void **store_8** **(** :ref:`int` value **)** Stores an integer as 8 bits in the file. +---- + .. _class_File_method_store_buffer: - void **store_buffer** **(** :ref:`PoolByteArray` buffer **)** Stores the given array of bytes in the file. +---- + .. _class_File_method_store_csv_line: - void **store_csv_line** **(** :ref:`PoolStringArray` values, :ref:`String` delim="," **)** @@ -444,18 +518,24 @@ Store the given :ref:`PoolStringArray` in the file as a l Text will be encoded as UTF-8. +---- + .. _class_File_method_store_double: - void **store_double** **(** :ref:`float` value **)** Stores a floating point number as 64 bits in the file. +---- + .. _class_File_method_store_float: - void **store_float** **(** :ref:`float` value **)** Stores a floating point number as 32 bits in the file. +---- + .. _class_File_method_store_line: - void **store_line** **(** :ref:`String` line **)** @@ -464,6 +544,8 @@ Stores the given :ref:`String` as a line in the file. Text will be encoded as UTF-8. +---- + .. _class_File_method_store_pascal_string: - void **store_pascal_string** **(** :ref:`String` string **)** @@ -472,12 +554,16 @@ Stores the given :ref:`String` as a line in the file in Pascal for Text will be encoded as UTF-8. +---- + .. _class_File_method_store_real: - void **store_real** **(** :ref:`float` value **)** Stores a floating point number in the file. +---- + .. _class_File_method_store_string: - void **store_string** **(** :ref:`String` string **)** @@ -486,6 +572,8 @@ Stores the given :ref:`String` in the file. Text will be encoded as UTF-8. +---- + .. _class_File_method_store_var: - void **store_var** **(** :ref:`Variant` value, :ref:`bool` full_objects=false **)** diff --git a/classes/class_filedialog.rst b/classes/class_filedialog.rst index 169905f86..852b65ecd 100644 --- a/classes/class_filedialog.rst +++ b/classes/class_filedialog.rst @@ -78,12 +78,16 @@ Signals Event emitted when the user selects a directory. +---- + .. _class_FileDialog_signal_file_selected: - **file_selected** **(** :ref:`String` path **)** Event emitted when the user selects a file (double clicks it or presses the OK button). +---- + .. _class_FileDialog_signal_files_selected: - **files_selected** **(** :ref:`PoolStringArray` paths **)** @@ -117,6 +121,8 @@ enum **Mode**: - **MODE_SAVE_FILE** = **4** --- The dialog will warn when a file exists. +---- + .. _enum_FileDialog_Access: .. _class_FileDialog_constant_ACCESS_RESOURCES: @@ -153,6 +159,8 @@ Property Descriptions The file system access scope. See enum ``Access`` constants. +---- + .. _class_FileDialog_property_current_dir: - :ref:`String` **current_dir** @@ -165,6 +173,8 @@ The file system access scope. See enum ``Access`` constants. The current working directory of the file dialog. +---- + .. _class_FileDialog_property_current_file: - :ref:`String` **current_file** @@ -177,6 +187,8 @@ The current working directory of the file dialog. The currently selected file of the file dialog. +---- + .. _class_FileDialog_property_current_path: - :ref:`String` **current_path** @@ -189,6 +201,8 @@ The currently selected file of the file dialog. The currently selected file path of the file dialog. +---- + .. _class_FileDialog_property_filters: - :ref:`PoolStringArray` **filters** @@ -201,6 +215,8 @@ The currently selected file path of the file dialog. Set file type filters. This example shows only .png and .gd files ``set_filters(PoolStringArray(["*.png ; PNG Images","*.gd ; GD Script"]))``. +---- + .. _class_FileDialog_property_mode: - :ref:`Mode` **mode** @@ -213,6 +229,8 @@ Set file type filters. This example shows only .png and .gd files ``set_filters( Set dialog to open or save mode, changes selection behavior. See enum ``Mode`` constants. +---- + .. _class_FileDialog_property_mode_overrides_title: - :ref:`bool` **mode_overrides_title** @@ -225,6 +243,8 @@ Set dialog to open or save mode, changes selection behavior. See enum ``Mode`` c If ``true``, changing the ``Mode`` property will set the window title accordingly (e.g. setting mode to :ref:`MODE_OPEN_FILE` will change the window title to "Open a File"). +---- + .. _class_FileDialog_property_show_hidden_files: - :ref:`bool` **show_hidden_files** @@ -246,30 +266,40 @@ Method Descriptions Add a custom filter. Example: ``add_filter("*.png ; PNG Images")`` +---- + .. _class_FileDialog_method_clear_filters: - void **clear_filters** **(** **)** Clear all the added filters in the dialog. +---- + .. _class_FileDialog_method_deselect_items: - void **deselect_items** **(** **)** Clear currently selected items in the dialog. +---- + .. _class_FileDialog_method_get_line_edit: - :ref:`LineEdit` **get_line_edit** **(** **)** Returns the LineEdit for the selected file. +---- + .. _class_FileDialog_method_get_vbox: - :ref:`VBoxContainer` **get_vbox** **(** **)** Returns the vertical box container of the dialog, custom controls can be added to it. +---- + .. _class_FileDialog_method_invalidate: - void **invalidate** **(** **)** diff --git a/classes/class_float.rst b/classes/class_float.rst index ff740d4d8..902731c12 100644 --- a/classes/class_float.rst +++ b/classes/class_float.rst @@ -41,10 +41,14 @@ Method Descriptions Cast a :ref:`bool` value to a floating point value, ``float(true)`` will be equal to 1.0 and ``float(false)`` will be equal to 0.0. +---- + - :ref:`float` **float** **(** :ref:`int` from **)** Cast an :ref:`int` value to a floating point value, ``float(1)`` will be equal to 1.0. +---- + - :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 ad61829c6..fe431181b 100644 --- a/classes/class_font.rst +++ b/classes/class_font.rst @@ -57,44 +57,60 @@ Method Descriptions 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_method_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 ), :ref:`bool` outline=false **)** 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_method_get_ascent: - :ref:`float` **get_ascent** **(** **)** const Returns the font ascent (number of pixels above the baseline). +---- + .. _class_Font_method_get_descent: - :ref:`float` **get_descent** **(** **)** const Returns the font descent (number of pixels below the baseline). +---- + .. _class_Font_method_get_height: - :ref:`float` **get_height** **(** **)** const Returns the total font height (ascent plus descent) in pixels. +---- + .. _class_Font_method_get_string_size: - :ref:`Vector2` **get_string_size** **(** :ref:`String` string **)** const Returns the size of a string, taking kerning and advance into account. +---- + .. _class_Font_method_has_outline: - :ref:`bool` **has_outline** **(** **)** const +---- + .. _class_Font_method_is_distance_field_hint: - :ref:`bool` **is_distance_field_hint** **(** **)** const +---- + .. _class_Font_method_update_changes: - void **update_changes** **(** **)** diff --git a/classes/class_funcref.rst b/classes/class_funcref.rst index 33d1908cf..d253e0459 100644 --- a/classes/class_funcref.rst +++ b/classes/class_funcref.rst @@ -45,12 +45,16 @@ Method Descriptions Calls the referenced function previously set by :ref:`set_function` or :ref:`@GDScript.funcref`. +---- + .. _class_FuncRef_method_set_function: - void **set_function** **(** :ref:`String` name **)** The name of the referenced function to call on the object, without parentheses or any parameters. +---- + .. _class_FuncRef_method_set_instance: - void **set_instance** **(** :ref:`Object` instance **)** diff --git a/classes/class_gdnative.rst b/classes/class_gdnative.rst index 99cd6e344..56fb5ac39 100644 --- a/classes/class_gdnative.rst +++ b/classes/class_gdnative.rst @@ -56,10 +56,14 @@ Method Descriptions - :ref:`Variant` **call_native** **(** :ref:`String` calling_type, :ref:`String` procedure_name, :ref:`Array` arguments **)** +---- + .. _class_GDNative_method_initialize: - :ref:`bool` **initialize** **(** **)** +---- + .. _class_GDNative_method_terminate: - :ref:`bool` **terminate** **(** **)** diff --git a/classes/class_gdnativelibrary.rst b/classes/class_gdnativelibrary.rst index 5c5ceccef..17cb7f9db 100644 --- a/classes/class_gdnativelibrary.rst +++ b/classes/class_gdnativelibrary.rst @@ -16,7 +16,7 @@ GDNativeLibrary Brief Description ----------------- - +An external library containing functions or script classes to use in Godot. Properties ---------- @@ -42,6 +42,18 @@ Methods | :ref:`String` | :ref:`get_current_library_path` **(** **)** const | +-----------------------------------------------+----------------------------------------------------------------------------------------------------------+ +Description +----------- + +A GDNative library can implement :ref:`NativeScript`\ s, global functions to call with the :ref:`GDNative` class, or low-level engine extensions through interfaces such as :ref:`ARVRInterfaceGDNative`. The library must be compiled for each platform and architecture that the project will run on. + +Tutorials +--------- + +- :doc:`../tutorials/plugins/gdnative/gdnative-c-example` + +- :doc:`../tutorials/plugins/gdnative/gdnative-cpp-example` + Property Descriptions --------------------- @@ -55,6 +67,10 @@ Property Descriptions | *Getter* | get_config_file() | +----------+------------------------+ +This resource in INI-style :ref:`ConfigFile` format, as in ``.gdnlib`` files. + +---- + .. _class_GDNativeLibrary_property_load_once: - :ref:`bool` **load_once** @@ -65,6 +81,12 @@ Property Descriptions | *Getter* | should_load_once() | +----------+----------------------+ +If ``true``, Godot loads only one copy of the library and each script that references the library will share static data like static or global variables. + +If ``false``, Godot loads a separate copy of the library into memory for each script that references it. + +---- + .. _class_GDNativeLibrary_property_reloadable: - :ref:`bool` **reloadable** @@ -75,6 +97,12 @@ Property Descriptions | *Getter* | is_reloadable() | +----------+-----------------------+ +If ``true``, the editor will temporarily unload the library whenever the user switches away from the editor window, allowing the user to recompile the library without restarting Godot. + +**Note:** If the library defines tool scripts that run inside the editor, ``reloadable`` must be ``false``. Otherwise, the editor will attempt to unload the tool scripts while they're in use and crash. + +---- + .. _class_GDNativeLibrary_property_singleton: - :ref:`bool` **singleton** @@ -85,6 +113,12 @@ Property Descriptions | *Getter* | is_singleton() | +----------+----------------------+ +If ``true``, Godot loads the library at startup rather than the first time a script uses the library, calling ``gdnative_singleton`` after initializing the library. The library remains loaded as long as Godot is running. + +**Note:** A singleton library cannot be :ref:`reloadable`. + +---- + .. _class_GDNativeLibrary_property_symbol_prefix: - :ref:`String` **symbol_prefix** @@ -95,6 +129,10 @@ Property Descriptions | *Getter* | get_symbol_prefix() | +----------+--------------------------+ +The prefix this library's entry point functions begin with. For example, a GDNativeLibrary would declare its ``gdnative_init`` function as ``godot_gdnative_init`` by default. + +On platforms that require statically linking libraries (currently only iOS), each library must have a different ``symbol_prefix``. + Method Descriptions ------------------- @@ -102,7 +140,13 @@ Method Descriptions - :ref:`PoolStringArray` **get_current_dependencies** **(** **)** const +Returns paths to all dependency libraries for the current platform and architecture. + +---- + .. _class_GDNativeLibrary_method_get_current_library_path: - :ref:`String` **get_current_library_path** **(** **)** const +Returns the path to the dynamic library file for the current platform and architecture. + diff --git a/classes/class_gdscript.rst b/classes/class_gdscript.rst index 6a95e39a4..e23952944 100644 --- a/classes/class_gdscript.rst +++ b/classes/class_gdscript.rst @@ -48,6 +48,8 @@ Method Descriptions Returns byte code for the script source code. +---- + .. _class_GDScript_method_new: - :ref:`Object` **new** **(** ... **)** vararg diff --git a/classes/class_gdscriptfunctionstate.rst b/classes/class_gdscriptfunctionstate.rst index 6e424d021..fcbe62cba 100644 --- a/classes/class_gdscriptfunctionstate.rst +++ b/classes/class_gdscriptfunctionstate.rst @@ -50,6 +50,8 @@ Check whether the function call may be resumed. This is not the case if the func If ``extended_check`` is enabled, it also checks if the associated script and object still exist. The extended check is done in debug mode as part of :ref:`resume`, but you can use this if you know you may be trying to resume without knowing for sure the object and/or script have survived up to that point. +---- + .. _class_GDScriptFunctionState_method_resume: - :ref:`Variant` **resume** **(** :ref:`Variant` arg=null **)** diff --git a/classes/class_generic6dofjoint.rst b/classes/class_generic6dofjoint.rst index 99a729aa9..0ef9f43a3 100644 --- a/classes/class_generic6dofjoint.rst +++ b/classes/class_generic6dofjoint.rst @@ -268,6 +268,8 @@ enum **Param**: - **PARAM_MAX** = **22** --- Represents the size of the :ref:`Param` enum. +---- + .. _enum_Generic6DOFJoint_Flag: .. _class_Generic6DOFJoint_constant_FLAG_ENABLE_LINEAR_LIMIT: @@ -322,6 +324,8 @@ The amount of rotational damping across the x-axis. The lower, the longer an impulse from one side takes to travel to the other side. +---- + .. _class_Generic6DOFJoint_property_angular_limit_x/enabled: - :ref:`bool` **angular_limit_x/enabled** @@ -334,6 +338,8 @@ The lower, the longer an impulse from one side takes to travel to the other side If ``true``, rotation across the x-axis is limited. +---- + .. _class_Generic6DOFJoint_property_angular_limit_x/erp: - :ref:`float` **angular_limit_x/erp** @@ -346,6 +352,8 @@ If ``true``, rotation across the x-axis is limited. When rotating across x-axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. +---- + .. _class_Generic6DOFJoint_property_angular_limit_x/force_limit: - :ref:`float` **angular_limit_x/force_limit** @@ -358,12 +366,16 @@ When rotating across x-axis, this error tolerance factor defines how much the co The maximum amount of force that can occur, when rotating around x-axis. +---- + .. _class_Generic6DOFJoint_property_angular_limit_x/lower_angle: - :ref:`float` **angular_limit_x/lower_angle** The minimum rotation in negative direction to break loose and rotate around the x-axis. +---- + .. _class_Generic6DOFJoint_property_angular_limit_x/restitution: - :ref:`float` **angular_limit_x/restitution** @@ -376,6 +388,8 @@ The minimum rotation in negative direction to break loose and rotate around the The amount of rotational restitution across the x-axis. The lower, the more restitution occurs. +---- + .. _class_Generic6DOFJoint_property_angular_limit_x/softness: - :ref:`float` **angular_limit_x/softness** @@ -388,12 +402,16 @@ The amount of rotational restitution across the x-axis. The lower, the more rest The speed of all rotations across the x-axis. +---- + .. _class_Generic6DOFJoint_property_angular_limit_x/upper_angle: - :ref:`float` **angular_limit_x/upper_angle** The minimum rotation in positive direction to break loose and rotate around the x-axis. +---- + .. _class_Generic6DOFJoint_property_angular_limit_y/damping: - :ref:`float` **angular_limit_y/damping** @@ -406,6 +424,8 @@ The minimum rotation in positive direction to break loose and rotate around the The amount of rotational damping across the y-axis. The lower, the more dampening occurs. +---- + .. _class_Generic6DOFJoint_property_angular_limit_y/enabled: - :ref:`bool` **angular_limit_y/enabled** @@ -418,6 +438,8 @@ The amount of rotational damping across the y-axis. The lower, the more dampenin If ``true``, rotation across the y-axis is limited. +---- + .. _class_Generic6DOFJoint_property_angular_limit_y/erp: - :ref:`float` **angular_limit_y/erp** @@ -430,6 +452,8 @@ If ``true``, rotation across the y-axis is limited. When rotating across y-axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. +---- + .. _class_Generic6DOFJoint_property_angular_limit_y/force_limit: - :ref:`float` **angular_limit_y/force_limit** @@ -442,12 +466,16 @@ When rotating across y-axis, this error tolerance factor defines how much the co The maximum amount of force that can occur, when rotating around y-axis. +---- + .. _class_Generic6DOFJoint_property_angular_limit_y/lower_angle: - :ref:`float` **angular_limit_y/lower_angle** The minimum rotation in negative direction to break loose and rotate around the y-axis. +---- + .. _class_Generic6DOFJoint_property_angular_limit_y/restitution: - :ref:`float` **angular_limit_y/restitution** @@ -460,6 +488,8 @@ The minimum rotation in negative direction to break loose and rotate around the The amount of rotational restitution across the y-axis. The lower, the more restitution occurs. +---- + .. _class_Generic6DOFJoint_property_angular_limit_y/softness: - :ref:`float` **angular_limit_y/softness** @@ -472,12 +502,16 @@ The amount of rotational restitution across the y-axis. The lower, the more rest The speed of all rotations across the y-axis. +---- + .. _class_Generic6DOFJoint_property_angular_limit_y/upper_angle: - :ref:`float` **angular_limit_y/upper_angle** The minimum rotation in positive direction to break loose and rotate around the y-axis. +---- + .. _class_Generic6DOFJoint_property_angular_limit_z/damping: - :ref:`float` **angular_limit_z/damping** @@ -490,6 +524,8 @@ The minimum rotation in positive direction to break loose and rotate around the The amount of rotational damping across the z-axis. The lower, the more dampening occurs. +---- + .. _class_Generic6DOFJoint_property_angular_limit_z/enabled: - :ref:`bool` **angular_limit_z/enabled** @@ -502,6 +538,8 @@ The amount of rotational damping across the z-axis. The lower, the more dampenin If ``true``, rotation across the z-axis is limited. +---- + .. _class_Generic6DOFJoint_property_angular_limit_z/erp: - :ref:`float` **angular_limit_z/erp** @@ -514,6 +552,8 @@ If ``true``, rotation across the z-axis is limited. When rotating across z-axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. +---- + .. _class_Generic6DOFJoint_property_angular_limit_z/force_limit: - :ref:`float` **angular_limit_z/force_limit** @@ -526,12 +566,16 @@ When rotating across z-axis, this error tolerance factor defines how much the co The maximum amount of force that can occur, when rotating around z-axis. +---- + .. _class_Generic6DOFJoint_property_angular_limit_z/lower_angle: - :ref:`float` **angular_limit_z/lower_angle** The minimum rotation in negative direction to break loose and rotate around the z-axis. +---- + .. _class_Generic6DOFJoint_property_angular_limit_z/restitution: - :ref:`float` **angular_limit_z/restitution** @@ -544,6 +588,8 @@ The minimum rotation in negative direction to break loose and rotate around the The amount of rotational restitution across the z-axis. The lower, the more restitution occurs. +---- + .. _class_Generic6DOFJoint_property_angular_limit_z/softness: - :ref:`float` **angular_limit_z/softness** @@ -556,12 +602,16 @@ The amount of rotational restitution across the z-axis. The lower, the more rest The speed of all rotations across the z-axis. +---- + .. _class_Generic6DOFJoint_property_angular_limit_z/upper_angle: - :ref:`float` **angular_limit_z/upper_angle** The minimum rotation in positive direction to break loose and rotate around the z-axis. +---- + .. _class_Generic6DOFJoint_property_angular_motor_x/enabled: - :ref:`bool` **angular_motor_x/enabled** @@ -574,6 +624,8 @@ The minimum rotation in positive direction to break loose and rotate around the If ``true``, a rotating motor at the x-axis is enabled. +---- + .. _class_Generic6DOFJoint_property_angular_motor_x/force_limit: - :ref:`float` **angular_motor_x/force_limit** @@ -586,6 +638,8 @@ If ``true``, a rotating motor at the x-axis is enabled. Maximum acceleration for the motor at the x-axis. +---- + .. _class_Generic6DOFJoint_property_angular_motor_x/target_velocity: - :ref:`float` **angular_motor_x/target_velocity** @@ -598,6 +652,8 @@ Maximum acceleration for the motor at the x-axis. Target speed for the motor at the x-axis. +---- + .. _class_Generic6DOFJoint_property_angular_motor_y/enabled: - :ref:`bool` **angular_motor_y/enabled** @@ -610,6 +666,8 @@ Target speed for the motor at the x-axis. If ``true``, a rotating motor at the y-axis is enabled. +---- + .. _class_Generic6DOFJoint_property_angular_motor_y/force_limit: - :ref:`float` **angular_motor_y/force_limit** @@ -622,6 +680,8 @@ If ``true``, a rotating motor at the y-axis is enabled. Maximum acceleration for the motor at the y-axis. +---- + .. _class_Generic6DOFJoint_property_angular_motor_y/target_velocity: - :ref:`float` **angular_motor_y/target_velocity** @@ -634,6 +694,8 @@ Maximum acceleration for the motor at the y-axis. Target speed for the motor at the y-axis. +---- + .. _class_Generic6DOFJoint_property_angular_motor_z/enabled: - :ref:`bool` **angular_motor_z/enabled** @@ -646,6 +708,8 @@ Target speed for the motor at the y-axis. If ``true``, a rotating motor at the z-axis is enabled. +---- + .. _class_Generic6DOFJoint_property_angular_motor_z/force_limit: - :ref:`float` **angular_motor_z/force_limit** @@ -658,6 +722,8 @@ If ``true``, a rotating motor at the z-axis is enabled. Maximum acceleration for the motor at the z-axis. +---- + .. _class_Generic6DOFJoint_property_angular_motor_z/target_velocity: - :ref:`float` **angular_motor_z/target_velocity** @@ -670,6 +736,8 @@ Maximum acceleration for the motor at the z-axis. Target speed for the motor at the z-axis. +---- + .. _class_Generic6DOFJoint_property_angular_spring_x/damping: - :ref:`float` **angular_spring_x/damping** @@ -680,6 +748,8 @@ Target speed for the motor at the z-axis. | *Getter* | get_param_x() | +----------+--------------------+ +---- + .. _class_Generic6DOFJoint_property_angular_spring_x/enabled: - :ref:`bool` **angular_spring_x/enabled** @@ -690,6 +760,8 @@ Target speed for the motor at the z-axis. | *Getter* | get_flag_x() | +----------+-------------------+ +---- + .. _class_Generic6DOFJoint_property_angular_spring_x/equilibrium_point: - :ref:`float` **angular_spring_x/equilibrium_point** @@ -700,6 +772,8 @@ Target speed for the motor at the z-axis. | *Getter* | get_param_x() | +----------+--------------------+ +---- + .. _class_Generic6DOFJoint_property_angular_spring_x/stiffness: - :ref:`float` **angular_spring_x/stiffness** @@ -710,6 +784,8 @@ Target speed for the motor at the z-axis. | *Getter* | get_param_x() | +----------+--------------------+ +---- + .. _class_Generic6DOFJoint_property_angular_spring_y/damping: - :ref:`float` **angular_spring_y/damping** @@ -720,6 +796,8 @@ Target speed for the motor at the z-axis. | *Getter* | get_param_y() | +----------+--------------------+ +---- + .. _class_Generic6DOFJoint_property_angular_spring_y/enabled: - :ref:`bool` **angular_spring_y/enabled** @@ -730,6 +808,8 @@ Target speed for the motor at the z-axis. | *Getter* | get_flag_y() | +----------+-------------------+ +---- + .. _class_Generic6DOFJoint_property_angular_spring_y/equilibrium_point: - :ref:`float` **angular_spring_y/equilibrium_point** @@ -740,6 +820,8 @@ Target speed for the motor at the z-axis. | *Getter* | get_param_y() | +----------+--------------------+ +---- + .. _class_Generic6DOFJoint_property_angular_spring_y/stiffness: - :ref:`float` **angular_spring_y/stiffness** @@ -750,6 +832,8 @@ Target speed for the motor at the z-axis. | *Getter* | get_param_y() | +----------+--------------------+ +---- + .. _class_Generic6DOFJoint_property_angular_spring_z/damping: - :ref:`float` **angular_spring_z/damping** @@ -760,6 +844,8 @@ Target speed for the motor at the z-axis. | *Getter* | get_param_z() | +----------+--------------------+ +---- + .. _class_Generic6DOFJoint_property_angular_spring_z/enabled: - :ref:`bool` **angular_spring_z/enabled** @@ -770,6 +856,8 @@ Target speed for the motor at the z-axis. | *Getter* | get_flag_z() | +----------+-------------------+ +---- + .. _class_Generic6DOFJoint_property_angular_spring_z/equilibrium_point: - :ref:`float` **angular_spring_z/equilibrium_point** @@ -780,6 +868,8 @@ Target speed for the motor at the z-axis. | *Getter* | get_param_z() | +----------+--------------------+ +---- + .. _class_Generic6DOFJoint_property_angular_spring_z/stiffness: - :ref:`float` **angular_spring_z/stiffness** @@ -790,6 +880,8 @@ Target speed for the motor at the z-axis. | *Getter* | get_param_z() | +----------+--------------------+ +---- + .. _class_Generic6DOFJoint_property_linear_limit_x/damping: - :ref:`float` **linear_limit_x/damping** @@ -802,6 +894,8 @@ Target speed for the motor at the z-axis. The amount of damping that happens at the x-motion. +---- + .. _class_Generic6DOFJoint_property_linear_limit_x/enabled: - :ref:`bool` **linear_limit_x/enabled** @@ -814,6 +908,8 @@ The amount of damping that happens at the x-motion. If ``true``, the linear motion across the x-axis is limited. +---- + .. _class_Generic6DOFJoint_property_linear_limit_x/lower_distance: - :ref:`float` **linear_limit_x/lower_distance** @@ -826,6 +922,8 @@ If ``true``, the linear motion across the x-axis is limited. The minimum difference between the pivot points' x-axis. +---- + .. _class_Generic6DOFJoint_property_linear_limit_x/restitution: - :ref:`float` **linear_limit_x/restitution** @@ -838,6 +936,8 @@ The minimum difference between the pivot points' x-axis. The amount of restitution on the x-axis movement The lower, the more momentum gets lost. +---- + .. _class_Generic6DOFJoint_property_linear_limit_x/softness: - :ref:`float` **linear_limit_x/softness** @@ -850,6 +950,8 @@ The amount of restitution on the x-axis movement The lower, the more momentum ge A factor applied to the movement across the x-axis The lower, the slower the movement. +---- + .. _class_Generic6DOFJoint_property_linear_limit_x/upper_distance: - :ref:`float` **linear_limit_x/upper_distance** @@ -862,6 +964,8 @@ A factor applied to the movement across the x-axis The lower, the slower the mov The maximum difference between the pivot points' x-axis. +---- + .. _class_Generic6DOFJoint_property_linear_limit_y/damping: - :ref:`float` **linear_limit_y/damping** @@ -874,6 +978,8 @@ The maximum difference between the pivot points' x-axis. The amount of damping that happens at the y-motion. +---- + .. _class_Generic6DOFJoint_property_linear_limit_y/enabled: - :ref:`bool` **linear_limit_y/enabled** @@ -886,6 +992,8 @@ The amount of damping that happens at the y-motion. If ``true``, the linear motion across the y-axis is limited. +---- + .. _class_Generic6DOFJoint_property_linear_limit_y/lower_distance: - :ref:`float` **linear_limit_y/lower_distance** @@ -898,6 +1006,8 @@ If ``true``, the linear motion across the y-axis is limited. The minimum difference between the pivot points' y-axis. +---- + .. _class_Generic6DOFJoint_property_linear_limit_y/restitution: - :ref:`float` **linear_limit_y/restitution** @@ -910,6 +1020,8 @@ The minimum difference between the pivot points' y-axis. The amount of restitution on the y-axis movement The lower, the more momentum gets lost. +---- + .. _class_Generic6DOFJoint_property_linear_limit_y/softness: - :ref:`float` **linear_limit_y/softness** @@ -922,6 +1034,8 @@ The amount of restitution on the y-axis movement The lower, the more momentum ge A factor applied to the movement across the y-axis The lower, the slower the movement. +---- + .. _class_Generic6DOFJoint_property_linear_limit_y/upper_distance: - :ref:`float` **linear_limit_y/upper_distance** @@ -934,6 +1048,8 @@ A factor applied to the movement across the y-axis The lower, the slower the mov The maximum difference between the pivot points' y-axis. +---- + .. _class_Generic6DOFJoint_property_linear_limit_z/damping: - :ref:`float` **linear_limit_z/damping** @@ -946,6 +1062,8 @@ The maximum difference between the pivot points' y-axis. The amount of damping that happens at the z-motion. +---- + .. _class_Generic6DOFJoint_property_linear_limit_z/enabled: - :ref:`bool` **linear_limit_z/enabled** @@ -958,6 +1076,8 @@ The amount of damping that happens at the z-motion. If ``true``, the linear motion across the z-axis is limited. +---- + .. _class_Generic6DOFJoint_property_linear_limit_z/lower_distance: - :ref:`float` **linear_limit_z/lower_distance** @@ -970,6 +1090,8 @@ If ``true``, the linear motion across the z-axis is limited. The minimum difference between the pivot points' z-axis. +---- + .. _class_Generic6DOFJoint_property_linear_limit_z/restitution: - :ref:`float` **linear_limit_z/restitution** @@ -982,6 +1104,8 @@ The minimum difference between the pivot points' z-axis. The amount of restitution on the z-axis movement The lower, the more momentum gets lost. +---- + .. _class_Generic6DOFJoint_property_linear_limit_z/softness: - :ref:`float` **linear_limit_z/softness** @@ -994,6 +1118,8 @@ The amount of restitution on the z-axis movement The lower, the more momentum ge A factor applied to the movement across the z-axis The lower, the slower the movement. +---- + .. _class_Generic6DOFJoint_property_linear_limit_z/upper_distance: - :ref:`float` **linear_limit_z/upper_distance** @@ -1006,6 +1132,8 @@ A factor applied to the movement across the z-axis The lower, the slower the mov The maximum difference between the pivot points' z-axis. +---- + .. _class_Generic6DOFJoint_property_linear_motor_x/enabled: - :ref:`bool` **linear_motor_x/enabled** @@ -1018,6 +1146,8 @@ The maximum difference between the pivot points' z-axis. If ``true``, then there is a linear motor on the x-axis. It will attempt to reach the target velocity while staying within the force limits. +---- + .. _class_Generic6DOFJoint_property_linear_motor_x/force_limit: - :ref:`float` **linear_motor_x/force_limit** @@ -1030,6 +1160,8 @@ If ``true``, then there is a linear motor on the x-axis. It will attempt to reac The maximum force the linear motor can apply on the x-axis while trying to reach the target velocity. +---- + .. _class_Generic6DOFJoint_property_linear_motor_x/target_velocity: - :ref:`float` **linear_motor_x/target_velocity** @@ -1042,6 +1174,8 @@ The maximum force the linear motor can apply on the x-axis while trying to reach The speed that the linear motor will attempt to reach on the x-axis. +---- + .. _class_Generic6DOFJoint_property_linear_motor_y/enabled: - :ref:`bool` **linear_motor_y/enabled** @@ -1054,6 +1188,8 @@ The speed that the linear motor will attempt to reach on the x-axis. If ``true``, then there is a linear motor on the y-axis. It will attempt to reach the target velocity while staying within the force limits. +---- + .. _class_Generic6DOFJoint_property_linear_motor_y/force_limit: - :ref:`float` **linear_motor_y/force_limit** @@ -1066,6 +1202,8 @@ If ``true``, then there is a linear motor on the y-axis. It will attempt to reac The maximum force the linear motor can apply on the y-axis while trying to reach the target velocity. +---- + .. _class_Generic6DOFJoint_property_linear_motor_y/target_velocity: - :ref:`float` **linear_motor_y/target_velocity** @@ -1078,6 +1216,8 @@ The maximum force the linear motor can apply on the y-axis while trying to reach The speed that the linear motor will attempt to reach on the y-axis. +---- + .. _class_Generic6DOFJoint_property_linear_motor_z/enabled: - :ref:`bool` **linear_motor_z/enabled** @@ -1090,6 +1230,8 @@ The speed that the linear motor will attempt to reach on the y-axis. If ``true``, then there is a linear motor on the z-axis. It will attempt to reach the target velocity while staying within the force limits. +---- + .. _class_Generic6DOFJoint_property_linear_motor_z/force_limit: - :ref:`float` **linear_motor_z/force_limit** @@ -1102,6 +1244,8 @@ If ``true``, then there is a linear motor on the z-axis. It will attempt to reac The maximum force the linear motor can apply on the z-axis while trying to reach the target velocity. +---- + .. _class_Generic6DOFJoint_property_linear_motor_z/target_velocity: - :ref:`float` **linear_motor_z/target_velocity** @@ -1114,6 +1258,8 @@ The maximum force the linear motor can apply on the z-axis while trying to reach The speed that the linear motor will attempt to reach on the z-axis. +---- + .. _class_Generic6DOFJoint_property_linear_spring_x/damping: - :ref:`float` **linear_spring_x/damping** @@ -1124,6 +1270,8 @@ The speed that the linear motor will attempt to reach on the z-axis. | *Getter* | get_param_x() | +----------+--------------------+ +---- + .. _class_Generic6DOFJoint_property_linear_spring_x/enabled: - :ref:`bool` **linear_spring_x/enabled** @@ -1134,6 +1282,8 @@ The speed that the linear motor will attempt to reach on the z-axis. | *Getter* | get_flag_x() | +----------+-------------------+ +---- + .. _class_Generic6DOFJoint_property_linear_spring_x/equilibrium_point: - :ref:`float` **linear_spring_x/equilibrium_point** @@ -1144,6 +1294,8 @@ The speed that the linear motor will attempt to reach on the z-axis. | *Getter* | get_param_x() | +----------+--------------------+ +---- + .. _class_Generic6DOFJoint_property_linear_spring_x/stiffness: - :ref:`float` **linear_spring_x/stiffness** @@ -1154,6 +1306,8 @@ The speed that the linear motor will attempt to reach on the z-axis. | *Getter* | get_param_x() | +----------+--------------------+ +---- + .. _class_Generic6DOFJoint_property_linear_spring_y/damping: - :ref:`float` **linear_spring_y/damping** @@ -1164,6 +1318,8 @@ The speed that the linear motor will attempt to reach on the z-axis. | *Getter* | get_param_y() | +----------+--------------------+ +---- + .. _class_Generic6DOFJoint_property_linear_spring_y/enabled: - :ref:`bool` **linear_spring_y/enabled** @@ -1174,6 +1330,8 @@ The speed that the linear motor will attempt to reach on the z-axis. | *Getter* | get_flag_y() | +----------+-------------------+ +---- + .. _class_Generic6DOFJoint_property_linear_spring_y/equilibrium_point: - :ref:`float` **linear_spring_y/equilibrium_point** @@ -1184,6 +1342,8 @@ The speed that the linear motor will attempt to reach on the z-axis. | *Getter* | get_param_y() | +----------+--------------------+ +---- + .. _class_Generic6DOFJoint_property_linear_spring_y/stiffness: - :ref:`float` **linear_spring_y/stiffness** @@ -1194,6 +1354,8 @@ The speed that the linear motor will attempt to reach on the z-axis. | *Getter* | get_param_y() | +----------+--------------------+ +---- + .. _class_Generic6DOFJoint_property_linear_spring_z/damping: - :ref:`float` **linear_spring_z/damping** @@ -1204,6 +1366,8 @@ The speed that the linear motor will attempt to reach on the z-axis. | *Getter* | get_param_z() | +----------+--------------------+ +---- + .. _class_Generic6DOFJoint_property_linear_spring_z/enabled: - :ref:`bool` **linear_spring_z/enabled** @@ -1214,6 +1378,8 @@ The speed that the linear motor will attempt to reach on the z-axis. | *Getter* | get_flag_z() | +----------+-------------------+ +---- + .. _class_Generic6DOFJoint_property_linear_spring_z/equilibrium_point: - :ref:`float` **linear_spring_z/equilibrium_point** @@ -1224,6 +1390,8 @@ The speed that the linear motor will attempt to reach on the z-axis. | *Getter* | get_param_z() | +----------+--------------------+ +---- + .. _class_Generic6DOFJoint_property_linear_spring_z/stiffness: - :ref:`float` **linear_spring_z/stiffness** @@ -1234,6 +1402,8 @@ The speed that the linear motor will attempt to reach on the z-axis. | *Getter* | get_param_z() | +----------+--------------------+ +---- + .. _class_Generic6DOFJoint_property_precision: - :ref:`int` **precision** diff --git a/classes/class_geometry.rst b/classes/class_geometry.rst index 3cd37157a..e04a539be 100644 --- a/classes/class_geometry.rst +++ b/classes/class_geometry.rst @@ -78,130 +78,174 @@ Method Descriptions Returns an array with 6 :ref:`Plane`\ s that describe the sides of a box centered at the origin. The box size is defined by ``extents``, which represents one (positive) corner of the box (i.e. half its actual size). +---- + .. _class_Geometry_method_build_capsule_planes: - :ref:`Array` **build_capsule_planes** **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`int` lats, Vector3.Axis axis=2 **)** Returns an array of :ref:`Plane`\ s closely bounding a faceted capsule centered at the origin with radius ``radius`` and height ``height``. The parameter ``sides`` defines how many planes will be generated for the side part of the capsule, whereas ``lats`` gives the number of latitudinal steps at the bottom and top of the capsule. The parameter ``axis`` describes the axis along which the capsule is oriented (0 for X, 1 for Y, 2 for Z). +---- + .. _class_Geometry_method_build_cylinder_planes: - :ref:`Array` **build_cylinder_planes** **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, Vector3.Axis axis=2 **)** Returns an array of :ref:`Plane`\ s closely bounding a faceted cylinder centered at the origin with radius ``radius`` and height ``height``. The parameter ``sides`` defines how many planes will be generated for the round part of the cylinder. The parameter ``axis`` describes the axis along which the cylinder is oriented (0 for X, 1 for Y, 2 for Z). +---- + .. _class_Geometry_method_clip_polygon: - :ref:`PoolVector3Array` **clip_polygon** **(** :ref:`PoolVector3Array` points, :ref:`Plane` plane **)** Clips the polygon defined by the points in ``points`` against the ``plane`` and returns the points of the clipped polygon. +---- + .. _class_Geometry_method_convex_hull_2d: - :ref:`PoolVector2Array` **convex_hull_2d** **(** :ref:`PoolVector2Array` points **)** Given an array of :ref:`Vector2`\ s, returns the convex hull as a list of points in counter-clockwise order. The last point is the same as the first one. +---- + .. _class_Geometry_method_get_closest_point_to_segment: - :ref:`Vector3` **get_closest_point_to_segment** **(** :ref:`Vector3` point, :ref:`Vector3` s1, :ref:`Vector3` s2 **)** Returns the 3d point on the 3d segment (``s1``, ``s2``) that is closest to ``point``. The returned point will always be inside the specified segment. +---- + .. _class_Geometry_method_get_closest_point_to_segment_2d: - :ref:`Vector2` **get_closest_point_to_segment_2d** **(** :ref:`Vector2` point, :ref:`Vector2` s1, :ref:`Vector2` s2 **)** Returns the 2d point on the 2d segment (``s1``, ``s2``) that is closest to ``point``. The returned point will always be inside the specified segment. +---- + .. _class_Geometry_method_get_closest_point_to_segment_uncapped: - :ref:`Vector3` **get_closest_point_to_segment_uncapped** **(** :ref:`Vector3` point, :ref:`Vector3` s1, :ref:`Vector3` s2 **)** Returns the 3d point on the 3d line defined by (``s1``, ``s2``) that is closest to ``point``. The returned point can be inside the segment (``s1``, ``s2``) or outside of it, i.e. somewhere on the line extending from the segment. +---- + .. _class_Geometry_method_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 **)** Returns the 2d point on the 2d line defined by (``s1``, ``s2``) that is closest to ``point``. The returned point can be inside the segment (``s1``, ``s2``) or outside of it, i.e. somewhere on the line extending from the segment. +---- + .. _class_Geometry_method_get_closest_points_between_segments: - :ref:`PoolVector3Array` **get_closest_points_between_segments** **(** :ref:`Vector3` p1, :ref:`Vector3` p2, :ref:`Vector3` q1, :ref:`Vector3` q2 **)** Given the two 3d segments (``p1``, ``p2``) and (``q1``, ``q2``), finds those two points on the two segments that are closest to each other. Returns a :ref:`PoolVector3Array` that contains this point on (``p1``, ``p2``) as well the accompanying point on (``q1``, ``q2``). +---- + .. _class_Geometry_method_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 **)** Given the two 2d segments (``p1``, ``p2``) and (``q1``, ``q2``), finds those two points on the two segments that are closest to each other. Returns a :ref:`PoolVector2Array` that contains this point on (``p1``, ``p2``) as well the accompanying point on (``q1``, ``q2``). +---- + .. _class_Geometry_method_get_uv84_normal_bit: - :ref:`int` **get_uv84_normal_bit** **(** :ref:`Vector3` normal **)** +---- + .. _class_Geometry_method_line_intersects_line_2d: - :ref:`Variant` **line_intersects_line_2d** **(** :ref:`Vector2` from_a, :ref:`Vector2` dir_a, :ref:`Vector2` from_b, :ref:`Vector2` dir_b **)** Checks if the two lines (``from_a``, ``dir_a``) and (``from_b``, ``dir_b``) intersect. If yes, return the point of intersection as :ref:`Vector2`. If no intersection takes place, returns an empty :ref:`Variant`. Note that the lines are specified using direction vectors, not end points. +---- + .. _class_Geometry_method_make_atlas: - :ref:`Dictionary` **make_atlas** **(** :ref:`PoolVector2Array` sizes **)** Given an array of :ref:`Vector2`\ s representing tiles, builds an atlas. The returned dictionary has two keys: ``points`` is a vector of :ref:`Vector2` that specifies the positions of each tile, ``size`` contains the overall size of the whole atlas as :ref:`Vector2`. +---- + .. _class_Geometry_method_point_is_inside_triangle: - :ref:`bool` **point_is_inside_triangle** **(** :ref:`Vector2` point, :ref:`Vector2` a, :ref:`Vector2` b, :ref:`Vector2` c **)** const Returns if ``point`` is inside the triangle specified by ``a``, ``b`` and ``c``. +---- + .. _class_Geometry_method_ray_intersects_triangle: - :ref:`Variant` **ray_intersects_triangle** **(** :ref:`Vector3` from, :ref:`Vector3` dir, :ref:`Vector3` a, :ref:`Vector3` b, :ref:`Vector3` c **)** Tests if the 3d ray starting at ``from`` with the direction of ``dir`` intersects the triangle specified by ``a``, ``b`` and ``c``. If yes, returns the point of intersection as :ref:`Vector3`. If no intersection takes place, an empty :ref:`Variant` is returned. +---- + .. _class_Geometry_method_segment_intersects_circle: - :ref:`float` **segment_intersects_circle** **(** :ref:`Vector2` segment_from, :ref:`Vector2` segment_to, :ref:`Vector2` circle_position, :ref:`float` circle_radius **)** Given the 2d segment (``segment_from``, ``segment_to``), returns the position on the segment (as a number between 0 and 1) at which the segment hits the circle that is located at position ``circle_position`` and has radius ``circle_radius``. If the segment does not intersect the circle, -1 is returned (this is also the case if the line extending the segment would intersect the circle, but the segment does not). +---- + .. _class_Geometry_method_segment_intersects_convex: - :ref:`PoolVector3Array` **segment_intersects_convex** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` planes **)** Given a convex hull defined though the :ref:`Plane`\ s in the array ``planes``, tests if the segment (``from``, ``to``) intersects with that hull. If an intersection is found, returns a :ref:`PoolVector3Array` containing the point the intersection and the hull's normal. If no intersecion is found, an the returned array is empty. +---- + .. _class_Geometry_method_segment_intersects_cylinder: - :ref:`PoolVector3Array` **segment_intersects_cylinder** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`float` height, :ref:`float` radius **)** Checks if the segment (``from``, ``to``) intersects the cylinder with height ``height`` that is centered at the origin and has radius ``radius``. If no, returns an empty :ref:`PoolVector3Array`. If an intersection takes place, the returned array contains the point of intersection and the cylinder's normal at the point of intersection. +---- + .. _class_Geometry_method_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 **)** Checks if the two segments (``from_a``, ``to_a``) and (``from_b``, ``to_b``) intersect. If yes, return the point of intersection as :ref:`Vector2`. If no intersection takes place, returns an empty :ref:`Variant`. +---- + .. _class_Geometry_method_segment_intersects_sphere: - :ref:`PoolVector3Array` **segment_intersects_sphere** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` sphere_position, :ref:`float` sphere_radius **)** Checks if the segment (``from``, ``to``) intersects the sphere that is located at ``sphere_position`` and has radius ``sphere_radius``. If no, returns an empty :ref:`PoolVector3Array`. If yes, returns a :ref:`PoolVector3Array` containing the point of intersection and the sphere's normal at the point of intersection. +---- + .. _class_Geometry_method_segment_intersects_triangle: - :ref:`Variant` **segment_intersects_triangle** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` a, :ref:`Vector3` b, :ref:`Vector3` c **)** Tests if the segment (``from``, ``to``) intersects the triangle ``a``, ``b``, ``c``. If yes, returns the point of intersection as :ref:`Vector3`. If no intersection takes place, an empty :ref:`Variant` is returned. +---- + .. _class_Geometry_method_triangulate_polygon: - :ref:`PoolIntArray` **triangulate_polygon** **(** :ref:`PoolVector2Array` polygon **)** diff --git a/classes/class_geometryinstance.rst b/classes/class_geometryinstance.rst index bda3044f5..f643022a6 100644 --- a/classes/class_geometryinstance.rst +++ b/classes/class_geometryinstance.rst @@ -68,7 +68,9 @@ Will not take culling into account, so all faces will be taken into account when - **SHADOW_CASTING_SETTING_SHADOWS_ONLY** = **3** --- Will only show the shadows casted from this object. -In other words: The actual mesh will not be visible, only the shadows casted from the mesh. +In other words, the actual mesh will not be visible, only the shadows casted from the mesh will be. + +---- .. _enum_GeometryInstance_Flags: @@ -78,7 +80,7 @@ In other words: The actual mesh will not be visible, only the shadows casted fro enum **Flags**: -- **FLAG_USE_BAKED_LIGHT** = **0** --- Will allow the GeometryInstance to be used when baking lights using a :ref:`GIProbe` and/or any other form of baked lighting. +- **FLAG_USE_BAKED_LIGHT** = **0** --- Will allow the GeometryInstance to be used when baking lights using a :ref:`GIProbe` or :ref:`BakedLightmap`. - **FLAG_MAX** = **2** --- Represents the size of the :ref:`Flags` enum. @@ -102,6 +104,8 @@ Property Descriptions The selected shadow casting flag. See :ref:`ShadowCastingSetting` for possible values. +---- + .. _class_GeometryInstance_property_extra_cull_margin: - :ref:`float` **extra_cull_margin** @@ -114,6 +118,8 @@ The selected shadow casting flag. See :ref:`ShadowCastingSetting`) to increase its cull box. +---- + .. _class_GeometryInstance_property_lod_max_distance: - :ref:`float` **lod_max_distance** @@ -126,6 +132,10 @@ The extra distance added to the GeometryInstance's bounding box (:ref:`AABB` **lod_max_hysteresis** @@ -138,6 +148,10 @@ The GeometryInstance's max LOD distance. The GeometryInstance's max LOD margin. +**Note:** This property currently has no effect. + +---- + .. _class_GeometryInstance_property_lod_min_distance: - :ref:`float` **lod_min_distance** @@ -150,6 +164,10 @@ The GeometryInstance's max LOD margin. The GeometryInstance's min LOD distance. +**Note:** This property currently has no effect. + +---- + .. _class_GeometryInstance_property_lod_min_hysteresis: - :ref:`float` **lod_min_hysteresis** @@ -162,6 +180,10 @@ The GeometryInstance's min LOD distance. The GeometryInstance's min LOD margin. +**Note:** This property currently has no effect. + +---- + .. _class_GeometryInstance_property_material_override: - :ref:`Material` **material_override** @@ -174,7 +196,9 @@ The GeometryInstance's min LOD margin. The material override for the whole geometry. -If there is a material in ``material_override``, it will be used instead of any material set in any material slot of the mesh. +If a material is assigned to this property, it will be used instead of any material set in any material slot of the mesh. + +---- .. _class_GeometryInstance_property_use_in_baked_light: @@ -186,5 +210,5 @@ If there is a material in ``material_override``, it will be used instead of any | *Getter* | get_flag() | +----------+-----------------+ -If ``true``, this GeometryInstance will be used when baking lights using a :ref:`GIProbe` and/or any other form of baked lighting. +If ``true``, this GeometryInstance will be used when baking lights using a :ref:`GIProbe` or :ref:`BakedLightmap`. diff --git a/classes/class_giprobe.rst b/classes/class_giprobe.rst index 371909782..a891a6253 100644 --- a/classes/class_giprobe.rst +++ b/classes/class_giprobe.rst @@ -97,6 +97,8 @@ Property Descriptions | *Getter* | get_bias() | +----------+-----------------+ +---- + .. _class_GIProbe_property_compress: - :ref:`bool` **compress** @@ -107,6 +109,8 @@ Property Descriptions | *Getter* | is_compressed() | +----------+---------------------+ +---- + .. _class_GIProbe_property_data: - :ref:`GIProbeData` **data** @@ -117,6 +121,8 @@ Property Descriptions | *Getter* | get_probe_data() | +----------+-----------------------+ +---- + .. _class_GIProbe_property_dynamic_range: - :ref:`int` **dynamic_range** @@ -127,6 +133,8 @@ Property Descriptions | *Getter* | get_dynamic_range() | +----------+--------------------------+ +---- + .. _class_GIProbe_property_energy: - :ref:`float` **energy** @@ -137,6 +145,8 @@ Property Descriptions | *Getter* | get_energy() | +----------+-------------------+ +---- + .. _class_GIProbe_property_extents: - :ref:`Vector3` **extents** @@ -147,6 +157,8 @@ Property Descriptions | *Getter* | get_extents() | +----------+--------------------+ +---- + .. _class_GIProbe_property_interior: - :ref:`bool` **interior** @@ -157,6 +169,8 @@ Property Descriptions | *Getter* | is_interior() | +----------+---------------------+ +---- + .. _class_GIProbe_property_normal_bias: - :ref:`float` **normal_bias** @@ -167,6 +181,8 @@ Property Descriptions | *Getter* | get_normal_bias() | +----------+------------------------+ +---- + .. _class_GIProbe_property_propagation: - :ref:`float` **propagation** @@ -177,6 +193,8 @@ Property Descriptions | *Getter* | get_propagation() | +----------+------------------------+ +---- + .. _class_GIProbe_property_subdiv: - :ref:`Subdiv` **subdiv** @@ -194,6 +212,8 @@ Method Descriptions - void **bake** **(** :ref:`Node` from_node=null, :ref:`bool` create_visual_debug=false **)** +---- + .. _class_GIProbe_method_debug_bake: - void **debug_bake** **(** **)** diff --git a/classes/class_giprobedata.rst b/classes/class_giprobedata.rst index 17cd2fd5d..7fdd8d229 100644 --- a/classes/class_giprobedata.rst +++ b/classes/class_giprobedata.rst @@ -58,6 +58,8 @@ Property Descriptions | *Getter* | get_bias() | +----------+-----------------+ +---- + .. _class_GIProbeData_property_bounds: - :ref:`AABB` **bounds** @@ -68,6 +70,8 @@ Property Descriptions | *Getter* | get_bounds() | +----------+-------------------+ +---- + .. _class_GIProbeData_property_cell_size: - :ref:`float` **cell_size** @@ -78,6 +82,8 @@ Property Descriptions | *Getter* | get_cell_size() | +----------+----------------------+ +---- + .. _class_GIProbeData_property_compress: - :ref:`bool` **compress** @@ -88,6 +94,8 @@ Property Descriptions | *Getter* | is_compressed() | +----------+---------------------+ +---- + .. _class_GIProbeData_property_dynamic_data: - :ref:`PoolIntArray` **dynamic_data** @@ -98,6 +106,8 @@ Property Descriptions | *Getter* | get_dynamic_data() | +----------+-------------------------+ +---- + .. _class_GIProbeData_property_dynamic_range: - :ref:`int` **dynamic_range** @@ -108,6 +118,8 @@ Property Descriptions | *Getter* | get_dynamic_range() | +----------+--------------------------+ +---- + .. _class_GIProbeData_property_energy: - :ref:`float` **energy** @@ -118,6 +130,8 @@ Property Descriptions | *Getter* | get_energy() | +----------+-------------------+ +---- + .. _class_GIProbeData_property_interior: - :ref:`bool` **interior** @@ -128,6 +142,8 @@ Property Descriptions | *Getter* | is_interior() | +----------+---------------------+ +---- + .. _class_GIProbeData_property_normal_bias: - :ref:`float` **normal_bias** @@ -138,6 +154,8 @@ Property Descriptions | *Getter* | get_normal_bias() | +----------+------------------------+ +---- + .. _class_GIProbeData_property_propagation: - :ref:`float` **propagation** @@ -148,6 +166,8 @@ Property Descriptions | *Getter* | get_propagation() | +----------+------------------------+ +---- + .. _class_GIProbeData_property_to_cell_xform: - :ref:`Transform` **to_cell_xform** diff --git a/classes/class_godotsharp.rst b/classes/class_godotsharp.rst index 67f0ce874..3d49870de 100644 --- a/classes/class_godotsharp.rst +++ b/classes/class_godotsharp.rst @@ -48,34 +48,48 @@ Method Descriptions Attaches the current thread to the mono runtime. +---- + .. _class_GodotSharp_method_detach_thread: - void **detach_thread** **(** **)** Detaches the current thread from the mono runtime. +---- + .. _class_GodotSharp_method_get_domain_id: - :ref:`int` **get_domain_id** **(** **)** +---- + .. _class_GodotSharp_method_get_scripts_domain_id: - :ref:`int` **get_scripts_domain_id** **(** **)** +---- + .. _class_GodotSharp_method_is_domain_finalizing_for_unload: - :ref:`bool` **is_domain_finalizing_for_unload** **(** :ref:`int` domain_id **)** Returns whether the domain is being finalized. +---- + .. _class_GodotSharp_method_is_runtime_initialized: - :ref:`bool` **is_runtime_initialized** **(** **)** +---- + .. _class_GodotSharp_method_is_runtime_shutting_down: - :ref:`bool` **is_runtime_shutting_down** **(** **)** +---- + .. _class_GodotSharp_method_is_scripts_domain_loaded: - :ref:`bool` **is_scripts_domain_loaded** **(** **)** diff --git a/classes/class_gradient.rst b/classes/class_gradient.rst index 334189991..d5baf1e78 100644 --- a/classes/class_gradient.rst +++ b/classes/class_gradient.rst @@ -68,6 +68,8 @@ Property Descriptions Gradient's colors returned as a :ref:`PoolColorArray`. +---- + .. _class_Gradient_property_offsets: - :ref:`PoolRealArray` **offsets** @@ -89,42 +91,56 @@ Method Descriptions Adds the specified color to the end of the ramp, with the specified offset +---- + .. _class_Gradient_method_get_color: - :ref:`Color` **get_color** **(** :ref:`int` point **)** const Returns the color of the ramp color at index *point* +---- + .. _class_Gradient_method_get_offset: - :ref:`float` **get_offset** **(** :ref:`int` point **)** const Returns the offset of the ramp color at index *point* +---- + .. _class_Gradient_method_get_point_count: - :ref:`int` **get_point_count** **(** **)** const Returns the number of colors in the ramp +---- + .. _class_Gradient_method_interpolate: - :ref:`Color` **interpolate** **(** :ref:`float` offset **)** Returns the interpolated color specified by *offset* +---- + .. _class_Gradient_method_remove_point: - void **remove_point** **(** :ref:`int` offset **)** Removes the color at the index *offset* +---- + .. _class_Gradient_method_set_color: - void **set_color** **(** :ref:`int` point, :ref:`Color` color **)** Sets the color of the ramp color at index *point* +---- + .. _class_Gradient_method_set_offset: - void **set_offset** **(** :ref:`int` point, :ref:`float` offset **)** diff --git a/classes/class_gradienttexture.rst b/classes/class_gradienttexture.rst index bb0646470..1b5fbef40 100644 --- a/classes/class_gradienttexture.rst +++ b/classes/class_gradienttexture.rst @@ -47,6 +47,8 @@ Property Descriptions The :ref:`Gradient` that will be used to fill the texture. +---- + .. _class_GradientTexture_property_width: - :ref:`int` **width** diff --git a/classes/class_graphedit.rst b/classes/class_graphedit.rst index 88524f6db..cc45b6410 100644 --- a/classes/class_graphedit.rst +++ b/classes/class_graphedit.rst @@ -106,52 +106,70 @@ Signals Signal sent at the beginning of a GraphNode movement. +---- + .. _class_GraphEdit_signal__end_node_move: - **_end_node_move** **(** **)** Signal sent at the end of a GraphNode movement. +---- + .. _class_GraphEdit_signal_connection_request: - **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_signal_connection_to_empty: - **connection_to_empty** **(** :ref:`String` from, :ref:`int` from_slot, :ref:`Vector2` release_position **)** +---- + .. _class_GraphEdit_signal_delete_nodes_request: - **delete_nodes_request** **(** **)** Signal sent when a GraphNode is attempted to be removed from the GraphEdit. +---- + .. _class_GraphEdit_signal_disconnection_request: - **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_signal_duplicate_nodes_request: - **duplicate_nodes_request** **(** **)** Signal sent when a GraphNode is attempted to be duplicated in the GraphEdit. +---- + .. _class_GraphEdit_signal_node_selected: - **node_selected** **(** :ref:`Node` node **)** Emitted when a GraphNode is selected. +---- + .. _class_GraphEdit_signal_popup_request: - **popup_request** **(** :ref:`Vector2` 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_signal_scroll_offset_changed: - **scroll_offset_changed** **(** :ref:`Vector2` ofs **)** @@ -178,6 +196,8 @@ Property Descriptions If ``true``, enables disconnection of existing connections in the GraphEdit by dragging the right end. +---- + .. _class_GraphEdit_property_scroll_offset: - :ref:`Vector2` **scroll_offset** @@ -190,6 +210,8 @@ If ``true``, enables disconnection of existing connections in the GraphEdit by d The scroll offset. +---- + .. _class_GraphEdit_property_snap_distance: - :ref:`int` **snap_distance** @@ -202,6 +224,8 @@ The scroll offset. The snapping distance in pixels. +---- + .. _class_GraphEdit_property_use_snap: - :ref:`bool` **use_snap** @@ -214,6 +238,8 @@ The snapping distance in pixels. If ``true``, enables snapping. +---- + .. _class_GraphEdit_property_zoom: - :ref:`float` **zoom** @@ -235,80 +261,108 @@ Method Descriptions Makes possible the connection between two different slot types. The type is defined with the :ref:`GraphNode.set_slot` method. +---- + .. _class_GraphEdit_method_add_valid_left_disconnect_type: - void **add_valid_left_disconnect_type** **(** :ref:`int` type **)** Makes possible to disconnect nodes when dragging from the slot at the left if it has the specified type. +---- + .. _class_GraphEdit_method_add_valid_right_disconnect_type: - void **add_valid_right_disconnect_type** **(** :ref:`int` type **)** Makes possible to disconnect nodes when dragging from the slot at the right if it has the specified type. +---- + .. _class_GraphEdit_method_clear_connections: - void **clear_connections** **(** **)** Remove all connections between nodes. +---- + .. _class_GraphEdit_method_connect_node: - :ref:`Error` **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_method_disconnect_node: - 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_method_get_connection_list: - :ref:`Array` **get_connection_list** **(** **)** const Returns an Array containing the list of connections. A connection consists in a structure of the form {from_port: 0, from: "GraphNode name 0", to_port: 1, to: "GraphNode name 1" } +---- + .. _class_GraphEdit_method_get_zoom_hbox: - :ref:`HBoxContainer` **get_zoom_hbox** **(** **)** +---- + .. _class_GraphEdit_method_is_node_connected: - :ref:`bool` **is_node_connected** **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** Returns ``true`` if the 'from_port' slot of 'from' GraphNode is connected to the 'to_port' slot of 'to' GraphNode. +---- + .. _class_GraphEdit_method_is_valid_connection_type: - :ref:`bool` **is_valid_connection_type** **(** :ref:`int` from_type, :ref:`int` to_type **)** const Returns whether it's possible to connect slots of the specified types. +---- + .. _class_GraphEdit_method_remove_valid_connection_type: - void **remove_valid_connection_type** **(** :ref:`int` from_type, :ref:`int` to_type **)** Makes it not possible to connect between two different slot types. The type is defined with the :ref:`GraphNode.set_slot` method. +---- + .. _class_GraphEdit_method_remove_valid_left_disconnect_type: - void **remove_valid_left_disconnect_type** **(** :ref:`int` type **)** Removes the possibility to disconnect nodes when dragging from the slot at the left if it has the specified type. +---- + .. _class_GraphEdit_method_remove_valid_right_disconnect_type: - void **remove_valid_right_disconnect_type** **(** :ref:`int` type **)** Removes the possibility to disconnect nodes when dragging from the slot at the right if it has the specified type. +---- + .. _class_GraphEdit_method_set_connection_activity: - void **set_connection_activity** **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port, :ref:`float` amount **)** +---- + .. _class_GraphEdit_method_set_selected: - void **set_selected** **(** :ref:`Node` node **)** diff --git a/classes/class_graphnode.rst b/classes/class_graphnode.rst index b2953adf7..e9132d07c 100644 --- a/classes/class_graphnode.rst +++ b/classes/class_graphnode.rst @@ -126,24 +126,32 @@ Signals Signal sent on closing the GraphNode. +---- + .. _class_GraphNode_signal_dragged: - **dragged** **(** :ref:`Vector2` from, :ref:`Vector2` to **)** Signal sent when the GraphNode is dragged. +---- + .. _class_GraphNode_signal_offset_changed: - **offset_changed** **(** **)** Signal sent when the GraphNode is moved. +---- + .. _class_GraphNode_signal_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_signal_resize_request: - **resize_request** **(** :ref:`Vector2` new_minsize **)** @@ -185,6 +193,8 @@ Property Descriptions | *Getter* | is_comment() | +----------+--------------------+ +---- + .. _class_GraphNode_property_offset: - :ref:`Vector2` **offset** @@ -197,6 +207,8 @@ Property Descriptions The offset of the GraphNode, relative to the scroll offset of the :ref:`GraphEdit`. Note that you cannot use position directly, as :ref:`GraphEdit` is a :ref:`Container`. +---- + .. _class_GraphNode_property_overlay: - :ref:`Overlay` **overlay** @@ -207,6 +219,8 @@ The offset of the GraphNode, relative to the scroll offset of the :ref:`GraphEdi | *Getter* | get_overlay() | +----------+--------------------+ +---- + .. _class_GraphNode_property_resizable: - :ref:`bool` **resizable** @@ -217,6 +231,8 @@ The offset of the GraphNode, relative to the scroll offset of the :ref:`GraphEdi | *Getter* | is_resizable() | +----------+----------------------+ +---- + .. _class_GraphNode_property_selected: - :ref:`bool` **selected** @@ -227,6 +243,8 @@ The offset of the GraphNode, relative to the scroll offset of the :ref:`GraphEdi | *Getter* | is_selected() | +----------+---------------------+ +---- + .. _class_GraphNode_property_show_close: - :ref:`bool` **show_close** @@ -237,6 +255,8 @@ The offset of the GraphNode, relative to the scroll offset of the :ref:`GraphEdi | *Getter* | is_close_button_visible() | +----------+------------------------------+ +---- + .. _class_GraphNode_property_title: - :ref:`String` **title** @@ -256,96 +276,128 @@ Method Descriptions Disable all input and output slots of the GraphNode. +---- + .. _class_GraphNode_method_clear_slot: - void **clear_slot** **(** :ref:`int` idx **)** Disable input and output slot whose index is 'idx'. +---- + .. _class_GraphNode_method_get_connection_input_color: - :ref:`Color` **get_connection_input_color** **(** :ref:`int` idx **)** Returns the color of the input connection 'idx'. +---- + .. _class_GraphNode_method_get_connection_input_count: - :ref:`int` **get_connection_input_count** **(** **)** Returns the number of enabled input slots (connections) to the GraphNode. +---- + .. _class_GraphNode_method_get_connection_input_position: - :ref:`Vector2` **get_connection_input_position** **(** :ref:`int` idx **)** Returns the position of the input connection 'idx'. +---- + .. _class_GraphNode_method_get_connection_input_type: - :ref:`int` **get_connection_input_type** **(** :ref:`int` idx **)** Returns the type of the input connection 'idx'. +---- + .. _class_GraphNode_method_get_connection_output_color: - :ref:`Color` **get_connection_output_color** **(** :ref:`int` idx **)** Returns the color of the output connection 'idx'. +---- + .. _class_GraphNode_method_get_connection_output_count: - :ref:`int` **get_connection_output_count** **(** **)** Returns the number of enabled output slots (connections) of the GraphNode. +---- + .. _class_GraphNode_method_get_connection_output_position: - :ref:`Vector2` **get_connection_output_position** **(** :ref:`int` idx **)** Returns the position of the output connection 'idx'. +---- + .. _class_GraphNode_method_get_connection_output_type: - :ref:`int` **get_connection_output_type** **(** :ref:`int` idx **)** Returns the type of the output connection 'idx'. +---- + .. _class_GraphNode_method_get_slot_color_left: - :ref:`Color` **get_slot_color_left** **(** :ref:`int` idx **)** const Returns the color set to 'idx' left (input) slot. +---- + .. _class_GraphNode_method_get_slot_color_right: - :ref:`Color` **get_slot_color_right** **(** :ref:`int` idx **)** const Returns the color set to 'idx' right (output) slot. +---- + .. _class_GraphNode_method_get_slot_type_left: - :ref:`int` **get_slot_type_left** **(** :ref:`int` idx **)** const Returns the (integer) type of left (input) 'idx' slot. +---- + .. _class_GraphNode_method_get_slot_type_right: - :ref:`int` **get_slot_type_right** **(** :ref:`int` idx **)** const Returns the (integer) type of right (output) 'idx' slot. +---- + .. _class_GraphNode_method_is_slot_enabled_left: - :ref:`bool` **is_slot_enabled_left** **(** :ref:`int` idx **)** const Returns ``true`` if left (input) slot 'idx' is enabled, ``false`` otherwise. +---- + .. _class_GraphNode_method_is_slot_enabled_right: - :ref:`bool` **is_slot_enabled_right** **(** :ref:`int` idx **)** const Returns ``true`` if right (output) slot 'idx' is enabled, ``false`` otherwise. +---- + .. _class_GraphNode_method_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 **)** diff --git a/classes/class_gridmap.rst b/classes/class_gridmap.rst index 90c340dc2..2634cb043 100644 --- a/classes/class_gridmap.rst +++ b/classes/class_gridmap.rst @@ -122,6 +122,8 @@ Property Descriptions If ``true``, grid items are centered on the X axis. +---- + .. _class_GridMap_property_cell_center_y: - :ref:`bool` **cell_center_y** @@ -134,6 +136,8 @@ If ``true``, grid items are centered on the X axis. If ``true``, grid items are centered on the Y axis. +---- + .. _class_GridMap_property_cell_center_z: - :ref:`bool` **cell_center_z** @@ -146,6 +150,8 @@ If ``true``, grid items are centered on the Y axis. If ``true``, grid items are centered on the Z axis. +---- + .. _class_GridMap_property_cell_octant_size: - :ref:`int` **cell_octant_size** @@ -158,6 +164,8 @@ If ``true``, grid items are centered on the Z axis. The size of each octant measured in number of cells. This applies to all three axis. +---- + .. _class_GridMap_property_cell_scale: - :ref:`float` **cell_scale** @@ -168,6 +176,8 @@ The size of each octant measured in number of cells. This applies to all three a | *Getter* | get_cell_scale() | +----------+-----------------------+ +---- + .. _class_GridMap_property_cell_size: - :ref:`Vector3` **cell_size** @@ -180,6 +190,8 @@ The size of each octant measured in number of cells. This applies to all three a The dimensions of the grid's cells. +---- + .. _class_GridMap_property_collision_layer: - :ref:`int` **collision_layer** @@ -190,6 +202,8 @@ The dimensions of the grid's cells. | *Getter* | get_collision_layer() | +----------+----------------------------+ +---- + .. _class_GridMap_property_collision_mask: - :ref:`int` **collision_mask** @@ -200,6 +214,8 @@ The dimensions of the grid's cells. | *Getter* | get_collision_mask() | +----------+---------------------------+ +---- + .. _class_GridMap_property_mesh_library: - :ref:`MeshLibrary` **mesh_library** @@ -212,6 +228,8 @@ The dimensions of the grid's cells. The assigned :ref:`MeshLibrary`. +---- + .. _class_GridMap_property_theme: - :ref:`MeshLibrary` **theme** @@ -233,62 +251,88 @@ Method Descriptions Clear all cells. +---- + .. _class_GridMap_method_clear_baked_meshes: - void **clear_baked_meshes** **(** **)** +---- + .. _class_GridMap_method_get_bake_mesh_instance: - :ref:`RID` **get_bake_mesh_instance** **(** :ref:`int` idx **)** +---- + .. _class_GridMap_method_get_bake_meshes: - :ref:`Array` **get_bake_meshes** **(** **)** +---- + .. _class_GridMap_method_get_cell_item: - :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, :ref:`INVALID_CELL_ITEM` will be returned. +---- + .. _class_GridMap_method_get_cell_item_orientation: - :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 returned if the cell is empty. +---- + .. _class_GridMap_method_get_collision_layer_bit: - :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const +---- + .. _class_GridMap_method_get_collision_mask_bit: - :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const +---- + .. _class_GridMap_method_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_method_get_used_cells: - :ref:`Array` **get_used_cells** **(** **)** const Array of :ref:`Vector3` with the non empty cell coordinates in the grid map. +---- + .. _class_GridMap_method_make_baked_meshes: - void **make_baked_meshes** **(** :ref:`bool` gen_lightmap_uv=false, :ref:`float` lightmap_uv_texel_size=0.1 **)** +---- + .. _class_GridMap_method_map_to_world: - :ref:`Vector3` **map_to_world** **(** :ref:`int` x, :ref:`int` y, :ref:`int` z **)** const +---- + .. _class_GridMap_method_resource_changed: - void **resource_changed** **(** :ref:`Resource` resource **)** +---- + .. _class_GridMap_method_set_cell_item: - void **set_cell_item** **(** :ref:`int` x, :ref:`int` y, :ref:`int` z, :ref:`int` item, :ref:`int` orientation=0 **)** @@ -299,18 +343,26 @@ A negative item index will clear the cell. Optionally, the item's orientation can be passed. +---- + .. _class_GridMap_method_set_clip: - void **set_clip** **(** :ref:`bool` enabled, :ref:`bool` clipabove=true, :ref:`int` floor=0, Vector3.Axis axis=0 **)** +---- + .. _class_GridMap_method_set_collision_layer_bit: - void **set_collision_layer_bit** **(** :ref:`int` bit, :ref:`bool` value **)** +---- + .. _class_GridMap_method_set_collision_mask_bit: - void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** +---- + .. _class_GridMap_method_world_to_map: - :ref:`Vector3` **world_to_map** **(** :ref:`Vector3` pos **)** const diff --git a/classes/class_groovejoint2d.rst b/classes/class_groovejoint2d.rst index f4519bfcd..c3f0ec733 100644 --- a/classes/class_groovejoint2d.rst +++ b/classes/class_groovejoint2d.rst @@ -47,6 +47,8 @@ Property Descriptions The body B's initial anchor position defined by the joint's origin and a local offset :ref:`initial_offset` along the joint's y axis (along the groove). Default value: ``25`` +---- + .. _class_GrooveJoint2D_property_length: - :ref:`float` **length** diff --git a/classes/class_heightmapshape.rst b/classes/class_heightmapshape.rst index 6922acc50..80f8f7b50 100644 --- a/classes/class_heightmapshape.rst +++ b/classes/class_heightmapshape.rst @@ -49,6 +49,8 @@ Property Descriptions Height map data, pool array must be of :ref:`map_width` \* :ref:`map_depth` size. +---- + .. _class_HeightMapShape_property_map_depth: - :ref:`int` **map_depth** @@ -61,6 +63,8 @@ Height map data, pool array must be of :ref:`map_width`. +---- + .. _class_HeightMapShape_property_map_width: - :ref:`int` **map_width** diff --git a/classes/class_hingejoint.rst b/classes/class_hingejoint.rst index 043a9ae0b..75dbfbb35 100644 --- a/classes/class_hingejoint.rst +++ b/classes/class_hingejoint.rst @@ -86,6 +86,8 @@ enum **Param**: - **PARAM_MAX** = **8** --- Represents the size of the :ref:`Param` enum. +---- + .. _enum_HingeJoint_Flag: .. _class_HingeJoint_constant_FLAG_USE_LIMIT: @@ -122,6 +124,8 @@ Property Descriptions The speed with which the rotation across the axis perpendicular to the hinge gets corrected. +---- + .. _class_HingeJoint_property_angular_limit/enable: - :ref:`bool` **angular_limit/enable** @@ -134,12 +138,16 @@ The speed with which the rotation across the axis perpendicular to the hinge get If ``true``, the hinges maximum and minimum rotation, defined by :ref:`angular_limit/lower` and :ref:`angular_limit/upper` has effects. +---- + .. _class_HingeJoint_property_angular_limit/lower: - :ref:`float` **angular_limit/lower** The minimum rotation. only active if :ref:`angular_limit/enable` is ``true``. +---- + .. _class_HingeJoint_property_angular_limit/relaxation: - :ref:`float` **angular_limit/relaxation** @@ -152,6 +160,8 @@ The minimum rotation. only active if :ref:`angular_limit/enable` **angular_limit/softness** @@ -162,12 +172,16 @@ The lower this value, the more the rotation gets slowed down. | *Getter* | get_param() | +----------+------------------+ +---- + .. _class_HingeJoint_property_angular_limit/upper: - :ref:`float` **angular_limit/upper** The maximum rotation. only active if :ref:`angular_limit/enable` is ``true``. +---- + .. _class_HingeJoint_property_motor/enable: - :ref:`bool` **motor/enable** @@ -180,6 +194,8 @@ The maximum rotation. only active if :ref:`angular_limit/enable` **motor/max_impulse** @@ -192,6 +208,8 @@ When activated, a motor turns the hinge. Maximum acceleration for the motor. +---- + .. _class_HingeJoint_property_motor/target_velocity: - :ref:`float` **motor/target_velocity** @@ -204,6 +222,8 @@ Maximum acceleration for the motor. Target speed for the motor. +---- + .. _class_HingeJoint_property_params/bias: - :ref:`float` **params/bias** diff --git a/classes/class_httpclient.rst b/classes/class_httpclient.rst index d7b0bed08..517225e9a 100644 --- a/classes/class_httpclient.rst +++ b/classes/class_httpclient.rst @@ -109,6 +109,8 @@ enum **Method**: - **METHOD_MAX** = **9** --- Represents the size of the :ref:`Method` enum. +---- + .. _enum_HTTPClient_Status: .. _class_HTTPClient_constant_STATUS_DISCONNECTED: @@ -153,6 +155,8 @@ enum **Status**: - **STATUS_SSL_HANDSHAKE_ERROR** = **9** --- Status: Error in SSL handshake. +---- + .. _enum_HTTPClient_ResponseCode: .. _class_HTTPClient_constant_RESPONSE_CONTINUE: @@ -434,6 +438,8 @@ Property Descriptions If ``true``, execution will block until all data is read from the response. +---- + .. _class_HTTPClient_property_connection: - :ref:`StreamPeer` **connection** @@ -455,6 +461,8 @@ Method Descriptions Closes the current connection, allowing reuse of this ``HTTPClient``. +---- + .. _class_HTTPClient_method_connect_to_host: - :ref:`Error` **connect_to_host** **(** :ref:`String` host, :ref:`int` port=-1, :ref:`bool` use_ssl=false, :ref:`bool` verify_host=true **)** @@ -467,24 +475,32 @@ If no ``port`` is specified (or ``-1`` is used), it is automatically set to 80 f ``verify_host`` will check the SSL identity of the host if set to ``true``. +---- + .. _class_HTTPClient_method_get_response_body_length: - :ref:`int` **get_response_body_length** **(** **)** const Returns the response's body length. +---- + .. _class_HTTPClient_method_get_response_code: - :ref:`int` **get_response_code** **(** **)** const Returns the response's HTTP status code. +---- + .. _class_HTTPClient_method_get_response_headers: - :ref:`PoolStringArray` **get_response_headers** **(** **)** Returns the response headers. +---- + .. _class_HTTPClient_method_get_response_headers_as_dictionary: - :ref:`Dictionary` **get_response_headers_as_dictionary** **(** **)** @@ -495,30 +511,40 @@ Structure: ("key":"value1; value2") Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) +---- + .. _class_HTTPClient_method_get_status: - :ref:`Status` **get_status** **(** **)** const Returns a STATUS\_\* enum constant. Need to call :ref:`poll` in order to get status updates. +---- + .. _class_HTTPClient_method_has_response: - :ref:`bool` **has_response** **(** **)** const If ``true``, this ``HTTPClient`` has a response available. +---- + .. _class_HTTPClient_method_is_response_chunked: - :ref:`bool` **is_response_chunked** **(** **)** const If ``true``, this ``HTTPClient`` has a response that is chunked. +---- + .. _class_HTTPClient_method_poll: - :ref:`Error` **poll** **(** **)** This needs to be called in order to have any request processed. Check results with :ref:`get_status` +---- + .. _class_HTTPClient_method_query_string_from_dict: - :ref:`String` **query_string_from_dict** **(** :ref:`Dictionary` fields **)** @@ -539,12 +565,16 @@ Furthermore, if a key has a null value, only the key itself is added, without eq String query_string = http_client.query_string_from_dict(fields) # returns: "single=123¬_valued&multiple=22&multiple=33&multiple=44" +---- + .. _class_HTTPClient_method_read_response_body_chunk: - :ref:`PoolByteArray` **read_response_body_chunk** **(** **)** Reads one chunk from the response. +---- + .. _class_HTTPClient_method_request: - :ref:`Error` **request** **(** :ref:`Method` method, :ref:`String` url, :ref:`PoolStringArray` headers, :ref:`String` body="" **)** @@ -562,6 +592,8 @@ To create a POST request with query strings to push to the server, do: var headers = ["Content-Type: application/x-www-form-urlencoded", "Content-Length: " + str(query_string.length())] var result = http_client.request(http_client.METHOD_POST, "index.php", headers, query_string) +---- + .. _class_HTTPClient_method_request_raw: - :ref:`Error` **request_raw** **(** :ref:`Method` method, :ref:`String` url, :ref:`PoolStringArray` headers, :ref:`PoolByteArray` body **)** @@ -572,6 +604,8 @@ Headers are HTTP request headers. For available HTTP methods, see ``METHOD_*``. Sends the body data raw, as a byte array and does not encode it in any way. +---- + .. _class_HTTPClient_method_set_read_chunk_size: - void **set_read_chunk_size** **(** :ref:`int` bytes **)** diff --git a/classes/class_httprequest.rst b/classes/class_httprequest.rst index 5480ffca5..e9f8ae35b 100644 --- a/classes/class_httprequest.rst +++ b/classes/class_httprequest.rst @@ -137,6 +137,8 @@ Property Descriptions Maximum allowed size for response bodies. +---- + .. _class_HTTPRequest_property_download_file: - :ref:`String` **download_file** @@ -149,6 +151,8 @@ Maximum allowed size for response bodies. The file to download into. Will output any received file into it. +---- + .. _class_HTTPRequest_property_max_redirects: - :ref:`int` **max_redirects** @@ -161,6 +165,8 @@ The file to download into. Will output any received file into it. Maximum number of allowed redirects. +---- + .. _class_HTTPRequest_property_use_threads: - :ref:`bool` **use_threads** @@ -182,24 +188,32 @@ Method Descriptions Cancels the current request. +---- + .. _class_HTTPRequest_method_get_body_size: - :ref:`int` **get_body_size** **(** **)** const Returns the response body length. +---- + .. _class_HTTPRequest_method_get_downloaded_bytes: - :ref:`int` **get_downloaded_bytes** **(** **)** const Returns the amount of bytes this HTTPRequest downloaded. +---- + .. _class_HTTPRequest_method_get_http_client_status: - :ref:`Status` **get_http_client_status** **(** **)** const Returns the current status of the underlying :ref:`HTTPClient`. See ``STATUS_*`` enum on :ref:`HTTPClient`. +---- + .. _class_HTTPRequest_method_request: - :ref:`Error` **request** **(** :ref:`String` url, :ref:`PoolStringArray` custom_headers=PoolStringArray( ), :ref:`bool` ssl_validate_domain=true, :ref:`Method` method=0, :ref:`String` request_data="" **)** diff --git a/classes/class_image.rst b/classes/class_image.rst index 6be75951c..6beab4205 100644 --- a/classes/class_image.rst +++ b/classes/class_image.rst @@ -289,6 +289,8 @@ enum **Format**: - **FORMAT_MAX** = **37** --- Represents the size of the :ref:`Format` enum. +---- + .. _enum_Image_Interpolation: .. _class_Image_constant_INTERPOLATE_NEAREST: @@ -315,6 +317,8 @@ If the image does not have mipmaps, they will be generated and used internally, On the other hand, if the image already has mipmaps, they will be used, and a new set will be generated for the resulting image. +---- + .. _enum_Image_AlphaMode: .. _class_Image_constant_ALPHA_NONE: @@ -331,6 +335,8 @@ enum **AlphaMode**: - **ALPHA_BLEND** = **2** +---- + .. _enum_Image_CompressMode: .. _class_Image_constant_COMPRESS_S3TC: @@ -355,6 +361,8 @@ enum **CompressMode**: - **COMPRESS_ETC2** = **4** +---- + .. _enum_Image_CompressSource: .. _class_Image_constant_COMPRESS_SOURCE_GENERIC: @@ -405,264 +413,354 @@ Method Descriptions Alpha-blends ``src_rect`` from ``src`` image to this image at coordinates ``dest``. +---- + .. _class_Image_method_blend_rect_mask: - void **blend_rect_mask** **(** :ref:`Image` src, :ref:`Image` mask, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** Alpha-blends ``src_rect`` from ``src`` image to this image using ``mask`` image at coordinates ``dst``. Alpha channels are required for both ``src`` and ``mask``. ``dst`` pixels and ``src`` pixels will blend if the corresponding mask pixel's alpha value is not 0. ``src`` image and ``mask`` image **must** have the same size (width and height) but they can have different formats. +---- + .. _class_Image_method_blit_rect: - void **blit_rect** **(** :ref:`Image` src, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** Copies ``src_rect`` from ``src`` image to this image at coordinates ``dst``. +---- + .. _class_Image_method_blit_rect_mask: - void **blit_rect_mask** **(** :ref:`Image` src, :ref:`Image` mask, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** Blits ``src_rect`` area from ``src`` image to this image at the coordinates given by ``dst``. ``src`` pixel is copied onto ``dst`` if the corresponding ``mask`` pixel's alpha value is not 0. ``src`` image and ``mask`` image **must** have the same size (width and height) but they can have different formats. +---- + .. _class_Image_method_bumpmap_to_normalmap: - void **bumpmap_to_normalmap** **(** :ref:`float` bump_scale=1.0 **)** +---- + .. _class_Image_method_clear_mipmaps: - void **clear_mipmaps** **(** **)** Removes the image's mipmaps. +---- + .. _class_Image_method_compress: - :ref:`Error` **compress** **(** :ref:`CompressMode` mode, :ref:`CompressSource` source, :ref:`float` lossy_quality **)** Compresses the image to use less memory. Can not directly access pixel data while the image is compressed. Returns error if the chosen compression mode is not available. See ``COMPRESS_*`` constants. +---- + .. _class_Image_method_convert: - void **convert** **(** :ref:`Format` format **)** Converts the image's format. See ``FORMAT_*`` constants. +---- + .. _class_Image_method_copy_from: - void **copy_from** **(** :ref:`Image` src **)** Copies ``src`` image to this image. +---- + .. _class_Image_method_create: - void **create** **(** :ref:`int` width, :ref:`int` height, :ref:`bool` use_mipmaps, :ref:`Format` format **)** Creates an empty image of given size and format. See ``FORMAT_*`` constants. If ``use_mipmaps`` is ``true`` then generate mipmaps for this image. See the ``generate_mipmaps`` method. +---- + .. _class_Image_method_create_from_data: - void **create_from_data** **(** :ref:`int` width, :ref:`int` height, :ref:`bool` use_mipmaps, :ref:`Format` format, :ref:`PoolByteArray` data **)** Creates a new image of given size and format. See ``FORMAT_*`` constants. Fills the image with the given raw data. If ``use_mipmaps`` is ``true`` then generate mipmaps for this image. See the ``generate_mipmaps`` method. +---- + .. _class_Image_method_crop: - void **crop** **(** :ref:`int` width, :ref:`int` height **)** Crops the image to the given ``width`` and ``height``. If the specified size is larger than the current size, the extra area is filled with black pixels. +---- + .. _class_Image_method_decompress: - :ref:`Error` **decompress** **(** **)** Decompresses the image if it is compressed. Returns an error if decompress function is not available. +---- + .. _class_Image_method_detect_alpha: - :ref:`AlphaMode` **detect_alpha** **(** **)** const Returns ALPHA_BLEND if the image has data for alpha values. Returns ALPHA_BIT if all the alpha values are below a certain threshold or the maximum value. Returns ALPHA_NONE if no data for alpha values is found. +---- + .. _class_Image_method_expand_x2_hq2x: - void **expand_x2_hq2x** **(** **)** Stretches the image and enlarges it by a factor of 2. No interpolation is done. +---- + .. _class_Image_method_fill: - void **fill** **(** :ref:`Color` color **)** Fills the image with a given :ref:`Color`. +---- + .. _class_Image_method_fix_alpha_edges: - void **fix_alpha_edges** **(** **)** Blends low-alpha pixels with nearby pixels. +---- + .. _class_Image_method_flip_x: - void **flip_x** **(** **)** Flips the image horizontally. +---- + .. _class_Image_method_flip_y: - void **flip_y** **(** **)** Flips the image vertically. +---- + .. _class_Image_method_generate_mipmaps: - :ref:`Error` **generate_mipmaps** **(** :ref:`bool` renormalize=false **)** Generates mipmaps for the image. Mipmaps are pre-calculated and lower resolution copies of the image. Mipmaps are automatically used if the image needs to be scaled down when rendered. This improves image quality and the performance of the rendering. Returns an error if the image is compressed, in a custom format or if the image's width/height is 0. +---- + .. _class_Image_method_get_data: - :ref:`PoolByteArray` **get_data** **(** **)** const Returns the image's raw data. +---- + .. _class_Image_method_get_format: - :ref:`Format` **get_format** **(** **)** const Returns the image's format. See ``FORMAT_*`` constants. +---- + .. _class_Image_method_get_height: - :ref:`int` **get_height** **(** **)** const Returns the image's height. +---- + .. _class_Image_method_get_mipmap_offset: - :ref:`int` **get_mipmap_offset** **(** :ref:`int` mipmap **)** const Returns the offset where the image's mipmap with index ``mipmap`` is stored in the ``data`` dictionary. +---- + .. _class_Image_method_get_pixel: - :ref:`Color` **get_pixel** **(** :ref:`int` x, :ref:`int` y **)** const Returns the color of the pixel at ``(x, y)`` if the image is locked. If the image is unlocked it always returns a :ref:`Color` with the value ``(0, 0, 0, 1.0)``. +---- + .. _class_Image_method_get_pixelv: - :ref:`Color` **get_pixelv** **(** :ref:`Vector2` src **)** const +---- + .. _class_Image_method_get_rect: - :ref:`Image` **get_rect** **(** :ref:`Rect2` rect **)** const Returns a new image that is a copy of the image's area specified with ``rect``. +---- + .. _class_Image_method_get_size: - :ref:`Vector2` **get_size** **(** **)** const Returns the image's size (width and height). +---- + .. _class_Image_method_get_used_rect: - :ref:`Rect2` **get_used_rect** **(** **)** const Returns a :ref:`Rect2` enclosing the visible portion of the image. +---- + .. _class_Image_method_get_width: - :ref:`int` **get_width** **(** **)** const Returns the image's width. +---- + .. _class_Image_method_has_mipmaps: - :ref:`bool` **has_mipmaps** **(** **)** const Returns ``true`` if the image has generated mipmaps. +---- + .. _class_Image_method_is_compressed: - :ref:`bool` **is_compressed** **(** **)** const Returns ``true`` if the image is compressed. +---- + .. _class_Image_method_is_empty: - :ref:`bool` **is_empty** **(** **)** const Returns ``true`` if the image has no data. +---- + .. _class_Image_method_is_invisible: - :ref:`bool` **is_invisible** **(** **)** const Returns ``true`` if all the image's pixels have an alpha value of 0. Returns ``false`` if any pixel has an alpha value higher than 0. +---- + .. _class_Image_method_load: - :ref:`Error` **load** **(** :ref:`String` path **)** Loads an image from file ``path``. +---- + .. _class_Image_method_load_jpg_from_buffer: - :ref:`Error` **load_jpg_from_buffer** **(** :ref:`PoolByteArray` buffer **)** Loads an image from the binary contents of a JPEG file. +---- + .. _class_Image_method_load_png_from_buffer: - :ref:`Error` **load_png_from_buffer** **(** :ref:`PoolByteArray` buffer **)** Loads an image from the binary contents of a PNG file. +---- + .. _class_Image_method_load_webp_from_buffer: - :ref:`Error` **load_webp_from_buffer** **(** :ref:`PoolByteArray` buffer **)** Loads an image from the binary contents of a WebP file. +---- + .. _class_Image_method_lock: - void **lock** **(** **)** Locks the data for reading and writing access. Sends an error to the console if the image is not locked when reading or writing a pixel. +---- + .. _class_Image_method_normalmap_to_xy: - void **normalmap_to_xy** **(** **)** Converts the image's data to represent coordinates on a 3D plane. This is used when the image represents a normalmap. A normalmap can add lots of detail to a 3D surface without increasing the polygon count. +---- + .. _class_Image_method_premultiply_alpha: - void **premultiply_alpha** **(** **)** Multiplies color values with alpha values. Resulting color values for a pixel are ``(color * alpha)/256``. +---- + .. _class_Image_method_resize: - void **resize** **(** :ref:`int` width, :ref:`int` height, :ref:`Interpolation` interpolation=1 **)** Resizes the image to the given ``width`` and ``height``. New pixels are calculated using ``interpolation``. See ``interpolation`` constants. +---- + .. _class_Image_method_resize_to_po2: - void **resize_to_po2** **(** :ref:`bool` square=false **)** Resizes the image to the nearest power of 2 for the width and height. If ``square`` is ``true`` then set width and height to be the same. +---- + .. _class_Image_method_rgbe_to_srgb: - :ref:`Image` **rgbe_to_srgb** **(** **)** +---- + .. _class_Image_method_save_png: - :ref:`Error` **save_png** **(** :ref:`String` path **)** const Saves the image as a PNG file to ``path``. +---- + .. _class_Image_method_set_pixel: - void **set_pixel** **(** :ref:`int` x, :ref:`int` y, :ref:`Color` color **)** @@ -678,22 +776,30 @@ Sets the :ref:`Color` of the pixel at ``(x, y)`` if the image is lo img.unlock() img.set_pixel(x, y, color) # Does not have an effect +---- + .. _class_Image_method_set_pixelv: - void **set_pixelv** **(** :ref:`Vector2` dst, :ref:`Color` color **)** +---- + .. _class_Image_method_shrink_x2: - void **shrink_x2** **(** **)** Shrinks the image by a factor of 2. +---- + .. _class_Image_method_srgb_to_linear: - void **srgb_to_linear** **(** **)** Converts the raw data from the sRGB colorspace to a linear scale. +---- + .. _class_Image_method_unlock: - void **unlock** **(** **)** diff --git a/classes/class_imagetexture.rst b/classes/class_imagetexture.rst index ad807ed71..bff672db5 100644 --- a/classes/class_imagetexture.rst +++ b/classes/class_imagetexture.rst @@ -83,6 +83,8 @@ Property Descriptions The storage quality for :ref:`STORAGE_COMPRESS_LOSSY`. +---- + .. _class_ImageTexture_property_storage: - :ref:`Storage` **storage** @@ -106,30 +108,40 @@ Create a new ``ImageTexture`` with ``width`` and ``height``. ``format`` is a value from :ref:`Format`, ``flags`` is any combination of :ref:`Flags`. +---- + .. _class_ImageTexture_method_create_from_image: - void **create_from_image** **(** :ref:`Image` image, :ref:`int` flags=7 **)** Create a new ``ImageTexture`` from an :ref:`Image` with ``flags`` from :ref:`Flags`. An sRGB to linear color space conversion can take place, according to :ref:`Format`. +---- + .. _class_ImageTexture_method_get_format: - :ref:`Format` **get_format** **(** **)** const Returns the format of the ``ImageTexture``, one of :ref:`Format`. +---- + .. _class_ImageTexture_method_load: - :ref:`Error` **load** **(** :ref:`String` path **)** Load an ``ImageTexture`` from a file path. +---- + .. _class_ImageTexture_method_set_data: - void **set_data** **(** :ref:`Image` image **)** Set the :ref:`Image` of this ``ImageTexture``. +---- + .. _class_ImageTexture_method_set_size_override: - void **set_size_override** **(** :ref:`Vector2` size **)** diff --git a/classes/class_immediategeometry.rst b/classes/class_immediategeometry.rst index 8f098bfb2..11be596fa 100644 --- a/classes/class_immediategeometry.rst +++ b/classes/class_immediategeometry.rst @@ -57,12 +57,16 @@ Method Descriptions Simple helper to draw a uvsphere, with given latitudes, longitude and radius. +---- + .. _class_ImmediateGeometry_method_add_vertex: - void **add_vertex** **(** :ref:`Vector3` position **)** Adds a vertex with the currently set color/uv/etc. +---- + .. _class_ImmediateGeometry_method_begin: - void **begin** **(** :ref:`PrimitiveType` primitive, :ref:`Texture` texture=null **)** @@ -71,42 +75,56 @@ Begin drawing (And optionally pass a texture override). When done call end(). Fo For the type of primitive, use the :ref:`Mesh`.PRIMITIVE\_\* enumerations. +---- + .. _class_ImmediateGeometry_method_clear: - void **clear** **(** **)** Clears everything that was drawn using begin/end. +---- + .. _class_ImmediateGeometry_method_end: - void **end** **(** **)** Ends a drawing context and displays the results. +---- + .. _class_ImmediateGeometry_method_set_color: - void **set_color** **(** :ref:`Color` color **)** The current drawing color. +---- + .. _class_ImmediateGeometry_method_set_normal: - void **set_normal** **(** :ref:`Vector3` normal **)** The next vertex's normal. +---- + .. _class_ImmediateGeometry_method_set_tangent: - void **set_tangent** **(** :ref:`Plane` tangent **)** The next vertex's tangent (and binormal facing). +---- + .. _class_ImmediateGeometry_method_set_uv: - void **set_uv** **(** :ref:`Vector2` uv **)** The next vertex's UV. +---- + .. _class_ImmediateGeometry_method_set_uv2: - void **set_uv2** **(** :ref:`Vector2` uv **)** diff --git a/classes/class_input.rst b/classes/class_input.rst index 45787ac56..148adaf11 100644 --- a/classes/class_input.rst +++ b/classes/class_input.rst @@ -23,83 +23,87 @@ A Singleton that deals with inputs. Methods ------- -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`action_press` **(** :ref:`String` action, :ref:`float` strength=1.0 **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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:`float` | :ref:`get_action_strength` **(** :ref:`String` action **)** 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:`MouseMode` | :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:`CursorShape` shape=0, :ref:`Vector2` hotspot=Vector2( 0, 0 ) **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_default_cursor_shape` **(** :ref:`CursorShape` shape=0 **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mouse_mode` **(** :ref:`MouseMode` mode **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_accumulated_input` **(** :ref:`bool` enable **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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, :ref:`float` strength=1.0 **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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:`float` | :ref:`get_action_strength` **(** :ref:`String` action **)** const | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_connected_joypads` **(** **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`CursorShape` | :ref:`get_current_cursor_shape` **(** **)** const | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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:`MouseMode` | :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:`CursorShape` shape=0, :ref:`Vector2` hotspot=Vector2( 0, 0 ) **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_default_cursor_shape` **(** :ref:`CursorShape` shape=0 **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_mouse_mode` **(** :ref:`MouseMode` mode **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_accumulated_input` **(** :ref:`bool` enable **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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:`vibrate_handheld` **(** :ref:`int` duration_ms=500 **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`warp_mouse_position` **(** :ref:`Vector2` to **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -133,6 +137,8 @@ enum **MouseMode**: - **MOUSE_MODE_CONFINED** = **3** --- Makes the mouse cursor visible but confines it to the game window. +---- + .. _enum_Input_CursorShape: .. _class_Input_constant_CURSOR_ARROW: @@ -226,18 +232,26 @@ This will simulate pressing the specified action. The strength can be used for non-boolean actions, it's ranged between 0 and 1 representing the intensity of the given action. +**Note:** This method will not cause any :ref:`Node._input` calls. It is intended to be used with :ref:`is_action_pressed` and :ref:`is_action_just_pressed`. If you want to simulate ``_input``, use :ref:`parse_input_event` instead. + +---- + .. _class_Input_method_action_release: - void **action_release** **(** :ref:`String` action **)** If the specified action is already pressed, this will release it. +---- + .. _class_Input_method_add_joy_mapping: - 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_method_get_accelerometer: - :ref:`Vector3` **get_accelerometer** **(** **)** const @@ -246,108 +260,150 @@ If the device has an accelerometer, this will return the acceleration. Otherwise Note this method returns an empty :ref:`Vector3` when running from the editor even when your device has an accelerometer. You must export your project to a supported device to read values from the accelerometer. +---- + .. _class_Input_method_get_action_strength: - :ref:`float` **get_action_strength** **(** :ref:`String` action **)** const Returns a value between 0 and 1 representing the intensity of the given action. In a joypad, for example, the further away the axis (analog sticks or L2, R2 triggers) is from the dead zone, the closer the value will be to 1. If the action is mapped to a control that has no axis as the keyboard, the value returned will be 0 or 1. +---- + .. _class_Input_method_get_connected_joypads: - :ref:`Array` **get_connected_joypads** **(** **)** Returns an :ref:`Array` containing the device IDs of all currently connected joypads. +---- + +.. _class_Input_method_get_current_cursor_shape: + +- :ref:`CursorShape` **get_current_cursor_shape** **(** **)** const + +---- + .. _class_Input_method_get_gravity: - :ref:`Vector3` **get_gravity** **(** **)** const If the device has an accelerometer, this will return the gravity. Otherwise, it returns an empty :ref:`Vector3`. +---- + .. _class_Input_method_get_gyroscope: - :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. Otherwise, it returns an empty :ref:`Vector3`. +---- + .. _class_Input_method_get_joy_axis: - :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:`@GlobalScope`) +---- + .. _class_Input_method_get_joy_axis_index_from_string: - :ref:`int` **get_joy_axis_index_from_string** **(** :ref:`String` axis **)** Returns the index of the provided axis name. +---- + .. _class_Input_method_get_joy_axis_string: - :ref:`String` **get_joy_axis_string** **(** :ref:`int` axis_index **)** Receives a ``JOY_AXIS_*`` Enum and returns its equivalent name as a string. +---- + .. _class_Input_method_get_joy_button_index_from_string: - :ref:`int` **get_joy_button_index_from_string** **(** :ref:`String` button **)** Returns the index of the provided button name. +---- + .. _class_Input_method_get_joy_button_string: - :ref:`String` **get_joy_button_string** **(** :ref:`int` button_index **)** Receives a ``JOY_BUTTON_*`` Enum and returns its equivalent name as a string. +---- + .. _class_Input_method_get_joy_guid: - :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_method_get_joy_name: - :ref:`String` **get_joy_name** **(** :ref:`int` device **)** Returns the name of the joypad at the specified device index +---- + .. _class_Input_method_get_joy_vibration_duration: - :ref:`float` **get_joy_vibration_duration** **(** :ref:`int` device **)** Returns the duration of the current vibration effect in seconds. +---- + .. _class_Input_method_get_joy_vibration_strength: - :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_method_get_last_mouse_speed: - :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_method_get_magnetometer: - :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_method_get_mouse_button_mask: - :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_method_get_mouse_mode: - :ref:`MouseMode` **get_mouse_mode** **(** **)** const Returns the mouse mode. See the constants for more information. +---- + .. _class_Input_method_is_action_just_pressed: - :ref:`bool` **is_action_just_pressed** **(** :ref:`String` action **)** const @@ -356,17 +412,23 @@ Returns ``true`` when the user starts pressing the action event, meaning it's `` This is useful for code that needs to run only once when an action is pressed, instead of every frame while it's pressed. +---- + .. _class_Input_method_is_action_just_released: - :ref:`bool` **is_action_just_released** **(** :ref:`String` action **)** const Returns ``true`` when the user stops pressing the action event, meaning it's ``true`` only on the frame that the user released the button. +---- + .. _class_Input_method_is_action_pressed: - :ref:`bool` **is_action_pressed** **(** :ref:`String` action **)** const -Returns ``true`` if you are pressing the action event. +Returns ``true`` if you are pressing the action event. Note that if an action has multiple buttons asigned and more than one of them is pressed, releasing one button will release the action, even if some other button assigned to this action is still pressed. + +---- .. _class_Input_method_is_joy_button_pressed: @@ -374,33 +436,54 @@ Returns ``true`` if you are pressing the action event. Returns ``true`` if you are pressing the joypad button. (see ``JOY_*`` constants in :ref:`@GlobalScope`) +---- + .. _class_Input_method_is_joy_known: - :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:`@GlobalScope`). Unknown joypads are not expected to match these constants, but you can still retrieve events from them. +---- + .. _class_Input_method_is_key_pressed: - :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:`@GlobalScope`. +---- + .. _class_Input_method_is_mouse_button_pressed: - :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:`@GlobalScope`. +---- + .. _class_Input_method_joy_connection_changed: - void **joy_connection_changed** **(** :ref:`int` device, :ref:`bool` connected, :ref:`String` name, :ref:`String` guid **)** +---- + .. _class_Input_method_parse_input_event: - void **parse_input_event** **(** :ref:`InputEvent` event **)** -Feeds an :ref:`InputEvent` to the game. Can be used to artificially trigger input events from code. +Feeds an :ref:`InputEvent` to the game. Can be used to artificially trigger input events from code. Also generates :ref:`Node._input` calls. + +Example: + +:: + + var a = InputEventAction.new() + a.action = "ui_cancel" + a.pressed = true + Input.parse_input_event(a) + +---- .. _class_Input_method_remove_joy_mapping: @@ -408,6 +491,8 @@ Feeds an :ref:`InputEvent` to the game. Can be used to artific Removes all mappings from the internal db that match the given uid. +---- + .. _class_Input_method_set_custom_mouse_cursor: - void **set_custom_mouse_cursor** **(** :ref:`Resource` image, :ref:`CursorShape` shape=0, :ref:`Vector2` hotspot=Vector2( 0, 0 ) **)** @@ -418,13 +503,19 @@ Sets a custom mouse cursor image, which is only visible inside the game window. ``hotspot`` must be within ``image``'s size. +---- + .. _class_Input_method_set_default_cursor_shape: - void **set_default_cursor_shape** **(** :ref:`CursorShape` shape=0 **)** Sets the default cursor shape to be used in the viewport instead of :ref:`CURSOR_ARROW`. -Note that if you want to change the default cursor shape for :ref:`Control`'s nodes, use :ref:`Control.mouse_default_cursor_shape` instead. +**Note:** If you want to change the default cursor shape for :ref:`Control`'s nodes, use :ref:`Control.mouse_default_cursor_shape` instead. + +**Note:** This method generates an :ref:`InputEventMouseMotion` to update cursor immediately. + +---- .. _class_Input_method_set_mouse_mode: @@ -432,12 +523,16 @@ Note that if you want to change the default cursor shape for :ref:`Control` enable **)** Whether to accumulate similar input events sent by the operating system. Defaults to ``true``. +---- + .. _class_Input_method_start_joy_vibration: - void **start_joy_vibration** **(** :ref:`int` device, :ref:`float` weak_magnitude, :ref:`float` strong_magnitude, :ref:`float` duration=0 **)** @@ -446,12 +541,26 @@ Starts to vibrate the joypad. Joypads usually come with two rumble motors, a str Note that not every hardware is compatible with long effect durations, it is recommended to restart an effect if in need to play it for more than a few seconds. +---- + .. _class_Input_method_stop_joy_vibration: - void **stop_joy_vibration** **(** :ref:`int` device **)** Stops the vibration of the joypad. +---- + +.. _class_Input_method_vibrate_handheld: + +- void **vibrate_handheld** **(** :ref:`int` duration_ms=500 **)** + +Vibrate Android and iOS devices. + +**Note:** It needs VIBRATE permission for Android at export settings. iOS does not support duration. + +---- + .. _class_Input_method_warp_mouse_position: - void **warp_mouse_position** **(** :ref:`Vector2` to **)** diff --git a/classes/class_inputevent.rst b/classes/class_inputevent.rst index e23590962..65138cfa3 100644 --- a/classes/class_inputevent.rst +++ b/classes/class_inputevent.rst @@ -92,60 +92,80 @@ Returns ``true`` if the given input event and this input event can be added toge The given input event's position, global position and speed will be copied. The resulting ``relative`` is a sum of both events. Both events' modifiers have to be identical. +---- + .. _class_InputEvent_method_as_text: - :ref:`String` **as_text** **(** **)** const Returns a :ref:`String` representation of the event. +---- + .. _class_InputEvent_method_get_action_strength: - :ref:`float` **get_action_strength** **(** :ref:`String` action **)** const Returns a value between 0.0 and 1.0 depending on the given actions' state. Useful for getting the value of events of type :ref:`InputEventJoypadMotion`. +---- + .. _class_InputEvent_method_is_action: - :ref:`bool` **is_action** **(** :ref:`String` action **)** const Returns ``true`` if this input event matches a pre-defined action of any type. +---- + .. _class_InputEvent_method_is_action_pressed: - :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 :ref:`InputEventKey` events). Not relevant for events of type :ref:`InputEventMouseMotion` or :ref:`InputEventScreenDrag`. +---- + .. _class_InputEvent_method_is_action_released: - :ref:`bool` **is_action_released** **(** :ref:`String` action **)** const Returns ``true`` if the given action is released (i.e. not pressed). Not relevant for events of type :ref:`InputEventMouseMotion` or :ref:`InputEventScreenDrag`. +---- + .. _class_InputEvent_method_is_action_type: - :ref:`bool` **is_action_type** **(** **)** const Returns ``true`` if this input event's type is one that can be assigned to an input action. +---- + .. _class_InputEvent_method_is_echo: - :ref:`bool` **is_echo** **(** **)** const Returns ``true`` if this input event is an echo event (only for events of type :ref:`InputEventKey`). +---- + .. _class_InputEvent_method_is_pressed: - :ref:`bool` **is_pressed** **(** **)** const Returns ``true`` if this input event is pressed. Not relevant for events of type :ref:`InputEventMouseMotion` or :ref:`InputEventScreenDrag`. +---- + .. _class_InputEvent_method_shortcut_match: - :ref:`bool` **shortcut_match** **(** :ref:`InputEvent` event **)** const Returns ``true`` if the given input event is checking for the same key (:ref:`InputEventKey`), button (:ref:`InputEventJoypadButton`) or action (:ref:`InputEventAction`). +---- + .. _class_InputEvent_method_xformed_by: - :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 7cb008359..a38509ed3 100644 --- a/classes/class_inputeventaction.rst +++ b/classes/class_inputeventaction.rst @@ -52,6 +52,8 @@ Property Descriptions The action's name. Actions are accessed via this :ref:`String`. +---- + .. _class_InputEventAction_property_pressed: - :ref:`bool` **pressed** diff --git a/classes/class_inputeventjoypadbutton.rst b/classes/class_inputeventjoypadbutton.rst index 0c5ed47d7..7f5427560 100644 --- a/classes/class_inputeventjoypadbutton.rst +++ b/classes/class_inputeventjoypadbutton.rst @@ -54,6 +54,8 @@ Property Descriptions Button identifier. One of the ``JOY_BUTTON_*`` constants from :ref:`@GlobalScope`. +---- + .. _class_InputEventJoypadButton_property_pressed: - :ref:`bool` **pressed** @@ -66,6 +68,8 @@ Button identifier. One of the ``JOY_BUTTON_*`` constants from :ref:`@GlobalScope If ``true``, the button's state is pressed. If ``false``, the button's state is released. +---- + .. _class_InputEventJoypadButton_property_pressure: - :ref:`float` **pressure** diff --git a/classes/class_inputeventjoypadmotion.rst b/classes/class_inputeventjoypadmotion.rst index 483374e3a..6e1054450 100644 --- a/classes/class_inputeventjoypadmotion.rst +++ b/classes/class_inputeventjoypadmotion.rst @@ -52,6 +52,8 @@ Property Descriptions Axis identifier. Use one of the ``JOY_AXIS_*`` constants in :ref:`@GlobalScope`. +---- + .. _class_InputEventJoypadMotion_property_axis_value: - :ref:`float` **axis_value** diff --git a/classes/class_inputeventkey.rst b/classes/class_inputeventkey.rst index a48303637..018e32c9e 100644 --- a/classes/class_inputeventkey.rst +++ b/classes/class_inputeventkey.rst @@ -63,6 +63,8 @@ Property Descriptions If ``true``, the key was already pressed before this event. It means the user is holding the key down. +---- + .. _class_InputEventKey_property_pressed: - :ref:`bool` **pressed** @@ -75,6 +77,8 @@ If ``true``, the key was already pressed before this event. It means the user is If ``true``, the key's state is pressed. If ``false``, the key's state is released. +---- + .. _class_InputEventKey_property_scancode: - :ref:`int` **scancode** @@ -87,6 +91,8 @@ If ``true``, the key's state is pressed. If ``false``, the key's state is releas Key scancode, one of the ``KEY_*`` constants in :ref:`@GlobalScope`. +---- + .. _class_InputEventKey_property_unicode: - :ref:`int` **unicode** diff --git a/classes/class_inputeventmidi.rst b/classes/class_inputeventmidi.rst index 82bfcacc9..41d2f56ce 100644 --- a/classes/class_inputeventmidi.rst +++ b/classes/class_inputeventmidi.rst @@ -52,6 +52,8 @@ Property Descriptions | *Getter* | get_channel() | +----------+--------------------+ +---- + .. _class_InputEventMIDI_property_controller_number: - :ref:`int` **controller_number** @@ -62,6 +64,8 @@ Property Descriptions | *Getter* | get_controller_number() | +----------+------------------------------+ +---- + .. _class_InputEventMIDI_property_controller_value: - :ref:`int` **controller_value** @@ -72,6 +76,8 @@ Property Descriptions | *Getter* | get_controller_value() | +----------+-----------------------------+ +---- + .. _class_InputEventMIDI_property_instrument: - :ref:`int` **instrument** @@ -82,6 +88,8 @@ Property Descriptions | *Getter* | get_instrument() | +----------+-----------------------+ +---- + .. _class_InputEventMIDI_property_message: - :ref:`int` **message** @@ -92,6 +100,8 @@ Property Descriptions | *Getter* | get_message() | +----------+--------------------+ +---- + .. _class_InputEventMIDI_property_pitch: - :ref:`int` **pitch** @@ -102,6 +112,8 @@ Property Descriptions | *Getter* | get_pitch() | +----------+------------------+ +---- + .. _class_InputEventMIDI_property_pressure: - :ref:`int` **pressure** @@ -112,6 +124,8 @@ Property Descriptions | *Getter* | get_pressure() | +----------+---------------------+ +---- + .. _class_InputEventMIDI_property_velocity: - :ref:`int` **velocity** diff --git a/classes/class_inputeventmouse.rst b/classes/class_inputeventmouse.rst index 610ccd0f0..3088ce548 100644 --- a/classes/class_inputeventmouse.rst +++ b/classes/class_inputeventmouse.rst @@ -56,6 +56,8 @@ Property Descriptions Mouse button mask identifier, one of or a bitwise combination of the BUTTON_MASK\_\* constants in :ref:`@GlobalScope`. +---- + .. _class_InputEventMouse_property_global_position: - :ref:`Vector2` **global_position** @@ -68,6 +70,8 @@ Mouse button mask identifier, one of or a bitwise combination of the BUTTON_MASK Mouse position relative to the current :ref:`Viewport` when used in :ref:`Control._gui_input`, otherwise is at 0,0. +---- + .. _class_InputEventMouse_property_position: - :ref:`Vector2` **position** diff --git a/classes/class_inputeventmousebutton.rst b/classes/class_inputeventmousebutton.rst index 8785e0e7c..9d1f78090 100644 --- a/classes/class_inputeventmousebutton.rst +++ b/classes/class_inputeventmousebutton.rst @@ -56,6 +56,8 @@ Property Descriptions Mouse button identifier, one of the BUTTON\_\* or BUTTON_WHEEL\_\* constants in :ref:`@GlobalScope`. +---- + .. _class_InputEventMouseButton_property_doubleclick: - :ref:`bool` **doubleclick** @@ -68,6 +70,8 @@ Mouse button identifier, one of the BUTTON\_\* or BUTTON_WHEEL\_\* constants in If ``true``, the mouse button's state is a double-click. +---- + .. _class_InputEventMouseButton_property_factor: - :ref:`float` **factor** @@ -80,6 +84,8 @@ If ``true``, the mouse button's state is a double-click. Magnitude. Amount (or delta) of the event. Used for scroll events, indicates scroll amount (vertically or horizontally). Only supported on some platforms, sensitivity varies by platform. May be 0 if not supported. +---- + .. _class_InputEventMouseButton_property_pressed: - :ref:`bool` **pressed** diff --git a/classes/class_inputeventmousemotion.rst b/classes/class_inputeventmousemotion.rst index 3a881160b..5caa938bd 100644 --- a/classes/class_inputeventmousemotion.rst +++ b/classes/class_inputeventmousemotion.rst @@ -52,6 +52,8 @@ Property Descriptions Mouse position relative to the previous position (position at the last frame). +---- + .. _class_InputEventMouseMotion_property_speed: - :ref:`Vector2` **speed** diff --git a/classes/class_inputeventscreendrag.rst b/classes/class_inputeventscreendrag.rst index f75a3b1b3..ac44cf444 100644 --- a/classes/class_inputeventscreendrag.rst +++ b/classes/class_inputeventscreendrag.rst @@ -58,6 +58,8 @@ Property Descriptions Drag event index in the case of a multi-drag event. +---- + .. _class_InputEventScreenDrag_property_position: - :ref:`Vector2` **position** @@ -70,6 +72,8 @@ Drag event index in the case of a multi-drag event. Drag position. +---- + .. _class_InputEventScreenDrag_property_relative: - :ref:`Vector2` **relative** @@ -82,6 +86,8 @@ Drag position. Drag position relative to its start position. +---- + .. _class_InputEventScreenDrag_property_speed: - :ref:`Vector2` **speed** diff --git a/classes/class_inputeventscreentouch.rst b/classes/class_inputeventscreentouch.rst index 8ff2dfcd2..900c586b1 100644 --- a/classes/class_inputeventscreentouch.rst +++ b/classes/class_inputeventscreentouch.rst @@ -56,6 +56,8 @@ Property Descriptions Touch index in the case of a multi-touch event. One index = one finger. +---- + .. _class_InputEventScreenTouch_property_position: - :ref:`Vector2` **position** @@ -68,6 +70,8 @@ Touch index in the case of a multi-touch event. One index = one finger. Touch position. +---- + .. _class_InputEventScreenTouch_property_pressed: - :ref:`bool` **pressed** diff --git a/classes/class_inputeventwithmodifiers.rst b/classes/class_inputeventwithmodifiers.rst index ef51d72af..f11464b19 100644 --- a/classes/class_inputeventwithmodifiers.rst +++ b/classes/class_inputeventwithmodifiers.rst @@ -60,6 +60,8 @@ Property Descriptions State of the ``Alt`` modifier. +---- + .. _class_InputEventWithModifiers_property_command: - :ref:`bool` **command** @@ -72,6 +74,8 @@ State of the ``Alt`` modifier. State of the ``Command`` modifier. +---- + .. _class_InputEventWithModifiers_property_control: - :ref:`bool` **control** @@ -84,6 +88,8 @@ State of the ``Command`` modifier. State of the ``Ctrl`` modifier. +---- + .. _class_InputEventWithModifiers_property_meta: - :ref:`bool` **meta** @@ -96,6 +102,8 @@ State of the ``Ctrl`` modifier. State of the ``Meta`` modifier. +---- + .. _class_InputEventWithModifiers_property_shift: - :ref:`bool` **shift** diff --git a/classes/class_inputmap.rst b/classes/class_inputmap.rst index 39469f388..77f30a568 100644 --- a/classes/class_inputmap.rst +++ b/classes/class_inputmap.rst @@ -66,28 +66,38 @@ Method Descriptions Adds an :ref:`InputEvent` to an action. This :ref:`InputEvent` will trigger the action. +---- + .. _class_InputMap_method_action_erase_event: - void **action_erase_event** **(** :ref:`String` action, :ref:`InputEvent` event **)** Removes an :ref:`InputEvent` from an action. +---- + .. _class_InputMap_method_action_erase_events: - void **action_erase_events** **(** :ref:`String` action **)** Removes all events from an action. +---- + .. _class_InputMap_method_action_has_event: - :ref:`bool` **action_has_event** **(** :ref:`String` action, :ref:`InputEvent` event **)** Returns ``true`` if the action has the given :ref:`InputEvent` associated with it. +---- + .. _class_InputMap_method_action_set_deadzone: - void **action_set_deadzone** **(** :ref:`String` action, :ref:`float` deadzone **)** +---- + .. _class_InputMap_method_add_action: - void **add_action** **(** :ref:`String` action, :ref:`float` deadzone=0.5 **)** @@ -96,36 +106,48 @@ Adds an empty action to the ``InputMap`` with a configurable ``deadzone``. An :ref:`InputEvent` can then be added to this action with :ref:`action_add_event`. +---- + .. _class_InputMap_method_erase_action: - void **erase_action** **(** :ref:`String` action **)** Removes an action from the ``InputMap``. +---- + .. _class_InputMap_method_event_is_action: - :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_method_get_action_list: - :ref:`Array` **get_action_list** **(** :ref:`String` action **)** Returns an array of :ref:`InputEvent`\ s associated with a given action. +---- + .. _class_InputMap_method_get_actions: - :ref:`Array` **get_actions** **(** **)** Returns an array of all actions in the ``InputMap``. +---- + .. _class_InputMap_method_has_action: - :ref:`bool` **has_action** **(** :ref:`String` action **)** const Returns ``true`` if the ``InputMap`` has a registered action with the given name. +---- + .. _class_InputMap_method_load_from_globals: - void **load_from_globals** **(** **)** diff --git a/classes/class_instanceplaceholder.rst b/classes/class_instanceplaceholder.rst index 823ecc559..a77112bd8 100644 --- a/classes/class_instanceplaceholder.rst +++ b/classes/class_instanceplaceholder.rst @@ -45,16 +45,22 @@ Method Descriptions - :ref:`Node` **create_instance** **(** :ref:`bool` replace=false, :ref:`PackedScene` custom_scene=null **)** +---- + .. _class_InstancePlaceholder_method_get_instance_path: - :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_method_get_stored_values: - :ref:`Dictionary` **get_stored_values** **(** :ref:`bool` with_order=false **)** +---- + .. _class_InstancePlaceholder_method_replace_by_instance: - void **replace_by_instance** **(** :ref:`PackedScene` custom_scene=null **)** diff --git a/classes/class_int.rst b/classes/class_int.rst index 77570e1f7..e59cd76cc 100644 --- a/classes/class_int.rst +++ b/classes/class_int.rst @@ -58,10 +58,14 @@ Method Descriptions Cast a :ref:`bool` value to an integer value, ``int(true)`` will be equals to 1 and ``int(false)`` will be equals to 0. +---- + - :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. +---- + - :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 80dd05c84..b27a70f6e 100644 --- a/classes/class_interpolatedcamera.rst +++ b/classes/class_interpolatedcamera.rst @@ -58,6 +58,8 @@ Property Descriptions If ``true``, and a target is set, the camera will move automatically. +---- + .. _class_InterpolatedCamera_property_speed: - :ref:`float` **speed** @@ -70,6 +72,8 @@ If ``true``, and a target is set, the camera will move automatically. How quickly the camera moves toward its target. Higher values will result in tighter camera motion. +---- + .. _class_InterpolatedCamera_property_target: - :ref:`NodePath` **target** diff --git a/classes/class_ip.rst b/classes/class_ip.rst index e2e7c64cd..fe774ec49 100644 --- a/classes/class_ip.rst +++ b/classes/class_ip.rst @@ -62,6 +62,8 @@ enum **ResolverStatus**: - **RESOLVER_STATUS_ERROR** = **3** --- DNS hostname resolver status: Error. +---- + .. _enum_IP_Type: .. _class_IP_constant_TYPE_NONE: @@ -107,36 +109,48 @@ Method Descriptions Removes all of a "hostname"'s cached references. If no "hostname" is given then all cached IP addresses are removed. +---- + .. _class_IP_method_erase_resolve_item: - 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_method_get_local_addresses: - :ref:`Array` **get_local_addresses** **(** **)** const Returns all of the user's current IPv4 and IPv6 addresses as an array. +---- + .. _class_IP_method_get_resolve_item_address: - :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_method_get_resolve_item_status: - :ref:`ResolverStatus` **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_method_resolve_hostname: - :ref:`String` **resolve_hostname** **(** :ref:`String` host, :ref:`Type` 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_method_resolve_hostname_queue_item: - :ref:`int` **resolve_hostname_queue_item** **(** :ref:`String` host, :ref:`Type` ip_type=3 **)** diff --git a/classes/class_itemlist.rst b/classes/class_itemlist.rst index 23fdc4343..b8b1fb0db 100644 --- a/classes/class_itemlist.rst +++ b/classes/class_itemlist.rst @@ -172,6 +172,8 @@ Signals Triggered when specified list item is activated via double click or Enter. +---- + .. _class_ItemList_signal_item_rmb_selected: - **item_rmb_selected** **(** :ref:`int` index, :ref:`Vector2` at_position **)** @@ -184,6 +186,8 @@ at the correct location. :ref:`allow_rmb_select` must be enabled. +---- + .. _class_ItemList_signal_item_selected: - **item_selected** **(** :ref:`int` index **)** @@ -192,18 +196,24 @@ Triggered when specified item has been selected. :ref:`allow_reselect` must be enabled to reselect an item. +---- + .. _class_ItemList_signal_multi_selected: - **multi_selected** **(** :ref:`int` index, :ref:`bool` selected **)** Triggered when a multiple selection is altered on a list allowing multiple selection. +---- + .. _class_ItemList_signal_nothing_selected: - **nothing_selected** **(** **)** Triggered when a left mouse click is issued within the rect of the list but on empty space. +---- + .. _class_ItemList_signal_rmb_clicked: - **rmb_clicked** **(** :ref:`Vector2` at_position **)** @@ -227,6 +237,8 @@ enum **IconMode**: - **ICON_MODE_LEFT** = **1** +---- + .. _enum_ItemList_SelectMode: .. _class_ItemList_constant_SELECT_SINGLE: @@ -261,6 +273,8 @@ Property Descriptions If ``true``, the currently selected item can be selected again. +---- + .. _class_ItemList_property_allow_rmb_select: - :ref:`bool` **allow_rmb_select** @@ -273,6 +287,8 @@ If ``true``, the currently selected item can be selected again. If ``true``, right mouse button click can select items. +---- + .. _class_ItemList_property_auto_height: - :ref:`bool` **auto_height** @@ -285,6 +301,8 @@ If ``true``, right mouse button click can select items. If ``true``, the control will automatically resize the height to fit its content. +---- + .. _class_ItemList_property_fixed_column_width: - :ref:`int` **fixed_column_width** @@ -299,6 +317,8 @@ Sets the default column width in pixels. If left to default value, each item will have a width equal to the width of its content and the columns will have an uneven width. +---- + .. _class_ItemList_property_fixed_icon_size: - :ref:`Vector2` **fixed_icon_size** @@ -311,6 +331,8 @@ If left to default value, each item will have a width equal to the width of its Sets the default icon size in pixels. +---- + .. _class_ItemList_property_icon_mode: - :ref:`IconMode` **icon_mode** @@ -323,6 +345,8 @@ Sets the default icon size in pixels. Sets the default position of the icon to either :ref:`ICON_MODE_LEFT` or :ref:`ICON_MODE_TOP`. +---- + .. _class_ItemList_property_icon_scale: - :ref:`float` **icon_scale** @@ -335,6 +359,8 @@ Sets the default position of the icon to either :ref:`ICON_MODE_LEFT` **max_columns** @@ -349,6 +375,8 @@ Sets the maximum columns the list will have. If set to anything other than the default, the content will be split among the specified columns. +---- + .. _class_ItemList_property_max_text_lines: - :ref:`int` **max_text_lines** @@ -359,6 +387,8 @@ If set to anything other than the default, the content will be split among the s | *Getter* | get_max_text_lines() | +----------+---------------------------+ +---- + .. _class_ItemList_property_same_column_width: - :ref:`bool` **same_column_width** @@ -371,6 +401,8 @@ If set to anything other than the default, the content will be split among the s If set to ``true``, all columns will have the same width specified by :ref:`fixed_column_width`. +---- + .. _class_ItemList_property_select_mode: - :ref:`SelectMode` **select_mode** @@ -392,6 +424,8 @@ Method Descriptions Adds an item to the item list with no text, only an icon. +---- + .. _class_ItemList_method_add_item: - void **add_item** **(** :ref:`String` text, :ref:`Texture` icon=null, :ref:`bool` selectable=true **)** @@ -400,134 +434,180 @@ Adds an item to the item list with specified text. Specify an icon of null for a If selectable is ``true`` the list item will be selectable. +---- + .. _class_ItemList_method_clear: - void **clear** **(** **)** Remove all items from the list. +---- + .. _class_ItemList_method_ensure_current_is_visible: - void **ensure_current_is_visible** **(** **)** Ensure current selection is visible, adjusting the scroll position as necessary. +---- + .. _class_ItemList_method_get_item_at_position: - :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_method_get_item_count: - :ref:`int` **get_item_count** **(** **)** const Returns the number of items currently in the list. +---- + .. _class_ItemList_method_get_item_custom_bg_color: - :ref:`Color` **get_item_custom_bg_color** **(** :ref:`int` idx **)** const Returns the :ref:`Color` set by :ref:`set_item_custom_bg_color`. Default value is ``Color(0, 0, 0, 0)``. +---- + .. _class_ItemList_method_get_item_custom_fg_color: - :ref:`Color` **get_item_custom_fg_color** **(** :ref:`int` idx **)** const Returns the :ref:`Color` set by :ref:`set_item_custom_fg_color`. Default value is ``Color(0, 0, 0, 0)``. +---- + .. _class_ItemList_method_get_item_icon: - :ref:`Texture` **get_item_icon** **(** :ref:`int` idx **)** const Returns the icon associated with the specified index. Default value is ``null``. +---- + .. _class_ItemList_method_get_item_icon_modulate: - :ref:`Color` **get_item_icon_modulate** **(** :ref:`int` idx **)** const Returns a :ref:`Color` modulating item's icon at the specified index. +---- + .. _class_ItemList_method_get_item_icon_region: - :ref:`Rect2` **get_item_icon_region** **(** :ref:`int` idx **)** const +---- + .. _class_ItemList_method_get_item_metadata: - :ref:`Variant` **get_item_metadata** **(** :ref:`int` idx **)** const Returns the metadata value of the specified index set by :ref:`set_item_metadata`. +---- + .. _class_ItemList_method_get_item_text: - :ref:`String` **get_item_text** **(** :ref:`int` idx **)** const Returns the text associated with the specified index. +---- + .. _class_ItemList_method_get_item_tooltip: - :ref:`String` **get_item_tooltip** **(** :ref:`int` idx **)** const Returns the tooltip hint associated with the specified index. +---- + .. _class_ItemList_method_get_selected_items: - :ref:`PoolIntArray` **get_selected_items** **(** **)** Returns an array with the indexes of the selected items. +---- + .. _class_ItemList_method_get_v_scroll: - :ref:`VScrollBar` **get_v_scroll** **(** **)** Returns the :ref:`Object` ID associated with the list. +---- + .. _class_ItemList_method_is_anything_selected: - :ref:`bool` **is_anything_selected** **(** **)** Returns ``true`` if one or more items are selected. +---- + .. _class_ItemList_method_is_item_disabled: - :ref:`bool` **is_item_disabled** **(** :ref:`int` idx **)** const Returns whether or not the item at the specified index is disabled. +---- + .. _class_ItemList_method_is_item_icon_transposed: - :ref:`bool` **is_item_icon_transposed** **(** :ref:`int` idx **)** const +---- + .. _class_ItemList_method_is_item_selectable: - :ref:`bool` **is_item_selectable** **(** :ref:`int` idx **)** const Returns whether or not the item at the specified index is selectable. +---- + .. _class_ItemList_method_is_item_tooltip_enabled: - :ref:`bool` **is_item_tooltip_enabled** **(** :ref:`int` idx **)** const Returns whether the tooltip is enabled for specified item index. +---- + .. _class_ItemList_method_is_selected: - :ref:`bool` **is_selected** **(** :ref:`int` idx **)** const Returns whether or not item at the specified index is currently selected. +---- + .. _class_ItemList_method_move_item: - void **move_item** **(** :ref:`int` from_idx, :ref:`int` to_idx **)** Moves item from index ``from_idx`` to ``to_idx``. +---- + .. _class_ItemList_method_remove_item: - void **remove_item** **(** :ref:`int` idx **)** Removes the item specified by ``idx`` index from the list. +---- + .. _class_ItemList_method_select: - void **select** **(** :ref:`int` idx, :ref:`bool` single=true **)** @@ -536,6 +616,8 @@ Select the item at the specified index. Note: This method does not trigger the item selection signal. +---- + .. _class_ItemList_method_set_item_custom_bg_color: - void **set_item_custom_bg_color** **(** :ref:`int` idx, :ref:`Color` custom_bg_color **)** @@ -547,6 +629,8 @@ Sets the background color of the item specified by ``idx`` index to the specifie var some_string = "Some text" some_string.set_item_custom_bg_color(0,Color(1, 0, 0, 1) # This will set the background color of the first item of the control to red. +---- + .. _class_ItemList_method_set_item_custom_fg_color: - void **set_item_custom_fg_color** **(** :ref:`int` idx, :ref:`Color` custom_fg_color **)** @@ -558,6 +642,8 @@ Sets the foreground color of the item specified by ``idx`` index to the specifie var some_string = "Some text" some_string.set_item_custom_fg_color(0,Color(1, 0, 0, 1) # This will set the foreground color of the first item of the control to red. +---- + .. _class_ItemList_method_set_item_disabled: - void **set_item_disabled** **(** :ref:`int` idx, :ref:`bool` disabled **)** @@ -566,68 +652,92 @@ Disable (or enable) item at the specified index. Disabled items are not be selectable and do not trigger activation (Enter or double-click) signals. +---- + .. _class_ItemList_method_set_item_icon: - void **set_item_icon** **(** :ref:`int` idx, :ref:`Texture` icon **)** Set (or replace) the icon's :ref:`Texture` associated with the specified index. +---- + .. _class_ItemList_method_set_item_icon_modulate: - void **set_item_icon_modulate** **(** :ref:`int` idx, :ref:`Color` modulate **)** Sets a modulating :ref:`Color` of the item associated with the specified index. +---- + .. _class_ItemList_method_set_item_icon_region: - void **set_item_icon_region** **(** :ref:`int` idx, :ref:`Rect2` rect **)** +---- + .. _class_ItemList_method_set_item_icon_transposed: - void **set_item_icon_transposed** **(** :ref:`int` idx, :ref:`bool` rect **)** +---- + .. _class_ItemList_method_set_item_metadata: - void **set_item_metadata** **(** :ref:`int` idx, :ref:`Variant` metadata **)** Sets a value (of any type) to be stored with the item associated with the specified index. +---- + .. _class_ItemList_method_set_item_selectable: - void **set_item_selectable** **(** :ref:`int` idx, :ref:`bool` selectable **)** Allow or disallow selection of the item associated with the specified index. +---- + .. _class_ItemList_method_set_item_text: - void **set_item_text** **(** :ref:`int` idx, :ref:`String` text **)** Sets text of the item associated with the specified index. +---- + .. _class_ItemList_method_set_item_tooltip: - void **set_item_tooltip** **(** :ref:`int` idx, :ref:`String` tooltip **)** Sets tooltip hint for the item associated with the specified index. +---- + .. _class_ItemList_method_set_item_tooltip_enabled: - void **set_item_tooltip_enabled** **(** :ref:`int` idx, :ref:`bool` enable **)** Sets whether the tooltip hint is enabled for specified item index. +---- + .. _class_ItemList_method_sort_items_by_text: - void **sort_items_by_text** **(** **)** Sorts items in the list by their text. +---- + .. _class_ItemList_method_unselect: - void **unselect** **(** :ref:`int` idx **)** Ensure the item associated with the specified index is not selected. +---- + .. _class_ItemList_method_unselect_all: - void **unselect_all** **(** **)** diff --git a/classes/class_joint.rst b/classes/class_joint.rst index a375dc932..a32f6020f 100644 --- a/classes/class_joint.rst +++ b/classes/class_joint.rst @@ -53,6 +53,8 @@ Property Descriptions If ``true``, the two bodies of the nodes are not able to collide with each other. +---- + .. _class_Joint_property_nodes/node_a: - :ref:`NodePath` **nodes/node_a** @@ -65,6 +67,8 @@ If ``true``, the two bodies of the nodes are not able to collide with each other The node attached to the first side (A) of the joint. +---- + .. _class_Joint_property_nodes/node_b: - :ref:`NodePath` **nodes/node_b** @@ -77,6 +81,8 @@ The node attached to the first side (A) of the joint. The node attached to the second side (B) of the joint. +---- + .. _class_Joint_property_solver/priority: - :ref:`int` **solver/priority** diff --git a/classes/class_joint2d.rst b/classes/class_joint2d.rst index 2b99f5d7a..1a39f2dee 100644 --- a/classes/class_joint2d.rst +++ b/classes/class_joint2d.rst @@ -53,6 +53,8 @@ Property Descriptions When :ref:`node_a` and :ref:`node_b` move in different directions the ``bias`` controls how fast the joint pulls them back to their original position. The lower the ``bias`` the more the two bodies can pull on the joint. Default value: ``0`` +---- + .. _class_Joint2D_property_disable_collision: - :ref:`bool` **disable_collision** @@ -65,6 +67,8 @@ When :ref:`node_a` and :ref:`node_b` and :ref:`node_b` can collide. Default value: ``false``. +---- + .. _class_Joint2D_property_node_a: - :ref:`NodePath` **node_a** @@ -77,6 +81,8 @@ If ``true``, :ref:`node_a` and :ref:`node_b`. +---- + .. _class_Joint2D_property_node_b: - :ref:`NodePath` **node_b** diff --git a/classes/class_json.rst b/classes/class_json.rst index 523c20002..cbd308e51 100644 --- a/classes/class_json.rst +++ b/classes/class_json.rst @@ -41,6 +41,8 @@ Method Descriptions Parses a JSON encoded string and returns a :ref:`JSONParseResult` containing the result. +---- + .. _class_JSON_method_print: - :ref:`String` **print** **(** :ref:`Variant` value, :ref:`String` indent="", :ref:`bool` sort_keys=false **)** diff --git a/classes/class_jsonparseresult.rst b/classes/class_jsonparseresult.rst index 0b7d64d02..4be437f2b 100644 --- a/classes/class_jsonparseresult.rst +++ b/classes/class_jsonparseresult.rst @@ -51,6 +51,8 @@ Property Descriptions The error type if JSON source was not successfully parsed. See :ref:`@GlobalScope` ERR\_\* constants. +---- + .. _class_JSONParseResult_property_error_line: - :ref:`int` **error_line** @@ -63,6 +65,8 @@ The error type if JSON source was not successfully parsed. See :ref:`@GlobalScop The line number where the error occurred if JSON source was not successfully parsed. +---- + .. _class_JSONParseResult_property_error_string: - :ref:`String` **error_string** @@ -75,6 +79,8 @@ The line number where the error occurred if JSON source was not successfully par The error message if JSON source was not successfully parsed. See :ref:`@GlobalScope` ERR\_\* constants. +---- + .. _class_JSONParseResult_property_result: - :ref:`Variant` **result** diff --git a/classes/class_kinematicbody.rst b/classes/class_kinematicbody.rst index d820fdb26..9b5eebfa8 100644 --- a/classes/class_kinematicbody.rst +++ b/classes/class_kinematicbody.rst @@ -85,6 +85,8 @@ Property Descriptions If the body is at least this close to another body, this body will consider them to be colliding. +---- + .. _class_KinematicBody_property_move_lock_x: - :ref:`bool` **move_lock_x** @@ -97,6 +99,8 @@ If the body is at least this close to another body, this body will consider them Lock the body's movement in the x-axis. +---- + .. _class_KinematicBody_property_move_lock_y: - :ref:`bool` **move_lock_y** @@ -109,6 +113,8 @@ Lock the body's movement in the x-axis. Lock the body's movement in the y-axis. +---- + .. _class_KinematicBody_property_move_lock_z: - :ref:`bool` **move_lock_z** @@ -130,36 +136,48 @@ Method Descriptions Returns the velocity of the floor. Only updates when calling :ref:`move_and_slide`. +---- + .. _class_KinematicBody_method_get_slide_collision: - :ref:`KinematicCollision` **get_slide_collision** **(** :ref:`int` slide_idx **)** Returns a :ref:`KinematicCollision`, which contains information about a collision that occurred 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_method_get_slide_count: - :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_method_is_on_ceiling: - :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_method_is_on_floor: - :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_method_is_on_wall: - :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_method_move_and_collide: - :ref:`KinematicCollision` **move_and_collide** **(** :ref:`Vector3` rel_vec, :ref:`bool` infinite_inertia=true, :ref:`bool` exclude_raycast_shapes=true, :ref:`bool` test_only=false **)** @@ -168,6 +186,8 @@ Moves the body along the vector ``rel_vec``. The body will stop if it collides. If ``test_only`` is ``true``, the body does not move but the would-be collision information is given. +---- + .. _class_KinematicBody_method_move_and_slide: - :ref:`Vector3` **move_and_slide** **(** :ref:`Vector3` linear_velocity, :ref:`Vector3` floor_normal=Vector3( 0, 0, 0 ), :ref:`bool` stop_on_slope=false, :ref:`int` max_slides=4, :ref:`float` floor_max_angle=0.785398, :ref:`bool` infinite_inertia=true **)** @@ -188,6 +208,8 @@ If ``infinite_inertia`` is ``true``, body will be able to push :ref:`RigidBody`. +---- + .. _class_KinematicBody_method_move_and_slide_with_snap: - :ref:`Vector3` **move_and_slide_with_snap** **(** :ref:`Vector3` linear_velocity, :ref:`Vector3` snap, :ref:`Vector3` floor_normal=Vector3( 0, 0, 0 ), :ref:`bool` stop_on_slope=false, :ref:`int` max_slides=4, :ref:`float` floor_max_angle=0.785398, :ref:`bool` infinite_inertia=true **)** @@ -196,6 +218,8 @@ Moves the body while keeping it attached to slopes. Similar to :ref:`move_and_sl As long as the ``snap`` vector is in contact with the ground, the body will remain attached to the surface. This means you must disable snap in order to jump, for example. You can do this by setting``snap`` to``(0, 0, 0)`` or by using :ref:`move_and_slide` instead. +---- + .. _class_KinematicBody_method_test_move: - :ref:`bool` **test_move** **(** :ref:`Transform` from, :ref:`Vector3` rel_vec, :ref:`bool` infinite_inertia=true **)** diff --git a/classes/class_kinematicbody2d.rst b/classes/class_kinematicbody2d.rst index a03daea83..4630e596e 100644 --- a/classes/class_kinematicbody2d.rst +++ b/classes/class_kinematicbody2d.rst @@ -83,6 +83,8 @@ Property Descriptions If the body is at least this close to another body, this body will consider them to be colliding. +---- + .. _class_KinematicBody2D_property_motion/sync_to_physics: - :ref:`bool` **motion/sync_to_physics** @@ -104,6 +106,8 @@ Method Descriptions Returns the velocity of the floor. Only updates when calling :ref:`move_and_slide`. +---- + .. _class_KinematicBody2D_method_get_slide_collision: - :ref:`KinematicCollision2D` **get_slide_collision** **(** :ref:`int` slide_idx **)** @@ -118,30 +122,40 @@ Example usage: var collision = get_slide_collision(i) print("Collided with: ", collision.collider.name) +---- + .. _class_KinematicBody2D_method_get_slide_count: - :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_method_is_on_ceiling: - :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_method_is_on_floor: - :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_method_is_on_wall: - :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_method_move_and_collide: - :ref:`KinematicCollision2D` **move_and_collide** **(** :ref:`Vector2` rel_vec, :ref:`bool` infinite_inertia=true, :ref:`bool` exclude_raycast_shapes=true, :ref:`bool` test_only=false **)** @@ -150,6 +164,8 @@ Moves the body along the vector ``rel_vec``. The body will stop if it collides. If ``test_only`` is ``true``, the body does not move but the would-be collision information is given. +---- + .. _class_KinematicBody2D_method_move_and_slide: - :ref:`Vector2` **move_and_slide** **(** :ref:`Vector2` linear_velocity, :ref:`Vector2` floor_normal=Vector2( 0, 0 ), :ref:`bool` stop_on_slope=false, :ref:`int` max_slides=4, :ref:`float` floor_max_angle=0.785398, :ref:`bool` infinite_inertia=true **)** @@ -170,6 +186,8 @@ If ``infinite_inertia`` is ``true``, body will be able to push :ref:`RigidBody2D Returns the ``linear_velocity`` vector, rotated and/or scaled if a slide collision occurred. To get detailed information about collisions that occurred, use :ref:`get_slide_collision`. +---- + .. _class_KinematicBody2D_method_move_and_slide_with_snap: - :ref:`Vector2` **move_and_slide_with_snap** **(** :ref:`Vector2` linear_velocity, :ref:`Vector2` snap, :ref:`Vector2` floor_normal=Vector2( 0, 0 ), :ref:`bool` stop_on_slope=false, :ref:`int` max_slides=4, :ref:`float` floor_max_angle=0.785398, :ref:`bool` infinite_inertia=true **)** @@ -178,6 +196,8 @@ Moves the body while keeping it attached to slopes. Similar to :ref:`move_and_sl As long as the ``snap`` vector is in contact with the ground, the body will remain attached to the surface. This means you must disable snap in order to jump, for example. You can do this by setting ``snap`` to ``(0, 0)`` or by using :ref:`move_and_slide` instead. +---- + .. _class_KinematicBody2D_method_test_move: - :ref:`bool` **test_move** **(** :ref:`Transform2D` from, :ref:`Vector2` rel_vec, :ref:`bool` infinite_inertia=true **)** diff --git a/classes/class_kinematiccollision.rst b/classes/class_kinematiccollision.rst index fad1169bc..06adc4df5 100644 --- a/classes/class_kinematiccollision.rst +++ b/classes/class_kinematiccollision.rst @@ -65,6 +65,8 @@ Property Descriptions The colliding body. +---- + .. _class_KinematicCollision_property_collider_id: - :ref:`int` **collider_id** @@ -75,6 +77,8 @@ The colliding body. The colliding body's unique :ref:`RID`. +---- + .. _class_KinematicCollision_property_collider_metadata: - :ref:`Variant` **collider_metadata** @@ -85,6 +89,8 @@ The colliding body's unique :ref:`RID`. The colliding body's metadata. See :ref:`Object`. +---- + .. _class_KinematicCollision_property_collider_shape: - :ref:`Object` **collider_shape** @@ -95,6 +101,8 @@ The colliding body's metadata. See :ref:`Object`. The colliding body's shape. +---- + .. _class_KinematicCollision_property_collider_shape_index: - :ref:`int` **collider_shape_index** @@ -105,6 +113,8 @@ The colliding body's shape. The colliding shape's index. See :ref:`CollisionObject`. +---- + .. _class_KinematicCollision_property_collider_velocity: - :ref:`Vector3` **collider_velocity** @@ -115,6 +125,8 @@ The colliding shape's index. See :ref:`CollisionObject`. The colliding object's velocity. +---- + .. _class_KinematicCollision_property_local_shape: - :ref:`Object` **local_shape** @@ -125,6 +137,8 @@ The colliding object's velocity. The moving object's colliding shape. +---- + .. _class_KinematicCollision_property_normal: - :ref:`Vector3` **normal** @@ -135,6 +149,8 @@ The moving object's colliding shape. The colliding body's shape's normal at the point of collision. +---- + .. _class_KinematicCollision_property_position: - :ref:`Vector3` **position** @@ -145,6 +161,8 @@ The colliding body's shape's normal at the point of collision. The point of collision. +---- + .. _class_KinematicCollision_property_remainder: - :ref:`Vector3` **remainder** @@ -155,6 +173,8 @@ The point of collision. The moving object's remaining movement vector. +---- + .. _class_KinematicCollision_property_travel: - :ref:`Vector3` **travel** diff --git a/classes/class_kinematiccollision2d.rst b/classes/class_kinematiccollision2d.rst index 227d7be5e..312b62a1d 100644 --- a/classes/class_kinematiccollision2d.rst +++ b/classes/class_kinematiccollision2d.rst @@ -65,6 +65,8 @@ Property Descriptions The colliding body. +---- + .. _class_KinematicCollision2D_property_collider_id: - :ref:`int` **collider_id** @@ -75,6 +77,8 @@ The colliding body. The colliding body's unique :ref:`RID`. +---- + .. _class_KinematicCollision2D_property_collider_metadata: - :ref:`Variant` **collider_metadata** @@ -85,6 +89,8 @@ The colliding body's unique :ref:`RID`. The colliding body's metadata. See :ref:`Object`. +---- + .. _class_KinematicCollision2D_property_collider_shape: - :ref:`Object` **collider_shape** @@ -95,6 +101,8 @@ The colliding body's metadata. See :ref:`Object`. The colliding body's shape. +---- + .. _class_KinematicCollision2D_property_collider_shape_index: - :ref:`int` **collider_shape_index** @@ -105,6 +113,8 @@ The colliding body's shape. The colliding shape's index. See :ref:`CollisionObject2D`. +---- + .. _class_KinematicCollision2D_property_collider_velocity: - :ref:`Vector2` **collider_velocity** @@ -115,6 +125,8 @@ The colliding shape's index. See :ref:`CollisionObject2D` **local_shape** @@ -125,6 +137,8 @@ The colliding object's velocity. The moving object's colliding shape. +---- + .. _class_KinematicCollision2D_property_normal: - :ref:`Vector2` **normal** @@ -135,6 +149,8 @@ The moving object's colliding shape. The colliding body's shape's normal at the point of collision. +---- + .. _class_KinematicCollision2D_property_position: - :ref:`Vector2` **position** @@ -145,6 +161,8 @@ The colliding body's shape's normal at the point of collision. The point of collision. +---- + .. _class_KinematicCollision2D_property_remainder: - :ref:`Vector2` **remainder** @@ -155,6 +173,8 @@ The point of collision. The moving object's remaining movement vector. +---- + .. _class_KinematicCollision2D_property_travel: - :ref:`Vector2` **travel** diff --git a/classes/class_label.rst b/classes/class_label.rst index fb66204fc..633226ce2 100644 --- a/classes/class_label.rst +++ b/classes/class_label.rst @@ -102,6 +102,8 @@ enum **Align**: - **ALIGN_FILL** = **3** --- Expand row whitespaces to fit the width. +---- + .. _enum_Label_VAlign: .. _class_Label_constant_VALIGN_TOP: @@ -144,6 +146,8 @@ Property Descriptions Controls the text's horizontal align. Supports left, center, right, and fill, or justify. Set it to one of the ``ALIGN_*`` constants. +---- + .. _class_Label_property_autowrap: - :ref:`bool` **autowrap** @@ -156,6 +160,8 @@ Controls the text's horizontal align. Supports left, center, right, and fill, or If ``true``, wraps the text inside the node's bounding rectangle. If you resize the node, it will change its height automatically to show all the text. Default: ``false``. +---- + .. _class_Label_property_clip_text: - :ref:`bool` **clip_text** @@ -168,6 +174,8 @@ If ``true``, wraps the text inside the node's bounding rectangle. If you resize If ``true``, the Label only shows the text that fits inside its bounding rectangle. It also lets you scale the node down freely. +---- + .. _class_Label_property_lines_skipped: - :ref:`int` **lines_skipped** @@ -180,6 +188,8 @@ If ``true``, the Label only shows the text that fits inside its bounding rectang The node ignores the first ``lines_skipped`` lines before it starts to display text. +---- + .. _class_Label_property_max_lines_visible: - :ref:`int` **max_lines_visible** @@ -192,6 +202,8 @@ The node ignores the first ``lines_skipped`` lines before it starts to display t Limits the lines of text the node shows on screen. +---- + .. _class_Label_property_percent_visible: - :ref:`float` **percent_visible** @@ -204,6 +216,8 @@ Limits the lines of text the node shows on screen. Limits the count of visible characters. If you set ``percent_visible`` to 50, only up to half of the text's characters will display on screen. Useful to animate the text in a dialog box. +---- + .. _class_Label_property_text: - :ref:`String` **text** @@ -216,6 +230,8 @@ Limits the count of visible characters. If you set ``percent_visible`` to 50, on The text to display on screen. +---- + .. _class_Label_property_uppercase: - :ref:`bool` **uppercase** @@ -228,6 +244,8 @@ The text to display on screen. If ``true``, all the text displays as UPPERCASE. +---- + .. _class_Label_property_valign: - :ref:`VAlign` **valign** @@ -240,6 +258,8 @@ If ``true``, all the text displays as UPPERCASE. Controls the text's vertical align. Supports top, center, bottom, and fill. Set it to one of the ``VALIGN_*`` constants. +---- + .. _class_Label_property_visible_characters: - :ref:`int` **visible_characters** @@ -261,18 +281,24 @@ Method Descriptions Returns the amount of lines of text the Label has. +---- + .. _class_Label_method_get_line_height: - :ref:`int` **get_line_height** **(** **)** const Returns the font size in pixels. +---- + .. _class_Label_method_get_total_character_count: - :ref:`int` **get_total_character_count** **(** **)** const Returns the total number of printable characters in the text (excluding spaces and newlines). +---- + .. _class_Label_method_get_visible_line_count: - :ref:`int` **get_visible_line_count** **(** **)** const diff --git a/classes/class_largetexture.rst b/classes/class_largetexture.rst index 3ff85ba32..8ce080d9a 100644 --- a/classes/class_largetexture.rst +++ b/classes/class_largetexture.rst @@ -55,42 +55,56 @@ Method Descriptions Add another :ref:`Texture` to this ``LargeTexture``, starting on offset "ofs". +---- + .. _class_LargeTexture_method_clear: - void **clear** **(** **)** Clears the ``LargeTexture``. +---- + .. _class_LargeTexture_method_get_piece_count: - :ref:`int` **get_piece_count** **(** **)** const Returns the number of pieces currently in this ``LargeTexture``. +---- + .. _class_LargeTexture_method_get_piece_offset: - :ref:`Vector2` **get_piece_offset** **(** :ref:`int` idx **)** const Returns the offset of the piece with index "idx". +---- + .. _class_LargeTexture_method_get_piece_texture: - :ref:`Texture` **get_piece_texture** **(** :ref:`int` idx **)** const Returns the :ref:`Texture` of the piece with index "idx". +---- + .. _class_LargeTexture_method_set_piece_offset: - void **set_piece_offset** **(** :ref:`int` idx, :ref:`Vector2` ofs **)** Sets the offset of the piece with index "idx" to "ofs". +---- + .. _class_LargeTexture_method_set_piece_texture: - void **set_piece_texture** **(** :ref:`int` idx, :ref:`Texture` texture **)** Sets the :ref:`Texture` of the piece with index "idx" to "texture". +---- + .. _class_LargeTexture_method_set_size: - void **set_size** **(** :ref:`Vector2` size **)** diff --git a/classes/class_light.rst b/classes/class_light.rst index a5e18899a..fe41c6cb0 100644 --- a/classes/class_light.rst +++ b/classes/class_light.rst @@ -122,6 +122,8 @@ enum **Param**: - **PARAM_MAX** = **15** --- Represents the size of the :ref:`Param` enum. +---- + .. _enum_Light_BakeMode: .. _class_Light_constant_BAKE_DISABLED: @@ -163,6 +165,8 @@ Property Descriptions If ``true``, the light only appears in the editor and will not be visible at runtime. Default value:``false``. +---- + .. _class_Light_property_light_bake_mode: - :ref:`BakeMode` **light_bake_mode** @@ -175,6 +179,8 @@ If ``true``, the light only appears in the editor and will not be visible at run The light's bake mode. See :ref:`BakeMode`. +---- + .. _class_Light_property_light_color: - :ref:`Color` **light_color** @@ -187,6 +193,8 @@ The light's bake mode. See :ref:`BakeMode`. The light's color. +---- + .. _class_Light_property_light_cull_mask: - :ref:`int` **light_cull_mask** @@ -199,6 +207,8 @@ The light's color. The light will affect objects in the selected layers. +---- + .. _class_Light_property_light_energy: - :ref:`float` **light_energy** @@ -211,6 +221,8 @@ The light will affect objects in the selected layers. The light's strength multiplier. +---- + .. _class_Light_property_light_indirect_energy: - :ref:`float` **light_indirect_energy** @@ -223,6 +235,8 @@ The light's strength multiplier. Secondary multiplier used with indirect light (light bounces). This works in baked light or GIProbe. +---- + .. _class_Light_property_light_negative: - :ref:`bool` **light_negative** @@ -235,6 +249,8 @@ Secondary multiplier used with indirect light (light bounces). This works in bak If ``true``, the light's effect is reversed, darkening areas and casting bright shadows. Default value: ``false``. +---- + .. _class_Light_property_light_specular: - :ref:`float` **light_specular** @@ -247,6 +263,8 @@ If ``true``, the light's effect is reversed, darkening areas and casting bright The intensity of the specular blob in objects affected by the light. At ``0`` the light becomes a pure diffuse light. +---- + .. _class_Light_property_shadow_bias: - :ref:`float` **shadow_bias** @@ -259,6 +277,8 @@ The intensity of the specular blob in objects affected by the light. At ``0`` th Used to adjust shadow appearance. Too small a value results in self shadowing, while too large a value causes shadows to separate from casters. Adjust as needed. +---- + .. _class_Light_property_shadow_color: - :ref:`Color` **shadow_color** @@ -271,6 +291,8 @@ Used to adjust shadow appearance. Too small a value results in self shadowing, w The color of shadows cast by this light. +---- + .. _class_Light_property_shadow_contact: - :ref:`float` **shadow_contact** @@ -283,6 +305,8 @@ The color of shadows cast by this light. Attempts to reduce :ref:`shadow_bias` gap. +---- + .. _class_Light_property_shadow_enabled: - :ref:`bool` **shadow_enabled** @@ -295,6 +319,8 @@ Attempts to reduce :ref:`shadow_bias` gap. If ``true``, the light will cast shadows. Default value: ``false``. +---- + .. _class_Light_property_shadow_reverse_cull_face: - :ref:`bool` **shadow_reverse_cull_face** diff --git a/classes/class_light2d.rst b/classes/class_light2d.rst index 473d4b2da..2f4ff3657 100644 --- a/classes/class_light2d.rst +++ b/classes/class_light2d.rst @@ -88,6 +88,8 @@ enum **Mode**: - **MODE_MASK** = **3** --- The light texture of the Light2D is used as a mask, hiding or revealing parts of the screen underneath depending on the value of each pixel of the light (mask) texture. +---- + .. _enum_Light2D_ShadowFilter: .. _class_Light2D_constant_SHADOW_FILTER_NONE: @@ -141,6 +143,8 @@ Property Descriptions The Light2D's :ref:`Color`. +---- + .. _class_Light2D_property_editor_only: - :ref:`bool` **editor_only** @@ -153,6 +157,8 @@ The Light2D's :ref:`Color`. If ``true``, Light2D will only appear when editing the scene. Default value: ``false``. +---- + .. _class_Light2D_property_enabled: - :ref:`bool` **enabled** @@ -165,6 +171,8 @@ If ``true``, Light2D will only appear when editing the scene. Default value: ``f If ``true``, Light2D will emit light. Default value: ``true``. +---- + .. _class_Light2D_property_energy: - :ref:`float` **energy** @@ -177,6 +185,8 @@ If ``true``, Light2D will emit light. Default value: ``true``. The Light2D's energy value. The larger the value, the stronger the light. +---- + .. _class_Light2D_property_mode: - :ref:`Mode` **mode** @@ -189,6 +199,8 @@ The Light2D's energy value. The larger the value, the stronger the light. The Light2D's mode. See MODE\_\* constants for values. +---- + .. _class_Light2D_property_offset: - :ref:`Vector2` **offset** @@ -201,6 +213,8 @@ The Light2D's mode. See MODE\_\* constants for values. The offset of the Light2D's ``texture``. +---- + .. _class_Light2D_property_range_height: - :ref:`float` **range_height** @@ -213,6 +227,8 @@ The offset of the Light2D's ``texture``. The height of the Light2D. Used with 2D normal mapping. +---- + .. _class_Light2D_property_range_item_cull_mask: - :ref:`int` **range_item_cull_mask** @@ -225,6 +241,8 @@ The height of the Light2D. Used with 2D normal mapping. The layer mask. Only objects with a matching mask will be affected by the Light2D. +---- + .. _class_Light2D_property_range_layer_max: - :ref:`int` **range_layer_max** @@ -237,6 +255,8 @@ The layer mask. Only objects with a matching mask will be affected by the Light2 Maximum layer value of objects that are affected by the Light2D. Default value: ``0``. +---- + .. _class_Light2D_property_range_layer_min: - :ref:`int` **range_layer_min** @@ -249,6 +269,8 @@ Maximum layer value of objects that are affected by the Light2D. Default value: Minimum layer value of objects that are affected by the Light2D. Default value: ``0``. +---- + .. _class_Light2D_property_range_z_max: - :ref:`int` **range_z_max** @@ -261,6 +283,8 @@ Minimum layer value of objects that are affected by the Light2D. Default value: Maximum ``z`` value of objects that are affected by the Light2D. Default value: ``1024``. +---- + .. _class_Light2D_property_range_z_min: - :ref:`int` **range_z_min** @@ -273,6 +297,8 @@ Maximum ``z`` value of objects that are affected by the Light2D. Default value: Minimum ``z`` value of objects that are affected by the Light2D. Default value: ``-1024``. +---- + .. _class_Light2D_property_shadow_buffer_size: - :ref:`int` **shadow_buffer_size** @@ -285,6 +311,8 @@ Minimum ``z`` value of objects that are affected by the Light2D. Default value: Shadow buffer size. Default value: ``2048``. +---- + .. _class_Light2D_property_shadow_color: - :ref:`Color` **shadow_color** @@ -297,6 +325,8 @@ Shadow buffer size. Default value: ``2048``. :ref:`Color` of shadows cast by the Light2D. +---- + .. _class_Light2D_property_shadow_enabled: - :ref:`bool` **shadow_enabled** @@ -309,6 +339,8 @@ Shadow buffer size. Default value: ``2048``. If ``true``, the Light2D will cast shadows. Default value: ``false``. +---- + .. _class_Light2D_property_shadow_filter: - :ref:`ShadowFilter` **shadow_filter** @@ -321,6 +353,8 @@ If ``true``, the Light2D will cast shadows. Default value: ``false``. Shadow filter type. Use :ref:`ShadowFilter` constants as values. Default value: ``SHADOW_FILTER_NONE``. +---- + .. _class_Light2D_property_shadow_filter_smooth: - :ref:`float` **shadow_filter_smooth** @@ -333,6 +367,8 @@ Shadow filter type. Use :ref:`ShadowFilter` constants Smoothing value for shadows. +---- + .. _class_Light2D_property_shadow_gradient_length: - :ref:`float` **shadow_gradient_length** @@ -345,6 +381,8 @@ Smoothing value for shadows. Smooth shadow gradient length. +---- + .. _class_Light2D_property_shadow_item_cull_mask: - :ref:`int` **shadow_item_cull_mask** @@ -357,6 +395,8 @@ Smooth shadow gradient length. The shadow mask. Used with :ref:`LightOccluder2D` to cast shadows. Only occluders with a matching shadow mask will cast shadows. +---- + .. _class_Light2D_property_texture: - :ref:`Texture` **texture** @@ -369,6 +409,8 @@ The shadow mask. Used with :ref:`LightOccluder2D` to cast :ref:`Texture` used for the Light2D's appearance. +---- + .. _class_Light2D_property_texture_scale: - :ref:`float` **texture_scale** diff --git a/classes/class_lightoccluder2d.rst b/classes/class_lightoccluder2d.rst index cae6e8381..4940a8555 100644 --- a/classes/class_lightoccluder2d.rst +++ b/classes/class_lightoccluder2d.rst @@ -52,6 +52,8 @@ Property Descriptions The LightOccluder2D's light mask. The LightOccluder2D will cast shadows only from Light2D(s) that have the same light mask(s). +---- + .. _class_LightOccluder2D_property_occluder: - :ref:`OccluderPolygon2D` **occluder** diff --git a/classes/class_line2d.rst b/classes/class_line2d.rst index d71d17e75..6380986b3 100644 --- a/classes/class_line2d.rst +++ b/classes/class_line2d.rst @@ -81,6 +81,8 @@ enum **LineJointMode**: - **LINE_JOINT_ROUND** = **2** --- The line's joints will be rounded. +---- + .. _enum_Line2D_LineCapMode: .. _class_Line2D_constant_LINE_CAP_NONE: @@ -97,6 +99,8 @@ enum **LineCapMode**: - **LINE_CAP_ROUND** = **2** --- Draws the line cap as a circle. +---- + .. _enum_Line2D_LineTextureMode: .. _class_Line2D_constant_LINE_TEXTURE_NONE: @@ -133,6 +137,8 @@ Property Descriptions Controls the style of the line's first point. Use ``LINE_CAP_*`` constants. Default value: :ref:`LINE_CAP_NONE`. +---- + .. _class_Line2D_property_default_color: - :ref:`Color` **default_color** @@ -145,6 +151,8 @@ Controls the style of the line's first point. Use ``LINE_CAP_*`` constants. Defa The line's color. Will not be used if a gradient is set. +---- + .. _class_Line2D_property_end_cap_mode: - :ref:`LineCapMode` **end_cap_mode** @@ -157,6 +165,8 @@ The line's color. Will not be used if a gradient is set. Controls the style of the line's last point. Use ``LINE_CAP_*`` constants. Default value: :ref:`LINE_CAP_NONE`. +---- + .. _class_Line2D_property_gradient: - :ref:`Gradient` **gradient** @@ -169,6 +179,8 @@ Controls the style of the line's last point. Use ``LINE_CAP_*`` constants. Defau The gradient is drawn through the whole line from start to finish. The default color will not be used if a gradient is set. +---- + .. _class_Line2D_property_joint_mode: - :ref:`LineJointMode` **joint_mode** @@ -181,6 +193,8 @@ The gradient is drawn through the whole line from start to finish. The default c The style for the points between the start and the end. +---- + .. _class_Line2D_property_points: - :ref:`PoolVector2Array` **points** @@ -193,6 +207,8 @@ The style for the points between the start and the end. The points that form the lines. The line is drawn between every point set in this array. +---- + .. _class_Line2D_property_round_precision: - :ref:`int` **round_precision** @@ -205,6 +221,8 @@ The points that form the lines. The line is drawn between every point set in thi The smoothness of the rounded joints and caps. This is only used if a cap or joint is set as round. +---- + .. _class_Line2D_property_sharp_limit: - :ref:`float` **sharp_limit** @@ -217,6 +235,8 @@ The smoothness of the rounded joints and caps. This is only used if a cap or joi The direction difference in radians between vector points. This value is only used if ``joint mode`` is set to :ref:`LINE_JOINT_SHARP`. +---- + .. _class_Line2D_property_texture: - :ref:`Texture` **texture** @@ -229,6 +249,8 @@ The direction difference in radians between vector points. This value is only us The texture used for the line's texture. Uses ``texture_mode`` for drawing style. +---- + .. _class_Line2D_property_texture_mode: - :ref:`LineTextureMode` **texture_mode** @@ -241,6 +263,8 @@ The texture used for the line's texture. Uses ``texture_mode`` for drawing style The style to render the ``texture`` on the line. Use ``LINE_TEXTURE_*`` constants. Default value: :ref:`LINE_TEXTURE_NONE`. +---- + .. _class_Line2D_property_width: - :ref:`float` **width** @@ -262,30 +286,40 @@ Method Descriptions Add a point at the ``position``. Appends the point at the end of the line. +---- + .. _class_Line2D_method_clear_points: - void **clear_points** **(** **)** Removes all points from the line. +---- + .. _class_Line2D_method_get_point_count: - :ref:`int` **get_point_count** **(** **)** const Returns the Line2D's amount of points. +---- + .. _class_Line2D_method_get_point_position: - :ref:`Vector2` **get_point_position** **(** :ref:`int` i **)** const Returns point ``i``'s position. +---- + .. _class_Line2D_method_remove_point: - void **remove_point** **(** :ref:`int` i **)** Remove the point at index ``i`` from the line. +---- + .. _class_Line2D_method_set_point_position: - void **set_point_position** **(** :ref:`int` i, :ref:`Vector2` position **)** diff --git a/classes/class_lineedit.rst b/classes/class_lineedit.rst index 0396ea09f..b17653c8a 100644 --- a/classes/class_lineedit.rst +++ b/classes/class_lineedit.rst @@ -110,6 +110,8 @@ Signals Emitted when the text changes. +---- + .. _class_LineEdit_signal_text_entered: - **text_entered** **(** :ref:`String` new_text **)** @@ -139,6 +141,8 @@ enum **Align**: - **ALIGN_FILL** = **3** --- Stretches whitespaces to fit the ``LineEdit``'s width. +---- + .. _enum_LineEdit_MenuItems: .. _class_LineEdit_constant_MENU_CUT: @@ -213,6 +217,8 @@ Property Descriptions Text alignment as defined in the ALIGN\_\* enum. +---- + .. _class_LineEdit_property_caret_blink: - :ref:`bool` **caret_blink** @@ -225,6 +231,8 @@ Text alignment as defined in the ALIGN\_\* enum. If ``true``, the caret (visual cursor) blinks. +---- + .. _class_LineEdit_property_caret_blink_speed: - :ref:`float` **caret_blink_speed** @@ -237,6 +245,8 @@ If ``true``, the caret (visual cursor) blinks. Duration (in seconds) of a caret's blinking cycle. +---- + .. _class_LineEdit_property_caret_position: - :ref:`int` **caret_position** @@ -249,6 +259,8 @@ Duration (in seconds) of a caret's blinking cycle. The cursor's position inside the ``LineEdit``. When set, the text may scroll to accommodate it. +---- + .. _class_LineEdit_property_clear_button_enabled: - :ref:`bool` **clear_button_enabled** @@ -261,6 +273,8 @@ The cursor's position inside the ``LineEdit``. When set, the text may scroll to If ``true``, the ``LineEdit`` will show a clear button if ``text`` is not empty. +---- + .. _class_LineEdit_property_context_menu_enabled: - :ref:`bool` **context_menu_enabled** @@ -273,6 +287,8 @@ If ``true``, the ``LineEdit`` will show a clear button if ``text`` is not empty. If ``true``, the context menu will appear when right clicked. +---- + .. _class_LineEdit_property_editable: - :ref:`bool` **editable** @@ -285,6 +301,8 @@ If ``true``, the context menu will appear when right clicked. If ``false``, existing text cannot be modified and new text cannot be added. +---- + .. _class_LineEdit_property_expand_to_text_length: - :ref:`bool` **expand_to_text_length** @@ -297,6 +315,8 @@ If ``false``, existing text cannot be modified and new text cannot be added. If ``true``, the ``LineEdit`` width will increase to stay longer than the :ref:`text`. It will **not** compress if the :ref:`text` is shortened. +---- + .. _class_LineEdit_property_focus_mode: - :ref:`FocusMode` **focus_mode** @@ -309,6 +329,8 @@ If ``true``, the ``LineEdit`` width will increase to stay longer than the :ref:` Defines how the ``LineEdit`` can grab focus (Keyboard and mouse, only keyboard, or none). See ``enum FocusMode`` in :ref:`Control` for details. +---- + .. _class_LineEdit_property_max_length: - :ref:`int` **max_length** @@ -321,6 +343,8 @@ Defines how the ``LineEdit`` can grab focus (Keyboard and mouse, only keyboard, Maximum amount of characters that can be entered inside the ``LineEdit``. If ``0``, there is no limit. +---- + .. _class_LineEdit_property_placeholder_alpha: - :ref:`float` **placeholder_alpha** @@ -333,6 +357,8 @@ Maximum amount of characters that can be entered inside the ``LineEdit``. If ``0 Opacity of the :ref:`placeholder_text`. From ``0`` to ``1``. +---- + .. _class_LineEdit_property_placeholder_text: - :ref:`String` **placeholder_text** @@ -345,6 +371,8 @@ Opacity of the :ref:`placeholder_text` Text shown when the ``LineEdit`` is empty. It is **not** the ``LineEdit``'s default value (see :ref:`text`). +---- + .. _class_LineEdit_property_secret: - :ref:`bool` **secret** @@ -357,6 +385,8 @@ Text shown when the ``LineEdit`` is empty. It is **not** the ``LineEdit``'s defa If ``true``, every character is replaced with the secret character (see :ref:`secret_character`). +---- + .. _class_LineEdit_property_secret_character: - :ref:`String` **secret_character** @@ -369,6 +399,8 @@ If ``true``, every character is replaced with the secret character (see :ref:`se The character to use to mask secret input (defaults to "\*"). Only a single character can be used as the secret character. +---- + .. _class_LineEdit_property_text: - :ref:`String` **text** @@ -390,30 +422,40 @@ Method Descriptions Adds ``text`` after the cursor. If the resulting value is longer than :ref:`max_length`, nothing happens. +---- + .. _class_LineEdit_method_clear: - void **clear** **(** **)** Erases the ``LineEdit`` text. +---- + .. _class_LineEdit_method_deselect: - void **deselect** **(** **)** Clears the current selection. +---- + .. _class_LineEdit_method_get_menu: - :ref:`PopupMenu` **get_menu** **(** **)** const Returns the :ref:`PopupMenu` of this ``LineEdit``. By default, this menu is displayed when right-clicking on the ``LineEdit``. +---- + .. _class_LineEdit_method_menu_option: - void **menu_option** **(** :ref:`int` option **)** Executes a given action as defined in the MENU\_\* enum. +---- + .. _class_LineEdit_method_select: - void **select** **(** :ref:`int` from=0, :ref:`int` to=-1 **)** @@ -427,6 +469,8 @@ Selects characters inside ``LineEdit`` between ``from`` and ``to``. By default ` select(4) # ome select(2, 5) # lco +---- + .. _class_LineEdit_method_select_all: - void **select_all** **(** **)** diff --git a/classes/class_lineshape2d.rst b/classes/class_lineshape2d.rst index 7a978b066..40da3c480 100644 --- a/classes/class_lineshape2d.rst +++ b/classes/class_lineshape2d.rst @@ -47,6 +47,8 @@ Property Descriptions The line's distance from the origin. +---- + .. _class_LineShape2D_property_normal: - :ref:`Vector2` **normal** diff --git a/classes/class_linkbutton.rst b/classes/class_linkbutton.rst index f97d03635..b38f8f93c 100644 --- a/classes/class_linkbutton.rst +++ b/classes/class_linkbutton.rst @@ -81,6 +81,8 @@ Property Descriptions | *Getter* | get_text() | +----------+-----------------+ +---- + .. _class_LinkButton_property_underline: - :ref:`UnderlineMode` **underline** diff --git a/classes/class_listener.rst b/classes/class_listener.rst index 19cd23cea..3a709fd6a 100644 --- a/classes/class_listener.rst +++ b/classes/class_listener.rst @@ -38,14 +38,20 @@ Method Descriptions - void **clear_current** **(** **)** +---- + .. _class_Listener_method_get_listener_transform: - :ref:`Transform` **get_listener_transform** **(** **)** const +---- + .. _class_Listener_method_is_current: - :ref:`bool` **is_current** **(** **)** const +---- + .. _class_Listener_method_make_current: - void **make_current** **(** **)** diff --git a/classes/class_mainloop.rst b/classes/class_mainloop.rst index b1857c8ce..94ec3f968 100644 --- a/classes/class_mainloop.rst +++ b/classes/class_mainloop.rst @@ -175,12 +175,16 @@ Method Descriptions Called when files are dragged from the OS file manager and dropped in the game window. The arguments are a list of file paths and the identifier of the screen where the drag originated. +---- + .. _class_MainLoop_method__finalize: - void **_finalize** **(** **)** virtual Called before the program exits. +---- + .. _class_MainLoop_method__idle: - :ref:`bool` **_idle** **(** :ref:`float` delta **)** virtual @@ -189,24 +193,32 @@ Called each idle frame with the time since the last idle frame as argument (in s If implemented, the method must return a boolean value. ``true`` ends the main loop, while ``false`` lets it proceed to the next frame. +---- + .. _class_MainLoop_method__initialize: - void **_initialize** **(** **)** virtual Called once during initialization. +---- + .. _class_MainLoop_method__input_event: - void **_input_event** **(** :ref:`InputEvent` event **)** virtual Called whenever an :ref:`InputEvent` is received by the main loop. +---- + .. _class_MainLoop_method__input_text: - void **_input_text** **(** :ref:`String` text **)** virtual Deprecated callback, does not do anything. Use :ref:`_input_event` to parse text input. Will be removed in Godot 4.0. +---- + .. _class_MainLoop_method__iteration: - :ref:`bool` **_iteration** **(** :ref:`float` delta **)** virtual @@ -215,36 +227,48 @@ Called each physics frame with the time since the last physics frame as argument If implemented, the method must return a boolean value. ``true`` ends the main loop, while ``false`` lets it proceed to the next frame. +---- + .. _class_MainLoop_method_finish: - void **finish** **(** **)** Should not be called manually, override :ref:`_finalize` instead. Will be removed in Godot 4.0. +---- + .. _class_MainLoop_method_idle: - :ref:`bool` **idle** **(** :ref:`float` delta **)** Should not be called manually, override :ref:`_idle` instead. Will be removed in Godot 4.0. +---- + .. _class_MainLoop_method_init: - void **init** **(** **)** Should not be called manually, override :ref:`_initialize` instead. Will be removed in Godot 4.0. +---- + .. _class_MainLoop_method_input_event: - void **input_event** **(** :ref:`InputEvent` event **)** Should not be called manually, override :ref:`_input_event` instead. Will be removed in Godot 4.0. +---- + .. _class_MainLoop_method_input_text: - void **input_text** **(** :ref:`String` text **)** Should not be called manually, override :ref:`_input_text` instead. Will be removed in Godot 4.0. +---- + .. _class_MainLoop_method_iteration: - :ref:`bool` **iteration** **(** :ref:`float` delta **)** diff --git a/classes/class_marshalls.rst b/classes/class_marshalls.rst index fed787d28..8380d6a86 100644 --- a/classes/class_marshalls.rst +++ b/classes/class_marshalls.rst @@ -49,12 +49,16 @@ Method Descriptions Returns :ref:`PoolByteArray` of a given base64 encoded String. +---- + .. _class_Marshalls_method_base64_to_utf8: - :ref:`String` **base64_to_utf8** **(** :ref:`String` base64_str **)** Returns utf8 String of a given base64 encoded String. +---- + .. _class_Marshalls_method_base64_to_variant: - :ref:`Variant` **base64_to_variant** **(** :ref:`String` base64_str, :ref:`bool` allow_objects=false **)** @@ -63,18 +67,24 @@ Returns :ref:`Variant` of a given base64 encoded String. When ``a **WARNING:** Deserialized object can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats (remote code execution). +---- + .. _class_Marshalls_method_raw_to_base64: - :ref:`String` **raw_to_base64** **(** :ref:`PoolByteArray` array **)** Returns base64 encoded String of a given :ref:`PoolByteArray`. +---- + .. _class_Marshalls_method_utf8_to_base64: - :ref:`String` **utf8_to_base64** **(** :ref:`String` utf8_str **)** Returns base64 encoded String of a given utf8 String. +---- + .. _class_Marshalls_method_variant_to_base64: - :ref:`String` **variant_to_base64** **(** :ref:`Variant` variant, :ref:`bool` full_objects=false **)** diff --git a/classes/class_material.rst b/classes/class_material.rst index 5cab5cfc5..ebb56aa6a 100644 --- a/classes/class_material.rst +++ b/classes/class_material.rst @@ -58,6 +58,8 @@ Property Descriptions | *Getter* | get_next_pass() | +----------+----------------------+ +---- + .. _class_Material_property_render_priority: - :ref:`int` **render_priority** diff --git a/classes/class_menubutton.rst b/classes/class_menubutton.rst index 8590b2b2a..72be80a16 100644 --- a/classes/class_menubutton.rst +++ b/classes/class_menubutton.rst @@ -99,6 +99,8 @@ Method Descriptions Returns the :ref:`PopupMenu` contained in this button. +---- + .. _class_MenuButton_method_set_disable_shortcuts: - void **set_disable_shortcuts** **(** :ref:`bool` disabled **)** diff --git a/classes/class_mesh.rst b/classes/class_mesh.rst index d24d676fc..9522db9f4 100644 --- a/classes/class_mesh.rst +++ b/classes/class_mesh.rst @@ -85,6 +85,8 @@ enum **PrimitiveType**: - **PRIMITIVE_TRIANGLE_FAN** = **6** --- Render array as triangle fans. +---- + .. _enum_Mesh_BlendShapeMode: .. _class_Mesh_constant_BLEND_SHAPE_MODE_NORMALIZED: @@ -97,6 +99,8 @@ enum **BlendShapeMode**: - **BLEND_SHAPE_MODE_RELATIVE** = **1** +---- + .. _enum_Mesh_ArrayFormat: .. _class_Mesh_constant_ARRAY_FORMAT_VERTEX: @@ -189,6 +193,8 @@ enum **ArrayFormat**: - **ARRAY_COMPRESS_DEFAULT** = **97280** +---- + .. _enum_Mesh_ArrayType: .. _class_Mesh_constant_ARRAY_VERTEX: @@ -260,48 +266,64 @@ Method Descriptions Calculate a :ref:`ConvexPolygonShape` from the mesh. +---- + .. _class_Mesh_method_create_outline: - :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_method_create_trimesh_shape: - :ref:`Shape` **create_trimesh_shape** **(** **)** const Calculate a :ref:`ConcavePolygonShape` from the mesh. +---- + .. _class_Mesh_method_generate_triangle_mesh: - :ref:`TriangleMesh` **generate_triangle_mesh** **(** **)** const Generate a :ref:`TriangleMesh` from the mesh. +---- + .. _class_Mesh_method_get_faces: - :ref:`PoolVector3Array` **get_faces** **(** **)** const Returns all the vertices that make up the faces of the mesh. Each three vertices represent one triangle. +---- + .. _class_Mesh_method_get_surface_count: - :ref:`int` **get_surface_count** **(** **)** const Returns the amount of surfaces that the ``Mesh`` holds. +---- + .. _class_Mesh_method_surface_get_arrays: - :ref:`Array` **surface_get_arrays** **(** :ref:`int` surf_idx **)** const Returns the arrays for the vertices, normals, uvs, etc. that make up the requested surface (see :ref:`ArrayMesh.add_surface_from_arrays`). +---- + .. _class_Mesh_method_surface_get_blend_shape_arrays: - :ref:`Array` **surface_get_blend_shape_arrays** **(** :ref:`int` surf_idx **)** const Returns the blend shape arrays for the requested surface. +---- + .. _class_Mesh_method_surface_get_material: - :ref:`Material` **surface_get_material** **(** :ref:`int` surf_idx **)** const diff --git a/classes/class_meshdatatool.rst b/classes/class_meshdatatool.rst index 251beb36c..b48e7daa3 100644 --- a/classes/class_meshdatatool.rst +++ b/classes/class_meshdatatool.rst @@ -128,12 +128,16 @@ Method Descriptions Clears all data currently in MeshDataTool. +---- + .. _class_MeshDataTool_method_commit_to_surface: - :ref:`Error` **commit_to_surface** **(** :ref:`ArrayMesh` mesh **)** Adds a new surface to specified :ref:`Mesh` with edited data. +---- + .. _class_MeshDataTool_method_create_from_surface: - :ref:`Error` **create_from_surface** **(** :ref:`ArrayMesh` mesh, :ref:`int` surface **)** @@ -142,24 +146,32 @@ Uses specified surface of given :ref:`Mesh` to populate data for Mes Requires :ref:`Mesh` with primitive type :ref:`Mesh.PRIMITIVE_TRIANGLES`. +---- + .. _class_MeshDataTool_method_get_edge_count: - :ref:`int` **get_edge_count** **(** **)** const Returns the number of edges in this :ref:`Mesh`. +---- + .. _class_MeshDataTool_method_get_edge_faces: - :ref:`PoolIntArray` **get_edge_faces** **(** :ref:`int` idx **)** const Returns array of faces that touch given edge. +---- + .. _class_MeshDataTool_method_get_edge_meta: - :ref:`Variant` **get_edge_meta** **(** :ref:`int` idx **)** const Returns meta information assigned to given edge. +---- + .. _class_MeshDataTool_method_get_edge_vertex: - :ref:`int` **get_edge_vertex** **(** :ref:`int` idx, :ref:`int` vertex **)** const @@ -168,12 +180,16 @@ Returns index of specified vertex connected to given edge. Vertex argument can only be 0 or 1 because edges are comprised of two vertices. +---- + .. _class_MeshDataTool_method_get_face_count: - :ref:`int` **get_face_count** **(** **)** const Returns the number of faces in this :ref:`Mesh`. +---- + .. _class_MeshDataTool_method_get_face_edge: - :ref:`int` **get_face_edge** **(** :ref:`int` idx, :ref:`int` edge **)** const @@ -182,18 +198,24 @@ Returns specified edge associated with given face. Edge argument must 2 or less because a face only has three edges. +---- + .. _class_MeshDataTool_method_get_face_meta: - :ref:`Variant` **get_face_meta** **(** :ref:`int` idx **)** const Returns meta data associated with given face. +---- + .. _class_MeshDataTool_method_get_face_normal: - :ref:`Vector3` **get_face_normal** **(** :ref:`int` idx **)** const Calculates and returns face normal of given face. +---- + .. _class_MeshDataTool_method_get_face_vertex: - :ref:`int` **get_face_vertex** **(** :ref:`int` idx, :ref:`int` vertex **)** const @@ -202,6 +224,8 @@ Returns specified vertex of given face. Vertex argument must be 2 or less because faces contain three vertices. +---- + .. _class_MeshDataTool_method_get_format: - :ref:`int` **get_format** **(** **)** const @@ -210,150 +234,200 @@ Returns format of :ref:`Mesh`. Format is an integer made up of :ref: For list of format flags see :ref:`ArrayFormat`. +---- + .. _class_MeshDataTool_method_get_material: - :ref:`Material` **get_material** **(** **)** const Returns material assigned to the :ref:`Mesh`. +---- + .. _class_MeshDataTool_method_get_vertex: - :ref:`Vector3` **get_vertex** **(** :ref:`int` idx **)** const Returns the vertex at given index. +---- + .. _class_MeshDataTool_method_get_vertex_bones: - :ref:`PoolIntArray` **get_vertex_bones** **(** :ref:`int` idx **)** const Returns the bones of the given vertex. +---- + .. _class_MeshDataTool_method_get_vertex_color: - :ref:`Color` **get_vertex_color** **(** :ref:`int` idx **)** const Returns the color of the given vertex. +---- + .. _class_MeshDataTool_method_get_vertex_count: - :ref:`int` **get_vertex_count** **(** **)** const Returns the total number of vertices in :ref:`Mesh`. +---- + .. _class_MeshDataTool_method_get_vertex_edges: - :ref:`PoolIntArray` **get_vertex_edges** **(** :ref:`int` idx **)** const Returns array of edges that share given vertex. +---- + .. _class_MeshDataTool_method_get_vertex_faces: - :ref:`PoolIntArray` **get_vertex_faces** **(** :ref:`int` idx **)** const Returns array of faces that share given vertex. +---- + .. _class_MeshDataTool_method_get_vertex_meta: - :ref:`Variant` **get_vertex_meta** **(** :ref:`int` idx **)** const Returns meta data associated with given vertex. +---- + .. _class_MeshDataTool_method_get_vertex_normal: - :ref:`Vector3` **get_vertex_normal** **(** :ref:`int` idx **)** const Returns normal of given vertex. +---- + .. _class_MeshDataTool_method_get_vertex_tangent: - :ref:`Plane` **get_vertex_tangent** **(** :ref:`int` idx **)** const Returns tangent of given vertex. +---- + .. _class_MeshDataTool_method_get_vertex_uv: - :ref:`Vector2` **get_vertex_uv** **(** :ref:`int` idx **)** const Returns UV of given vertex. +---- + .. _class_MeshDataTool_method_get_vertex_uv2: - :ref:`Vector2` **get_vertex_uv2** **(** :ref:`int` idx **)** const Returns UV2 of given vertex. +---- + .. _class_MeshDataTool_method_get_vertex_weights: - :ref:`PoolRealArray` **get_vertex_weights** **(** :ref:`int` idx **)** const Returns bone weights of given vertex. +---- + .. _class_MeshDataTool_method_set_edge_meta: - void **set_edge_meta** **(** :ref:`int` idx, :ref:`Variant` meta **)** Sets the meta data of given edge. +---- + .. _class_MeshDataTool_method_set_face_meta: - void **set_face_meta** **(** :ref:`int` idx, :ref:`Variant` meta **)** Sets the meta data of given face. +---- + .. _class_MeshDataTool_method_set_material: - void **set_material** **(** :ref:`Material` material **)** Sets the material to be used by newly constructed :ref:`Mesh`. +---- + .. _class_MeshDataTool_method_set_vertex: - void **set_vertex** **(** :ref:`int` idx, :ref:`Vector3` vertex **)** Sets the position of given vertex. +---- + .. _class_MeshDataTool_method_set_vertex_bones: - void **set_vertex_bones** **(** :ref:`int` idx, :ref:`PoolIntArray` bones **)** Sets the bones of given vertex. +---- + .. _class_MeshDataTool_method_set_vertex_color: - void **set_vertex_color** **(** :ref:`int` idx, :ref:`Color` color **)** Sets the color of given vertex. +---- + .. _class_MeshDataTool_method_set_vertex_meta: - void **set_vertex_meta** **(** :ref:`int` idx, :ref:`Variant` meta **)** Sets the meta data associated with given vertex. +---- + .. _class_MeshDataTool_method_set_vertex_normal: - void **set_vertex_normal** **(** :ref:`int` idx, :ref:`Vector3` normal **)** Sets the normal of given vertex. +---- + .. _class_MeshDataTool_method_set_vertex_tangent: - void **set_vertex_tangent** **(** :ref:`int` idx, :ref:`Plane` tangent **)** Sets the tangent of given vertex. +---- + .. _class_MeshDataTool_method_set_vertex_uv: - void **set_vertex_uv** **(** :ref:`int` idx, :ref:`Vector2` uv **)** Sets the UV of given vertex. +---- + .. _class_MeshDataTool_method_set_vertex_uv2: - void **set_vertex_uv2** **(** :ref:`int` idx, :ref:`Vector2` uv2 **)** Sets the UV2 of given vertex. +---- + .. _class_MeshDataTool_method_set_vertex_weights: - void **set_vertex_weights** **(** :ref:`int` idx, :ref:`PoolRealArray` weights **)** diff --git a/classes/class_meshinstance.rst b/classes/class_meshinstance.rst index c3c5239a7..71b917140 100644 --- a/classes/class_meshinstance.rst +++ b/classes/class_meshinstance.rst @@ -66,6 +66,8 @@ Property Descriptions The :ref:`Mesh` resource for the instance. +---- + .. _class_MeshInstance_property_skeleton: - :ref:`NodePath` **skeleton** @@ -87,30 +89,40 @@ Method Descriptions This helper creates a :ref:`StaticBody` child node with a :ref:`ConvexPolygonShape` collision shape calculated from the mesh geometry. It's mainly used for testing. +---- + .. _class_MeshInstance_method_create_debug_tangents: - void **create_debug_tangents** **(** **)** This helper creates a :ref:`MeshInstance` child node with gizmos at every vertex calculated from the mesh geometry. It's mainly used for testing. +---- + .. _class_MeshInstance_method_create_trimesh_collision: - void **create_trimesh_collision** **(** **)** This helper creates a :ref:`StaticBody` child node with a :ref:`ConcavePolygonShape` collision shape calculated from the mesh geometry. It's mainly used for testing. +---- + .. _class_MeshInstance_method_get_surface_material: - :ref:`Material` **get_surface_material** **(** :ref:`int` surface **)** const Returns the :ref:`Material` for a surface of the :ref:`Mesh` resource. +---- + .. _class_MeshInstance_method_get_surface_material_count: - :ref:`int` **get_surface_material_count** **(** **)** const Returns the number of surface materials. +---- + .. _class_MeshInstance_method_set_surface_material: - void **set_surface_material** **(** :ref:`int` surface, :ref:`Material` material **)** diff --git a/classes/class_meshinstance2d.rst b/classes/class_meshinstance2d.rst index 4a4fa671c..cd823a687 100644 --- a/classes/class_meshinstance2d.rst +++ b/classes/class_meshinstance2d.rst @@ -54,6 +54,8 @@ Property Descriptions The :ref:`Mesh` that will be drawn by the :ref:`MeshInstance2D`. +---- + .. _class_MeshInstance2D_property_normal_map: - :ref:`Texture` **normal_map** @@ -66,6 +68,8 @@ The :ref:`Mesh` that will be drawn by the :ref:`MeshInstance2D`. +---- + .. _class_MeshInstance2D_property_texture: - :ref:`Texture` **texture** diff --git a/classes/class_meshlibrary.rst b/classes/class_meshlibrary.rst index 8a8380a38..c102ff0f2 100644 --- a/classes/class_meshlibrary.rst +++ b/classes/class_meshlibrary.rst @@ -69,78 +69,108 @@ Method Descriptions Clear the library. +---- + .. _class_MeshLibrary_method_create_item: - void **create_item** **(** :ref:`int` id **)** Create a new item in the library, supplied an id. +---- + .. _class_MeshLibrary_method_find_item_by_name: - :ref:`int` **find_item_by_name** **(** :ref:`String` name **)** const +---- + .. _class_MeshLibrary_method_get_item_list: - :ref:`PoolIntArray` **get_item_list** **(** **)** const Returns the list of items. +---- + .. _class_MeshLibrary_method_get_item_mesh: - :ref:`Mesh` **get_item_mesh** **(** :ref:`int` id **)** const Returns the mesh of the item. +---- + .. _class_MeshLibrary_method_get_item_name: - :ref:`String` **get_item_name** **(** :ref:`int` id **)** const Returns the name of the item. +---- + .. _class_MeshLibrary_method_get_item_navmesh: - :ref:`NavigationMesh` **get_item_navmesh** **(** :ref:`int` id **)** const +---- + .. _class_MeshLibrary_method_get_item_preview: - :ref:`Texture` **get_item_preview** **(** :ref:`int` id **)** const +---- + .. _class_MeshLibrary_method_get_item_shapes: - :ref:`Array` **get_item_shapes** **(** :ref:`int` id **)** const +---- + .. _class_MeshLibrary_method_get_last_unused_item_id: - :ref:`int` **get_last_unused_item_id** **(** **)** const Get an unused id for a new item. +---- + .. _class_MeshLibrary_method_remove_item: - void **remove_item** **(** :ref:`int` id **)** Remove the item. +---- + .. _class_MeshLibrary_method_set_item_mesh: - void **set_item_mesh** **(** :ref:`int` id, :ref:`Mesh` mesh **)** Set the mesh of the item. +---- + .. _class_MeshLibrary_method_set_item_name: - void **set_item_name** **(** :ref:`int` id, :ref:`String` name **)** Set the name of the item. +---- + .. _class_MeshLibrary_method_set_item_navmesh: - void **set_item_navmesh** **(** :ref:`int` id, :ref:`NavigationMesh` navmesh **)** +---- + .. _class_MeshLibrary_method_set_item_preview: - void **set_item_preview** **(** :ref:`int` id, :ref:`Texture` texture **)** +---- + .. _class_MeshLibrary_method_set_item_shapes: - void **set_item_shapes** **(** :ref:`int` id, :ref:`Array` shapes **)** diff --git a/classes/class_mobilevrinterface.rst b/classes/class_mobilevrinterface.rst index 961429bda..f1f7d5654 100644 --- a/classes/class_mobilevrinterface.rst +++ b/classes/class_mobilevrinterface.rst @@ -67,6 +67,8 @@ Property Descriptions The distance between the display and the lenses inside of the device in centimeters. +---- + .. _class_MobileVRInterface_property_display_width: - :ref:`float` **display_width** @@ -79,6 +81,8 @@ The distance between the display and the lenses inside of the device in centimet The width of the display in centimeters. +---- + .. _class_MobileVRInterface_property_eye_height: - :ref:`float` **eye_height** @@ -91,6 +95,8 @@ The width of the display in centimeters. The height at which the camera is placed in relation to the ground (i.e. :ref:`ARVROrigin` node). +---- + .. _class_MobileVRInterface_property_iod: - :ref:`float` **iod** @@ -103,6 +109,8 @@ The height at which the camera is placed in relation to the ground (i.e. :ref:`A The interocular distance, also known as the interpupillary distance. The distance between the pupils of the left and right eye. +---- + .. _class_MobileVRInterface_property_k1: - :ref:`float` **k1** @@ -115,6 +123,8 @@ The interocular distance, also known as the interpupillary distance. The distanc The k1 lens factor is one of the two constants that define the strength of the lens used and directly influences the lens distortion effect. +---- + .. _class_MobileVRInterface_property_k2: - :ref:`float` **k2** @@ -127,6 +137,8 @@ The k1 lens factor is one of the two constants that define the strength of the l The k2 lens factor, see k1. +---- + .. _class_MobileVRInterface_property_oversample: - :ref:`float` **oversample** diff --git a/classes/class_multimesh.rst b/classes/class_multimesh.rst index e7e75cced..d760464c7 100644 --- a/classes/class_multimesh.rst +++ b/classes/class_multimesh.rst @@ -73,6 +73,8 @@ enum **TransformFormat**: - **TRANSFORM_3D** = **1** --- Use this when using 3D transforms. +---- + .. _enum_MultiMesh_ColorFormat: .. _class_MultiMesh_constant_COLOR_NONE: @@ -89,6 +91,8 @@ enum **ColorFormat**: - **COLOR_FLOAT** = **2** --- The :ref:`Color` passed into :ref:`set_instance_color` will use 4 floats. Use this for highest precision :ref:`Color`. +---- + .. _enum_MultiMesh_CustomDataFormat: .. _class_MultiMesh_constant_CUSTOM_DATA_NONE: @@ -136,6 +140,8 @@ Property Descriptions Format of colors in color array that gets passed to shader. +---- + .. _class_MultiMesh_property_custom_data_format: - :ref:`CustomDataFormat` **custom_data_format** @@ -148,6 +154,8 @@ Format of colors in color array that gets passed to shader. Format of custom data in custom data array that gets passed to shader. +---- + .. _class_MultiMesh_property_instance_count: - :ref:`int` **instance_count** @@ -160,6 +168,8 @@ Format of custom data in custom data array that gets passed to shader. Number of instances that will get drawn. +---- + .. _class_MultiMesh_property_mesh: - :ref:`Mesh` **mesh** @@ -172,6 +182,8 @@ Number of instances that will get drawn. Mesh to be drawn. +---- + .. _class_MultiMesh_property_transform_format: - :ref:`TransformFormat` **transform_format** @@ -184,6 +196,8 @@ Mesh to be drawn. Format of transform used to transform mesh, either 2D or 3D. +---- + .. _class_MultiMesh_property_visible_instance_count: - :ref:`int` **visible_instance_count** @@ -203,30 +217,40 @@ Method Descriptions Returns the visibility AABB. +---- + .. _class_MultiMesh_method_get_instance_color: - :ref:`Color` **get_instance_color** **(** :ref:`int` instance **)** const Get the color of a specific instance. +---- + .. _class_MultiMesh_method_get_instance_custom_data: - :ref:`Color` **get_instance_custom_data** **(** :ref:`int` instance **)** const Returns the custom data that has been set for a specific instance. +---- + .. _class_MultiMesh_method_get_instance_transform: - :ref:`Transform` **get_instance_transform** **(** :ref:`int` instance **)** const Returns the :ref:`Transform` of a specific instance. +---- + .. _class_MultiMesh_method_get_instance_transform_2d: - :ref:`Transform2D` **get_instance_transform_2d** **(** :ref:`int` instance **)** const Returns the :ref:`Transform2D` of a specific instance. +---- + .. _class_MultiMesh_method_set_instance_color: - void **set_instance_color** **(** :ref:`int` instance, :ref:`Color` color **)** @@ -235,18 +259,24 @@ Set the color of a specific instance. For the color to take effect, ensure that :ref:`color_format` is non-``null`` on the ``MultiMesh`` and :ref:`SpatialMaterial.vertex_color_use_as_albedo` is ``true`` on the material. +---- + .. _class_MultiMesh_method_set_instance_custom_data: - void **set_instance_custom_data** **(** :ref:`int` instance, :ref:`Color` custom_data **)** Set custom data for a specific instance. Although :ref:`Color` is used, it is just a container for 4 numbers. +---- + .. _class_MultiMesh_method_set_instance_transform: - void **set_instance_transform** **(** :ref:`int` instance, :ref:`Transform` transform **)** Set the transform for a specific instance. +---- + .. _class_MultiMesh_method_set_instance_transform_2d: - void **set_instance_transform_2d** **(** :ref:`int` instance, :ref:`Transform2D` transform **)** diff --git a/classes/class_multiplayerapi.rst b/classes/class_multiplayerapi.rst index dfccf9378..e92ced7fb 100644 --- a/classes/class_multiplayerapi.rst +++ b/classes/class_multiplayerapi.rst @@ -61,30 +61,40 @@ Signals Emitted whenever this MultiplayerAPI's :ref:`network_peer` successfully connected to a server. Only emitted on clients. +---- + .. _class_MultiplayerAPI_signal_connection_failed: - **connection_failed** **(** **)** Emitted whenever this MultiplayerAPI's :ref:`network_peer` fails to establish a connection to a server. Only emitted on clients. +---- + .. _class_MultiplayerAPI_signal_network_peer_connected: - **network_peer_connected** **(** :ref:`int` id **)** Emitted whenever this MultiplayerAPI's :ref:`network_peer` connects with a new peer. ID is the peer ID of the new peer. Clients get notified when other clients connect to the same server. Upon connecting to a server, a client also receives this signal for the server (with ID being 1). +---- + .. _class_MultiplayerAPI_signal_network_peer_disconnected: - **network_peer_disconnected** **(** :ref:`int` id **)** Emitted whenever this MultiplayerAPI's :ref:`network_peer` disconnects from a peer. Clients get notified when other clients disconnect from the same server. +---- + .. _class_MultiplayerAPI_signal_network_peer_packet: - **network_peer_packet** **(** :ref:`int` id, :ref:`PoolByteArray` packet **)** Emitted whenever this MultiplayerAPI's :ref:`network_peer` receive a ``packet`` with custom data (see :ref:`send_bytes`). ID is the peer ID of the peer that sent the packet. +---- + .. _class_MultiplayerAPI_signal_server_disconnected: - **server_disconnected** **(** **)** @@ -160,6 +170,8 @@ If ``true`` (or if the :ref:`network_peer` **network_peer** @@ -172,6 +184,8 @@ If ``true`` (or if the :ref:`network_peer`) 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 puppet. 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 MultiplayerAPI's signals. +---- + .. _class_MultiplayerAPI_property_refuse_new_network_connections: - :ref:`bool` **refuse_new_network_connections** @@ -193,18 +207,24 @@ Method Descriptions Clears the current MultiplayerAPI network state (you shouldn't call this unless you know what you are doing). +---- + .. _class_MultiplayerAPI_method_get_network_connected_peers: - :ref:`PoolIntArray` **get_network_connected_peers** **(** **)** const Returns the peer IDs of all connected peers of this MultiplayerAPI's :ref:`network_peer`. +---- + .. _class_MultiplayerAPI_method_get_network_unique_id: - :ref:`int` **get_network_unique_id** **(** **)** const Returns the unique peer ID of this MultiplayerAPI's :ref:`network_peer`. +---- + .. _class_MultiplayerAPI_method_get_rpc_sender_id: - :ref:`int` **get_rpc_sender_id** **(** **)** const @@ -213,18 +233,24 @@ Returns the sender's peer ID for the RPC currently being executed. NOTE: If not inside an RPC this method will return 0. +---- + .. _class_MultiplayerAPI_method_has_network_peer: - :ref:`bool` **has_network_peer** **(** **)** const Returns ``true`` if there is a :ref:`network_peer` set. +---- + .. _class_MultiplayerAPI_method_is_network_server: - :ref:`bool` **is_network_server** **(** **)** const Returns ``true`` if this MultiplayerAPI's :ref:`network_peer` is in server mode (listening for connections). +---- + .. _class_MultiplayerAPI_method_poll: - void **poll** **(** **)** @@ -233,12 +259,16 @@ Method used for polling the MultiplayerAPI. You only need to worry about this if NOTE: This method results in RPCs and RSETs being called, so they will be executed in the same context of this function (e.g. ``_process``, ``physics``, :ref:`Thread`). +---- + .. _class_MultiplayerAPI_method_send_bytes: - :ref:`Error` **send_bytes** **(** :ref:`PoolByteArray` bytes, :ref:`int` id=0, :ref:`TransferMode` mode=2 **)** Sends the given raw ``bytes`` to a specific peer identified by ``id`` (see :ref:`NetworkedMultiplayerPeer.set_target_peer`). Default ID is ``0``, i.e. broadcast to all peers. +---- + .. _class_MultiplayerAPI_method_set_root_node: - void **set_root_node** **(** :ref:`Node` node **)** diff --git a/classes/class_mutex.rst b/classes/class_mutex.rst index 7e517d684..f67f87c19 100644 --- a/classes/class_mutex.rst +++ b/classes/class_mutex.rst @@ -43,12 +43,16 @@ Method Descriptions Lock this ``Mutex``, blocks until it is unlocked by the current owner. +---- + .. _class_Mutex_method_try_lock: - :ref:`Error` **try_lock** **(** **)** Try locking this ``Mutex``, does not block. Returns :ref:`@GlobalScope.OK` on success, :ref:`@GlobalScope.ERR_BUSY` otherwise. +---- + .. _class_Mutex_method_unlock: - void **unlock** **(** **)** diff --git a/classes/class_nativescript.rst b/classes/class_nativescript.rst index 5b590ca80..dbc6ba9da 100644 --- a/classes/class_nativescript.rst +++ b/classes/class_nativescript.rst @@ -59,6 +59,8 @@ Property Descriptions | *Getter* | get_class_name() | +----------+-----------------------+ +---- + .. _class_NativeScript_property_library: - :ref:`GDNativeLibrary` **library** @@ -69,6 +71,8 @@ Property Descriptions | *Getter* | get_library() | +----------+--------------------+ +---- + .. _class_NativeScript_property_script_class_icon_path: - :ref:`String` **script_class_icon_path** @@ -79,6 +83,8 @@ Property Descriptions | *Getter* | get_script_class_icon_path() | +----------+-----------------------------------+ +---- + .. _class_NativeScript_property_script_class_name: - :ref:`String` **script_class_name** @@ -98,24 +104,32 @@ Method Descriptions Returns the documentation string that was previously set with ``godot_nativescript_set_class_documentation``. +---- + .. _class_NativeScript_method_get_method_documentation: - :ref:`String` **get_method_documentation** **(** :ref:`String` method **)** const Returns the documentation string that was previously set with ``godot_nativescript_set_method_documentation``. +---- + .. _class_NativeScript_method_get_property_documentation: - :ref:`String` **get_property_documentation** **(** :ref:`String` path **)** const Returns the documentation string that was previously set with ``godot_nativescript_set_property_documentation``. +---- + .. _class_NativeScript_method_get_signal_documentation: - :ref:`String` **get_signal_documentation** **(** :ref:`String` signal_name **)** const Returns the documentation string that was previously set with ``godot_nativescript_set_signal_documentation``. +---- + .. _class_NativeScript_method_new: - :ref:`Object` **new** **(** ... **)** vararg diff --git a/classes/class_navigation.rst b/classes/class_navigation.rst index e5344ccdf..fe00bd635 100644 --- a/classes/class_navigation.rst +++ b/classes/class_navigation.rst @@ -75,42 +75,56 @@ Method Descriptions Returns the navigation point closest to the point given. Points are in local coordinate space. +---- + .. _class_Navigation_method_get_closest_point_normal: - :ref:`Vector3` **get_closest_point_normal** **(** :ref:`Vector3` to_point **)** Returns the surface normal at the navigation point closest to the point given. Useful for rotating a navigation agent according to the navigation mesh it moves on. +---- + .. _class_Navigation_method_get_closest_point_owner: - :ref:`Object` **get_closest_point_owner** **(** :ref:`Vector3` to_point **)** Returns the owner of the :ref:`NavigationMesh` which contains the navigation point closest to the point given. This is usually a :ref:`NavigationMeshInstance`. For meshes added via :ref:`navmesh_add`, returns the owner that was given (or ``null`` if the ``owner`` parameter was omitted). +---- + .. _class_Navigation_method_get_closest_point_to_segment: - :ref:`Vector3` **get_closest_point_to_segment** **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` use_collision=false **)** Returns the navigation point closest to the given line segment. When enabling ``use_collision``, only considers intersection points between segment and navigation meshes. If multiple intersection points are found, the one closest to the segment start point is returned. +---- + .. _class_Navigation_method_get_simple_path: - :ref:`PoolVector3Array` **get_simple_path** **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` optimize=true **)** Returns the path between two given points. Points are in local coordinate space. If ``optimize`` is ``true`` (the default), the agent properties associated with each :ref:`NavigationMesh` (radius, height, etc.) are considered in the path calculation, otherwise they are ignored. +---- + .. _class_Navigation_method_navmesh_add: - :ref:`int` **navmesh_add** **(** :ref:`NavigationMesh` mesh, :ref:`Transform` xform, :ref:`Object` owner=null **)** Adds a :ref:`NavigationMesh`. Returns an ID for use with :ref:`navmesh_remove` or :ref:`navmesh_set_transform`. If given, a :ref:`Transform2D` is applied to the polygon. The optional ``owner`` is used as return value for :ref:`get_closest_point_owner`. +---- + .. _class_Navigation_method_navmesh_remove: - void **navmesh_remove** **(** :ref:`int` id **)** Removes the :ref:`NavigationMesh` with the given ID. +---- + .. _class_Navigation_method_navmesh_set_transform: - void **navmesh_set_transform** **(** :ref:`int` id, :ref:`Transform` xform **)** diff --git a/classes/class_navigation2d.rst b/classes/class_navigation2d.rst index 188774037..caa114ce1 100644 --- a/classes/class_navigation2d.rst +++ b/classes/class_navigation2d.rst @@ -49,30 +49,40 @@ Method Descriptions Returns the navigation point closest to the point given. Points are in local coordinate space. +---- + .. _class_Navigation2D_method_get_closest_point_owner: - :ref:`Object` **get_closest_point_owner** **(** :ref:`Vector2` to_point **)** Returns the owner of the :ref:`NavigationPolygon` which contains the navigation point closest to the point given. This is usually a :ref:`NavigationPolygonInstance`. For polygons added via :ref:`navpoly_add`, returns the owner that was given (or ``null`` if the ``owner`` parameter was omitted). +---- + .. _class_Navigation2D_method_get_simple_path: - :ref:`PoolVector2Array` **get_simple_path** **(** :ref:`Vector2` start, :ref:`Vector2` end, :ref:`bool` optimize=true **)** Returns the path between two given points. Points are in local coordinate space. If ``optimize`` is ``true`` (the default), the path is smoothed by merging path segments where possible. +---- + .. _class_Navigation2D_method_navpoly_add: - :ref:`int` **navpoly_add** **(** :ref:`NavigationPolygon` mesh, :ref:`Transform2D` xform, :ref:`Object` owner=null **)** Adds a :ref:`NavigationPolygon`. Returns an ID for use with :ref:`navpoly_remove` or :ref:`navpoly_set_transform`. If given, a :ref:`Transform2D` is applied to the polygon. The optional ``owner`` is used as return value for :ref:`get_closest_point_owner`. +---- + .. _class_Navigation2D_method_navpoly_remove: - void **navpoly_remove** **(** :ref:`int` id **)** Removes the :ref:`NavigationPolygon` with the given ID. +---- + .. _class_Navigation2D_method_navpoly_set_transform: - void **navpoly_set_transform** **(** :ref:`int` id, :ref:`Transform2D` xform **)** diff --git a/classes/class_navigationmesh.rst b/classes/class_navigationmesh.rst index c2ade4eea..8516b32e7 100644 --- a/classes/class_navigationmesh.rst +++ b/classes/class_navigationmesh.rst @@ -104,6 +104,8 @@ Property Descriptions | *Getter* | get_agent_height() | +----------+-------------------------+ +---- + .. _class_NavigationMesh_property_agent/max_climb: - :ref:`float` **agent/max_climb** @@ -114,6 +116,8 @@ Property Descriptions | *Getter* | get_agent_max_climb() | +----------+----------------------------+ +---- + .. _class_NavigationMesh_property_agent/max_slope: - :ref:`float` **agent/max_slope** @@ -124,6 +128,8 @@ Property Descriptions | *Getter* | get_agent_max_slope() | +----------+----------------------------+ +---- + .. _class_NavigationMesh_property_agent/radius: - :ref:`float` **agent/radius** @@ -134,6 +140,8 @@ Property Descriptions | *Getter* | get_agent_radius() | +----------+-------------------------+ +---- + .. _class_NavigationMesh_property_cell/height: - :ref:`float` **cell/height** @@ -144,6 +152,8 @@ Property Descriptions | *Getter* | get_cell_height() | +----------+------------------------+ +---- + .. _class_NavigationMesh_property_cell/size: - :ref:`float` **cell/size** @@ -154,6 +164,8 @@ Property Descriptions | *Getter* | get_cell_size() | +----------+----------------------+ +---- + .. _class_NavigationMesh_property_detail/sample_distance: - :ref:`float` **detail/sample_distance** @@ -164,6 +176,8 @@ Property Descriptions | *Getter* | get_detail_sample_distance() | +----------+-----------------------------------+ +---- + .. _class_NavigationMesh_property_detail/sample_max_error: - :ref:`float` **detail/sample_max_error** @@ -174,6 +188,8 @@ Property Descriptions | *Getter* | get_detail_sample_max_error() | +----------+------------------------------------+ +---- + .. _class_NavigationMesh_property_edge/max_error: - :ref:`float` **edge/max_error** @@ -184,6 +200,8 @@ Property Descriptions | *Getter* | get_edge_max_error() | +----------+---------------------------+ +---- + .. _class_NavigationMesh_property_edge/max_length: - :ref:`float` **edge/max_length** @@ -194,6 +212,8 @@ Property Descriptions | *Getter* | get_edge_max_length() | +----------+----------------------------+ +---- + .. _class_NavigationMesh_property_filter/filter_walkable_low_height_spans: - :ref:`bool` **filter/filter_walkable_low_height_spans** @@ -204,6 +224,8 @@ Property Descriptions | *Getter* | get_filter_walkable_low_height_spans() | +----------+---------------------------------------------+ +---- + .. _class_NavigationMesh_property_filter/ledge_spans: - :ref:`bool` **filter/ledge_spans** @@ -214,6 +236,8 @@ Property Descriptions | *Getter* | get_filter_ledge_spans() | +----------+-------------------------------+ +---- + .. _class_NavigationMesh_property_filter/low_hanging_obstacles: - :ref:`bool` **filter/low_hanging_obstacles** @@ -224,6 +248,8 @@ Property Descriptions | *Getter* | get_filter_low_hanging_obstacles() | +----------+-----------------------------------------+ +---- + .. _class_NavigationMesh_property_polygon/verts_per_poly: - :ref:`float` **polygon/verts_per_poly** @@ -234,6 +260,8 @@ Property Descriptions | *Getter* | get_verts_per_poly() | +----------+---------------------------+ +---- + .. _class_NavigationMesh_property_region/merge_size: - :ref:`float` **region/merge_size** @@ -244,6 +272,8 @@ Property Descriptions | *Getter* | get_region_merge_size() | +----------+------------------------------+ +---- + .. _class_NavigationMesh_property_region/min_size: - :ref:`float` **region/min_size** @@ -254,6 +284,8 @@ Property Descriptions | *Getter* | get_region_min_size() | +----------+----------------------------+ +---- + .. _class_NavigationMesh_property_sample_partition_type/sample_partition_type: - :ref:`int` **sample_partition_type/sample_partition_type** @@ -271,26 +303,38 @@ Method Descriptions - void **add_polygon** **(** :ref:`PoolIntArray` polygon **)** +---- + .. _class_NavigationMesh_method_clear_polygons: - void **clear_polygons** **(** **)** +---- + .. _class_NavigationMesh_method_create_from_mesh: - void **create_from_mesh** **(** :ref:`Mesh` mesh **)** +---- + .. _class_NavigationMesh_method_get_polygon: - :ref:`PoolIntArray` **get_polygon** **(** :ref:`int` idx **)** +---- + .. _class_NavigationMesh_method_get_polygon_count: - :ref:`int` **get_polygon_count** **(** **)** const +---- + .. _class_NavigationMesh_method_get_vertices: - :ref:`PoolVector3Array` **get_vertices** **(** **)** const +---- + .. _class_NavigationMesh_method_set_vertices: - void **set_vertices** **(** :ref:`PoolVector3Array` vertices **)** diff --git a/classes/class_navigationmeshinstance.rst b/classes/class_navigationmeshinstance.rst index 4b61fd2f8..c6fecc751 100644 --- a/classes/class_navigationmeshinstance.rst +++ b/classes/class_navigationmeshinstance.rst @@ -40,6 +40,8 @@ Property Descriptions | *Getter* | is_enabled() | +----------+--------------------+ +---- + .. _class_NavigationMeshInstance_property_navmesh: - :ref:`NavigationMesh` **navmesh** diff --git a/classes/class_navigationpolygon.rst b/classes/class_navigationpolygon.rst index 9fa577a28..d60db2678 100644 --- a/classes/class_navigationpolygon.rst +++ b/classes/class_navigationpolygon.rst @@ -86,78 +86,104 @@ Method Descriptions Appends a :ref:`PoolVector2Array` that contains the vertices of an outline to the internal array that contains all the outlines. You have to call :ref:`make_polygons_from_outlines` in order for this array to be converted to polygons that the engine will use. +---- + .. _class_NavigationPolygon_method_add_outline_at_index: - void **add_outline_at_index** **(** :ref:`PoolVector2Array` outline, :ref:`int` index **)** Adds a :ref:`PoolVector2Array` that contains the vertices of an outline to the internal array that contains all the outlines at a fixed position. You have to call :ref:`make_polygons_from_outlines` in order for this array to be converted to polygons that the engine will use. +---- + .. _class_NavigationPolygon_method_add_polygon: - void **add_polygon** **(** :ref:`PoolIntArray` polygon **)** Adds a polygon using the indices of the vertices you get when calling :ref:`get_vertices`. +---- + .. _class_NavigationPolygon_method_clear_outlines: - void **clear_outlines** **(** **)** Clears the array of the outlines, but it doesn't clear the vertices and the polygons that were created by them. +---- + .. _class_NavigationPolygon_method_clear_polygons: - void **clear_polygons** **(** **)** Clears the array of polygons, but it doesn't clear the array of outlines and vertices. +---- + .. _class_NavigationPolygon_method_get_outline: - :ref:`PoolVector2Array` **get_outline** **(** :ref:`int` idx **)** const Returns a :ref:`PoolVector2Array` containing the vertices of an outline that was created in the editor or by script. +---- + .. _class_NavigationPolygon_method_get_outline_count: - :ref:`int` **get_outline_count** **(** **)** const Returns the number of outlines that were created in the editor or by script. +---- + .. _class_NavigationPolygon_method_get_polygon: - :ref:`PoolIntArray` **get_polygon** **(** :ref:`int` idx **)** Returns a :ref:`PoolIntArray` containing the indices of the vertices of a created polygon. +---- + .. _class_NavigationPolygon_method_get_polygon_count: - :ref:`int` **get_polygon_count** **(** **)** const Returns the count of all polygons. +---- + .. _class_NavigationPolygon_method_get_vertices: - :ref:`PoolVector2Array` **get_vertices** **(** **)** const Returns a :ref:`PoolVector2Array` containing all the vertices being used to create the polygons. +---- + .. _class_NavigationPolygon_method_make_polygons_from_outlines: - void **make_polygons_from_outlines** **(** **)** Creates polygons from the outlines added in the editor or by script. +---- + .. _class_NavigationPolygon_method_remove_outline: - void **remove_outline** **(** :ref:`int` idx **)** Removes an outline created in the editor or by script. You have to call :ref:`make_polygons_from_outlines` for the polygons to update. +---- + .. _class_NavigationPolygon_method_set_outline: - void **set_outline** **(** :ref:`int` idx, :ref:`PoolVector2Array` outline **)** Changes an outline created in the editor or by script. You have to call :ref:`make_polygons_from_outlines` for the polygons to update. +---- + .. _class_NavigationPolygon_method_set_vertices: - void **set_vertices** **(** :ref:`PoolVector2Array` vertices **)** diff --git a/classes/class_navigationpolygoninstance.rst b/classes/class_navigationpolygoninstance.rst index f4ed108a6..2a23c63e4 100644 --- a/classes/class_navigationpolygoninstance.rst +++ b/classes/class_navigationpolygoninstance.rst @@ -40,6 +40,8 @@ Property Descriptions | *Getter* | is_enabled() | +----------+--------------------+ +---- + .. _class_NavigationPolygonInstance_property_navpoly: - :ref:`NavigationPolygon` **navpoly** diff --git a/classes/class_networkedmultiplayerenet.rst b/classes/class_networkedmultiplayerenet.rst index 186dd08ec..813c62b5e 100644 --- a/classes/class_networkedmultiplayerenet.rst +++ b/classes/class_networkedmultiplayerenet.rst @@ -108,6 +108,8 @@ Property Descriptions Enforce ordered packets when using :ref:`NetworkedMultiplayerPeer.TRANSFER_MODE_UNRELIABLE` (thus behaving similarly to :ref:`NetworkedMultiplayerPeer.TRANSFER_MODE_UNRELIABLE_ORDERED`). This is the only way to use ordering with the RPC system. +---- + .. _class_NetworkedMultiplayerENet_property_channel_count: - :ref:`int` **channel_count** @@ -120,6 +122,8 @@ Enforce ordered packets when using :ref:`NetworkedMultiplayerPeer.TRANSFER_MODE_ The number of channels to be used by ENet. Default: ``3``. Channels are used to separate different kinds of data. In realiable or ordered mode, for example, the packet delivery order is ensured on a per channel basis. +---- + .. _class_NetworkedMultiplayerENet_property_compression_mode: - :ref:`CompressionMode` **compression_mode** @@ -132,6 +136,8 @@ The number of channels to be used by ENet. Default: ``3``. Channels are used to The compression method used for network packets. Default is no compression. These have different tradeoffs of compression speed versus bandwidth, you may need to test which one works best for your use case if you use compression at all. +---- + .. _class_NetworkedMultiplayerENet_property_transfer_channel: - :ref:`int` **transfer_channel** @@ -153,48 +159,64 @@ Method Descriptions Closes the connection. Ignored if no connection is currently established. If this is a server it tries to notify all clients before forcibly disconnecting them. If this is a client it simply closes the connection to the server. +---- + .. _class_NetworkedMultiplayerENet_method_create_client: - :ref:`Error` **create_client** **(** :ref:`String` address, :ref:`int` port, :ref:`int` in_bandwidth=0, :ref:`int` out_bandwidth=0, :ref:`int` client_port=0 **)** Create client that connects to a server at ``address`` using specified ``port``. The given address needs to be either a fully qualified domain name (e.g. ``www.example.com``) or an IP address in IPv4 or IPv6 format (e.g. ``192.168.1.1``). The ``port`` is the port the server is listening on. The ``in_bandwidth`` and ``out_bandwidth`` parameters can be used to limit the incoming and outgoing bandwidth to the given number of bytes per second. The default of 0 means unlimited bandwidth. Note that ENet will strategically drop packets on specific sides of a connection between peers to ensure the peer's bandwidth is not overwhelmed. The bandwidth parameters also determine the window size of a connection which limits the amount of reliable packets that may be in transit at any given time. Returns :ref:`@GlobalScope.OK` if a client was created, :ref:`@GlobalScope.ERR_ALREADY_IN_USE` if this NetworkedMultiplayerEnet instance already has an open connection (in which case you need to call :ref:`close_connection` first) or :ref:`@GlobalScope.ERR_CANT_CREATE` if the client could not be created. If ``client_port`` is specified, the client will also listen to the given port, this is useful in some NAT traversal technique. +---- + .. _class_NetworkedMultiplayerENet_method_create_server: - :ref:`Error` **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``. The port needs to be an available, unused port between 0 and 65535. Note that ports below 1024 are privileged and may require elevated permissions depending on the platform. To change the interface the server listens on, use :ref:`set_bind_ip`. The default IP is the wildcard ``*``, which listens on all available interfaces. ``max_clients`` is the maximum number of clients that are allowed at once, any number up to 4096 may be used, although the achievable number of simultaneous clients may be far lower and depends on the application. For additional details on the bandwidth parameters, see :ref:`create_client`. Returns :ref:`@GlobalScope.OK` if a server was created, :ref:`@GlobalScope.ERR_ALREADY_IN_USE` if this NetworkedMultiplayerEnet instance already has an open connection (in which case you need to call :ref:`close_connection` first) or :ref:`@GlobalScope.ERR_CANT_CREATE` if the server could not be created. +---- + .. _class_NetworkedMultiplayerENet_method_disconnect_peer: - void **disconnect_peer** **(** :ref:`int` id, :ref:`bool` now=false **)** Disconnect the given peer. If "now" is set to ``true``, the connection will be closed immediately without flushing queued messages. +---- + .. _class_NetworkedMultiplayerENet_method_get_last_packet_channel: - :ref:`int` **get_last_packet_channel** **(** **)** const Returns the channel of the last packet fetched via :ref:`PacketPeer.get_packet` +---- + .. _class_NetworkedMultiplayerENet_method_get_packet_channel: - :ref:`int` **get_packet_channel** **(** **)** const Returns the channel of the next packet that will be retrieved via :ref:`PacketPeer.get_packet` +---- + .. _class_NetworkedMultiplayerENet_method_get_peer_address: - :ref:`String` **get_peer_address** **(** :ref:`int` id **)** const Returns the IP address of the given peer. +---- + .. _class_NetworkedMultiplayerENet_method_get_peer_port: - :ref:`int` **get_peer_port** **(** :ref:`int` id **)** const Returns the remote port of the given peer. +---- + .. _class_NetworkedMultiplayerENet_method_set_bind_ip: - void **set_bind_ip** **(** :ref:`String` ip **)** diff --git a/classes/class_networkedmultiplayerpeer.rst b/classes/class_networkedmultiplayerpeer.rst index 6c2e65f0d..568a7b9da 100644 --- a/classes/class_networkedmultiplayerpeer.rst +++ b/classes/class_networkedmultiplayerpeer.rst @@ -53,24 +53,32 @@ Signals Emitted when a connection attempt fails. +---- + .. _class_NetworkedMultiplayerPeer_signal_connection_succeeded: - **connection_succeeded** **(** **)** Emitted when a connection attempt succeeds. +---- + .. _class_NetworkedMultiplayerPeer_signal_peer_connected: - **peer_connected** **(** :ref:`int` id **)** Emitted by the server when a client connects. +---- + .. _class_NetworkedMultiplayerPeer_signal_peer_disconnected: - **peer_disconnected** **(** :ref:`int` id **)** Emitted by the server when a client disconnects. +---- + .. _class_NetworkedMultiplayerPeer_signal_server_disconnected: - **server_disconnected** **(** **)** @@ -96,6 +104,8 @@ enum **TransferMode**: - **TRANSFER_MODE_RELIABLE** = **2** --- Packets must be received and resend attempts should be made until the packets are acknowledged. Packets must be received in the order they were sent in. Most reliable transfer mode, but potentially slowest due to the overhead. Use for critical data that must be transmitted and arrive in order, for example an ability being triggered or a chat message. Consider carefully if the information really is critical, and use sparingly. +---- + .. _enum_NetworkedMultiplayerPeer_ConnectionStatus: .. _class_NetworkedMultiplayerPeer_constant_CONNECTION_DISCONNECTED: @@ -148,6 +158,8 @@ Property Descriptions If ``true``, this ``NetworkedMultiplayerPeer`` refuses new connections. Default value: ``false``. +---- + .. _class_NetworkedMultiplayerPeer_property_transfer_mode: - :ref:`TransferMode` **transfer_mode** @@ -169,24 +181,32 @@ Method Descriptions Returns the current state of the connection. See :ref:`ConnectionStatus`. +---- + .. _class_NetworkedMultiplayerPeer_method_get_packet_peer: - :ref:`int` **get_packet_peer** **(** **)** const Returns the ID of the ``NetworkedMultiplayerPeer`` who sent the most recent packet. +---- + .. _class_NetworkedMultiplayerPeer_method_get_unique_id: - :ref:`int` **get_unique_id** **(** **)** const Returns the ID of this ``NetworkedMultiplayerPeer``. +---- + .. _class_NetworkedMultiplayerPeer_method_poll: - void **poll** **(** **)** Waits up to 1 second to receive a new network event. +---- + .. _class_NetworkedMultiplayerPeer_method_set_target_peer: - void **set_target_peer** **(** :ref:`int` id **)** diff --git a/classes/class_nil.rst b/classes/class_nil.rst index 45da9427a..671852b3f 100644 --- a/classes/class_nil.rst +++ b/classes/class_nil.rst @@ -80,53 +80,103 @@ Method Descriptions - void **Nil** **(** :ref:`PoolColorArray` from **)** +---- + - void **Nil** **(** :ref:`PoolVector3Array` from **)** +---- + - void **Nil** **(** :ref:`PoolVector2Array` from **)** +---- + - void **Nil** **(** :ref:`PoolStringArray` from **)** +---- + - void **Nil** **(** :ref:`PoolRealArray` from **)** +---- + - void **Nil** **(** :ref:`PoolIntArray` from **)** +---- + - void **Nil** **(** :ref:`PoolByteArray` from **)** +---- + - void **Nil** **(** :ref:`Array` from **)** +---- + - void **Nil** **(** :ref:`Dictionary` from **)** +---- + - void **Nil** **(** :ref:`Object` from **)** +---- + - void **Nil** **(** :ref:`RID` from **)** +---- + - void **Nil** **(** :ref:`NodePath` from **)** +---- + - void **Nil** **(** :ref:`Color` from **)** +---- + - void **Nil** **(** :ref:`Transform` from **)** +---- + - void **Nil** **(** :ref:`Basis` from **)** +---- + - void **Nil** **(** :ref:`AABB` from **)** +---- + - void **Nil** **(** :ref:`Quat` from **)** +---- + - void **Nil** **(** :ref:`Plane` from **)** +---- + - void **Nil** **(** :ref:`Transform2D` from **)** +---- + - void **Nil** **(** :ref:`Vector3` from **)** +---- + - void **Nil** **(** :ref:`Rect2` from **)** +---- + - void **Nil** **(** :ref:`Vector2` from **)** +---- + - void **Nil** **(** :ref:`String` from **)** +---- + - void **Nil** **(** :ref:`float` from **)** +---- + - void **Nil** **(** :ref:`int` from **)** +---- + - void **Nil** **(** :ref:`bool` from **)** diff --git a/classes/class_ninepatchrect.rst b/classes/class_ninepatchrect.rst index 9dca71b3a..1d56fe1a8 100644 --- a/classes/class_ninepatchrect.rst +++ b/classes/class_ninepatchrect.rst @@ -89,6 +89,8 @@ Property Descriptions Doesn't do anything at the time of writing. +---- + .. _class_NinePatchRect_property_axis_stretch_vertical: - :ref:`AxisStretchMode` **axis_stretch_vertical** @@ -101,6 +103,8 @@ Doesn't do anything at the time of writing. Doesn't do anything at the time of writing. +---- + .. _class_NinePatchRect_property_draw_center: - :ref:`bool` **draw_center** @@ -113,6 +117,8 @@ Doesn't do anything at the time of writing. If ``true``, draw the panel's center. Else, only draw the 9-slice's borders. Default value: ``true`` +---- + .. _class_NinePatchRect_property_patch_margin_bottom: - :ref:`int` **patch_margin_bottom** @@ -125,6 +131,8 @@ If ``true``, draw the panel's center. Else, only draw the 9-slice's borders. Def The height of the 9-slice's bottom row. A margin of 16 means the 9-slice's bottom corners and side will have a height of 16 pixels. You can set all 4 margin values individually to create panels with non-uniform borders. +---- + .. _class_NinePatchRect_property_patch_margin_left: - :ref:`int` **patch_margin_left** @@ -137,6 +145,8 @@ The height of the 9-slice's bottom row. A margin of 16 means the 9-slice's botto The height of the 9-slice's left column. +---- + .. _class_NinePatchRect_property_patch_margin_right: - :ref:`int` **patch_margin_right** @@ -149,6 +159,8 @@ The height of the 9-slice's left column. The height of the 9-slice's right column. +---- + .. _class_NinePatchRect_property_patch_margin_top: - :ref:`int` **patch_margin_top** @@ -161,6 +173,8 @@ The height of the 9-slice's right column. The height of the 9-slice's top row. +---- + .. _class_NinePatchRect_property_region_rect: - :ref:`Rect2` **region_rect** @@ -173,6 +187,8 @@ The height of the 9-slice's top row. Rectangular region of the texture to sample from. If you're working with an atlas, use this property to define the area the 9-slice should use. All other properties are relative to this one. +---- + .. _class_NinePatchRect_property_texture: - :ref:`Texture` **texture** diff --git a/classes/class_node.rst b/classes/class_node.rst index f85b61229..a8a9f3ee3 100644 --- a/classes/class_node.rst +++ b/classes/class_node.rst @@ -217,24 +217,32 @@ Signals Emitted when the node is ready. +---- + .. _class_Node_signal_renamed: - **renamed** **(** **)** Emitted when the node is renamed. +---- + .. _class_Node_signal_tree_entered: - **tree_entered** **(** **)** Emitted when the node enters the tree. +---- + .. _class_Node_signal_tree_exited: - **tree_exited** **(** **)** Emitted after the node exits the tree and is no longer active. +---- + .. _class_Node_signal_tree_exiting: - **tree_exiting** **(** **)** @@ -260,6 +268,8 @@ enum **PauseMode**: - **PAUSE_MODE_PROCESS** = **2** --- Continue to process regardless of the :ref:`SceneTree` pause state. +---- + .. _enum_Node_DuplicateFlags: .. _class_Node_constant_DUPLICATE_SIGNALS: @@ -396,6 +406,8 @@ Property Descriptions The override to the default :ref:`MultiplayerAPI`. Set to null to use the default SceneTree one. +---- + .. _class_Node_property_filename: - :ref:`String` **filename** @@ -408,6 +420,8 @@ The override to the default :ref:`MultiplayerAPI`. Set to When a scene is instanced from a file, its topmost node contains the filename from which it was loaded. +---- + .. _class_Node_property_multiplayer: - :ref:`MultiplayerAPI` **multiplayer** @@ -418,6 +432,8 @@ When a scene is instanced from a file, its topmost node contains the filename fr The :ref:`MultiplayerAPI` instance associated with this node. Either the :ref:`custom_multiplayer`, or the default SceneTree one (if inside tree). +---- + .. _class_Node_property_name: - :ref:`String` **name** @@ -430,6 +446,8 @@ The :ref:`MultiplayerAPI` instance associated with this no The name of the node. This name is unique among the siblings (other child nodes from the same parent). When set to an existing name, the node will be automatically renamed +---- + .. _class_Node_property_owner: - :ref:`Node` **owner** @@ -442,6 +460,8 @@ The name of the node. This name is unique among the siblings (other child nodes The node owner. A node can have any other node as owner (as long as it is a valid parent, grandparent, etc. ascending in the tree). When saving a node (using :ref:`PackedScene`) all the nodes it owns will be saved with it. This allows for the creation of complex :ref:`SceneTree`\ s, with instancing and subinstancing. +---- + .. _class_Node_property_pause_mode: - :ref:`PauseMode` **pause_mode** @@ -465,6 +485,8 @@ Called when the node enters the :ref:`SceneTree` (e.g. upon ins Corresponds to the :ref:`NOTIFICATION_ENTER_TREE` notification in :ref:`Object._notification`. +---- + .. _class_Node_method__exit_tree: - void **_exit_tree** **(** **)** virtual @@ -473,6 +495,8 @@ Called when the node is about to leave the :ref:`SceneTree` (e. Corresponds to the :ref:`NOTIFICATION_EXIT_TREE` notification in :ref:`Object._notification` and signal :ref:`tree_exiting`. To get notified when the node has already left the active tree, connect to the :ref:`tree_exited` +---- + .. _class_Node_method__get_configuration_warning: - :ref:`String` **_get_configuration_warning** **(** **)** virtual @@ -481,6 +505,8 @@ The string returned from this method is displayed as a warning in the "Scene Doc Returning an empty string produces no warning. +---- + .. _class_Node_method__input: - void **_input** **(** :ref:`InputEvent` event **)** virtual @@ -493,6 +519,8 @@ To consume the input event and stop it propagating further to other nodes, :ref: For gameplay input, :ref:`_unhandled_input` and :ref:`_unhandled_key_input` are usually a better fit as they allow the GUI to intercept the events first. +---- + .. _class_Node_method__physics_process: - void **_physics_process** **(** :ref:`float` delta **)** virtual @@ -503,6 +531,8 @@ It is only called if physics processing is enabled, which is done automatically Corresponds to the :ref:`NOTIFICATION_PHYSICS_PROCESS` notification in :ref:`Object._notification`. +---- + .. _class_Node_method__process: - void **_process** **(** :ref:`float` delta **)** virtual @@ -513,6 +543,8 @@ It is only called if processing is enabled, which is done automatically if this Corresponds to the :ref:`NOTIFICATION_PROCESS` notification in :ref:`Object._notification`. +---- + .. _class_Node_method__ready: - void **_ready** **(** **)** virtual @@ -525,6 +557,8 @@ Usually used for initialization. For even earlier initialization, :ref:`Object._ **Note:** :ref:`_ready` may be called only once for each node. After removing a node from the scene tree and adding again, ``_ready`` will not be called for the second time. This can be bypassed with requesting another call with :ref:`request_ready`, which may be called anywhere before adding the node again. +---- + .. _class_Node_method__unhandled_input: - void **_unhandled_input** **(** :ref:`InputEvent` event **)** virtual @@ -537,6 +571,8 @@ To consume the input event and stop it propagating further to other nodes, :ref: For gameplay input, this and :ref:`_unhandled_key_input` are usually a better fit than :ref:`_input` as they allow the GUI to intercept the events first. +---- + .. _class_Node_method__unhandled_key_input: - void **_unhandled_key_input** **(** :ref:`InputEventKey` event **)** virtual @@ -549,6 +585,8 @@ To consume the input event and stop it propagating further to other nodes, :ref: For gameplay input, this and :ref:`_unhandled_input` are usually a better fit than :ref:`_input` as they allow the GUI to intercept the events first. +---- + .. _class_Node_method_add_child: - void **add_child** **(** :ref:`Node` node, :ref:`bool` legible_unique_name=false **)** @@ -557,6 +595,8 @@ Adds a child node. Nodes can have any number of children, but every child must h Setting ``legible_unique_name`` to ``true`` creates child nodes with human-readable names, based on the name of the node being instanced instead of its type. +---- + .. _class_Node_method_add_child_below_node: - void **add_child_below_node** **(** :ref:`Node` node, :ref:`Node` child_node, :ref:`bool` legible_unique_name=false **)** @@ -565,6 +605,8 @@ Adds a child node. The child is placed below the given node in the list of child Setting ``legible_unique_name`` to ``true`` creates child nodes with human-readable names, based on the name of the node being instanced instead of its type. +---- + .. _class_Node_method_add_to_group: - void **add_to_group** **(** :ref:`String` group, :ref:`bool` persistent=false **)** @@ -573,12 +615,16 @@ Adds the node to a group. Groups are helpers to name and organize a subset of no The ``persistent`` option is used when packing node to :ref:`PackedScene` and saving to file. Non-persistent groups aren't stored. +---- + .. _class_Node_method_can_process: - :ref:`bool` **can_process** **(** **)** const Returns ``true`` if the node can process while the scene tree is paused (see :ref:`pause_mode`). Always returns ``true`` if the scene tree is not paused, and ``false`` if the node is not in the tree. +---- + .. _class_Node_method_duplicate: - :ref:`Node` **duplicate** **(** :ref:`int` flags=15 **)** const @@ -587,6 +633,8 @@ Duplicates the node, returning a new node. You can fine-tune the behavior using the ``flags`` (see :ref:`DuplicateFlags`). +---- + .. _class_Node_method_find_node: - :ref:`Node` **find_node** **(** :ref:`String` mask, :ref:`bool` recursive=true, :ref:`bool` owned=true **)** const @@ -595,12 +643,16 @@ Finds a descendant of this node whose name matches ``mask`` as in :ref:`String.m If ``owned`` is ``true``, this method only finds nodes whose owner is this node. This is especially important for scenes instantiated through script, because those scenes don't have an owner. +---- + .. _class_Node_method_find_parent: - :ref:`Node` **find_parent** **(** :ref:`String` mask **)** const Finds the first parent of the current 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_method_get_child: - :ref:`Node` **get_child** **(** :ref:`int` idx **)** const @@ -609,36 +661,48 @@ Returns a child node by its index (see :ref:`get_child_count`. +---- + .. _class_Node_method_get_child_count: - :ref:`int` **get_child_count** **(** **)** const Returns the number of child nodes. +---- + .. _class_Node_method_get_children: - :ref:`Array` **get_children** **(** **)** const Returns an array of references to node's children. +---- + .. _class_Node_method_get_groups: - :ref:`Array` **get_groups** **(** **)** const Returns an array listing the groups that the node is a member of. +---- + .. _class_Node_method_get_index: - :ref:`int` **get_index** **(** **)** const Returns the node's index, i.e. its position among the siblings of its parent. +---- + .. _class_Node_method_get_network_master: - :ref:`int` **get_network_master** **(** **)** const Returns the peer ID of the network master for this node. See :ref:`set_network_master`. +---- + .. _class_Node_method_get_node: - :ref:`Node` **get_node** **(** :ref:`NodePath` path **)** const @@ -669,170 +733,228 @@ Possible paths are: get_node("../Swamp/Alligator") get_node("/root/MyGame") +---- + .. _class_Node_method_get_node_and_resource: - :ref:`Array` **get_node_and_resource** **(** :ref:`NodePath` path **)** +---- + .. _class_Node_method_get_node_or_null: - :ref:`Node` **get_node_or_null** **(** :ref:`NodePath` path **)** const Similar to :ref:`get_node`, but does not raise an error when ``path`` does not point to a valid ``Node``. +---- + .. _class_Node_method_get_parent: - :ref:`Node` **get_parent** **(** **)** const Returns the parent node of the current node, or an empty ``Node`` if the node lacks a parent. +---- + .. _class_Node_method_get_path: - :ref:`NodePath` **get_path** **(** **)** const Returns 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_method_get_path_to: - :ref:`NodePath` **get_path_to** **(** :ref:`Node` node **)** const Returns the relative :ref:`NodePath` from this node to the specified ``node``. Both nodes must be in the same scene or the function will fail. +---- + .. _class_Node_method_get_physics_process_delta_time: - :ref:`float` **get_physics_process_delta_time** **(** **)** const Returns 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 via :ref:`Engine.target_fps`. +---- + .. _class_Node_method_get_position_in_parent: - :ref:`int` **get_position_in_parent** **(** **)** const Returns the node's order in the scene tree branch. For example, if called on the first child node the position is ``0``. +---- + .. _class_Node_method_get_process_delta_time: - :ref:`float` **get_process_delta_time** **(** **)** const Returns the time elapsed (in seconds) since the last process callback. This value may vary from frame to frame. +---- + .. _class_Node_method_get_scene_instance_load_placeholder: - :ref:`bool` **get_scene_instance_load_placeholder** **(** **)** const Returns ``true`` if this is an instance load placeholder. See :ref:`InstancePlaceholder`. +---- + .. _class_Node_method_get_tree: - :ref:`SceneTree` **get_tree** **(** **)** const Returns the :ref:`SceneTree` that contains this node. +---- + .. _class_Node_method_get_viewport: - :ref:`Viewport` **get_viewport** **(** **)** const Returns the node's :ref:`Viewport`. +---- + .. _class_Node_method_has_node: - :ref:`bool` **has_node** **(** :ref:`NodePath` path **)** const Returns ``true`` if the node that the :ref:`NodePath` points to exists. +---- + .. _class_Node_method_has_node_and_resource: - :ref:`bool` **has_node_and_resource** **(** :ref:`NodePath` path **)** const +---- + .. _class_Node_method_is_a_parent_of: - :ref:`bool` **is_a_parent_of** **(** :ref:`Node` node **)** const Returns ``true`` if the given node is a direct or indirect child of the current node. +---- + .. _class_Node_method_is_displayed_folded: - :ref:`bool` **is_displayed_folded** **(** **)** const Returns ``true`` if the node is folded (collapsed) in the Scene dock. +---- + .. _class_Node_method_is_greater_than: - :ref:`bool` **is_greater_than** **(** :ref:`Node` node **)** const Returns ``true`` if the given node occurs later in the scene hierarchy than the current node. +---- + .. _class_Node_method_is_in_group: - :ref:`bool` **is_in_group** **(** :ref:`String` group **)** const Returns ``true`` if this node is in the specified group. See notes in the description, and the group methods in :ref:`SceneTree`. +---- + .. _class_Node_method_is_inside_tree: - :ref:`bool` **is_inside_tree** **(** **)** const Returns ``true`` if this node is currently inside a :ref:`SceneTree`. +---- + .. _class_Node_method_is_network_master: - :ref:`bool` **is_network_master** **(** **)** const Returns ``true`` if the local system is the master of this node. +---- + .. _class_Node_method_is_physics_processing: - :ref:`bool` **is_physics_processing** **(** **)** const Returns ``true`` if physics processing is enabled (see :ref:`set_physics_process`). +---- + .. _class_Node_method_is_physics_processing_internal: - :ref:`bool` **is_physics_processing_internal** **(** **)** const Returns ``true`` if internal physics processing is enabled (see :ref:`set_physics_process_internal`). +---- + .. _class_Node_method_is_processing: - :ref:`bool` **is_processing** **(** **)** const Returns ``true`` if processing is enabled (see :ref:`set_process`). +---- + .. _class_Node_method_is_processing_input: - :ref:`bool` **is_processing_input** **(** **)** const Returns ``true`` if the node is processing input (see :ref:`set_process_input`). +---- + .. _class_Node_method_is_processing_internal: - :ref:`bool` **is_processing_internal** **(** **)** const Returns ``true`` if internal processing is enabled (see :ref:`set_process_internal`). +---- + .. _class_Node_method_is_processing_unhandled_input: - :ref:`bool` **is_processing_unhandled_input** **(** **)** const Returns ``true`` if the node is processing unhandled input (see :ref:`set_process_unhandled_input`). +---- + .. _class_Node_method_is_processing_unhandled_key_input: - :ref:`bool` **is_processing_unhandled_key_input** **(** **)** const Returns ``true`` if the node is processing unhandled key input (see :ref:`set_process_unhandled_key_input`). +---- + .. _class_Node_method_move_child: - void **move_child** **(** :ref:`Node` child_node, :ref:`int` to_position **)** Moves a child node to a different position (order) among the other children. Since calls, signals, etc are performed by tree order, changing the order of children nodes may be useful. +---- + .. _class_Node_method_print_stray_nodes: - void **print_stray_nodes** **(** **)** Prints all stray nodes (nodes outside the :ref:`SceneTree`). Used for debugging. Works only in debug builds. +---- + .. _class_Node_method_print_tree: - void **print_tree** **(** **)** @@ -848,6 +970,8 @@ Prints the tree to stdout. Used mainly for debugging purposes. This version disp TheGame/SplashScreen TheGame/SplashScreen/Camera2D +---- + .. _class_Node_method_print_tree_pretty: - void **print_tree_pretty** **(** **)** @@ -863,180 +987,240 @@ Similar to :ref:`print_tree`, this prints the tree β”–-SplashScreen β”–β•΄Camera2D +---- + .. _class_Node_method_propagate_call: - void **propagate_call** **(** :ref:`String` method, :ref:`Array` args=[ ], :ref:`bool` parent_first=false **)** Calls the given method (if present) with the arguments given in ``args`` on this node and recursively on all its children. If the ``parent_first`` argument is ``true`` then the method will be called on the current node first, then on all children. If it is ``false`` then the children will be called first. +---- + .. _class_Node_method_propagate_notification: - void **propagate_notification** **(** :ref:`int` what **)** Notifies the current node and all its children recursively by calling :ref:`Object.notification` on all of them. +---- + .. _class_Node_method_queue_free: - void **queue_free** **(** **)** Queues a node for deletion at the end of the current frame. When deleted, all of its child 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 check whether a node will be deleted at the end of the frame. +---- + .. _class_Node_method_raise: - void **raise** **(** **)** Moves this node to the bottom of parent node's children hierarchy. This is often useful in GUIs (:ref:`Control` nodes), because their order of drawing depends on their order in the tree, i.e. the further they are on the node list, the higher they are drawn. After using ``raise``, a Control will be drawn on top of their siblings. +---- + .. _class_Node_method_remove_and_skip: - void **remove_and_skip** **(** **)** Removes a node and sets all its children as children of the parent node (if it exists). All event subscriptions that pass by the removed node will be unsubscribed. +---- + .. _class_Node_method_remove_child: - void **remove_child** **(** :ref:`Node` node **)** Removes a child node. The node is NOT deleted and must be deleted manually. +---- + .. _class_Node_method_remove_from_group: - void **remove_from_group** **(** :ref:`String` group **)** Removes a node from a group. See notes in the description, and the group methods in :ref:`SceneTree`. +---- + .. _class_Node_method_replace_by: - void **replace_by** **(** :ref:`Node` node, :ref:`bool` keep_data=false **)** Replaces a node in a scene by the given one. Subscriptions that pass through this node will be lost. +---- + .. _class_Node_method_request_ready: - void **request_ready** **(** **)** Requests that ``_ready`` be called again. Note that the method won't be called immediately, but is scheduled for when the node is added to the scene tree again (see :ref:`_ready`). ``_ready`` is called only for the node which requested it, which means that you need to request ready for each child if you want them to call ``_ready`` too (in which case, ``_ready`` will be called in the same order as it would normally). +---- + .. _class_Node_method_rpc: - :ref:`Variant` **rpc** **(** :ref:`String` method, ... **)** vararg Sends a remote procedure call request for the given ``method`` to peers on the network (and locally), optionally sending all additional arguments as arguments to the method called by the RPC. The call request will only be received by nodes with the same :ref:`NodePath`, including the exact same node name. Behaviour depends on the RPC configuration for the given method, see :ref:`rpc_config`. Methods are not exposed to RPCs by default. Also see :ref:`rset` and :ref:`rset_config` for properties. Returns an empty :ref:`Variant`. Note that you can only safely use RPCs on clients after you received the ``connected_to_server`` signal from the :ref:`SceneTree`. You also need to keep track of the connection state, either by the :ref:`SceneTree` signals like ``server_disconnected`` or by checking ``SceneTree.network_peer.get_connection_status() == CONNECTION_CONNECTED``. +---- + .. _class_Node_method_rpc_config: - void **rpc_config** **(** :ref:`String` method, :ref:`RPCMode` mode **)** Changes the RPC mode for the given ``method`` to the given ``mode``. See :ref:`RPCMode`. An alternative is annotating methods and properties with the corresponding keywords (``remote``, ``master``, ``puppet``, ``remotesync``, ``mastersync``, ``puppetsync``). By default, methods are not exposed to networking (and RPCs). Also see :ref:`rset` and :ref:`rset_config` for properties. +---- + .. _class_Node_method_rpc_id: - :ref:`Variant` **rpc_id** **(** :ref:`int` peer_id, :ref:`String` method, ... **)** vararg Sends a :ref:`rpc` to a specific peer identified by ``peer_id`` (see :ref:`NetworkedMultiplayerPeer.set_target_peer`). Returns an empty :ref:`Variant`. +---- + .. _class_Node_method_rpc_unreliable: - :ref:`Variant` **rpc_unreliable** **(** :ref:`String` method, ... **)** vararg Sends a :ref:`rpc` using an unreliable protocol. Returns an empty :ref:`Variant`. +---- + .. _class_Node_method_rpc_unreliable_id: - :ref:`Variant` **rpc_unreliable_id** **(** :ref:`int` peer_id, :ref:`String` method, ... **)** vararg Sends a :ref:`rpc` to a specific peer identified by ``peer_id`` using an unreliable protocol (see :ref:`NetworkedMultiplayerPeer.set_target_peer`). Returns an empty :ref:`Variant`. +---- + .. _class_Node_method_rset: - void **rset** **(** :ref:`String` property, :ref:`Variant` value **)** Remotely changes a property's value on other peers (and locally). Behaviour depends on the RPC configuration for the given property, see :ref:`rset_config`. Also see :ref:`rpc` for RPCs for methods, most information applies to this method as well. +---- + .. _class_Node_method_rset_config: - void **rset_config** **(** :ref:`String` property, :ref:`RPCMode` mode **)** Changes the RPC mode for the given ``property`` to the given ``mode``. See :ref:`RPCMode`. An alternative is annotating methods and properties with the corresponding keywords (``remote``, ``master``, ``puppet``, ``remotesync``, ``mastersync``, ``puppetsync``). By default, properties are not exposed to networking (and RPCs). Also see :ref:`rpc` and :ref:`rpc_config` for methods. +---- + .. _class_Node_method_rset_id: - void **rset_id** **(** :ref:`int` peer_id, :ref:`String` property, :ref:`Variant` value **)** Remotely changes the property's value on a specific peer identified by ``peer_id`` (see :ref:`NetworkedMultiplayerPeer.set_target_peer`). +---- + .. _class_Node_method_rset_unreliable: - void **rset_unreliable** **(** :ref:`String` property, :ref:`Variant` value **)** Remotely changes the property's value on other peers (and locally) using an unreliable protocol. +---- + .. _class_Node_method_rset_unreliable_id: - void **rset_unreliable_id** **(** :ref:`int` peer_id, :ref:`String` property, :ref:`Variant` value **)** Remotely changes property's value on a specific peer identified by ``peer_id`` using an unreliable protocol (see :ref:`NetworkedMultiplayerPeer.set_target_peer`). +---- + .. _class_Node_method_set_display_folded: - void **set_display_folded** **(** :ref:`bool` fold **)** Sets the folded state of the node in the Scene dock. +---- + .. _class_Node_method_set_network_master: - void **set_network_master** **(** :ref:`int` id, :ref:`bool` recursive=true **)** Sets the node's network master to the peer with the given peer ID. The network master is the peer that has authority over the node on the network. Useful in conjunction with the ``master`` and ``puppet`` keywords. Inherited from the parent node by default, which ultimately defaults to peer ID 1 (the server). If ``recursive``, the given peer is recursively set as the master for all children of this node. +---- + .. _class_Node_method_set_physics_process: - void **set_physics_process** **(** :ref:`bool` enable **)** Enables or disables physics (i.e. fixed framerate) processing. When a node is being processed, it will receive a :ref:`NOTIFICATION_PHYSICS_PROCESS` at a fixed (usually 60 FPS, see :ref:`Engine.target_fps` to change) interval (and the :ref:`_physics_process` callback will be called if exists). Enabled automatically if :ref:`_physics_process` is overridden. Any calls to this before :ref:`_ready` will be ignored. +---- + .. _class_Node_method_set_physics_process_internal: - void **set_physics_process_internal** **(** :ref:`bool` enable **)** Enables or disables internal physics for this node. Internal physics processing happens in isolation from the normal :ref:`_physics_process` calls and is used by some nodes internally to guarantee proper functioning even if the node is paused or physics processing is disabled for scripting (:ref:`set_physics_process`). Only useful for advanced uses to manipulate built-in nodes behavior. +---- + .. _class_Node_method_set_process: - void **set_process** **(** :ref:`bool` enable **)** Enables or disables processing. When a node is being processed, it will receive a :ref:`NOTIFICATION_PROCESS` on every drawn frame (and the :ref:`_process` callback will be called if exists). Enabled automatically if :ref:`_process` is overridden. Any calls to this before :ref:`_ready` will be ignored. +---- + .. _class_Node_method_set_process_input: - void **set_process_input** **(** :ref:`bool` enable **)** Enables or disables input processing. This is not required for GUI controls! Enabled automatically if :ref:`_input` is overridden. Any calls to this before :ref:`_ready` will be ignored. +---- + .. _class_Node_method_set_process_internal: - void **set_process_internal** **(** :ref:`bool` enable **)** Enables or disabled internal processing for this node. Internal processing happens in isolation from the normal :ref:`_process` calls and is used by some nodes internally to guarantee proper functioning even if the node is paused or processing is disabled for scripting (:ref:`set_process`). Only useful for advanced uses to manipulate built-in nodes behavior. +---- + .. _class_Node_method_set_process_priority: - void **set_process_priority** **(** :ref:`int` priority **)** Sets the node's priority in the execution order of the enabled processing callbacks (i.e. :ref:`NOTIFICATION_PROCESS`, :ref:`NOTIFICATION_PHYSICS_PROCESS` and their internal counterparts). Nodes with a higher process priority will have their processing callbacks executed first. +---- + .. _class_Node_method_set_process_unhandled_input: - void **set_process_unhandled_input** **(** :ref:`bool` enable **)** Enables unhandled input processing. This is not required for GUI controls! It enables the node to receive all input that was not previously handled (usually by a :ref:`Control`). Enabled automatically if :ref:`_unhandled_input` is overridden. Any calls to this before :ref:`_ready` will be ignored. +---- + .. _class_Node_method_set_process_unhandled_key_input: - void **set_process_unhandled_key_input** **(** :ref:`bool` enable **)** Enables unhandled key input processing. Enabled automatically if :ref:`_unhandled_key_input` is overridden. Any calls to this before :ref:`_ready` will be ignored. +---- + .. _class_Node_method_set_scene_instance_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 3f71687d8..147e97528 100644 --- a/classes/class_node2d.rst +++ b/classes/class_node2d.rst @@ -101,6 +101,8 @@ Property Descriptions Global position. +---- + .. _class_Node2D_property_global_rotation: - :ref:`float` **global_rotation** @@ -113,6 +115,8 @@ Global position. Global rotation in radians. +---- + .. _class_Node2D_property_global_rotation_degrees: - :ref:`float` **global_rotation_degrees** @@ -125,6 +129,8 @@ Global rotation in radians. Global rotation in degrees. +---- + .. _class_Node2D_property_global_scale: - :ref:`Vector2` **global_scale** @@ -137,6 +143,8 @@ Global rotation in degrees. Global scale. +---- + .. _class_Node2D_property_global_transform: - :ref:`Transform2D` **global_transform** @@ -149,6 +157,8 @@ Global scale. Global :ref:`Transform2D`. +---- + .. _class_Node2D_property_position: - :ref:`Vector2` **position** @@ -161,6 +171,8 @@ Global :ref:`Transform2D`. Position, relative to the node's parent. +---- + .. _class_Node2D_property_rotation: - :ref:`float` **rotation** @@ -173,6 +185,8 @@ Position, relative to the node's parent. Rotation in radians, relative to the node's parent. +---- + .. _class_Node2D_property_rotation_degrees: - :ref:`float` **rotation_degrees** @@ -185,6 +199,8 @@ Rotation in radians, relative to the node's parent. Rotation in degrees, relative to the node's parent. +---- + .. _class_Node2D_property_scale: - :ref:`Vector2` **scale** @@ -197,6 +213,8 @@ Rotation in degrees, relative to the node's parent. The node's scale. Unscaled value: ``(1, 1)`` +---- + .. _class_Node2D_property_transform: - :ref:`Transform2D` **transform** @@ -209,6 +227,8 @@ The node's scale. Unscaled value: ``(1, 1)`` Local :ref:`Transform2D`. +---- + .. _class_Node2D_property_z_as_relative: - :ref:`bool` **z_as_relative** @@ -221,6 +241,8 @@ Local :ref:`Transform2D`. If ``true``, the node's Z-index is 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_property_z_index: - :ref:`int` **z_index** @@ -242,60 +264,80 @@ Method Descriptions Multiplies the current scale by the 'ratio' vector. +---- + .. _class_Node2D_method_get_angle_to: - :ref:`float` **get_angle_to** **(** :ref:`Vector2` point **)** const Returns the angle between the node and the 'point' in radians. +---- + .. _class_Node2D_method_get_relative_transform_to_parent: - :ref:`Transform2D` **get_relative_transform_to_parent** **(** :ref:`Node` parent **)** const Returns the :ref:`Transform2D` relative to this node's parent. +---- + .. _class_Node2D_method_global_translate: - void **global_translate** **(** :ref:`Vector2` offset **)** Adds the 'offset' vector to the node's global position. +---- + .. _class_Node2D_method_look_at: - void **look_at** **(** :ref:`Vector2` point **)** Rotates the node so it points towards the 'point'. +---- + .. _class_Node2D_method_move_local_x: - void **move_local_x** **(** :ref:`float` delta, :ref:`bool` scaled=false **)** Applies a local translation on the node's X axis based on the :ref:`Node._process`'s ``delta``. If ``scaled`` is ``false``, normalizes the movement. +---- + .. _class_Node2D_method_move_local_y: - void **move_local_y** **(** :ref:`float` delta, :ref:`bool` scaled=false **)** Applies a local translation on the node's Y axis based on the :ref:`Node._process`'s ``delta``. If ``scaled`` is ``false``, normalizes the movement. +---- + .. _class_Node2D_method_rotate: - void **rotate** **(** :ref:`float` radians **)** Applies a rotation to the node, in radians, starting from its current rotation. +---- + .. _class_Node2D_method_to_global: - :ref:`Vector2` **to_global** **(** :ref:`Vector2` local_point **)** const Converts a local point's coordinates to global coordinates. +---- + .. _class_Node2D_method_to_local: - :ref:`Vector2` **to_local** **(** :ref:`Vector2` global_point **)** const Converts a global point's coordinates to local coordinates. +---- + .. _class_Node2D_method_translate: - void **translate** **(** :ref:`Vector2` offset **)** diff --git a/classes/class_nodepath.rst b/classes/class_nodepath.rst index 3b6505994..80d78c3ca 100644 --- a/classes/class_nodepath.rst +++ b/classes/class_nodepath.rst @@ -44,9 +44,24 @@ Description A pre-parsed relative or absolute path in a scene tree, for use with :ref:`Node.get_node` and similar functions. It can reference a node, a resource within a node, or a property of a node or resource. For instance, ``"Path2D/PathFollow2D/Sprite:texture:size"`` would refer to the ``size`` property of the ``texture`` resource on the node named ``"Sprite"`` which is a child of the other named nodes in the path. -You will usually just pass a string to :ref:`Node.get_node` and it will be automatically converted, but you may occasionally want to parse a path ahead of time with :ref:`NodePath` or the literal syntax ``@"path"``. Exporting a ``NodePath`` variable will give you a node selection widget in the properties panel of the editor, which can often be useful. +You will usually just pass a string to :ref:`Node.get_node` and it will be automatically converted, but you may occasionally want to parse a path ahead of time with :ref:`NodePath` or the literal syntax ``@"path"``. Exporting a :ref:`NodePath` variable will give you a node selection widget in the properties panel of the editor, which can often be useful. -A ``NodePath`` is composed of a list of slash-separated node names (like a filesystem path) and an optional colon-separated list of "subnames" which can be resources or properties. +A :ref:`NodePath` is composed of a list of slash-separated node names (like a filesystem path) and an optional colon-separated list of "subnames" which can be resources or properties. + +Some examples of NodePaths include the following: + +:: + + # No leading slash means it is relative to the current node. + @"A" # Immediate child A + @"A/B" # A's child B + @"." # The current node. + @".." # The parent node. + @"../C" # A sibling node C. + # A leading slash means it is absolute from the SceneTree. + @"/root" # Equivalent to get_tree().get_root(). + @"/root/Main" # If your main scene's root node were named "Main". + @"/root/MyAutoload" # If you have an autoloaded node or scene. Method Descriptions ------------------- @@ -76,6 +91,8 @@ Examples of valid NodePaths (assuming that those nodes exist and have the refere # Absolute path (from 'root') "/root/Level/Path2D" +---- + .. _class_NodePath_method_get_as_property_path: - :ref:`NodePath` **get_as_property_path** **(** **)** @@ -90,6 +107,8 @@ Returns a node path with a colon character (``:``) prepended, transforming it to var property_path = node_path.get_as_property_path() print(property_path) # :position:x +---- + .. _class_NodePath_method_get_concatenated_subnames: - :ref:`String` **get_concatenated_subnames** **(** **)** @@ -101,6 +120,8 @@ Returns all subnames concatenated with a colon character (``:``) as separator, i var nodepath = NodePath("Path2D/PathFollow2D/Sprite:texture:load_path") print(nodepath.get_concatenated_subnames()) # texture:load_path +---- + .. _class_NodePath_method_get_name: - :ref:`String` **get_name** **(** :ref:`int` idx **)** @@ -114,6 +135,8 @@ Get the node name indicated by ``idx`` (0 to :ref:`get_name_count` **get_name_count** **(** **)** @@ -122,6 +145,8 @@ Get the number of node names which make up the path. Subnames (see :ref:`get_sub For example, ``"Path2D/PathFollow2D/Sprite"`` has 3 names. +---- + .. _class_NodePath_method_get_subname: - :ref:`String` **get_subname** **(** :ref:`int` idx **)** @@ -134,6 +159,8 @@ Get the resource or property name indicated by ``idx`` (0 to :ref:`get_subname_c print(node_path.get_subname(0)) # texture print(node_path.get_subname(1)) # load_path +---- + .. _class_NodePath_method_get_subname_count: - :ref:`int` **get_subname_count** **(** **)** @@ -142,12 +169,16 @@ Get the number of resource or property names ("subnames") in the path. Each subn For example, ``"Path2D/PathFollow2D/Sprite:texture:load_path"`` has 2 subnames. +---- + .. _class_NodePath_method_is_absolute: - :ref:`bool` **is_absolute** **(** **)** Returns ``true`` if the node path is absolute (as opposed to relative), which means that it starts with a slash character (``/``). Absolute node paths can be used to access the root node (``"/root"``) or autoloads (e.g. ``"/global"`` if a "global" autoload was registered). +---- + .. _class_NodePath_method_is_empty: - :ref:`bool` **is_empty** **(** **)** diff --git a/classes/class_noisetexture.rst b/classes/class_noisetexture.rst index eb80da56a..e3e2d0135 100644 --- a/classes/class_noisetexture.rst +++ b/classes/class_noisetexture.rst @@ -57,6 +57,8 @@ Property Descriptions If ``true``, the resulting texture contains a normal map created from the original noise interpreted as a bump map. +---- + .. _class_NoiseTexture_property_bump_strength: - :ref:`float` **bump_strength** @@ -67,6 +69,8 @@ If ``true``, the resulting texture contains a normal map created from the origin | *Getter* | get_bump_strength() | +----------+--------------------------+ +---- + .. _class_NoiseTexture_property_height: - :ref:`int` **height** @@ -79,6 +83,8 @@ If ``true``, the resulting texture contains a normal map created from the origin Height of the generated texture. +---- + .. _class_NoiseTexture_property_noise: - :ref:`OpenSimplexNoise` **noise** @@ -91,6 +97,8 @@ Height of the generated texture. The :ref:`OpenSimplexNoise` instance used to generate the noise. +---- + .. _class_NoiseTexture_property_seamless: - :ref:`bool` **seamless** @@ -103,6 +111,8 @@ The :ref:`OpenSimplexNoise` instance used to generate th Whether the texture can be tiled without visible seams or not. Seamless textures take longer to generate. +---- + .. _class_NoiseTexture_property_width: - :ref:`int` **width** diff --git a/classes/class_object.rst b/classes/class_object.rst index da273ec8f..0c3562316 100644 --- a/classes/class_object.rst +++ b/classes/class_object.rst @@ -178,6 +178,8 @@ Virtual method which can be overridden to customize the return value of :ref:`ge Returns the given property. Returns ``null`` if the ``property`` does not exist. +---- + .. _class_Object_method__get_property_list: - :ref:`Array` **_get_property_list** **(** **)** virtual @@ -188,18 +190,24 @@ Returns the object's property list as an :ref:`Array` of dictionari Each property's :ref:`Dictionary` must contain at least ``name: String`` and ``type: int`` (see :ref:`Variant.Type`) entries. Optionally, it can also include ``hint: int`` (see :ref:`PropertyHint`), ``hint_string: String``, and ``usage: int`` (see :ref:`PropertyUsageFlags`). +---- + .. _class_Object_method__init: - void **_init** **(** **)** virtual Called when the object is initialized. +---- + .. _class_Object_method__notification: - void **_notification** **(** :ref:`int` what **)** virtual Called whenever the object receives a notification, which is identified in ``what`` by a constant. The base :ref:`Object` has two constants :ref:`NOTIFICATION_POSTINITIALIZE` and :ref:`NOTIFICATION_PREDELETE`, but subclasses such as :ref:`Node` define a lot more notifications which are also received by this method. +---- + .. _class_Object_method__set: - :ref:`bool` **_set** **(** :ref:`String` property, :ref:`Variant` value **)** virtual @@ -208,12 +216,16 @@ Virtual method which can be overridden to customize the return value of :ref:`se Sets a property. Returns ``true`` if the ``property`` exists. +---- + .. _class_Object_method_add_user_signal: - void **add_user_signal** **(** :ref:`String` signal, :ref:`Array` arguments=[ ] **)** Adds a user-defined ``signal``. Arguments are optional, but can be added as an :ref:`Array` of dictionaries, each containing ``name: String`` and ``type: int`` (see :ref:`Variant.Type`) entries. +---- + .. _class_Object_method_call: - :ref:`Variant` **call** **(** :ref:`String` method, ... **)** vararg @@ -224,6 +236,8 @@ Calls the ``method`` on the object and returns the result. This method supports call("set", "position", Vector2(42.0, 0.0)) +---- + .. _class_Object_method_call_deferred: - :ref:`Variant` **call_deferred** **(** :ref:`String` method, ... **)** vararg @@ -234,6 +248,8 @@ Calls the ``method`` on the object during idle time and returns the result. This call_deferred("set", "position", Vector2(42.0, 0.0)) +---- + .. _class_Object_method_callv: - :ref:`Variant` **callv** **(** :ref:`String` method, :ref:`Array` arg_array **)** @@ -244,12 +260,16 @@ Calls the ``method`` on the object and returns the result. Contrarily to :ref:`c callv("set", [ "position", Vector2(42.0, 0.0) ]) +---- + .. _class_Object_method_can_translate_messages: - :ref:`bool` **can_translate_messages** **(** **)** const Returns ``true`` if the object can translate strings. See :ref:`set_message_translation` and :ref:`tr`. +---- + .. _class_Object_method_connect: - :ref:`Error` **connect** **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method, :ref:`Array` binds=[ ], :ref:`int` flags=0 **)** @@ -268,6 +288,8 @@ Examples: connect("text_entered", self, "_on_LineEdit_text_entered") # LineEdit signal connect("hit", self, "_on_Player_hit", [ weapon_type, damage ]) # User-defined signal +---- + .. _class_Object_method_disconnect: - void **disconnect** **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method **)** @@ -276,6 +298,8 @@ Disconnects a ``signal`` from a ``method`` on the given ``target``. If you try to disconnect a connection that does not exist, the method will throw an error. Use :ref:`is_connected` to ensure that the connection exists. +---- + .. _class_Object_method_emit_signal: - :ref:`Variant` **emit_signal** **(** :ref:`String` signal, ... **)** vararg @@ -287,24 +311,32 @@ Emits the given ``signal``. The signal must exist, so it should be a built-in si emit_signal("hit", weapon_type, damage) emit_signal("game_over") +---- + .. _class_Object_method_free: - void **free** **(** **)** Deletes the object from memory. Any pre-existing reference to the freed object will now return ``null``. +---- + .. _class_Object_method_get: - :ref:`Variant` **get** **(** :ref:`String` property **)** const Returns the :ref:`Variant` value of the given ``property``. +---- + .. _class_Object_method_get_class: - :ref:`String` **get_class** **(** **)** const Returns the object's class as a :ref:`String`. +---- + .. _class_Object_method_get_incoming_connections: - :ref:`Array` **get_incoming_connections** **(** **)** const @@ -319,12 +351,16 @@ Each :ref:`Dictionary` contains three String entries: - ``method_name`` is the name of the method to which the signal is connected. +---- + .. _class_Object_method_get_indexed: - :ref:`Variant` **get_indexed** **(** :ref:`NodePath` property **)** const Get the object's property indexed by the given :ref:`NodePath`. The node path should be relative to the current object and can use the colon character (``:``) to access nested properties. Examples: ``"position:x"`` or ``"material:next_pass:blend_mode"``. +---- + .. _class_Object_method_get_instance_id: - :ref:`int` **get_instance_id** **(** **)** const @@ -333,24 +369,32 @@ Returns the object's unique instance ID. This ID can be saved in :ref:`EncodedObjectAsID`, and can be used to retrieve the object instance with :ref:`@GDScript.instance_from_id`. +---- + .. _class_Object_method_get_meta: - :ref:`Variant` **get_meta** **(** :ref:`String` name **)** const Returns the object's metadata entry for the given ``name``. +---- + .. _class_Object_method_get_meta_list: - :ref:`PoolStringArray` **get_meta_list** **(** **)** const Returns the object's metadata as a :ref:`PoolStringArray`. +---- + .. _class_Object_method_get_method_list: - :ref:`Array` **get_method_list** **(** **)** const Returns the object's methods and their signatures as an :ref:`Array`. +---- + .. _class_Object_method_get_property_list: - :ref:`Array` **get_property_list** **(** **)** const @@ -359,66 +403,88 @@ Returns the object's property list as an :ref:`Array` of dictionari Each property's :ref:`Dictionary` contain at least ``name: String`` and ``type: int`` (see :ref:`Variant.Type`) entries. Optionally, it can also include ``hint: int`` (see :ref:`PropertyHint`), ``hint_string: String``, and ``usage: int`` (see :ref:`PropertyUsageFlags`). +---- + .. _class_Object_method_get_script: - :ref:`Reference` **get_script** **(** **)** const Returns the object's :ref:`Script` instance, or ``null`` if none is assigned. +---- + .. _class_Object_method_get_signal_connection_list: - :ref:`Array` **get_signal_connection_list** **(** :ref:`String` signal **)** const Returns an :ref:`Array` of connections for the given ``signal``. +---- + .. _class_Object_method_get_signal_list: - :ref:`Array` **get_signal_list** **(** **)** const Returns the list of signals as an :ref:`Array` of dictionaries. +---- + .. _class_Object_method_has_meta: - :ref:`bool` **has_meta** **(** :ref:`String` name **)** const Returns ``true`` if a metadata entry is found with the given ``name``. +---- + .. _class_Object_method_has_method: - :ref:`bool` **has_method** **(** :ref:`String` method **)** const Returns ``true`` if the object contains the given ``method``. +---- + .. _class_Object_method_has_user_signal: - :ref:`bool` **has_user_signal** **(** :ref:`String` signal **)** const Returns ``true`` if the given user-defined ``signal`` exists. +---- + .. _class_Object_method_is_blocking_signals: - :ref:`bool` **is_blocking_signals** **(** **)** const Returns ``true`` if signal emission blocking is enabled. +---- + .. _class_Object_method_is_class: - :ref:`bool` **is_class** **(** :ref:`String` class **)** const Returns ``true`` if the object inherits from the given ``class``. +---- + .. _class_Object_method_is_connected: - :ref:`bool` **is_connected** **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method **)** const Returns ``true`` if a connection exists for a given ``signal``, ``target``, and ``method``. +---- + .. _class_Object_method_is_queued_for_deletion: - :ref:`bool` **is_queued_for_deletion** **(** **)** const Returns ``true`` if the :ref:`Node.queue_free` method was called for the object. +---- + .. _class_Object_method_notification: - void **notification** **(** :ref:`int` what, :ref:`bool` reversed=false **)** @@ -427,30 +493,40 @@ Send a given notification to the object, which will also trigger a call to the : If ``reversed`` is ``true``, :ref:`_notification` is called first on the object's own class, and then up to its successive parent classes. If ``reversed`` is ``false``, :ref:`_notification` is called first on the highest ancestor (:ref:`Object` itself), and then down to its successive inheriting classes. +---- + .. _class_Object_method_property_list_changed_notify: - void **property_list_changed_notify** **(** **)** Notify the editor that the property list has changed, so that editor plugins can take the new values into account. Does nothing on export builds. +---- + .. _class_Object_method_set: - void **set** **(** :ref:`String` property, :ref:`Variant` value **)** Assigns a new value to the given property. If the ``property`` does not exist, nothing will happen. +---- + .. _class_Object_method_set_block_signals: - void **set_block_signals** **(** :ref:`bool` enable **)** If set to ``true``, signal emission is blocked. +---- + .. _class_Object_method_set_deferred: - void **set_deferred** **(** :ref:`String` property, :ref:`Variant` value **)** Assigns a new value to the given property, after the current frame's physics step. This is equivalent to calling :ref:`set` via :ref:`call_deferred`, i.e. ``call_deferred("set", property, value)``. +---- + .. _class_Object_method_set_indexed: - void **set_indexed** **(** :ref:`NodePath` property, :ref:`Variant` value **)** @@ -463,24 +539,32 @@ Assigns a new value to the property identified by the :ref:`NodePath` enable **)** Defines whether the object can translate strings (with calls to :ref:`tr`). Default is ``true``. +---- + .. _class_Object_method_set_meta: - void **set_meta** **(** :ref:`String` name, :ref:`Variant` value **)** Adds or changes a given entry in the object's metadata. Metadata are serialized, and can take any :ref:`Variant` value. +---- + .. _class_Object_method_set_script: - void **set_script** **(** :ref:`Reference` script **)** Assigns a script to the object. Each object can have a single script assigned to it, which are used to extend its functionality. +---- + .. _class_Object_method_tr: - :ref:`String` **tr** **(** :ref:`String` message **)** const diff --git a/classes/class_occluderpolygon2d.rst b/classes/class_occluderpolygon2d.rst index 5ef49c1e8..5d0df0258 100644 --- a/classes/class_occluderpolygon2d.rst +++ b/classes/class_occluderpolygon2d.rst @@ -68,6 +68,8 @@ Property Descriptions If ``true``, closes the polygon. A closed OccluderPolygon2D occludes the light coming from any direction. An opened OccluderPolygon2D occludes the light only at its outline's direction. Default value: ``true``. +---- + .. _class_OccluderPolygon2D_property_cull_mode: - :ref:`CullMode` **cull_mode** @@ -80,6 +82,8 @@ If ``true``, closes the polygon. A closed OccluderPolygon2D occludes the light c Set the direction of the occlusion culling or disable it. Default value: :ref:`CULL_DISABLED`. +---- + .. _class_OccluderPolygon2D_property_polygon: - :ref:`PoolVector2Array` **polygon** diff --git a/classes/class_omnilight.rst b/classes/class_omnilight.rst index c35e76b06..4628b45af 100644 --- a/classes/class_omnilight.rst +++ b/classes/class_omnilight.rst @@ -46,6 +46,8 @@ enum **ShadowMode**: - **SHADOW_CUBE** = **1** +---- + .. _enum_OmniLight_ShadowDetail: .. _class_OmniLight_constant_SHADOW_DETAIL_VERTICAL: @@ -83,6 +85,8 @@ Property Descriptions The light's attenuation (drop-off) curve. A number of presets are available in the Inspector. +---- + .. _class_OmniLight_property_omni_range: - :ref:`float` **omni_range** @@ -95,6 +99,8 @@ The light's attenuation (drop-off) curve. A number of presets are available in t Maximum distance the light affects. +---- + .. _class_OmniLight_property_omni_shadow_detail: - :ref:`ShadowDetail` **omni_shadow_detail** @@ -107,6 +113,8 @@ Maximum distance the light affects. See :ref:`ShadowDetail`. +---- + .. _class_OmniLight_property_omni_shadow_mode: - :ref:`ShadowMode` **omni_shadow_mode** diff --git a/classes/class_opensimplexnoise.rst b/classes/class_opensimplexnoise.rst index cca6dbf34..e80865a2d 100644 --- a/classes/class_opensimplexnoise.rst +++ b/classes/class_opensimplexnoise.rst @@ -88,6 +88,8 @@ Property Descriptions Difference in period between :ref:`octaves`. +---- + .. _class_OpenSimplexNoise_property_octaves: - :ref:`int` **octaves** @@ -100,6 +102,8 @@ Difference in period between :ref:`octaves` **period** @@ -112,6 +116,8 @@ Number of OpenSimplex noise layers that are sampled to get the fractal noise. Period of the base octave. A lower period results in a higher-frequency noise (more value changes across the same distance). +---- + .. _class_OpenSimplexNoise_property_persistence: - :ref:`float` **persistence** @@ -124,6 +130,8 @@ Period of the base octave. A lower period results in a higher-frequency noise (m Contribution factor of the different octaves. A ``persistence`` value of 1 means all the octaves have the same contribution, a value of 0.5 means each octave contributes half as much as the previous one. +---- + .. _class_OpenSimplexNoise_property_seed: - :ref:`int` **seed** @@ -145,36 +153,48 @@ Method Descriptions Generate a noise image with the requested ``width`` and ``height``, based on the current noise parameters. +---- + .. _class_OpenSimplexNoise_method_get_noise_2d: - :ref:`float` **get_noise_2d** **(** :ref:`float` x, :ref:`float` y **)** Returns the 2D noise value ``[-1,1]`` at the given position. +---- + .. _class_OpenSimplexNoise_method_get_noise_2dv: - :ref:`float` **get_noise_2dv** **(** :ref:`Vector2` pos **)** Returns the 2D noise value ``[-1,1]`` at the given position. +---- + .. _class_OpenSimplexNoise_method_get_noise_3d: - :ref:`float` **get_noise_3d** **(** :ref:`float` x, :ref:`float` y, :ref:`float` z **)** Returns the 3D noise value ``[-1,1]`` at the given position. +---- + .. _class_OpenSimplexNoise_method_get_noise_3dv: - :ref:`float` **get_noise_3dv** **(** :ref:`Vector3` pos **)** Returns the 3D noise value ``[-1,1]`` at the given position. +---- + .. _class_OpenSimplexNoise_method_get_noise_4d: - :ref:`float` **get_noise_4d** **(** :ref:`float` x, :ref:`float` y, :ref:`float` z, :ref:`float` w **)** Returns the 4D noise value ``[-1,1]`` at the given position. +---- + .. _class_OpenSimplexNoise_method_get_seamless_image: - :ref:`Image` **get_seamless_image** **(** :ref:`int` size **)** diff --git a/classes/class_optionbutton.rst b/classes/class_optionbutton.rst index 62fa9c3b2..3e9b0bf9d 100644 --- a/classes/class_optionbutton.rst +++ b/classes/class_optionbutton.rst @@ -112,6 +112,8 @@ Signals This signal is emitted when user navigated to an item using ``ui_up`` or ``ui_down`` action. ID of the item selected is passed as argument. +---- + .. _class_OptionButton_signal_item_selected: - **item_selected** **(** :ref:`int` ID **)** @@ -143,106 +145,146 @@ Method Descriptions 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_method_add_item: - 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_method_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_method_clear: - void **clear** **(** **)** Clear all the items in the ``OptionButton``. +---- + .. _class_OptionButton_method_get_item_count: - :ref:`int` **get_item_count** **(** **)** const Returns the amount of items in the OptionButton. +---- + .. _class_OptionButton_method_get_item_icon: - :ref:`Texture` **get_item_icon** **(** :ref:`int` idx **)** const Returns the icon of the item at index "idx". +---- + .. _class_OptionButton_method_get_item_id: - :ref:`int` **get_item_id** **(** :ref:`int` idx **)** const Returns the ID of the item at index ``idx``. +---- + .. _class_OptionButton_method_get_item_index: - :ref:`int` **get_item_index** **(** :ref:`int` id **)** const Returns the index of the item with the given ``id``. +---- + .. _class_OptionButton_method_get_item_metadata: - :ref:`Variant` **get_item_metadata** **(** :ref:`int` idx **)** const +---- + .. _class_OptionButton_method_get_item_text: - :ref:`String` **get_item_text** **(** :ref:`int` idx **)** const Returns the text of the item at index "idx". +---- + .. _class_OptionButton_method_get_popup: - :ref:`PopupMenu` **get_popup** **(** **)** const Returns the :ref:`PopupMenu` contained in this button. +---- + .. _class_OptionButton_method_get_selected_id: - :ref:`int` **get_selected_id** **(** **)** const +---- + .. _class_OptionButton_method_get_selected_metadata: - :ref:`Variant` **get_selected_metadata** **(** **)** const +---- + .. _class_OptionButton_method_is_item_disabled: - :ref:`bool` **is_item_disabled** **(** :ref:`int` idx **)** const +---- + .. _class_OptionButton_method_remove_item: - void **remove_item** **(** :ref:`int` idx **)** +---- + .. _class_OptionButton_method_select: - void **select** **(** :ref:`int` idx **)** Select an item by index and make it the current item. +---- + .. _class_OptionButton_method_set_item_disabled: - void **set_item_disabled** **(** :ref:`int` idx, :ref:`bool` disabled **)** +---- + .. _class_OptionButton_method_set_item_icon: - void **set_item_icon** **(** :ref:`int` idx, :ref:`Texture` texture **)** Set the icon of an item at index "idx". +---- + .. _class_OptionButton_method_set_item_id: - void **set_item_id** **(** :ref:`int` idx, :ref:`int` id **)** Set the ID of an item at index "idx". +---- + .. _class_OptionButton_method_set_item_metadata: - void **set_item_metadata** **(** :ref:`int` idx, :ref:`Variant` metadata **)** +---- + .. _class_OptionButton_method_set_item_text: - void **set_item_text** **(** :ref:`int` idx, :ref:`String` text **)** diff --git a/classes/class_os.rst b/classes/class_os.rst index 37e777745..0c774f1b5 100644 --- a/classes/class_os.rst +++ b/classes/class_os.rst @@ -255,6 +255,8 @@ enum **VideoDriver**: - **VIDEO_DRIVER_GLES3** = **0** --- The GLES3 rendering backend. It uses OpenGL ES 3.0 on mobile devices, OpenGL 3.3 on desktop platforms and WebGL 2.0 on the web. +---- + .. _enum_OS_Weekday: .. _class_OS_constant_DAY_SUNDAY: @@ -287,6 +289,8 @@ enum **Weekday**: - **DAY_SATURDAY** = **6** --- Saturday. +---- + .. _enum_OS_Month: .. _class_OS_constant_MONTH_JANUARY: @@ -339,6 +343,8 @@ enum **Month**: - **MONTH_DECEMBER** = **12** --- December. +---- + .. _enum_OS_ScreenOrientation: .. _class_OS_constant_SCREEN_ORIENTATION_LANDSCAPE: @@ -371,6 +377,8 @@ enum **ScreenOrientation**: - **SCREEN_ORIENTATION_SENSOR** = **6** --- Uses most suitable orientation based on the hardware sensor. +---- + .. _enum_OS_SystemDir: .. _class_OS_constant_SYSTEM_DIR_DESKTOP: @@ -407,6 +415,8 @@ enum **SystemDir**: - **SYSTEM_DIR_RINGTONES** = **7** --- Ringtones directory path. +---- + .. _enum_OS_PowerState: .. _class_OS_constant_POWERSTATE_UNKNOWN: @@ -451,6 +461,8 @@ Property Descriptions The clipboard from the host OS. Might be unavailable on some platforms. +---- + .. _class_OS_property_current_screen: - :ref:`int` **current_screen** @@ -463,6 +475,8 @@ The clipboard from the host OS. Might be unavailable on some platforms. The current screen index (starting from 0). +---- + .. _class_OS_property_exit_code: - :ref:`int` **exit_code** @@ -475,6 +489,8 @@ The current screen index (starting from 0). The exit code passed to the OS when the main loop exits. +---- + .. _class_OS_property_keep_screen_on: - :ref:`bool` **keep_screen_on** @@ -487,6 +503,8 @@ The exit code passed to the OS when the main loop exits. If ``true``, the engine tries to keep the screen on while the game is running. Useful on mobile. +---- + .. _class_OS_property_low_processor_usage_mode: - :ref:`bool` **low_processor_usage_mode** @@ -499,6 +517,8 @@ If ``true``, the engine tries to keep the screen on while the game is running. U If ``true``, the engine optimizes for low processor usage by only refreshing the screen if needed. Can improve battery consumption on mobile. +---- + .. _class_OS_property_screen_orientation: - _OS.ScreenOrientation **screen_orientation** @@ -511,6 +531,8 @@ If ``true``, the engine optimizes for low processor usage by only refreshing the The current screen orientation. +---- + .. _class_OS_property_vsync_enabled: - :ref:`bool` **vsync_enabled** @@ -523,6 +545,8 @@ The current screen orientation. If ``true``, vertical synchronization (Vsync) is enabled. +---- + .. _class_OS_property_window_borderless: - :ref:`bool` **window_borderless** @@ -535,6 +559,8 @@ If ``true``, vertical synchronization (Vsync) is enabled. If ``true``, removes the window frame. +---- + .. _class_OS_property_window_fullscreen: - :ref:`bool` **window_fullscreen** @@ -547,6 +573,8 @@ If ``true``, removes the window frame. If ``true``, the window is fullscreen. +---- + .. _class_OS_property_window_maximized: - :ref:`bool` **window_maximized** @@ -559,6 +587,8 @@ If ``true``, the window is fullscreen. If ``true``, the window is maximized. +---- + .. _class_OS_property_window_minimized: - :ref:`bool` **window_minimized** @@ -571,6 +601,8 @@ If ``true``, the window is maximized. If ``true``, the window is minimized. +---- + .. _class_OS_property_window_per_pixel_transparency_enabled: - :ref:`bool` **window_per_pixel_transparency_enabled** @@ -581,6 +613,8 @@ If ``true``, the window is minimized. | *Getter* | get_window_per_pixel_transparency_enabled() | +----------+--------------------------------------------------+ +---- + .. _class_OS_property_window_position: - :ref:`Vector2` **window_position** @@ -593,6 +627,8 @@ If ``true``, the window is minimized. 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_property_window_resizable: - :ref:`bool` **window_resizable** @@ -605,6 +641,8 @@ The window position relative to the screen, the origin is the top left corner, + If ``true``, the window is resizable by the user. +---- + .. _class_OS_property_window_size: - :ref:`Vector2` **window_size** @@ -626,40 +664,54 @@ Method Descriptions Displays a modal dialog box utilizing the host OS. +---- + .. _class_OS_method_can_draw: - :ref:`bool` **can_draw** **(** **)** const Returns ``true`` if the host OS allows drawing. +---- + .. _class_OS_method_can_use_threads: - :ref:`bool` **can_use_threads** **(** **)** const Returns ``true`` if the current host platform is using multiple threads. +---- + .. _class_OS_method_center_window: - void **center_window** **(** **)** Centers the window on the screen if in windowed mode. +---- + .. _class_OS_method_close_midi_inputs: - void **close_midi_inputs** **(** **)** +---- + .. _class_OS_method_delay_msec: - void **delay_msec** **(** :ref:`int` msec **)** const Delay execution of the current thread by given milliseconds. +---- + .. _class_OS_method_delay_usec: - void **delay_usec** **(** :ref:`int` usec **)** const Delay execution of the current thread by given microseconds. +---- + .. _class_OS_method_dump_memory_to_file: - void **dump_memory_to_file** **(** :ref:`String` file **)** @@ -668,6 +720,8 @@ Dumps the memory allocation ringlist to a file (only works in debug). Entry format per line: "Address - Size - Description". +---- + .. _class_OS_method_dump_resources_to_file: - void **dump_resources_to_file** **(** :ref:`String` file **)** @@ -678,6 +732,8 @@ Entry format per line: "Resource Type : Resource Location". At the end of the file is a statistic of all used Resource Types. +---- + .. _class_OS_method_execute: - :ref:`int` **execute** **(** :ref:`String` path, :ref:`PoolStringArray` arguments, :ref:`bool` blocking, :ref:`Array` output=[ ] **)** @@ -713,52 +769,70 @@ If you wish to access a shell built-in or perform a composite command, a platfor OS.execute('CMD.exe', ['/C', 'cd %TEMP% && dir'], true, output) +---- + .. _class_OS_method_find_scancode_from_string: - :ref:`int` **find_scancode_from_string** **(** :ref:`String` string **)** const Returns the scancode of the given string (e.g. "Escape") +---- + .. _class_OS_method_get_audio_driver_count: - :ref:`int` **get_audio_driver_count** **(** **)** const Returns the total number of available audio drivers. +---- + .. _class_OS_method_get_audio_driver_name: - :ref:`String` **get_audio_driver_name** **(** :ref:`int` driver **)** const Returns the audio driver name for the given index. +---- + .. _class_OS_method_get_cmdline_args: - :ref:`PoolStringArray` **get_cmdline_args** **(** **)** Returns the command line arguments passed to the engine. +---- + .. _class_OS_method_get_connected_midi_inputs: - :ref:`PoolStringArray` **get_connected_midi_inputs** **(** **)** +---- + .. _class_OS_method_get_current_video_driver: - :ref:`VideoDriver` **get_current_video_driver** **(** **)** const Returns the currently used video driver, using one of the values from :ref:`VideoDriver`. +---- + .. _class_OS_method_get_date: - :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_method_get_datetime: - :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_method_get_datetime_from_unix_time: - :ref:`Dictionary` **get_datetime_from_unix_time** **(** :ref:`int` unix_time_val **)** const @@ -767,24 +841,32 @@ Get a dictionary of time values when given epoch time. Dictionary Time values will be a union of values from :ref:`get_time` and :ref:`get_date` dictionaries (with the exception of dst = day light standard time, as it cannot be determined from epoch). +---- + .. _class_OS_method_get_dynamic_memory_usage: - :ref:`int` **get_dynamic_memory_usage** **(** **)** const Returns the total amount of dynamic memory used (only works in debug). +---- + .. _class_OS_method_get_environment: - :ref:`String` **get_environment** **(** :ref:`String` environment **)** const Returns an environment variable. +---- + .. _class_OS_method_get_executable_path: - :ref:`String` **get_executable_path** **(** **)** const Returns the path to the current engine executable. +---- + .. _class_OS_method_get_ime_selection: - :ref:`Vector2` **get_ime_selection** **(** **)** const @@ -793,6 +875,8 @@ Returns IME cursor position (currently edited portion of the string) relative to :ref:`MainLoop.NOTIFICATION_OS_IME_UPDATE` is sent to the application to notify it of changes to the IME cursor position. +---- + .. _class_OS_method_get_ime_text: - :ref:`String` **get_ime_text** **(** **)** const @@ -801,6 +885,8 @@ Returns IME intermediate composition string. :ref:`MainLoop.NOTIFICATION_OS_IME_UPDATE` is sent to the application to notify it of changes to the IME composition string. +---- + .. _class_OS_method_get_latin_keyboard_variant: - :ref:`String` **get_latin_keyboard_variant** **(** **)** const @@ -809,72 +895,96 @@ Returns the current latin keyboard variant as a String. Possible return values are: "QWERTY", "AZERTY", "QZERTY", "DVORAK", "NEO", "COLEMAK" or "ERROR". +---- + .. _class_OS_method_get_locale: - :ref:`String` **get_locale** **(** **)** const Returns the host OS locale. +---- + .. _class_OS_method_get_model_name: - :ref:`String` **get_model_name** **(** **)** const Returns the model name of the current device. +---- + .. _class_OS_method_get_name: - :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_method_get_power_percent_left: - :ref:`int` **get_power_percent_left** **(** **)** Returns the amount of battery left in the device as a percentage. +---- + .. _class_OS_method_get_power_seconds_left: - :ref:`int` **get_power_seconds_left** **(** **)** Returns the time in seconds before the device runs out of battery. +---- + .. _class_OS_method_get_power_state: - :ref:`PowerState` **get_power_state** **(** **)** Returns the current state of the device regarding battery and power. See :ref:`PowerState` constants. +---- + .. _class_OS_method_get_process_id: - :ref:`int` **get_process_id** **(** **)** const Returns the game process ID +---- + .. _class_OS_method_get_processor_count: - :ref:`int` **get_processor_count** **(** **)** const Returns the number of cores available in the host machine. +---- + .. _class_OS_method_get_real_window_size: - :ref:`Vector2` **get_real_window_size** **(** **)** const Returns the window size including decorations like window borders. +---- + .. _class_OS_method_get_scancode_string: - :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_method_get_screen_count: - :ref:`int` **get_screen_count** **(** **)** const Returns the number of displays attached to the host machine. +---- + .. _class_OS_method_get_screen_dpi: - :ref:`int` **get_screen_dpi** **(** :ref:`int` screen=-1 **)** const @@ -895,78 +1005,104 @@ xxhdpi - 480 dpi xxxhdpi - 640 dpi +---- + .. _class_OS_method_get_screen_position: - :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_method_get_screen_size: - :ref:`Vector2` **get_screen_size** **(** :ref:`int` screen=-1 **)** const Returns the dimensions in pixels of the specified screen. +---- + .. _class_OS_method_get_splash_tick_msec: - :ref:`int` **get_splash_tick_msec** **(** **)** const Returns the amount of time in milliseconds it took for the boot logo to appear. +---- + .. _class_OS_method_get_static_memory_peak_usage: - :ref:`int` **get_static_memory_peak_usage** **(** **)** const Returns the max amount of static memory used (only works in debug). +---- + .. _class_OS_method_get_static_memory_usage: - :ref:`int` **get_static_memory_usage** **(** **)** const Returns the amount of static memory being used by the program in bytes. +---- + .. _class_OS_method_get_system_dir: - :ref:`String` **get_system_dir** **(** :ref:`SystemDir` dir **)** const Returns the actual path to commonly used folders across different platforms. Available locations are specified in :ref:`SystemDir`. +---- + .. _class_OS_method_get_system_time_msecs: - :ref:`int` **get_system_time_msecs** **(** **)** const Returns the epoch time of the operating system in milliseconds. +---- + .. _class_OS_method_get_system_time_secs: - :ref:`int` **get_system_time_secs** **(** **)** const Returns the epoch time of the operating system in seconds. +---- + .. _class_OS_method_get_ticks_msec: - :ref:`int` **get_ticks_msec** **(** **)** const Returns the amount of time passed in milliseconds since the engine started. +---- + .. _class_OS_method_get_ticks_usec: - :ref:`int` **get_ticks_usec** **(** **)** const Returns the amount of time passed in microseconds since the engine started. +---- + .. _class_OS_method_get_time: - :ref:`Dictionary` **get_time** **(** :ref:`bool` utc=false **)** const Returns current time as a dictionary of keys: hour, minute, second. +---- + .. _class_OS_method_get_time_zone_info: - :ref:`Dictionary` **get_time_zone_info** **(** **)** const Returns the current time zone as a dictionary with the keys: bias and name. +---- + .. _class_OS_method_get_unique_id: - :ref:`String` **get_unique_id** **(** **)** const @@ -975,12 +1111,16 @@ Returns a string that is unique to the device. Returns empty string on HTML5 and UWP which are not supported yet. +---- + .. _class_OS_method_get_unix_time: - :ref:`int` **get_unix_time** **(** **)** const Returns the current unix epoch timestamp. +---- + .. _class_OS_method_get_unix_time_from_datetime: - :ref:`int` **get_unix_time_from_datetime** **(** :ref:`Dictionary` datetime **)** const @@ -991,6 +1131,8 @@ Get an epoch time value from a dictionary of time values. You can pass the output from :ref:`get_datetime_from_unix_time` directly into this function. Daylight savings time (dst), if present, is ignored. +---- + .. _class_OS_method_get_user_data_dir: - :ref:`String` **get_user_data_dir** **(** **)** const @@ -1005,36 +1147,48 @@ On Windows, this is ``%APPDATA%\Godot\app_userdata\[project_name]``, or ``%APPDA If the project name is empty, ``user://`` falls back to ``res://``. +---- + .. _class_OS_method_get_video_driver_count: - :ref:`int` **get_video_driver_count** **(** **)** const Returns the number of video drivers supported on the current platform. +---- + .. _class_OS_method_get_video_driver_name: - :ref:`String` **get_video_driver_name** **(** :ref:`VideoDriver` driver **)** const Returns the name of the video driver matching the given ``driver`` index. This index is a value from :ref:`VideoDriver`, and you can use :ref:`get_current_video_driver` to get the current backend's index. +---- + .. _class_OS_method_get_virtual_keyboard_height: - :ref:`int` **get_virtual_keyboard_height** **(** **)** Returns the on-screen keyboard's height in pixels. Returns 0 if there is no keyboard or it is currently hidden. +---- + .. _class_OS_method_get_window_safe_area: - :ref:`Rect2` **get_window_safe_area** **(** **)** const Returns unobscured area of the window where interactive controls should be rendered. +---- + .. _class_OS_method_has_environment: - :ref:`bool` **has_environment** **(** :ref:`String` environment **)** const Returns ``true`` if an environment variable exists. +---- + .. _class_OS_method_has_feature: - :ref:`bool` **has_feature** **(** :ref:`String` tag_name **)** const @@ -1043,24 +1197,32 @@ Returns ``true`` if the feature for the given feature tag is supported in the cu Note that tag names are case-sensitive. +---- + .. _class_OS_method_has_touchscreen_ui_hint: - :ref:`bool` **has_touchscreen_ui_hint** **(** **)** const Returns ``true`` if the device has a touchscreen or emulates one. +---- + .. _class_OS_method_has_virtual_keyboard: - :ref:`bool` **has_virtual_keyboard** **(** **)** const Returns ``true`` if the platform has a virtual keyboard, ``false`` otherwise. +---- + .. _class_OS_method_hide_virtual_keyboard: - void **hide_virtual_keyboard** **(** **)** Hides the virtual keyboard if it is shown, does nothing otherwise. +---- + .. _class_OS_method_is_debug_build: - :ref:`bool` **is_debug_build** **(** **)** const @@ -1071,36 +1233,48 @@ Returns ``true`` when running in the editor. Returns ``false`` if the build is a release build. +---- + .. _class_OS_method_is_ok_left_and_cancel_right: - :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_method_is_scancode_unicode: - :ref:`bool` **is_scancode_unicode** **(** :ref:`int` code **)** const Returns ``true`` if the input code has a unicode character. +---- + .. _class_OS_method_is_stdout_verbose: - :ref:`bool` **is_stdout_verbose** **(** **)** const Returns ``true`` if the engine was executed with -v (verbose stdout). +---- + .. _class_OS_method_is_userfs_persistent: - :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_method_is_window_always_on_top: - :ref:`bool` **is_window_always_on_top** **(** **)** const Returns ``true`` if the window should always be on top of other windows. +---- + .. _class_OS_method_kill: - :ref:`Error` **kill** **(** :ref:`int` pid **)** @@ -1109,24 +1283,32 @@ Kill (terminate) the process identified by the given process ID (``pid``), e.g. Note that this method can also be used to kill processes that were not spawned by the game. +---- + .. _class_OS_method_move_window_to_foreground: - void **move_window_to_foreground** **(** **)** Moves the window to the front. +---- + .. _class_OS_method_native_video_is_playing: - :ref:`bool` **native_video_is_playing** **(** **)** Returns ``true`` if native video is playing. +---- + .. _class_OS_method_native_video_pause: - void **native_video_pause** **(** **)** Pauses native video playback. +---- + .. _class_OS_method_native_video_play: - :ref:`Error` **native_video_play** **(** :ref:`String` path, :ref:`float` volume, :ref:`String` audio_track, :ref:`String` subtitle_track **)** @@ -1135,100 +1317,134 @@ Plays native video from the specified path, at the given volume and with audio a Note: This method is only implemented on Android and iOS, and the current Android implementation does not support the ``volume``, ``audio_track`` and ``subtitle_track`` options. +---- + .. _class_OS_method_native_video_stop: - void **native_video_stop** **(** **)** Stops native video playback. +---- + .. _class_OS_method_native_video_unpause: - void **native_video_unpause** **(** **)** Resumes native video playback. +---- + .. _class_OS_method_open_midi_inputs: - void **open_midi_inputs** **(** **)** +---- + .. _class_OS_method_print_all_resources: - void **print_all_resources** **(** :ref:`String` tofile="" **)** Shows all resources in the game. Optionally the list can be written to a file. +---- + .. _class_OS_method_print_all_textures_by_size: - void **print_all_textures_by_size** **(** **)** Shows the list of loaded textures sorted by size in memory. +---- + .. _class_OS_method_print_resources_by_type: - void **print_resources_by_type** **(** :ref:`PoolStringArray` types **)** Shows the number of resources loaded by the game of the given types. +---- + .. _class_OS_method_print_resources_in_use: - void **print_resources_in_use** **(** :ref:`bool` short=false **)** Shows all resources currently used by the game. +---- + .. _class_OS_method_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_method_request_permission: - :ref:`bool` **request_permission** **(** :ref:`String` name **)** At the moment this function is only used by ``AudioDriverOpenSL`` to request permission for ``RECORD_AUDIO`` on Android. +---- + .. _class_OS_method_set_icon: - void **set_icon** **(** :ref:`Image` icon **)** Sets the game's icon. +---- + .. _class_OS_method_set_ime_active: - void **set_ime_active** **(** :ref:`bool` active **)** Sets whether IME input mode should be enabled. +---- + .. _class_OS_method_set_ime_position: - void **set_ime_position** **(** :ref:`Vector2` position **)** Sets position of IME suggestion list popup (in window coordinates). +---- + .. _class_OS_method_set_thread_name: - :ref:`Error` **set_thread_name** **(** :ref:`String` name **)** Sets the name of the current thread. +---- + .. _class_OS_method_set_use_file_access_save_and_swap: - void **set_use_file_access_save_and_swap** **(** :ref:`bool` enabled **)** Enables backup saves if ``enabled`` is ``true``. +---- + .. _class_OS_method_set_window_always_on_top: - void **set_window_always_on_top** **(** :ref:`bool` enabled **)** Sets whether the window should always be on top. +---- + .. _class_OS_method_set_window_title: - void **set_window_title** **(** :ref:`String` title **)** Sets the window title to the specified string. +---- + .. _class_OS_method_shell_open: - :ref:`Error` **shell_open** **(** :ref:`String` uri **)** @@ -1239,6 +1455,8 @@ Requests the OS to open a resource with the most appropriate program. For exampl ``OS.shell_open("https://godotengine.org")`` opens the default web browser on the official Godot website. +---- + .. _class_OS_method_show_virtual_keyboard: - void **show_virtual_keyboard** **(** :ref:`String` existing_text="" **)** diff --git a/classes/class_packeddatacontainer.rst b/classes/class_packeddatacontainer.rst index 8a4bb89e6..a5cb66537 100644 --- a/classes/class_packeddatacontainer.rst +++ b/classes/class_packeddatacontainer.rst @@ -48,6 +48,8 @@ Method Descriptions - :ref:`Error` **pack** **(** :ref:`Variant` value **)** +---- + .. _class_PackedDataContainer_method_size: - :ref:`int` **size** **(** **)** const diff --git a/classes/class_packedscene.rst b/classes/class_packedscene.rst index bd0851c4a..cafbb1f0a 100644 --- a/classes/class_packedscene.rst +++ b/classes/class_packedscene.rst @@ -106,18 +106,24 @@ Method Descriptions Returns ``true`` if the scene file has nodes. +---- + .. _class_PackedScene_method_get_state: - :ref:`SceneState` **get_state** **(** **)** Returns the ``SceneState`` representing the scene file contents. +---- + .. _class_PackedScene_method_instance: - :ref:`Node` **instance** **(** :ref:`GenEditState` edit_state=0 **)** const Instantiates the scene's node hierarchy. Triggers child scene instantiation(s). Triggers a :ref:`Node.NOTIFICATION_INSTANCED` notification on the root node. +---- + .. _class_PackedScene_method_pack: - :ref:`Error` **pack** **(** :ref:`Node` path **)** diff --git a/classes/class_packetpeer.rst b/classes/class_packetpeer.rst index 7d28cce5f..d52404281 100644 --- a/classes/class_packetpeer.rst +++ b/classes/class_packetpeer.rst @@ -77,18 +77,24 @@ Method Descriptions Returns the number of packets currently available in the ring-buffer. +---- + .. _class_PacketPeer_method_get_packet: - :ref:`PoolByteArray` **get_packet** **(** **)** Get a raw packet. +---- + .. _class_PacketPeer_method_get_packet_error: - :ref:`Error` **get_packet_error** **(** **)** const Returns the error state of the last packet received (via :ref:`get_packet` and :ref:`get_var`). +---- + .. _class_PacketPeer_method_get_var: - :ref:`Variant` **get_var** **(** :ref:`bool` allow_objects=false **)** @@ -97,12 +103,16 @@ Get a Variant. When ``allow_objects`` (or :ref:`allow_object_decoding` **put_packet** **(** :ref:`PoolByteArray` buffer **)** Send a raw packet. +---- + .. _class_PacketPeer_method_put_var: - :ref:`Error` **put_var** **(** :ref:`Variant` var, :ref:`bool` full_objects=false **)** diff --git a/classes/class_packetpeerstream.rst b/classes/class_packetpeerstream.rst index 5f1d07c66..9ba178350 100644 --- a/classes/class_packetpeerstream.rst +++ b/classes/class_packetpeerstream.rst @@ -47,6 +47,8 @@ Property Descriptions | *Getter* | get_input_buffer_max_size() | +----------+----------------------------------+ +---- + .. _class_PacketPeerStream_property_output_buffer_max_size: - :ref:`int` **output_buffer_max_size** @@ -57,6 +59,8 @@ Property Descriptions | *Getter* | get_output_buffer_max_size() | +----------+-----------------------------------+ +---- + .. _class_PacketPeerStream_property_stream_peer: - :ref:`StreamPeer` **stream_peer** diff --git a/classes/class_packetpeerudp.rst b/classes/class_packetpeerudp.rst index d365c31eb..20a102e65 100644 --- a/classes/class_packetpeerudp.rst +++ b/classes/class_packetpeerudp.rst @@ -51,24 +51,32 @@ Method Descriptions Close the UDP socket the ``PacketPeerUDP`` is currently listening on. +---- + .. _class_PacketPeerUDP_method_get_packet_ip: - :ref:`String` **get_packet_ip** **(** **)** const Returns the IP of the remote peer that sent the last packet(that was received with :ref:`PacketPeer.get_packet` or :ref:`PacketPeer.get_var`). +---- + .. _class_PacketPeerUDP_method_get_packet_port: - :ref:`int` **get_packet_port** **(** **)** const Returns the port of the remote peer that sent the last packet(that was received with :ref:`PacketPeer.get_packet` or :ref:`PacketPeer.get_var`). +---- + .. _class_PacketPeerUDP_method_is_listening: - :ref:`bool` **is_listening** **(** **)** const Returns whether this ``PacketPeerUDP`` is listening. +---- + .. _class_PacketPeerUDP_method_listen: - :ref:`Error` **listen** **(** :ref:`int` port, :ref:`String` bind_address="*", :ref:`int` recv_buf_size=65536 **)** @@ -81,12 +89,16 @@ If "bind_address" is set as "0.0.0.0" (for IPv4) or "::" (for IPv6), the peer wi If "bind_address" is set to any valid address (e.g. "192.168.1.101", "::1", etc), the peer will only listen on the interface with that addresses (or fail if no interface with the given address exists). +---- + .. _class_PacketPeerUDP_method_set_dest_address: - :ref:`Error` **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_method_wait: - :ref:`Error` **wait** **(** **)** diff --git a/classes/class_parallaxbackground.rst b/classes/class_parallaxbackground.rst index 8179c4079..c2c6068cd 100644 --- a/classes/class_parallaxbackground.rst +++ b/classes/class_parallaxbackground.rst @@ -55,6 +55,8 @@ Property Descriptions Base position offset of all :ref:`ParallaxLayer` children. +---- + .. _class_ParallaxBackground_property_scroll_base_scale: - :ref:`Vector2` **scroll_base_scale** @@ -67,6 +69,8 @@ Base position offset of all :ref:`ParallaxLayer` children. Base motion scale of all :ref:`ParallaxLayer` children. +---- + .. _class_ParallaxBackground_property_scroll_ignore_camera_zoom: - :ref:`bool` **scroll_ignore_camera_zoom** @@ -79,6 +83,8 @@ Base motion scale of all :ref:`ParallaxLayer` children. If ``true``, elements in :ref:`ParallaxLayer` child aren't affected by the zoom level of the camera. +---- + .. _class_ParallaxBackground_property_scroll_limit_begin: - :ref:`Vector2` **scroll_limit_begin** @@ -91,6 +97,8 @@ If ``true``, elements in :ref:`ParallaxLayer` child aren't Top left limits for scrolling to begin. If the camera is outside of this limit the background will stop scrolling. Must be lower than :ref:`scroll_limit_end` to work. +---- + .. _class_ParallaxBackground_property_scroll_limit_end: - :ref:`Vector2` **scroll_limit_end** @@ -103,6 +111,8 @@ Top left limits for scrolling to begin. If the camera is outside of this limit t Right bottom limits for scrolling to end. If the camera is outside of this limit the background will stop scrolling. Must be higher than :ref:`scroll_limit_begin` to work. +---- + .. _class_ParallaxBackground_property_scroll_offset: - :ref:`Vector2` **scroll_offset** diff --git a/classes/class_parallaxlayer.rst b/classes/class_parallaxlayer.rst index b573f6bd6..4079a0c11 100644 --- a/classes/class_parallaxlayer.rst +++ b/classes/class_parallaxlayer.rst @@ -53,6 +53,8 @@ Property Descriptions The ParallaxLayer's :ref:`Texture` mirroring. Useful for creating an infinite scrolling background. If an axis is set to ``0`` the :ref:`Texture` will not be mirrored. Default value: ``(0, 0)``. +---- + .. _class_ParallaxLayer_property_motion_offset: - :ref:`Vector2` **motion_offset** @@ -65,6 +67,8 @@ The ParallaxLayer's :ref:`Texture` mirroring. Useful for creating The ParallaxLayer's offset relative to the parent ParallaxBackground's :ref:`ParallaxBackground.scroll_offset`. +---- + .. _class_ParallaxLayer_property_motion_scale: - :ref:`Vector2` **motion_scale** diff --git a/classes/class_particles.rst b/classes/class_particles.rst index fb5eb0bf8..67597d662 100644 --- a/classes/class_particles.rst +++ b/classes/class_particles.rst @@ -123,6 +123,8 @@ Property Descriptions Number of particles to emit. +---- + .. _class_Particles_property_draw_order: - :ref:`DrawOrder` **draw_order** @@ -135,6 +137,8 @@ Number of particles to emit. Particle draw order. Uses ``DRAW_ORDER_*`` values. Default value: :ref:`DRAW_ORDER_INDEX`. +---- + .. _class_Particles_property_draw_pass_1: - :ref:`Mesh` **draw_pass_1** @@ -147,6 +151,8 @@ Particle draw order. Uses ``DRAW_ORDER_*`` values. Default value: :ref:`DRAW_ORD :ref:`Mesh` that is drawn for the first draw pass. +---- + .. _class_Particles_property_draw_pass_2: - :ref:`Mesh` **draw_pass_2** @@ -159,6 +165,8 @@ Particle draw order. Uses ``DRAW_ORDER_*`` values. Default value: :ref:`DRAW_ORD :ref:`Mesh` that is drawn for the second draw pass. +---- + .. _class_Particles_property_draw_pass_3: - :ref:`Mesh` **draw_pass_3** @@ -171,6 +179,8 @@ Particle draw order. Uses ``DRAW_ORDER_*`` values. Default value: :ref:`DRAW_ORD :ref:`Mesh` that is drawn for the third draw pass. +---- + .. _class_Particles_property_draw_pass_4: - :ref:`Mesh` **draw_pass_4** @@ -183,6 +193,8 @@ Particle draw order. Uses ``DRAW_ORDER_*`` values. Default value: :ref:`DRAW_ORD :ref:`Mesh` that is drawn for the fourth draw pass. +---- + .. _class_Particles_property_draw_passes: - :ref:`int` **draw_passes** @@ -195,6 +207,8 @@ Particle draw order. Uses ``DRAW_ORDER_*`` values. Default value: :ref:`DRAW_ORD The number of draw passes when rendering particles. +---- + .. _class_Particles_property_emitting: - :ref:`bool` **emitting** @@ -207,6 +221,8 @@ The number of draw passes when rendering particles. If ``true``, particles are being emitted. Default value: ``true``. +---- + .. _class_Particles_property_explosiveness: - :ref:`float` **explosiveness** @@ -219,6 +235,8 @@ If ``true``, particles are being emitted. Default value: ``true``. Time ratio between each emission. If ``0`` particles are emitted continuously. If ``1`` all particles are emitted simultaneously. Default value: ``0``. +---- + .. _class_Particles_property_fixed_fps: - :ref:`int` **fixed_fps** @@ -231,6 +249,8 @@ Time ratio between each emission. If ``0`` particles are emitted continuously. I The particle system's frame rate is fixed to a value. For instance, changing the value to 2 will make the particles render at 2 frames per second. Note this does not slow down the simulation of the particle system itself. +---- + .. _class_Particles_property_fract_delta: - :ref:`bool` **fract_delta** @@ -243,6 +263,8 @@ The particle system's frame rate is fixed to a value. For instance, changing the If ``true``, results in fractional delta calculation which has a smoother particles display effect. Default value: ``true``. +---- + .. _class_Particles_property_lifetime: - :ref:`float` **lifetime** @@ -255,6 +277,8 @@ If ``true``, results in fractional delta calculation which has a smoother partic Amount of time each particle will exist. Default value: ``1``. +---- + .. _class_Particles_property_local_coords: - :ref:`bool` **local_coords** @@ -267,6 +291,8 @@ Amount of time each particle will exist. Default value: ``1``. If ``true``, particles use the parent node's coordinate space. If ``false``, they use global coordinates. Default value: ``true``. +---- + .. _class_Particles_property_one_shot: - :ref:`bool` **one_shot** @@ -279,6 +305,8 @@ If ``true``, particles use the parent node's coordinate space. If ``false``, the If ``true``, only ``amount`` particles will be emitted. Default value: ``false``. +---- + .. _class_Particles_property_preprocess: - :ref:`float` **preprocess** @@ -291,6 +319,8 @@ If ``true``, only ``amount`` particles will be emitted. Default value: ``false`` Amount of time to preprocess the particles before animation starts. Lets you start the animation some time after particles have started emitting. +---- + .. _class_Particles_property_process_material: - :ref:`Material` **process_material** @@ -303,6 +333,8 @@ Amount of time to preprocess the particles before animation starts. Lets you sta :ref:`Material` for processing particles. Can be a :ref:`ParticlesMaterial` or a :ref:`ShaderMaterial`. +---- + .. _class_Particles_property_randomness: - :ref:`float` **randomness** @@ -315,6 +347,8 @@ Amount of time to preprocess the particles before animation starts. Lets you sta Emission randomness ratio. Default value: ``0``. +---- + .. _class_Particles_property_speed_scale: - :ref:`float` **speed_scale** @@ -327,6 +361,8 @@ Emission randomness ratio. Default value: ``0``. Speed scaling ratio. Default value: ``1``. A value of ``0`` can be used to pause the particles. +---- + .. _class_Particles_property_visibility_aabb: - :ref:`AABB` **visibility_aabb** @@ -348,6 +384,8 @@ Method Descriptions Returns the bounding box that contains all the particles that are active in the current frame. +---- + .. _class_Particles_method_restart: - void **restart** **(** **)** diff --git a/classes/class_particles2d.rst b/classes/class_particles2d.rst index 7aaed2298..96820d439 100644 --- a/classes/class_particles2d.rst +++ b/classes/class_particles2d.rst @@ -106,6 +106,8 @@ Property Descriptions Number of particles emitted in one emission cycle. +---- + .. _class_Particles2D_property_draw_order: - :ref:`DrawOrder` **draw_order** @@ -118,6 +120,8 @@ Number of particles emitted in one emission cycle. Particle draw order. Uses ``DRAW_ORDER_*`` values. Default value: :ref:`DRAW_ORDER_INDEX`. +---- + .. _class_Particles2D_property_emitting: - :ref:`bool` **emitting** @@ -130,6 +134,8 @@ Particle draw order. Uses ``DRAW_ORDER_*`` values. Default value: :ref:`DRAW_ORD If ``true``, particles are being emitted. Default value: ``true``. +---- + .. _class_Particles2D_property_explosiveness: - :ref:`float` **explosiveness** @@ -142,6 +148,8 @@ If ``true``, particles are being emitted. Default value: ``true``. How rapidly particles in an emission cycle are emitted. If greater than ``0``, there will be a gap in emissions before the next cycle begins. Default value: ``0``. +---- + .. _class_Particles2D_property_fixed_fps: - :ref:`int` **fixed_fps** @@ -154,6 +162,8 @@ How rapidly particles in an emission cycle are emitted. If greater than ``0``, t The particle system's frame rate is fixed to a value. For instance, changing the value to 2 will make the particles render at 2 frames per second. Note this does not slow down the simulation of the particle system itself. +---- + .. _class_Particles2D_property_fract_delta: - :ref:`bool` **fract_delta** @@ -166,6 +176,8 @@ The particle system's frame rate is fixed to a value. For instance, changing the If ``true``, results in fractional delta calculation which has a smoother particles display effect. Default value: ``true`` +---- + .. _class_Particles2D_property_lifetime: - :ref:`float` **lifetime** @@ -178,6 +190,8 @@ If ``true``, results in fractional delta calculation which has a smoother partic Amount of time each particle will exist. Default value: ``1``. +---- + .. _class_Particles2D_property_local_coords: - :ref:`bool` **local_coords** @@ -190,6 +204,8 @@ Amount of time each particle will exist. Default value: ``1``. If ``true``, particles use the parent node's coordinate space. If ``false``, they use global coordinates. Default value: ``true``. +---- + .. _class_Particles2D_property_normal_map: - :ref:`Texture` **normal_map** @@ -202,6 +218,8 @@ If ``true``, particles use the parent node's coordinate space. If ``false``, the Normal map to be used for the :ref:`texture` property. +---- + .. _class_Particles2D_property_one_shot: - :ref:`bool` **one_shot** @@ -214,6 +232,8 @@ Normal map to be used for the :ref:`texture` If ``true``, only one emission cycle occurs. If set ``true`` during a cycle, emission will stop at the cycle's end. Default value: ``false``. +---- + .. _class_Particles2D_property_preprocess: - :ref:`float` **preprocess** @@ -226,6 +246,8 @@ If ``true``, only one emission cycle occurs. If set ``true`` during a cycle, emi Particle system starts as if it had already run for this many seconds. +---- + .. _class_Particles2D_property_process_material: - :ref:`Material` **process_material** @@ -238,6 +260,8 @@ Particle system starts as if it had already run for this many seconds. :ref:`Material` for processing particles. Can be a :ref:`ParticlesMaterial` or a :ref:`ShaderMaterial`. +---- + .. _class_Particles2D_property_randomness: - :ref:`float` **randomness** @@ -250,6 +274,8 @@ Particle system starts as if it had already run for this many seconds. Emission lifetime randomness ratio. Default value: ``0``. +---- + .. _class_Particles2D_property_speed_scale: - :ref:`float` **speed_scale** @@ -262,6 +288,8 @@ Emission lifetime randomness ratio. Default value: ``0``. Particle system's running speed scaling ratio. Default value: ``1``. A value of ``0`` can be used to pause the particles. +---- + .. _class_Particles2D_property_texture: - :ref:`Texture` **texture** @@ -274,6 +302,8 @@ Particle system's running speed scaling ratio. Default value: ``1``. A value of Particle texture. If ``null`` particles will be squares. +---- + .. _class_Particles2D_property_visibility_rect: - :ref:`Rect2` **visibility_rect** @@ -295,6 +325,8 @@ Method Descriptions Returns a rectangle containing the positions of all existing particles. +---- + .. _class_Particles2D_method_restart: - void **restart** **(** **)** diff --git a/classes/class_particlesmaterial.rst b/classes/class_particlesmaterial.rst index 5689fa4d8..3c477ad05 100644 --- a/classes/class_particlesmaterial.rst +++ b/classes/class_particlesmaterial.rst @@ -186,7 +186,9 @@ enum **Parameter**: - **PARAM_ANIM_OFFSET** = **11** --- Use with :ref:`set_param`, :ref:`set_param_randomness`, and :ref:`set_param_texture` to set animation offset properties. -- **PARAM_MAX** = **12** +- **PARAM_MAX** = **12** --- Represents the size of the :ref:`Parameter` enum. + +---- .. _enum_ParticlesMaterial_Flags: @@ -194,15 +196,21 @@ enum **Parameter**: .. _class_ParticlesMaterial_constant_FLAG_ROTATE_Y: +.. _class_ParticlesMaterial_constant_FLAG_DISABLE_Z: + .. _class_ParticlesMaterial_constant_FLAG_MAX: enum **Flags**: - **FLAG_ALIGN_Y_TO_VELOCITY** = **0** --- Use with :ref:`set_flag` to set :ref:`flag_align_y`. -- **FLAG_ROTATE_Y** = **1** --- Use with :ref:`set_flag` to set :ref:`flag_rotate_y` +- **FLAG_ROTATE_Y** = **1** --- Use with :ref:`set_flag` to set :ref:`flag_rotate_y`. -- **FLAG_MAX** = **3** +- **FLAG_DISABLE_Z** = **2** --- Use with :ref:`set_flag` to set :ref:`flag_disable_z`. + +- **FLAG_MAX** = **3** --- Represents the size of the :ref:`Flags` enum. + +---- .. _enum_ParticlesMaterial_EmissionShape: @@ -254,6 +262,8 @@ Initial rotation applied to each particle, in degrees. Only applied when :ref:`flag_disable_z` or :ref:`flag_rotate_y` are ``true`` or the :ref:`SpatialMaterial` being used to draw the particle is using ``BillboardMode.BILLBOARD_PARTICLES``. +---- + .. _class_ParticlesMaterial_property_angle_curve: - :ref:`Texture` **angle_curve** @@ -266,6 +276,8 @@ Only applied when :ref:`flag_disable_z`. +---- + .. _class_ParticlesMaterial_property_angle_random: - :ref:`float` **angle_random** @@ -278,6 +290,8 @@ Each particle's rotation will be animated along this :ref:`CurveTexture` **angular_velocity** @@ -292,6 +306,8 @@ Initial angular velocity applied to each particle. Sets the speed of rotation of Only applied when :ref:`flag_disable_z` or :ref:`flag_rotate_y` are ``true`` or the :ref:`SpatialMaterial` being used to draw the particle is using ``BillboardMode.BILLBOARD_PARTICLES``. +---- + .. _class_ParticlesMaterial_property_angular_velocity_curve: - :ref:`Texture` **angular_velocity_curve** @@ -304,6 +320,8 @@ Only applied when :ref:`flag_disable_z`. +---- + .. _class_ParticlesMaterial_property_angular_velocity_random: - :ref:`float` **angular_velocity_random** @@ -316,6 +334,8 @@ Each particle's angular velocity will vary along this :ref:`CurveTexture` **anim_offset** @@ -328,6 +348,8 @@ Angular velocity randomness ratio. Default value: ``0``. Particle animation offset. +---- + .. _class_ParticlesMaterial_property_anim_offset_curve: - :ref:`Texture` **anim_offset_curve** @@ -340,6 +362,8 @@ Particle animation offset. Each particle's animation offset will vary along this :ref:`CurveTexture`. +---- + .. _class_ParticlesMaterial_property_anim_offset_random: - :ref:`float` **anim_offset_random** @@ -352,6 +376,8 @@ Each particle's animation offset will vary along this :ref:`CurveTexture` **anim_speed** @@ -364,6 +390,8 @@ Animation offset randomness ratio. Default value: ``0``. Particle animation speed. +---- + .. _class_ParticlesMaterial_property_anim_speed_curve: - :ref:`Texture` **anim_speed_curve** @@ -376,6 +404,8 @@ Particle animation speed. Each particle's animation speed will vary along this :ref:`CurveTexture`. +---- + .. _class_ParticlesMaterial_property_anim_speed_random: - :ref:`float` **anim_speed_random** @@ -388,6 +418,8 @@ Each particle's animation speed will vary along this :ref:`CurveTexture` **color** @@ -400,6 +432,8 @@ Animation speed randomness ratio. Default value: ``0``. Each particle's initial color. If the :ref:`Particles2D`'s ``texture`` is defined, it will be multiplied by this color. To have particle display color in a :ref:`SpatialMaterial` make sure to set :ref:`SpatialMaterial.vertex_color_use_as_albedo` to ``true``. +---- + .. _class_ParticlesMaterial_property_color_ramp: - :ref:`Texture` **color_ramp** @@ -412,6 +446,8 @@ Each particle's initial color. If the :ref:`Particles2D`'s `` Each particle's color will vary along this :ref:`GradientTexture`. +---- + .. _class_ParticlesMaterial_property_damping: - :ref:`float` **damping** @@ -424,6 +460,8 @@ Each particle's color will vary along this :ref:`GradientTexture` **damping_curve** @@ -436,6 +474,8 @@ The rate at which particles lose velocity. Damping will vary along this :ref:`CurveTexture`. +---- + .. _class_ParticlesMaterial_property_damping_random: - :ref:`float` **damping_random** @@ -448,6 +488,8 @@ Damping will vary along this :ref:`CurveTexture`. Damping randomness ratio. Default value: ``0``. +---- + .. _class_ParticlesMaterial_property_emission_box_extents: - :ref:`Vector3` **emission_box_extents** @@ -460,6 +502,8 @@ Damping randomness ratio. Default value: ``0``. The box's extents if ``emission_shape`` is set to :ref:`EMISSION_SHAPE_BOX`. +---- + .. _class_ParticlesMaterial_property_emission_color_texture: - :ref:`Texture` **emission_color_texture** @@ -472,6 +516,8 @@ The box's extents if ``emission_shape`` is set to :ref:`EMISSION_SHAPE_BOX`. +---- + .. _class_ParticlesMaterial_property_emission_normal_texture: - :ref:`Texture` **emission_normal_texture** @@ -484,6 +530,8 @@ Particle color will be modulated by color determined by sampling this texture at Particle velocity and rotation will be set by sampling this texture at the same point as the :ref:`emission_point_texture`. Used only in :ref:`EMISSION_SHAPE_DIRECTED_POINTS`. Can be created automatically from mesh or node by selecting "Create Emission Points from Mesh/Node" under the "Particles" tool in the toolbar. +---- + .. _class_ParticlesMaterial_property_emission_point_count: - :ref:`int` **emission_point_count** @@ -496,6 +544,8 @@ Particle velocity and rotation will be set by sampling this texture at the same The number of emission points if ``emission_shape`` is set to :ref:`EMISSION_SHAPE_POINTS` or :ref:`EMISSION_SHAPE_DIRECTED_POINTS`. +---- + .. _class_ParticlesMaterial_property_emission_point_texture: - :ref:`Texture` **emission_point_texture** @@ -508,6 +558,8 @@ The number of emission points if ``emission_shape`` is set to :ref:`EMISSION_SHA Particles will be emitted at positions determined by sampling this texture at a random position. Used with :ref:`EMISSION_SHAPE_POINTS` and :ref:`EMISSION_SHAPE_DIRECTED_POINTS`. Can be created automatically from mesh or node by selecting "Create Emission Points from Mesh/Node" under the "Particles" tool in the toolbar. +---- + .. _class_ParticlesMaterial_property_emission_shape: - :ref:`EmissionShape` **emission_shape** @@ -520,6 +572,8 @@ Particles will be emitted at positions determined by sampling this texture at a Particles will be emitted inside this region. Use ``EMISSION_SHAPE_*`` constants for values. Default value: :ref:`EMISSION_SHAPE_POINT`. +---- + .. _class_ParticlesMaterial_property_emission_sphere_radius: - :ref:`float` **emission_sphere_radius** @@ -532,6 +586,8 @@ Particles will be emitted inside this region. Use ``EMISSION_SHAPE_*`` constants The sphere's radius if ``emission_shape`` is set to :ref:`EMISSION_SHAPE_SPHERE`. +---- + .. _class_ParticlesMaterial_property_flag_align_y: - :ref:`bool` **flag_align_y** @@ -544,6 +600,8 @@ The sphere's radius if ``emission_shape`` is set to :ref:`EMISSION_SHAPE_SPHERE< Align y-axis of particle with the direction of its velocity. +---- + .. _class_ParticlesMaterial_property_flag_disable_z: - :ref:`bool` **flag_disable_z** @@ -556,6 +614,8 @@ Align y-axis of particle with the direction of its velocity. If ``true``, particles will not move on the z axis. Default value: ``true`` for :ref:`Particles2D`, ``false`` for :ref:`Particles`. +---- + .. _class_ParticlesMaterial_property_flag_rotate_y: - :ref:`bool` **flag_rotate_y** @@ -568,6 +628,8 @@ If ``true``, particles will not move on the z axis. Default value: ``true`` for If ``true``, particles rotate around y-axis by :ref:`angle`. +---- + .. _class_ParticlesMaterial_property_flatness: - :ref:`float` **flatness** @@ -580,6 +642,8 @@ If ``true``, particles rotate around y-axis by :ref:`angle` in Y/Z plane. A value of ``1`` restricts particles to X/Z plane. Default ``0``. +---- + .. _class_ParticlesMaterial_property_gravity: - :ref:`Vector3` **gravity** @@ -592,6 +656,8 @@ Amount of :ref:`spread` in Y/Z plane. A Gravity applied to every particle. Default value: ``(0, -9.8, 0)``. +---- + .. _class_ParticlesMaterial_property_hue_variation: - :ref:`float` **hue_variation** @@ -604,6 +670,8 @@ Gravity applied to every particle. Default value: ``(0, -9.8, 0)``. Initial hue variation applied to each particle. +---- + .. _class_ParticlesMaterial_property_hue_variation_curve: - :ref:`Texture` **hue_variation_curve** @@ -616,6 +684,8 @@ Initial hue variation applied to each particle. Each particle's hue will vary along this :ref:`CurveTexture`. +---- + .. _class_ParticlesMaterial_property_hue_variation_random: - :ref:`float` **hue_variation_random** @@ -628,6 +698,8 @@ Each particle's hue will vary along this :ref:`CurveTexture` Hue variation randomness ratio. Default value: ``0``. +---- + .. _class_ParticlesMaterial_property_initial_velocity: - :ref:`float` **initial_velocity** @@ -640,6 +712,8 @@ Hue variation randomness ratio. Default value: ``0``. Initial velocity magnitude for each particle. Direction comes from :ref:`spread` and the node's orientation. +---- + .. _class_ParticlesMaterial_property_initial_velocity_random: - :ref:`float` **initial_velocity_random** @@ -652,6 +726,8 @@ Initial velocity magnitude for each particle. Direction comes from :ref:`spread< Initial velocity randomness ratio. Default value: ``0``. +---- + .. _class_ParticlesMaterial_property_linear_accel: - :ref:`float` **linear_accel** @@ -664,6 +740,8 @@ Initial velocity randomness ratio. Default value: ``0``. Linear acceleration applied to each particle in the direction of motion. +---- + .. _class_ParticlesMaterial_property_linear_accel_curve: - :ref:`Texture` **linear_accel_curve** @@ -676,6 +754,8 @@ Linear acceleration applied to each particle in the direction of motion. Each particle's linear acceleration will vary along this :ref:`CurveTexture`. +---- + .. _class_ParticlesMaterial_property_linear_accel_random: - :ref:`float` **linear_accel_random** @@ -688,6 +768,8 @@ Each particle's linear acceleration will vary along this :ref:`CurveTexture` **orbit_velocity** @@ -702,6 +784,8 @@ Orbital velocity applied to each particle. Makes the particles circle around ori Only available when :ref:`flag_disable_z` is ``true``. +---- + .. _class_ParticlesMaterial_property_orbit_velocity_curve: - :ref:`Texture` **orbit_velocity_curve** @@ -714,6 +798,8 @@ Only available when :ref:`flag_disable_z`. +---- + .. _class_ParticlesMaterial_property_orbit_velocity_random: - :ref:`float` **orbit_velocity_random** @@ -726,6 +812,8 @@ Each particle's orbital velocity will vary along this :ref:`CurveTexture` **radial_accel** @@ -738,6 +826,8 @@ Orbital velocity randomness ratio. Default value: ``0``. Radial acceleration applied to each particle. Makes particle accelerate away from origin. +---- + .. _class_ParticlesMaterial_property_radial_accel_curve: - :ref:`Texture` **radial_accel_curve** @@ -750,6 +840,8 @@ Radial acceleration applied to each particle. Makes particle accelerate away fro Each particle's radial acceleration will vary along this :ref:`CurveTexture`. +---- + .. _class_ParticlesMaterial_property_radial_accel_random: - :ref:`float` **radial_accel_random** @@ -762,6 +854,8 @@ Each particle's radial acceleration will vary along this :ref:`CurveTexture` **scale** @@ -774,6 +868,8 @@ Radial acceleration randomness ratio. Default value: ``0``. Initial scale applied to each particle. +---- + .. _class_ParticlesMaterial_property_scale_curve: - :ref:`Texture` **scale_curve** @@ -786,6 +882,8 @@ Initial scale applied to each particle. Each particle's scale will vary along this :ref:`CurveTexture`. +---- + .. _class_ParticlesMaterial_property_scale_random: - :ref:`float` **scale_random** @@ -798,6 +896,8 @@ Each particle's scale will vary along this :ref:`CurveTexture` **spread** @@ -810,6 +910,8 @@ Scale randomness ratio. Default value: ``0``. Each particle's initial direction range from ``+spread`` to ``-spread`` degrees. Default value: ``45``. Applied to X/Z plane and Y/Z planes. +---- + .. _class_ParticlesMaterial_property_tangential_accel: - :ref:`float` **tangential_accel** @@ -822,6 +924,8 @@ Each particle's initial direction range from ``+spread`` to ``-spread`` degrees. Tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity giving the particles a swirling motion. +---- + .. _class_ParticlesMaterial_property_tangential_accel_curve: - :ref:`Texture` **tangential_accel_curve** @@ -834,6 +938,8 @@ Tangential acceleration applied to each particle. Tangential acceleration is per Each particle's tangential acceleration will vary along this :ref:`CurveTexture`. +---- + .. _class_ParticlesMaterial_property_tangential_accel_random: - :ref:`float` **tangential_accel_random** @@ -846,6 +952,8 @@ Each particle's tangential acceleration will vary along this :ref:`CurveTexture< Tangential acceleration randomness ratio. Default value: ``0``. +---- + .. _class_ParticlesMaterial_property_trail_color_modifier: - :ref:`GradientTexture` **trail_color_modifier** @@ -858,6 +966,8 @@ Tangential acceleration randomness ratio. Default value: ``0``. Trail particles' color will vary along this :ref:`GradientTexture`. +---- + .. _class_ParticlesMaterial_property_trail_divisor: - :ref:`int` **trail_divisor** @@ -870,6 +980,8 @@ Trail particles' color will vary along this :ref:`GradientTexture` **trail_size_modifier** diff --git a/classes/class_pathfollow.rst b/classes/class_pathfollow.rst index 2d85bd1ec..b139551d0 100644 --- a/classes/class_pathfollow.rst +++ b/classes/class_pathfollow.rst @@ -90,6 +90,8 @@ The points along the :ref:`Curve3D` of the :ref:`Path There are two answers to this problem: Either increase the number of cached points and increase memory consumption, or make a cubic interpolation between two points at the cost of (slightly) slower calculations. +---- + .. _class_PathFollow_property_h_offset: - :ref:`float` **h_offset** @@ -102,6 +104,8 @@ There are two answers to this problem: Either increase the number of cached poin The node's offset along the curve. +---- + .. _class_PathFollow_property_loop: - :ref:`bool` **loop** @@ -114,6 +118,8 @@ The node's offset along the curve. If ``true``, any offset outside the path's length will wrap around, instead of stopping at the ends. Use it for cyclic paths. +---- + .. _class_PathFollow_property_offset: - :ref:`float` **offset** @@ -126,6 +132,8 @@ If ``true``, any offset outside the path's length will wrap around, instead of s 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_property_rotation_mode: - :ref:`RotationMode` **rotation_mode** @@ -138,6 +146,8 @@ The distance from the first vertex, measured in 3D units along the path. This se Allows or forbids rotation on one or more axes, depending on the :ref:`RotationMode` constants being used. +---- + .. _class_PathFollow_property_unit_offset: - :ref:`float` **unit_offset** @@ -150,6 +160,8 @@ Allows or forbids rotation on one or more axes, depending on the :ref:`RotationM 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_property_v_offset: - :ref:`float` **v_offset** diff --git a/classes/class_pathfollow2d.rst b/classes/class_pathfollow2d.rst index 1395a6d27..5f7ad04dc 100644 --- a/classes/class_pathfollow2d.rst +++ b/classes/class_pathfollow2d.rst @@ -65,6 +65,8 @@ The points along the :ref:`Curve2D` of the :ref:`Path2D` **h_offset** @@ -77,6 +79,8 @@ There are two answers to this problem: Either increase the number of cached poin The node's offset along the curve. +---- + .. _class_PathFollow2D_property_lookahead: - :ref:`float` **lookahead** @@ -89,6 +93,8 @@ The node's offset along the curve. How far to look ahead of the curve to calculate the tangent if the node is rotating. E.g. shorter lookaheads will lead to faster rotations. Default value: ``4``. +---- + .. _class_PathFollow2D_property_loop: - :ref:`bool` **loop** @@ -101,6 +107,8 @@ How far to look ahead of the curve to calculate the tangent if the node is rotat If ``true``, any offset outside the path's length will wrap around, instead of stopping at the ends. Use it for cyclic paths. +---- + .. _class_PathFollow2D_property_offset: - :ref:`float` **offset** @@ -113,6 +121,8 @@ If ``true``, any offset outside the path's length will wrap around, instead of s The distance along the path in pixels. +---- + .. _class_PathFollow2D_property_rotate: - :ref:`bool` **rotate** @@ -125,6 +135,8 @@ The distance along the path in pixels. If ``true``, this node rotates to follow the path, making its descendants rotate. +---- + .. _class_PathFollow2D_property_unit_offset: - :ref:`float` **unit_offset** @@ -137,6 +149,8 @@ If ``true``, this node rotates to follow the path, making its descendants rotate The distance along the path as a number in the range 0.0 (for the first vertex) to 1.0 (for 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_property_v_offset: - :ref:`float` **v_offset** diff --git a/classes/class_pckpacker.rst b/classes/class_pckpacker.rst index b69d0bf57..c27cc853a 100644 --- a/classes/class_pckpacker.rst +++ b/classes/class_pckpacker.rst @@ -36,10 +36,14 @@ Method Descriptions - :ref:`Error` **add_file** **(** :ref:`String` pck_path, :ref:`String` source_path **)** +---- + .. _class_PCKPacker_method_flush: - :ref:`Error` **flush** **(** :ref:`bool` verbose **)** +---- + .. _class_PCKPacker_method_pck_start: - :ref:`Error` **pck_start** **(** :ref:`String` pck_name, :ref:`int` alignment **)** diff --git a/classes/class_physicalbone.rst b/classes/class_physicalbone.rst index 40d70a66f..de1aa52a7 100644 --- a/classes/class_physicalbone.rst +++ b/classes/class_physicalbone.rst @@ -96,6 +96,8 @@ Property Descriptions | *Getter* | get_body_offset() | +----------+------------------------+ +---- + .. _class_PhysicalBone_property_bounce: - :ref:`float` **bounce** @@ -106,6 +108,8 @@ Property Descriptions | *Getter* | get_bounce() | +----------+-------------------+ +---- + .. _class_PhysicalBone_property_friction: - :ref:`float` **friction** @@ -116,6 +120,8 @@ Property Descriptions | *Getter* | get_friction() | +----------+---------------------+ +---- + .. _class_PhysicalBone_property_gravity_scale: - :ref:`float` **gravity_scale** @@ -126,6 +132,8 @@ Property Descriptions | *Getter* | get_gravity_scale() | +----------+--------------------------+ +---- + .. _class_PhysicalBone_property_joint_offset: - :ref:`Transform` **joint_offset** @@ -136,6 +144,8 @@ Property Descriptions | *Getter* | get_joint_offset() | +----------+-------------------------+ +---- + .. _class_PhysicalBone_property_joint_type: - :ref:`JointType` **joint_type** @@ -146,6 +156,8 @@ Property Descriptions | *Getter* | get_joint_type() | +----------+-----------------------+ +---- + .. _class_PhysicalBone_property_mass: - :ref:`float` **mass** @@ -156,6 +168,8 @@ Property Descriptions | *Getter* | get_mass() | +----------+-----------------+ +---- + .. _class_PhysicalBone_property_weight: - :ref:`float` **weight** @@ -173,14 +187,20 @@ Method Descriptions - :ref:`int` **get_bone_id** **(** **)** const +---- + .. _class_PhysicalBone_method_get_simulate_physics: - :ref:`bool` **get_simulate_physics** **(** **)** +---- + .. _class_PhysicalBone_method_is_simulating_physics: - :ref:`bool` **is_simulating_physics** **(** **)** +---- + .. _class_PhysicalBone_method_is_static_body: - :ref:`bool` **is_static_body** **(** **)** diff --git a/classes/class_physics2ddirectbodystate.rst b/classes/class_physics2ddirectbodystate.rst index 84f438d05..2191864f4 100644 --- a/classes/class_physics2ddirectbodystate.rst +++ b/classes/class_physics2ddirectbodystate.rst @@ -113,6 +113,8 @@ Property Descriptions The body's rotational velocity. +---- + .. _class_Physics2DDirectBodyState_property_inverse_inertia: - :ref:`float` **inverse_inertia** @@ -123,6 +125,8 @@ The body's rotational velocity. The inverse of the inertia of the body. +---- + .. _class_Physics2DDirectBodyState_property_inverse_mass: - :ref:`float` **inverse_mass** @@ -133,6 +137,8 @@ The inverse of the inertia of the body. The inverse of the mass of the body. +---- + .. _class_Physics2DDirectBodyState_property_linear_velocity: - :ref:`Vector2` **linear_velocity** @@ -145,6 +151,8 @@ The inverse of the mass of the body. The body's linear velocity. +---- + .. _class_Physics2DDirectBodyState_property_sleeping: - :ref:`bool` **sleeping** @@ -157,6 +165,8 @@ The body's linear velocity. If ``true``, this body is currently sleeping (not active). +---- + .. _class_Physics2DDirectBodyState_property_step: - :ref:`float` **step** @@ -167,6 +177,8 @@ If ``true``, this body is currently sleeping (not active). The timestep (delta) used for the simulation. +---- + .. _class_Physics2DDirectBodyState_property_total_angular_damp: - :ref:`float` **total_angular_damp** @@ -177,6 +189,8 @@ The timestep (delta) used for the simulation. The rate at which the body stops rotating, if there are not any other forces moving it. +---- + .. _class_Physics2DDirectBodyState_property_total_gravity: - :ref:`Vector2` **total_gravity** @@ -187,6 +201,8 @@ The rate at which the body stops rotating, if there are not any other forces mov The total gravity vector being currently applied to this body. +---- + .. _class_Physics2DDirectBodyState_property_total_linear_damp: - :ref:`float` **total_linear_damp** @@ -197,6 +213,8 @@ The total gravity vector being currently applied to this body. The rate at which the body stops moving, if there are not any other forces moving it. +---- + .. _class_Physics2DDirectBodyState_property_transform: - :ref:`Transform2D` **transform** @@ -218,108 +236,144 @@ Method Descriptions Adds a constant directional force without affecting rotation. +---- + .. _class_Physics2DDirectBodyState_method_add_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_Physics2DDirectBodyState_method_add_torque: - void **add_torque** **(** :ref:`float` torque **)** Adds a constant rotational force. +---- + .. _class_Physics2DDirectBodyState_method_apply_central_impulse: - void **apply_central_impulse** **(** :ref:`Vector2` impulse **)** Applies a directional impulse without affecting rotation. +---- + .. _class_Physics2DDirectBodyState_method_apply_impulse: - void **apply_impulse** **(** :ref:`Vector2` offset, :ref:`Vector2` impulse **)** Applies a positioned impulse to the body. An impulse is time independent! Applying an impulse every frame would result in a framerate dependent force. For this reason it should only be used when simulating one-time impacts (use the "_force" functions otherwise). The offset uses the rotation of the global coordinate system, but is centered at the object's origin. +---- + .. _class_Physics2DDirectBodyState_method_apply_torque_impulse: - void **apply_torque_impulse** **(** :ref:`float` impulse **)** Applies a rotational impulse to the body. +---- + .. _class_Physics2DDirectBodyState_method_get_contact_collider: - :ref:`RID` **get_contact_collider** **(** :ref:`int` contact_idx **)** const Returns the collider's :ref:`RID`. +---- + .. _class_Physics2DDirectBodyState_method_get_contact_collider_id: - :ref:`int` **get_contact_collider_id** **(** :ref:`int` contact_idx **)** const Returns the collider's object id. +---- + .. _class_Physics2DDirectBodyState_method_get_contact_collider_object: - :ref:`Object` **get_contact_collider_object** **(** :ref:`int` contact_idx **)** const Returns the collider object. This depends on how it was created (will return a scene node if such was used to create it). +---- + .. _class_Physics2DDirectBodyState_method_get_contact_collider_position: - :ref:`Vector2` **get_contact_collider_position** **(** :ref:`int` contact_idx **)** const Returns the contact position in the collider. +---- + .. _class_Physics2DDirectBodyState_method_get_contact_collider_shape: - :ref:`int` **get_contact_collider_shape** **(** :ref:`int` contact_idx **)** const Returns the collider's shape index. +---- + .. _class_Physics2DDirectBodyState_method_get_contact_collider_shape_metadata: - :ref:`Variant` **get_contact_collider_shape_metadata** **(** :ref:`int` contact_idx **)** const Returns the collided shape's metadata. This metadata is different from :ref:`Object.get_meta`, and is set with :ref:`Physics2DServer.shape_set_data`. +---- + .. _class_Physics2DDirectBodyState_method_get_contact_collider_velocity_at_position: - :ref:`Vector2` **get_contact_collider_velocity_at_position** **(** :ref:`int` contact_idx **)** const Returns the linear velocity vector at the collider's contact point. +---- + .. _class_Physics2DDirectBodyState_method_get_contact_count: - :ref:`int` **get_contact_count** **(** **)** const Returns the number of contacts this body has with other bodies. Note that by default this returns 0 unless bodies are configured to log contacts. See :ref:`RigidBody2D.contact_monitor`. +---- + .. _class_Physics2DDirectBodyState_method_get_contact_local_normal: - :ref:`Vector2` **get_contact_local_normal** **(** :ref:`int` contact_idx **)** const Returns the local normal at the contact point. +---- + .. _class_Physics2DDirectBodyState_method_get_contact_local_position: - :ref:`Vector2` **get_contact_local_position** **(** :ref:`int` contact_idx **)** const Returns the local position of the contact point. +---- + .. _class_Physics2DDirectBodyState_method_get_contact_local_shape: - :ref:`int` **get_contact_local_shape** **(** :ref:`int` contact_idx **)** const Returns the local shape index of the collision. +---- + .. _class_Physics2DDirectBodyState_method_get_space_state: - :ref:`Physics2DDirectSpaceState` **get_space_state** **(** **)** Returns the current state of the space, useful for queries. +---- + .. _class_Physics2DDirectBodyState_method_integrate_forces: - void **integrate_forces** **(** **)** diff --git a/classes/class_physics2ddirectspacestate.rst b/classes/class_physics2ddirectspacestate.rst index f9ab8985b..2f5610d90 100644 --- a/classes/class_physics2ddirectspacestate.rst +++ b/classes/class_physics2ddirectspacestate.rst @@ -58,12 +58,16 @@ Checks how far the shape can travel toward a point. Note that both the shape and If the shape can not move, the array will be empty. +---- + .. _class_Physics2DDirectSpaceState_method_collide_shape: - :ref:`Array` **collide_shape** **(** :ref:`Physics2DShapeQueryParameters` shape, :ref:`int` max_results=32 **)** Checks 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_method_get_rest_info: - :ref:`Dictionary` **get_rest_info** **(** :ref:`Physics2DShapeQueryParameters` shape **)** @@ -86,6 +90,8 @@ Checks the intersections of a shape, given through a :ref:`Physics2DShapeQueryPa If the shape did not intersect anything, then an empty dictionary is returned instead. +---- + .. _class_Physics2DDirectSpaceState_method_intersect_point: - :ref:`Array` **intersect_point** **(** :ref:`Vector2` point, :ref:`int` max_results=32, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=2147483647, :ref:`bool` collide_with_bodies=true, :ref:`bool` collide_with_areas=false **)** @@ -104,10 +110,14 @@ Checks whether a point is inside any shape. The shapes the point is inside of ar Additionally, the method can take an ``exclude`` array of objects or :ref:`RID`\ s that are to be excluded from collisions, a ``collision_mask`` bitmask representing the physics layers to check in, or booleans to determine if the ray should collide with :ref:`PhysicsBody`\ s or :ref:`Area`\ s, respectively. +---- + .. _class_Physics2DDirectSpaceState_method_intersect_point_on_canvas: - :ref:`Array` **intersect_point_on_canvas** **(** :ref:`Vector2` point, :ref:`int` canvas_instance_id, :ref:`int` max_results=32, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=2147483647, :ref:`bool` collide_with_bodies=true, :ref:`bool` collide_with_areas=false **)** +---- + .. _class_Physics2DDirectSpaceState_method_intersect_ray: - :ref:`Dictionary` **intersect_ray** **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=2147483647, :ref:`bool` collide_with_bodies=true, :ref:`bool` collide_with_areas=false **)** @@ -132,6 +142,8 @@ If the ray did not intersect anything, then an empty dictionary is returned inst Additionally, the method can take an ``exclude`` array of objects or :ref:`RID`\ s that are to be excluded from collisions, a ``collision_mask`` bitmask representing the physics layers to check in, or booleans to determine if the ray should collide with :ref:`PhysicsBody`\ s or :ref:`Area`\ s, respectively. +---- + .. _class_Physics2DDirectSpaceState_method_intersect_shape: - :ref:`Array` **intersect_shape** **(** :ref:`Physics2DShapeQueryParameters` shape, :ref:`int` max_results=32 **)** diff --git a/classes/class_physics2dserver.rst b/classes/class_physics2dserver.rst index da3d6852d..d3e8ab721 100644 --- a/classes/class_physics2dserver.rst +++ b/classes/class_physics2dserver.rst @@ -268,6 +268,8 @@ enum **SpaceParameter**: - **SPACE_PARAM_TEST_MOTION_MIN_CONTACT_DEPTH** = **7** +---- + .. _enum_Physics2DServer_ShapeType: .. _class_Physics2DServer_constant_SHAPE_LINE: @@ -308,6 +310,8 @@ enum **ShapeType**: - **SHAPE_CUSTOM** = **8** --- This constant is used internally by the engine. Any attempt to create this kind of shape results in an error. +---- + .. _enum_Physics2DServer_AreaParameter: .. _class_Physics2DServer_constant_AREA_PARAM_GRAVITY: @@ -344,6 +348,8 @@ enum **AreaParameter**: - **AREA_PARAM_PRIORITY** = **7** --- Constant to set/get the priority (order of processing) of an area. +---- + .. _enum_Physics2DServer_AreaSpaceOverrideMode: .. _class_Physics2DServer_constant_AREA_SPACE_OVERRIDE_DISABLED: @@ -368,6 +374,8 @@ enum **AreaSpaceOverrideMode**: - **AREA_SPACE_OVERRIDE_REPLACE_COMBINE** = **4** --- This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one. +---- + .. _enum_Physics2DServer_BodyMode: .. _class_Physics2DServer_constant_BODY_MODE_STATIC: @@ -388,6 +396,8 @@ enum **BodyMode**: - **BODY_MODE_CHARACTER** = **3** --- Constant for rigid bodies in character mode. In this mode, a body can not rotate, and only its linear velocity is affected by physics. +---- + .. _enum_Physics2DServer_BodyParameter: .. _class_Physics2DServer_constant_BODY_PARAM_BOUNCE: @@ -424,6 +434,8 @@ enum **BodyParameter**: - **BODY_PARAM_MAX** = **7** --- Represents the size of the :ref:`BodyParameter` enum. +---- + .. _enum_Physics2DServer_BodyState: .. _class_Physics2DServer_constant_BODY_STATE_TRANSFORM: @@ -448,6 +460,8 @@ enum **BodyState**: - **BODY_STATE_CAN_SLEEP** = **4** --- Constant to set/get whether the body can sleep. +---- + .. _enum_Physics2DServer_JointType: .. _class_Physics2DServer_constant_JOINT_PIN: @@ -464,6 +478,8 @@ enum **JointType**: - **JOINT_DAMPED_SPRING** = **2** --- Constant to create damped spring joints. +---- + .. _enum_Physics2DServer_JointParam: .. _class_Physics2DServer_constant_JOINT_PARAM_BIAS: @@ -480,6 +496,8 @@ enum **JointParam**: - **JOINT_PARAM_MAX_FORCE** = **2** +---- + .. _enum_Physics2DServer_DampedStringParam: .. _class_Physics2DServer_constant_DAMPED_STRING_REST_LENGTH: @@ -496,6 +514,8 @@ enum **DampedStringParam**: - **DAMPED_STRING_DAMPING** = **2** --- 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). +---- + .. _enum_Physics2DServer_CCDMode: .. _class_Physics2DServer_constant_CCD_MODE_DISABLED: @@ -512,6 +532,8 @@ enum **CCDMode**: - **CCD_MODE_CAST_SHAPE** = **2** --- Enables continuous collision detection by shapecasting. It is the slowest CCD method, and the most precise. +---- + .. _enum_Physics2DServer_AreaBodyStatus: .. _class_Physics2DServer_constant_AREA_BODY_ADDED: @@ -524,6 +546,8 @@ enum **AreaBodyStatus**: - **AREA_BODY_REMOVED** = **1** --- The value of the first parameter and area callback function receives, when an object exits one of its shapes. +---- + .. _enum_Physics2DServer_ProcessInfo: .. _class_Physics2DServer_constant_INFO_ACTIVE_OBJECTS: @@ -554,102 +578,138 @@ Method Descriptions 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_method_area_attach_canvas_instance_id: - void **area_attach_canvas_instance_id** **(** :ref:`RID` area, :ref:`int` id **)** +---- + .. _class_Physics2DServer_method_area_attach_object_instance_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_method_area_clear_shapes: - 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_method_area_create: - :ref:`RID` **area_create** **(** **)** Creates an :ref:`Area2D`. +---- + .. _class_Physics2DServer_method_area_get_canvas_instance_id: - :ref:`int` **area_get_canvas_instance_id** **(** :ref:`RID` area **)** const +---- + .. _class_Physics2DServer_method_area_get_object_instance_id: - :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_method_area_get_param: - :ref:`Variant` **area_get_param** **(** :ref:`RID` area, :ref:`AreaParameter` param **)** const Returns an area parameter value. See :ref:`AreaParameter` for a list of available parameters. +---- + .. _class_Physics2DServer_method_area_get_shape: - :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_method_area_get_shape_count: - :ref:`int` **area_get_shape_count** **(** :ref:`RID` area **)** const Returns the number of shapes assigned to an area. +---- + .. _class_Physics2DServer_method_area_get_shape_transform: - :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_method_area_get_space: - :ref:`RID` **area_get_space** **(** :ref:`RID` area **)** const Returns the space assigned to the area. +---- + .. _class_Physics2DServer_method_area_get_space_override_mode: - :ref:`AreaSpaceOverrideMode` **area_get_space_override_mode** **(** :ref:`RID` area **)** const Returns the space override mode for the area. +---- + .. _class_Physics2DServer_method_area_get_transform: - :ref:`Transform2D` **area_get_transform** **(** :ref:`RID` area **)** const Returns the transform matrix for an area. +---- + .. _class_Physics2DServer_method_area_remove_shape: - 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_method_area_set_area_monitor_callback: - void **area_set_area_monitor_callback** **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** +---- + .. _class_Physics2DServer_method_area_set_collision_layer: - void **area_set_collision_layer** **(** :ref:`RID` area, :ref:`int` layer **)** Assigns the area to one or many physics layers. +---- + .. _class_Physics2DServer_method_area_set_collision_mask: - void **area_set_collision_mask** **(** :ref:`RID` area, :ref:`int` mask **)** Sets which physics layers the area will monitor. +---- + .. _class_Physics2DServer_method_area_set_monitor_callback: - void **area_set_monitor_callback** **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** @@ -666,238 +726,322 @@ Sets the function to call when any body/area enters or exits the area. This call 5: The shape index of the area where the object entered/exited. +---- + .. _class_Physics2DServer_method_area_set_monitorable: - void **area_set_monitorable** **(** :ref:`RID` area, :ref:`bool` monitorable **)** +---- + .. _class_Physics2DServer_method_area_set_param: - void **area_set_param** **(** :ref:`RID` area, :ref:`AreaParameter` param, :ref:`Variant` value **)** Sets the value for an area parameter. See :ref:`AreaParameter` for a list of available parameters. +---- + .. _class_Physics2DServer_method_area_set_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_method_area_set_shape_disabled: - void **area_set_shape_disabled** **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`bool` disable **)** Disables a given shape in an area. +---- + .. _class_Physics2DServer_method_area_set_shape_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_method_area_set_space: - void **area_set_space** **(** :ref:`RID` area, :ref:`RID` space **)** Assigns a space to the area. +---- + .. _class_Physics2DServer_method_area_set_space_override_mode: - void **area_set_space_override_mode** **(** :ref:`RID` area, :ref:`AreaSpaceOverrideMode` mode **)** Sets the space override mode for the area. See :ref:`AreaSpaceOverrideMode` for a list of available modes. +---- + .. _class_Physics2DServer_method_area_set_transform: - void **area_set_transform** **(** :ref:`RID` area, :ref:`Transform2D` transform **)** Sets the transform matrix for an area. +---- + .. _class_Physics2DServer_method_body_add_central_force: - void **body_add_central_force** **(** :ref:`RID` body, :ref:`Vector2` force **)** +---- + .. _class_Physics2DServer_method_body_add_collision_exception: - 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_method_body_add_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_method_body_add_shape: - 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_method_body_add_torque: - void **body_add_torque** **(** :ref:`RID` body, :ref:`float` torque **)** +---- + .. _class_Physics2DServer_method_body_apply_central_impulse: - void **body_apply_central_impulse** **(** :ref:`RID` body, :ref:`Vector2` impulse **)** +---- + .. _class_Physics2DServer_method_body_apply_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_method_body_apply_torque_impulse: - void **body_apply_torque_impulse** **(** :ref:`RID` body, :ref:`float` impulse **)** +---- + .. _class_Physics2DServer_method_body_attach_canvas_instance_id: - void **body_attach_canvas_instance_id** **(** :ref:`RID` body, :ref:`int` id **)** +---- + .. _class_Physics2DServer_method_body_attach_object_instance_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_method_body_clear_shapes: - void **body_clear_shapes** **(** :ref:`RID` body **)** Removes all shapes from a body. +---- + .. _class_Physics2DServer_method_body_create: - :ref:`RID` **body_create** **(** **)** Creates a physics body. +---- + .. _class_Physics2DServer_method_body_get_canvas_instance_id: - :ref:`int` **body_get_canvas_instance_id** **(** :ref:`RID` body **)** const +---- + .. _class_Physics2DServer_method_body_get_collision_layer: - :ref:`int` **body_get_collision_layer** **(** :ref:`RID` body **)** const Returns the physics layer or layers a body belongs to. +---- + .. _class_Physics2DServer_method_body_get_collision_mask: - :ref:`int` **body_get_collision_mask** **(** :ref:`RID` body **)** const Returns the physics layer or layers a body can collide with. +---- + .. _class_Physics2DServer_method_body_get_continuous_collision_detection_mode: - :ref:`CCDMode` **body_get_continuous_collision_detection_mode** **(** :ref:`RID` body **)** const Returns the continuous collision detection mode. +---- + .. _class_Physics2DServer_method_body_get_direct_state: - :ref:`Physics2DDirectBodyState` **body_get_direct_state** **(** :ref:`RID` body **)** Returns the :ref:`Physics2DDirectBodyState` of the body. +---- + .. _class_Physics2DServer_method_body_get_max_contacts_reported: - :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_method_body_get_mode: - :ref:`BodyMode` **body_get_mode** **(** :ref:`RID` body **)** const Returns the body mode. +---- + .. _class_Physics2DServer_method_body_get_object_instance_id: - :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_method_body_get_param: - :ref:`float` **body_get_param** **(** :ref:`RID` body, :ref:`BodyParameter` param **)** const Returns the value of a body parameter. See :ref:`BodyParameter` for a list of available parameters. +---- + .. _class_Physics2DServer_method_body_get_shape: - :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_method_body_get_shape_count: - :ref:`int` **body_get_shape_count** **(** :ref:`RID` body **)** const Returns the number of shapes assigned to a body. +---- + .. _class_Physics2DServer_method_body_get_shape_metadata: - :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_method_body_get_shape_transform: - :ref:`Transform2D` **body_get_shape_transform** **(** :ref:`RID` body, :ref:`int` shape_idx **)** const Returns the transform matrix of a body shape. +---- + .. _class_Physics2DServer_method_body_get_space: - :ref:`RID` **body_get_space** **(** :ref:`RID` body **)** const Returns the :ref:`RID` of the space assigned to a body. +---- + .. _class_Physics2DServer_method_body_get_state: - :ref:`Variant` **body_get_state** **(** :ref:`RID` body, :ref:`BodyState` state **)** const Returns a body state. +---- + .. _class_Physics2DServer_method_body_is_omitting_force_integration: - :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_method_body_remove_collision_exception: - 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_method_body_remove_shape: - 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_method_body_set_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_method_body_set_collision_layer: - void **body_set_collision_layer** **(** :ref:`RID` body, :ref:`int` layer **)** Sets the physics layer or layers a body belongs to. +---- + .. _class_Physics2DServer_method_body_set_collision_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_method_body_set_continuous_collision_detection_mode: - void **body_set_continuous_collision_detection_mode** **(** :ref:`RID` body, :ref:`CCDMode` mode **)** @@ -906,230 +1050,312 @@ Sets the continuous collision detection mode using one of the :ref:`CCDMode` 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_method_body_set_max_contacts_reported: - 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_method_body_set_mode: - void **body_set_mode** **(** :ref:`RID` body, :ref:`BodyMode` mode **)** Sets the body mode using one of the :ref:`BodyMode` constants. +---- + .. _class_Physics2DServer_method_body_set_omit_force_integration: - 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_method_body_set_param: - void **body_set_param** **(** :ref:`RID` body, :ref:`BodyParameter` param, :ref:`float` value **)** Sets a body parameter. See :ref:`BodyParameter` for a list of available parameters. +---- + .. _class_Physics2DServer_method_body_set_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_method_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, :ref:`float` margin **)** Enables one way collision on body if ``enable`` is ``true``. +---- + .. _class_Physics2DServer_method_body_set_shape_disabled: - 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_method_body_set_shape_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_method_body_set_shape_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_method_body_set_space: - void **body_set_space** **(** :ref:`RID` body, :ref:`RID` space **)** Assigns a space to the body (see :ref:`space_create`). +---- + .. _class_Physics2DServer_method_body_set_state: - void **body_set_state** **(** :ref:`RID` body, :ref:`BodyState` state, :ref:`Variant` value **)** Sets a body state using one of the :ref:`BodyState` constants. +---- + .. _class_Physics2DServer_method_body_test_motion: - :ref:`bool` **body_test_motion** **(** :ref:`RID` body, :ref:`Transform2D` from, :ref:`Vector2` motion, :ref:`bool` infinite_inertia, :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_method_capsule_shape_create: - :ref:`RID` **capsule_shape_create** **(** **)** +---- + .. _class_Physics2DServer_method_circle_shape_create: - :ref:`RID` **circle_shape_create** **(** **)** +---- + .. _class_Physics2DServer_method_concave_polygon_shape_create: - :ref:`RID` **concave_polygon_shape_create** **(** **)** +---- + .. _class_Physics2DServer_method_convex_polygon_shape_create: - :ref:`RID` **convex_polygon_shape_create** **(** **)** +---- + .. _class_Physics2DServer_method_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 **)** Creates a damped spring joint between two bodies. If not specified, the second body is assumed to be the joint itself. +---- + .. _class_Physics2DServer_method_damped_string_joint_get_param: - :ref:`float` **damped_string_joint_get_param** **(** :ref:`RID` joint, :ref:`DampedStringParam` param **)** const Returns the value of a damped spring joint parameter. +---- + .. _class_Physics2DServer_method_damped_string_joint_set_param: - void **damped_string_joint_set_param** **(** :ref:`RID` joint, :ref:`DampedStringParam` param, :ref:`float` value **)** Sets a damped spring joint parameter. See :ref:`DampedStringParam` for a list of available parameters. +---- + .. _class_Physics2DServer_method_free_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_method_get_process_info: - :ref:`int` **get_process_info** **(** :ref:`ProcessInfo` process_info **)** Returns information about the current state of the 2D physics engine. See :ref:`ProcessInfo` for a list of available states. +---- + .. _class_Physics2DServer_method_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 **)** Creates a groove joint between two bodies. If not specified, the bodies are assumed to be the joint itself. +---- + .. _class_Physics2DServer_method_joint_get_param: - :ref:`float` **joint_get_param** **(** :ref:`RID` joint, :ref:`JointParam` param **)** const Returns the value of a joint parameter. +---- + .. _class_Physics2DServer_method_joint_get_type: - :ref:`JointType` **joint_get_type** **(** :ref:`RID` joint **)** const Returns the type of a joint (see :ref:`JointType`). +---- + .. _class_Physics2DServer_method_joint_set_param: - void **joint_set_param** **(** :ref:`RID` joint, :ref:`JointParam` param, :ref:`float` value **)** Sets a joint parameter. See :ref:`JointParam` for a list of available parameters. +---- + .. _class_Physics2DServer_method_line_shape_create: - :ref:`RID` **line_shape_create** **(** **)** +---- + .. _class_Physics2DServer_method_pin_joint_create: - :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_method_ray_shape_create: - :ref:`RID` **ray_shape_create** **(** **)** +---- + .. _class_Physics2DServer_method_rectangle_shape_create: - :ref:`RID` **rectangle_shape_create** **(** **)** +---- + .. _class_Physics2DServer_method_segment_shape_create: - :ref:`RID` **segment_shape_create** **(** **)** +---- + .. _class_Physics2DServer_method_set_active: - void **set_active** **(** :ref:`bool` active **)** Activates or deactivates the 2D physics engine. +---- + .. _class_Physics2DServer_method_shape_get_data: - :ref:`Variant` **shape_get_data** **(** :ref:`RID` shape **)** const Returns the shape data. +---- + .. _class_Physics2DServer_method_shape_get_type: - :ref:`ShapeType` **shape_get_type** **(** :ref:`RID` shape **)** const Returns the type of shape (see :ref:`ShapeType`). +---- + .. _class_Physics2DServer_method_shape_set_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_method_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_method_space_get_direct_state: - :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_method_space_get_param: - :ref:`float` **space_get_param** **(** :ref:`RID` space, :ref:`SpaceParameter` param **)** const Returns the value of a space parameter. +---- + .. _class_Physics2DServer_method_space_is_active: - :ref:`bool` **space_is_active** **(** :ref:`RID` space **)** const Returns whether the space is active. +---- + .. _class_Physics2DServer_method_space_set_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_method_space_set_param: - void **space_set_param** **(** :ref:`RID` space, :ref:`SpaceParameter` param, :ref:`float` value **)** diff --git a/classes/class_physics2dshapequeryparameters.rst b/classes/class_physics2dshapequeryparameters.rst index 2cee0437d..5115abe7d 100644 --- a/classes/class_physics2dshapequeryparameters.rst +++ b/classes/class_physics2dshapequeryparameters.rst @@ -64,6 +64,8 @@ Property Descriptions | *Getter* | is_collide_with_areas_enabled() | +----------+---------------------------------+ +---- + .. _class_Physics2DShapeQueryParameters_property_collide_with_bodies: - :ref:`bool` **collide_with_bodies** @@ -74,6 +76,8 @@ Property Descriptions | *Getter* | is_collide_with_bodies_enabled() | +----------+----------------------------------+ +---- + .. _class_Physics2DShapeQueryParameters_property_collision_layer: - :ref:`int` **collision_layer** @@ -86,6 +90,8 @@ Property Descriptions The physics layer the query should be made on. +---- + .. _class_Physics2DShapeQueryParameters_property_exclude: - :ref:`Array` **exclude** @@ -98,6 +104,8 @@ The physics layer the query should be made on. The list of objects or object :ref:`RID`\ s, that will be excluded from collisions. +---- + .. _class_Physics2DShapeQueryParameters_property_margin: - :ref:`float` **margin** @@ -110,6 +118,8 @@ The list of objects or object :ref:`RID`\ s, that will be excluded fr The collision margin for the shape. +---- + .. _class_Physics2DShapeQueryParameters_property_motion: - :ref:`Vector2` **motion** @@ -122,6 +132,8 @@ The collision margin for the shape. The motion of the shape being queried for. +---- + .. _class_Physics2DShapeQueryParameters_property_shape_rid: - :ref:`RID` **shape_rid** @@ -134,6 +146,8 @@ The motion of the shape being queried for. The :ref:`RID` of the queried shape. See :ref:`set_shape` also. +---- + .. _class_Physics2DShapeQueryParameters_property_transform: - :ref:`Transform2D` **transform** diff --git a/classes/class_physics2dshapequeryresult.rst b/classes/class_physics2dshapequeryresult.rst index 64a7ca96a..105eae053 100644 --- a/classes/class_physics2dshapequeryresult.rst +++ b/classes/class_physics2dshapequeryresult.rst @@ -40,18 +40,26 @@ Method Descriptions - :ref:`int` **get_result_count** **(** **)** const +---- + .. _class_Physics2DShapeQueryResult_method_get_result_object: - :ref:`Object` **get_result_object** **(** :ref:`int` idx **)** const +---- + .. _class_Physics2DShapeQueryResult_method_get_result_object_id: - :ref:`int` **get_result_object_id** **(** :ref:`int` idx **)** const +---- + .. _class_Physics2DShapeQueryResult_method_get_result_object_shape: - :ref:`int` **get_result_object_shape** **(** :ref:`int` idx **)** const +---- + .. _class_Physics2DShapeQueryResult_method_get_result_rid: - :ref:`RID` **get_result_rid** **(** :ref:`int` idx **)** const diff --git a/classes/class_physics2dtestmotionresult.rst b/classes/class_physics2dtestmotionresult.rst index 420637cc6..20f0b089b 100644 --- a/classes/class_physics2dtestmotionresult.rst +++ b/classes/class_physics2dtestmotionresult.rst @@ -52,6 +52,8 @@ Property Descriptions | *Getter* | get_collider() | +----------+----------------+ +---- + .. _class_Physics2DTestMotionResult_property_collider_id: - :ref:`int` **collider_id** @@ -60,6 +62,8 @@ Property Descriptions | *Getter* | get_collider_id() | +----------+-------------------+ +---- + .. _class_Physics2DTestMotionResult_property_collider_rid: - :ref:`RID` **collider_rid** @@ -68,6 +72,8 @@ Property Descriptions | *Getter* | get_collider_rid() | +----------+--------------------+ +---- + .. _class_Physics2DTestMotionResult_property_collider_shape: - :ref:`int` **collider_shape** @@ -76,6 +82,8 @@ Property Descriptions | *Getter* | get_collider_shape() | +----------+----------------------+ +---- + .. _class_Physics2DTestMotionResult_property_collider_velocity: - :ref:`Vector2` **collider_velocity** @@ -84,6 +92,8 @@ Property Descriptions | *Getter* | get_collider_velocity() | +----------+-------------------------+ +---- + .. _class_Physics2DTestMotionResult_property_collision_normal: - :ref:`Vector2` **collision_normal** @@ -92,6 +102,8 @@ Property Descriptions | *Getter* | get_collision_normal() | +----------+------------------------+ +---- + .. _class_Physics2DTestMotionResult_property_collision_point: - :ref:`Vector2` **collision_point** @@ -100,6 +112,8 @@ Property Descriptions | *Getter* | get_collision_point() | +----------+-----------------------+ +---- + .. _class_Physics2DTestMotionResult_property_motion: - :ref:`Vector2` **motion** @@ -108,6 +122,8 @@ Property Descriptions | *Getter* | get_motion() | +----------+--------------+ +---- + .. _class_Physics2DTestMotionResult_property_motion_remainder: - :ref:`Vector2` **motion_remainder** diff --git a/classes/class_physicsbody.rst b/classes/class_physicsbody.rst index 1f3cd743c..f6c1d8efe 100644 --- a/classes/class_physicsbody.rst +++ b/classes/class_physicsbody.rst @@ -79,6 +79,8 @@ A contact is detected if object A is in any of the layers that object B scans, o Default value: 1 (the first layer/bit is enabled). +---- + .. _class_PhysicsBody_property_collision_mask: - :ref:`int` **collision_mask** @@ -102,36 +104,48 @@ Method Descriptions Adds a body to the list of bodies that this body can't collide with. +---- + .. _class_PhysicsBody_method_get_collision_exceptions: - :ref:`Array` **get_collision_exceptions** **(** **)** Returns an array of nodes that were added as collision exceptions for this body. +---- + .. _class_PhysicsBody_method_get_collision_layer_bit: - :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const Returns an individual bit on the :ref:`collision_layer`. +---- + .. _class_PhysicsBody_method_get_collision_mask_bit: - :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const Returns an individual bit on the :ref:`collision_mask`. +---- + .. _class_PhysicsBody_method_remove_collision_exception_with: - 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_method_set_collision_layer_bit: - void **set_collision_layer_bit** **(** :ref:`int` bit, :ref:`bool` value **)** Sets individual bits on the :ref:`collision_layer` bitmask. Use this if you only need to change one layer's value. +---- + .. _class_PhysicsBody_method_set_collision_mask_bit: - void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** diff --git a/classes/class_physicsbody2d.rst b/classes/class_physicsbody2d.rst index d88132f13..ef5a4a15b 100644 --- a/classes/class_physicsbody2d.rst +++ b/classes/class_physicsbody2d.rst @@ -81,6 +81,8 @@ A contact is detected if object A is in any of the layers that object B scans, o Default value: 1 (the first layer/bit is enabled). +---- + .. _class_PhysicsBody2D_property_collision_mask: - :ref:`int` **collision_mask** @@ -95,6 +97,8 @@ The physics layers this area scans for collisions. Default value: 1 (the first layer/bit is enabled). +---- + .. _class_PhysicsBody2D_property_layers: - :ref:`int` **layers** @@ -110,36 +114,48 @@ Method Descriptions Adds a body to the list of bodies that this body can't collide with. +---- + .. _class_PhysicsBody2D_method_get_collision_exceptions: - :ref:`Array` **get_collision_exceptions** **(** **)** Returns an array of nodes that were added as collision exceptions for this body. +---- + .. _class_PhysicsBody2D_method_get_collision_layer_bit: - :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const Returns an individual bit on the :ref:`collision_layer`. +---- + .. _class_PhysicsBody2D_method_get_collision_mask_bit: - :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const Returns an individual bit on the :ref:`collision_mask`. +---- + .. _class_PhysicsBody2D_method_remove_collision_exception_with: - 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_method_set_collision_layer_bit: - void **set_collision_layer_bit** **(** :ref:`int` bit, :ref:`bool` value **)** Sets individual bits on the :ref:`collision_layer` bitmask. Use this if you only need to change one layer's value. +---- + .. _class_PhysicsBody2D_method_set_collision_mask_bit: - void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** diff --git a/classes/class_physicsdirectbodystate.rst b/classes/class_physicsdirectbodystate.rst index a3ef91a57..4bd49eace 100644 --- a/classes/class_physicsdirectbodystate.rst +++ b/classes/class_physicsdirectbodystate.rst @@ -112,6 +112,8 @@ Property Descriptions The body's rotational velocity. +---- + .. _class_PhysicsDirectBodyState_property_center_of_mass: - :ref:`Vector3` **center_of_mass** @@ -120,6 +122,8 @@ The body's rotational velocity. | *Getter* | get_center_of_mass() | +----------+----------------------+ +---- + .. _class_PhysicsDirectBodyState_property_inverse_inertia: - :ref:`Vector3` **inverse_inertia** @@ -130,6 +134,8 @@ The body's rotational velocity. The inverse of the inertia of the body. +---- + .. _class_PhysicsDirectBodyState_property_inverse_mass: - :ref:`float` **inverse_mass** @@ -140,6 +146,8 @@ The inverse of the inertia of the body. The inverse of the mass of the body. +---- + .. _class_PhysicsDirectBodyState_property_linear_velocity: - :ref:`Vector3` **linear_velocity** @@ -152,6 +160,8 @@ The inverse of the mass of the body. The body's linear velocity. +---- + .. _class_PhysicsDirectBodyState_property_principal_inertia_axes: - :ref:`Basis` **principal_inertia_axes** @@ -160,6 +170,8 @@ The body's linear velocity. | *Getter* | get_principal_inertia_axes() | +----------+------------------------------+ +---- + .. _class_PhysicsDirectBodyState_property_sleeping: - :ref:`bool` **sleeping** @@ -172,6 +184,8 @@ The body's linear velocity. If ``true``, this body is currently sleeping (not active). +---- + .. _class_PhysicsDirectBodyState_property_step: - :ref:`float` **step** @@ -182,6 +196,8 @@ If ``true``, this body is currently sleeping (not active). The timestep (delta) used for the simulation. +---- + .. _class_PhysicsDirectBodyState_property_total_angular_damp: - :ref:`float` **total_angular_damp** @@ -192,6 +208,8 @@ The timestep (delta) used for the simulation. The rate at which the body stops rotating, if there are not any other forces moving it. +---- + .. _class_PhysicsDirectBodyState_property_total_gravity: - :ref:`Vector3` **total_gravity** @@ -202,6 +220,8 @@ The rate at which the body stops rotating, if there are not any other forces mov The total gravity vector being currently applied to this body. +---- + .. _class_PhysicsDirectBodyState_property_total_linear_damp: - :ref:`float` **total_linear_damp** @@ -212,6 +232,8 @@ The total gravity vector being currently applied to this body. The rate at which the body stops moving, if there are not any other forces moving it. +---- + .. _class_PhysicsDirectBodyState_property_transform: - :ref:`Transform` **transform** @@ -235,18 +257,24 @@ Adds a constant directional force without affecting rotation. This is equivalent to ``add_force(force, Vector3(0,0,0))``. +---- + .. _class_PhysicsDirectBodyState_method_add_force: - void **add_force** **(** :ref:`Vector3` force, :ref:`Vector3` position **)** Adds a positioned force to the body. Both the force and the offset from the body origin are in global coordinates. +---- + .. _class_PhysicsDirectBodyState_method_add_torque: - void **add_torque** **(** :ref:`Vector3` torque **)** Adds a constant rotational force without affecting position. +---- + .. _class_PhysicsDirectBodyState_method_apply_central_impulse: - void **apply_central_impulse** **(** :ref:`Vector3` j **)** @@ -255,90 +283,120 @@ Applies a single directional impulse without affecting rotation. This is equivalent to ``apply_impulse(Vector3(0, 0, 0), impulse)``. +---- + .. _class_PhysicsDirectBodyState_method_apply_impulse: - void **apply_impulse** **(** :ref:`Vector3` position, :ref:`Vector3` j **)** Applies a positioned impulse to the body. An impulse is time independent! Applying an impulse every frame would result in a framerate dependent force. For this reason it should only be used when simulating one-time impacts. The position uses the rotation of the global coordinate system, but is centered at the object's origin. +---- + .. _class_PhysicsDirectBodyState_method_apply_torque_impulse: - void **apply_torque_impulse** **(** :ref:`Vector3` j **)** Apply a torque impulse (which will be affected by the body mass and shape). This will rotate the body around the passed in vector. +---- + .. _class_PhysicsDirectBodyState_method_get_contact_collider: - :ref:`RID` **get_contact_collider** **(** :ref:`int` contact_idx **)** const Returns the collider's :ref:`RID`. +---- + .. _class_PhysicsDirectBodyState_method_get_contact_collider_id: - :ref:`int` **get_contact_collider_id** **(** :ref:`int` contact_idx **)** const Returns the collider's object id. +---- + .. _class_PhysicsDirectBodyState_method_get_contact_collider_object: - :ref:`Object` **get_contact_collider_object** **(** :ref:`int` contact_idx **)** const Returns the collider object. +---- + .. _class_PhysicsDirectBodyState_method_get_contact_collider_position: - :ref:`Vector3` **get_contact_collider_position** **(** :ref:`int` contact_idx **)** const Returns the contact position in the collider. +---- + .. _class_PhysicsDirectBodyState_method_get_contact_collider_shape: - :ref:`int` **get_contact_collider_shape** **(** :ref:`int` contact_idx **)** const Returns the collider's shape index. +---- + .. _class_PhysicsDirectBodyState_method_get_contact_collider_velocity_at_position: - :ref:`Vector3` **get_contact_collider_velocity_at_position** **(** :ref:`int` contact_idx **)** const Returns the linear velocity vector at the collider's contact point. +---- + .. _class_PhysicsDirectBodyState_method_get_contact_count: - :ref:`int` **get_contact_count** **(** **)** const Returns the number of contacts this body has with other bodies. Note that by default this returns 0 unless bodies are configured to log contacts. See :ref:`RigidBody.contact_monitor`. +---- + .. _class_PhysicsDirectBodyState_method_get_contact_impulse: - :ref:`float` **get_contact_impulse** **(** :ref:`int` contact_idx **)** const Impulse created by the contact. Only implemented for Bullet physics. +---- + .. _class_PhysicsDirectBodyState_method_get_contact_local_normal: - :ref:`Vector3` **get_contact_local_normal** **(** :ref:`int` contact_idx **)** const Returns the local normal at the contact point. +---- + .. _class_PhysicsDirectBodyState_method_get_contact_local_position: - :ref:`Vector3` **get_contact_local_position** **(** :ref:`int` contact_idx **)** const Returns the local position of the contact point. +---- + .. _class_PhysicsDirectBodyState_method_get_contact_local_shape: - :ref:`int` **get_contact_local_shape** **(** :ref:`int` contact_idx **)** const Returns the local shape index of the collision. +---- + .. _class_PhysicsDirectBodyState_method_get_space_state: - :ref:`PhysicsDirectSpaceState` **get_space_state** **(** **)** Returns the current state of the space, useful for queries. +---- + .. _class_PhysicsDirectBodyState_method_integrate_forces: - void **integrate_forces** **(** **)** diff --git a/classes/class_physicsdirectspacestate.rst b/classes/class_physicsdirectspacestate.rst index 413b1a5f1..7b6d1e351 100644 --- a/classes/class_physicsdirectspacestate.rst +++ b/classes/class_physicsdirectspacestate.rst @@ -54,12 +54,16 @@ Checks whether the shape can travel to a point. The method will return an array If the shape can not move, the returned array will be ``[0, 0]`` under Bullet, and empty under GodotPhysics. +---- + .. _class_PhysicsDirectSpaceState_method_collide_shape: - :ref:`Array` **collide_shape** **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`int` max_results=32 **)** Checks the intersections of a shape, given through a :ref:`PhysicsShapeQueryParameters` 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_PhysicsDirectSpaceState_method_get_rest_info: - :ref:`Dictionary` **get_rest_info** **(** :ref:`PhysicsShapeQueryParameters` shape **)** @@ -80,6 +84,8 @@ Checks the intersections of a shape, given through a :ref:`PhysicsShapeQueryPara If the shape did not intersect anything, then an empty dictionary is returned instead. +---- + .. _class_PhysicsDirectSpaceState_method_intersect_ray: - :ref:`Dictionary` **intersect_ray** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` exclude=[ ], :ref:`int` collision_mask=2147483647, :ref:`bool` collide_with_bodies=true, :ref:`bool` collide_with_areas=false **)** @@ -102,6 +108,8 @@ If the ray did not intersect anything, then an empty dictionary is returned inst Additionally, the method can take an ``exclude`` array of objects or :ref:`RID`\ s that are to be excluded from collisions, a ``collision_mask`` bitmask representing the physics layers to check in, or booleans to determine if the ray should collide with :ref:`PhysicsBody`\ s or :ref:`Area`\ s, respectively. +---- + .. _class_PhysicsDirectSpaceState_method_intersect_shape: - :ref:`Array` **intersect_shape** **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`int` max_results=32 **)** diff --git a/classes/class_physicsmaterial.rst b/classes/class_physicsmaterial.rst index 0bdf3890b..ce0278d68 100644 --- a/classes/class_physicsmaterial.rst +++ b/classes/class_physicsmaterial.rst @@ -49,6 +49,8 @@ Property Descriptions | *Getter* | is_absorbent() | +----------+----------------------+ +---- + .. _class_PhysicsMaterial_property_bounce: - :ref:`float` **bounce** @@ -61,6 +63,8 @@ Property Descriptions The body's bounciness. Default value: ``0``. +---- + .. _class_PhysicsMaterial_property_friction: - :ref:`float` **friction** @@ -73,6 +77,8 @@ The body's bounciness. Default value: ``0``. The body's friction. Values range from ``0`` (frictionless) to ``1`` (maximum friction). Default value: ``1``. +---- + .. _class_PhysicsMaterial_property_rough: - :ref:`bool` **rough** diff --git a/classes/class_physicsserver.rst b/classes/class_physicsserver.rst index 92a25efb3..69eddbfff 100644 --- a/classes/class_physicsserver.rst +++ b/classes/class_physicsserver.rst @@ -274,6 +274,8 @@ enum **JointType**: - **JOINT_6DOF** = **4** --- The :ref:`Joint` is a :ref:`Generic6DOFJoint`. +---- + .. _enum_PhysicsServer_PinJointParam: .. _class_PhysicsServer_constant_PIN_JOINT_BIAS: @@ -294,6 +296,8 @@ The higher, the stronger. - **PIN_JOINT_IMPULSE_CLAMP** = **2** --- If above 0, this value is the maximum value for an impulse that this Joint puts on its ends. +---- + .. _enum_PhysicsServer_HingeJointParam: .. _class_PhysicsServer_constant_HINGE_JOINT_BIAS: @@ -330,6 +334,8 @@ enum **HingeJointParam**: - **HINGE_JOINT_MOTOR_MAX_IMPULSE** = **7** --- Maximum acceleration for the motor. +---- + .. _enum_PhysicsServer_HingeJointFlag: .. _class_PhysicsServer_constant_HINGE_JOINT_FLAG_USE_LIMIT: @@ -342,6 +348,8 @@ enum **HingeJointFlag**: - **HINGE_JOINT_FLAG_ENABLE_MOTOR** = **1** --- If ``true``, a motor turns the Hinge +---- + .. _enum_PhysicsServer_SliderJointParam: .. _class_PhysicsServer_constant_SLIDER_JOINT_LINEAR_LIMIT_UPPER: @@ -438,6 +446,8 @@ enum **SliderJointParam**: - **SLIDER_JOINT_MAX** = **22** --- Represents the size of the :ref:`SliderJointParam` enum. +---- + .. _enum_PhysicsServer_ConeTwistJointParam: .. _class_PhysicsServer_constant_CONE_TWIST_JOINT_SWING_SPAN: @@ -472,6 +482,8 @@ The higher, the faster. - **CONE_TWIST_JOINT_RELAXATION** = **4** --- Defines, how fast the swing- and twist-speed-difference on both sides gets synced. +---- + .. _enum_PhysicsServer_G6DOFJointAxisParam: .. _class_PhysicsServer_constant_G6DOF_JOINT_LINEAR_LOWER_LIMIT: @@ -540,6 +552,8 @@ enum **G6DOFJointAxisParam**: - **G6DOF_JOINT_ANGULAR_MOTOR_FORCE_LIMIT** = **18** --- Maximum acceleration for the motor at the axes. +---- + .. _enum_PhysicsServer_G6DOFJointAxisFlag: .. _class_PhysicsServer_constant_G6DOF_JOINT_FLAG_ENABLE_LINEAR_LIMIT: @@ -560,6 +574,8 @@ enum **G6DOFJointAxisFlag**: - **G6DOF_JOINT_FLAG_ENABLE_LINEAR_MOTOR** = **5** --- If ``set`` there is a linear motor on this axis that targets a specific velocity. +---- + .. _enum_PhysicsServer_ShapeType: .. _class_PhysicsServer_constant_SHAPE_PLANE: @@ -604,6 +620,8 @@ enum **ShapeType**: - **SHAPE_CUSTOM** = **9** --- This constant is used internally by the engine. Any attempt to create this kind of shape results in an error. +---- + .. _enum_PhysicsServer_AreaParameter: .. _class_PhysicsServer_constant_AREA_PARAM_GRAVITY: @@ -640,6 +658,8 @@ enum **AreaParameter**: - **AREA_PARAM_PRIORITY** = **7** --- Constant to set/get the priority (order of processing) of an area. +---- + .. _enum_PhysicsServer_AreaSpaceOverrideMode: .. _class_PhysicsServer_constant_AREA_SPACE_OVERRIDE_DISABLED: @@ -664,6 +684,8 @@ enum **AreaSpaceOverrideMode**: - **AREA_SPACE_OVERRIDE_REPLACE_COMBINE** = **4** --- This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one. +---- + .. _enum_PhysicsServer_BodyMode: .. _class_PhysicsServer_constant_BODY_MODE_STATIC: @@ -684,6 +706,8 @@ enum **BodyMode**: - **BODY_MODE_CHARACTER** = **3** --- Constant for rigid bodies in character mode. In this mode, a body can not rotate, and only its linear velocity is affected by physics. +---- + .. _enum_PhysicsServer_BodyParameter: .. _class_PhysicsServer_constant_BODY_PARAM_BOUNCE: @@ -716,6 +740,8 @@ enum **BodyParameter**: - **BODY_PARAM_MAX** = **6** --- Represents the size of the :ref:`BodyParameter` enum. +---- + .. _enum_PhysicsServer_BodyState: .. _class_PhysicsServer_constant_BODY_STATE_TRANSFORM: @@ -740,6 +766,8 @@ enum **BodyState**: - **BODY_STATE_CAN_SLEEP** = **4** --- Constant to set/get whether the body can sleep. +---- + .. _enum_PhysicsServer_AreaBodyStatus: .. _class_PhysicsServer_constant_AREA_BODY_ADDED: @@ -752,6 +780,8 @@ enum **AreaBodyStatus**: - **AREA_BODY_REMOVED** = **1** --- The value of the first parameter and area callback function receives, when an object exits one of its shapes. +---- + .. _enum_PhysicsServer_ProcessInfo: .. _class_PhysicsServer_constant_INFO_ACTIVE_OBJECTS: @@ -768,6 +798,8 @@ enum **ProcessInfo**: - **INFO_ISLAND_COUNT** = **2** --- Constant to get the number of space regions where a collision could occur. +---- + .. _enum_PhysicsServer_SpaceParameter: .. _class_PhysicsServer_constant_SPACE_PARAM_CONTACT_RECYCLE_RADIUS: @@ -808,6 +840,8 @@ enum **SpaceParameter**: - **SPACE_PARAM_TEST_MOTION_MIN_CONTACT_DEPTH** = **8** +---- + .. _enum_PhysicsServer_BodyAxis: .. _class_PhysicsServer_constant_BODY_AXIS_LINEAR_X: @@ -850,100 +884,134 @@ Method Descriptions 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_method_area_attach_object_instance_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_method_area_clear_shapes: - 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_method_area_create: - :ref:`RID` **area_create** **(** **)** Creates an :ref:`Area`. +---- + .. _class_PhysicsServer_method_area_get_object_instance_id: - :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_method_area_get_param: - :ref:`Variant` **area_get_param** **(** :ref:`RID` area, :ref:`AreaParameter` param **)** const Returns an area parameter value. A list of available parameters is on the AREA_PARAM\_\* constants. +---- + .. _class_PhysicsServer_method_area_get_shape: - :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_method_area_get_shape_count: - :ref:`int` **area_get_shape_count** **(** :ref:`RID` area **)** const Returns the number of shapes assigned to an area. +---- + .. _class_PhysicsServer_method_area_get_shape_transform: - :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_method_area_get_space: - :ref:`RID` **area_get_space** **(** :ref:`RID` area **)** const Returns the space assigned to the area. +---- + .. _class_PhysicsServer_method_area_get_space_override_mode: - :ref:`AreaSpaceOverrideMode` **area_get_space_override_mode** **(** :ref:`RID` area **)** const Returns the space override mode for the area. +---- + .. _class_PhysicsServer_method_area_get_transform: - :ref:`Transform` **area_get_transform** **(** :ref:`RID` area **)** const Returns the transform matrix for an area. +---- + .. _class_PhysicsServer_method_area_is_ray_pickable: - :ref:`bool` **area_is_ray_pickable** **(** :ref:`RID` area **)** const If ``true``, area collides with rays. +---- + .. _class_PhysicsServer_method_area_remove_shape: - 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_method_area_set_area_monitor_callback: - void **area_set_area_monitor_callback** **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** +---- + .. _class_PhysicsServer_method_area_set_collision_layer: - void **area_set_collision_layer** **(** :ref:`RID` area, :ref:`int` layer **)** Assigns the area to one or many physics layers. +---- + .. _class_PhysicsServer_method_area_set_collision_mask: - void **area_set_collision_mask** **(** :ref:`RID` area, :ref:`int` mask **)** Sets which physics layers the area will monitor. +---- + .. _class_PhysicsServer_method_area_set_monitor_callback: - void **area_set_monitor_callback** **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** @@ -960,116 +1028,158 @@ Sets the function to call when any body/area enters or exits the area. This call 5: The shape index of the area where the object entered/exited. +---- + .. _class_PhysicsServer_method_area_set_monitorable: - void **area_set_monitorable** **(** :ref:`RID` area, :ref:`bool` monitorable **)** +---- + .. _class_PhysicsServer_method_area_set_param: - void **area_set_param** **(** :ref:`RID` area, :ref:`AreaParameter` param, :ref:`Variant` value **)** Sets the value for an area parameter. A list of available parameters is on the AREA_PARAM\_\* constants. +---- + .. _class_PhysicsServer_method_area_set_ray_pickable: - void **area_set_ray_pickable** **(** :ref:`RID` area, :ref:`bool` enable **)** Sets object pickable with rays. +---- + .. _class_PhysicsServer_method_area_set_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_method_area_set_shape_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_method_area_set_space: - void **area_set_space** **(** :ref:`RID` area, :ref:`RID` space **)** Assigns a space to the area. +---- + .. _class_PhysicsServer_method_area_set_space_override_mode: - void **area_set_space_override_mode** **(** :ref:`RID` area, :ref:`AreaSpaceOverrideMode` mode **)** Sets the space override mode for the area. The modes are described in the constants AREA_SPACE_OVERRIDE\_\*. +---- + .. _class_PhysicsServer_method_area_set_transform: - void **area_set_transform** **(** :ref:`RID` area, :ref:`Transform` transform **)** Sets the transform matrix for an area. +---- + .. _class_PhysicsServer_method_body_add_central_force: - void **body_add_central_force** **(** :ref:`RID` body, :ref:`Vector3` force **)** +---- + .. _class_PhysicsServer_method_body_add_collision_exception: - 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_method_body_add_force: - void **body_add_force** **(** :ref:`RID` body, :ref:`Vector3` force, :ref:`Vector3` position **)** +---- + .. _class_PhysicsServer_method_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 ) **)** 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_method_body_add_torque: - void **body_add_torque** **(** :ref:`RID` body, :ref:`Vector3` torque **)** +---- + .. _class_PhysicsServer_method_body_apply_central_impulse: - void **body_apply_central_impulse** **(** :ref:`RID` body, :ref:`Vector3` impulse **)** +---- + .. _class_PhysicsServer_method_body_apply_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_method_body_apply_torque_impulse: - void **body_apply_torque_impulse** **(** :ref:`RID` body, :ref:`Vector3` impulse **)** Gives the body a push to rotate it. +---- + .. _class_PhysicsServer_method_body_attach_object_instance_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_method_body_clear_shapes: - void **body_clear_shapes** **(** :ref:`RID` body **)** Removes all shapes from a body. +---- + .. _class_PhysicsServer_method_body_create: - :ref:`RID` **body_create** **(** :ref:`BodyMode` 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_method_body_get_collision_layer: - :ref:`int` **body_get_collision_layer** **(** :ref:`RID` body **)** const Returns the physics layer or layers a body belongs to. +---- + .. _class_PhysicsServer_method_body_get_collision_mask: - :ref:`int` **body_get_collision_mask** **(** :ref:`RID` body **)** const @@ -1078,92 +1188,124 @@ Returns the physics layer or layers a body can collide with. - +---- + .. _class_PhysicsServer_method_body_get_direct_state: - :ref:`PhysicsDirectBodyState` **body_get_direct_state** **(** :ref:`RID` body **)** Returns the :ref:`PhysicsDirectBodyState` of the body. +---- + .. _class_PhysicsServer_method_body_get_kinematic_safe_margin: - :ref:`float` **body_get_kinematic_safe_margin** **(** :ref:`RID` body **)** const +---- + .. _class_PhysicsServer_method_body_get_max_contacts_reported: - :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_method_body_get_mode: - :ref:`BodyMode` **body_get_mode** **(** :ref:`RID` body **)** const Returns the body mode. +---- + .. _class_PhysicsServer_method_body_get_object_instance_id: - :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_method_body_get_param: - :ref:`float` **body_get_param** **(** :ref:`RID` body, :ref:`BodyParameter` param **)** const Returns the value of a body parameter. A list of available parameters is on the BODY_PARAM\_\* constants. +---- + .. _class_PhysicsServer_method_body_get_shape: - :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_method_body_get_shape_count: - :ref:`int` **body_get_shape_count** **(** :ref:`RID` body **)** const Returns the number of shapes assigned to a body. +---- + .. _class_PhysicsServer_method_body_get_shape_transform: - :ref:`Transform` **body_get_shape_transform** **(** :ref:`RID` body, :ref:`int` shape_idx **)** const Returns the transform matrix of a body shape. +---- + .. _class_PhysicsServer_method_body_get_space: - :ref:`RID` **body_get_space** **(** :ref:`RID` body **)** const Returns the :ref:`RID` of the space assigned to a body. +---- + .. _class_PhysicsServer_method_body_get_state: - :ref:`Variant` **body_get_state** **(** :ref:`RID` body, :ref:`BodyState` state **)** const Returns a body state. +---- + .. _class_PhysicsServer_method_body_is_axis_locked: - :ref:`bool` **body_is_axis_locked** **(** :ref:`RID` body, :ref:`BodyAxis` axis **)** const +---- + .. _class_PhysicsServer_method_body_is_continuous_collision_detection_enabled: - :ref:`bool` **body_is_continuous_collision_detection_enabled** **(** :ref:`RID` body **)** const If ``true``, the continuous collision detection mode is enabled. +---- + .. _class_PhysicsServer_method_body_is_omitting_force_integration: - :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_method_body_is_ray_pickable: - :ref:`bool` **body_is_ray_pickable** **(** :ref:`RID` body **)** const If ``true``, the body can be detected by rays +---- + .. _class_PhysicsServer_method_body_remove_collision_exception: - void **body_remove_collision_exception** **(** :ref:`RID` body, :ref:`RID` excepted_body **)** @@ -1172,34 +1314,46 @@ Removes a body from the list of bodies exempt from collisions. Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. +---- + .. _class_PhysicsServer_method_body_remove_shape: - 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_method_body_set_axis_lock: - void **body_set_axis_lock** **(** :ref:`RID` body, :ref:`BodyAxis` axis, :ref:`bool` lock **)** +---- + .. _class_PhysicsServer_method_body_set_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_method_body_set_collision_layer: - void **body_set_collision_layer** **(** :ref:`RID` body, :ref:`int` layer **)** Sets the physics layer or layers a body belongs to. +---- + .. _class_PhysicsServer_method_body_set_collision_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_method_body_set_enable_continuous_collision_detection: - void **body_set_enable_continuous_collision_detection** **(** :ref:`RID` body, :ref:`bool` enable **)** @@ -1208,298 +1362,398 @@ If ``true``, the continuous collision detection mode is enabled. Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. +---- + .. _class_PhysicsServer_method_body_set_force_integration_callback: - 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_method_body_set_kinematic_safe_margin: - void **body_set_kinematic_safe_margin** **(** :ref:`RID` body, :ref:`float` margin **)** +---- + .. _class_PhysicsServer_method_body_set_max_contacts_reported: - 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_method_body_set_mode: - void **body_set_mode** **(** :ref:`RID` body, :ref:`BodyMode` mode **)** Sets the body mode, from one of the constants BODY_MODE\*. +---- + .. _class_PhysicsServer_method_body_set_omit_force_integration: - 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_method_body_set_param: - void **body_set_param** **(** :ref:`RID` body, :ref:`BodyParameter` param, :ref:`float` value **)** Sets a body parameter. A list of available parameters is on the BODY_PARAM\_\* constants. +---- + .. _class_PhysicsServer_method_body_set_ray_pickable: - void **body_set_ray_pickable** **(** :ref:`RID` body, :ref:`bool` enable **)** Sets the body pickable with rays if ``enabled`` is set. +---- + .. _class_PhysicsServer_method_body_set_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_method_body_set_shape_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_method_body_set_space: - void **body_set_space** **(** :ref:`RID` body, :ref:`RID` space **)** Assigns a space to the body (see :ref:`space_create`). +---- + .. _class_PhysicsServer_method_body_set_state: - void **body_set_state** **(** :ref:`RID` body, :ref:`BodyState` state, :ref:`Variant` value **)** Sets a body state (see BODY_STATE\* constants). +---- + .. _class_PhysicsServer_method_cone_twist_joint_get_param: - :ref:`float` **cone_twist_joint_get_param** **(** :ref:`RID` joint, :ref:`ConeTwistJointParam` param **)** const Gets a cone_twist_joint parameter (see CONE_TWIST_JOINT\* constants). +---- + .. _class_PhysicsServer_method_cone_twist_joint_set_param: - void **cone_twist_joint_set_param** **(** :ref:`RID` joint, :ref:`ConeTwistJointParam` param, :ref:`float` value **)** Sets a cone_twist_joint parameter (see CONE_TWIST_JOINT\* constants). +---- + .. _class_PhysicsServer_method_free_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_method_generic_6dof_joint_get_flag: - :ref:`bool` **generic_6dof_joint_get_flag** **(** :ref:`RID` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisFlag` flag **)** Gets a generic_6_DOF_joint flag (see G6DOF_JOINT_FLAG\* constants). +---- + .. _class_PhysicsServer_method_generic_6dof_joint_get_param: - :ref:`float` **generic_6dof_joint_get_param** **(** :ref:`RID` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisParam` param **)** Gets a generic_6_DOF_joint parameter (see G6DOF_JOINT\* constants without the G6DOF_JOINT_FLAG\*). +---- + .. _class_PhysicsServer_method_generic_6dof_joint_set_flag: - void **generic_6dof_joint_set_flag** **(** :ref:`RID` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisFlag` flag, :ref:`bool` enable **)** Sets a generic_6_DOF_joint flag (see G6DOF_JOINT_FLAG\* constants). +---- + .. _class_PhysicsServer_method_generic_6dof_joint_set_param: - void **generic_6dof_joint_set_param** **(** :ref:`RID` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisParam` param, :ref:`float` value **)** Sets a generic_6_DOF_joint parameter (see G6DOF_JOINT\* constants without the G6DOF_JOINT_FLAG\*). +---- + .. _class_PhysicsServer_method_get_process_info: - :ref:`int` **get_process_info** **(** :ref:`ProcessInfo` process_info **)** Returns an Info defined by the :ref:`ProcessInfo` input given. +---- + .. _class_PhysicsServer_method_hinge_joint_get_flag: - :ref:`bool` **hinge_joint_get_flag** **(** :ref:`RID` joint, :ref:`HingeJointFlag` flag **)** const Gets a hinge_joint flag (see HINGE_JOINT_FLAG\* constants). +---- + .. _class_PhysicsServer_method_hinge_joint_get_param: - :ref:`float` **hinge_joint_get_param** **(** :ref:`RID` joint, :ref:`HingeJointParam` param **)** const Gets a hinge_joint parameter (see HINGE_JOINT\* constants without the HINGE_JOINT_FLAG\*). +---- + .. _class_PhysicsServer_method_hinge_joint_set_flag: - void **hinge_joint_set_flag** **(** :ref:`RID` joint, :ref:`HingeJointFlag` flag, :ref:`bool` enabled **)** Sets a hinge_joint flag (see HINGE_JOINT_FLAG\* constants). +---- + .. _class_PhysicsServer_method_hinge_joint_set_param: - void **hinge_joint_set_param** **(** :ref:`RID` joint, :ref:`HingeJointParam` param, :ref:`float` value **)** Sets a hinge_joint parameter (see HINGE_JOINT\* constants without the HINGE_JOINT_FLAG\*). +---- + .. _class_PhysicsServer_method_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 **)** Creates a :ref:`ConeTwistJoint`. +---- + .. _class_PhysicsServer_method_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 **)** Creates a :ref:`Generic6DOFJoint`. +---- + .. _class_PhysicsServer_method_joint_create_hinge: - :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_method_joint_create_pin: - :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_method_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 **)** Creates a :ref:`SliderJoint`. +---- + .. _class_PhysicsServer_method_joint_get_solver_priority: - :ref:`int` **joint_get_solver_priority** **(** :ref:`RID` joint **)** const Gets the priority value of the Joint. +---- + .. _class_PhysicsServer_method_joint_get_type: - :ref:`JointType` **joint_get_type** **(** :ref:`RID` joint **)** const Returns the type of the Joint. +---- + .. _class_PhysicsServer_method_joint_set_solver_priority: - void **joint_set_solver_priority** **(** :ref:`RID` joint, :ref:`int` priority **)** Sets the priority value of the Joint. +---- + .. _class_PhysicsServer_method_pin_joint_get_local_a: - :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_method_pin_joint_get_local_b: - :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_method_pin_joint_get_param: - :ref:`float` **pin_joint_get_param** **(** :ref:`RID` joint, :ref:`PinJointParam` param **)** const Gets a pin_joint parameter (see PIN_JOINT\* constants). +---- + .. _class_PhysicsServer_method_pin_joint_set_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_method_pin_joint_set_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_method_pin_joint_set_param: - void **pin_joint_set_param** **(** :ref:`RID` joint, :ref:`PinJointParam` param, :ref:`float` value **)** Sets a pin_joint parameter (see PIN_JOINT\* constants). +---- + .. _class_PhysicsServer_method_set_active: - void **set_active** **(** :ref:`bool` active **)** Activates or deactivates the 3D physics engine. +---- + .. _class_PhysicsServer_method_shape_create: - :ref:`RID` **shape_create** **(** :ref:`ShapeType` 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_method_shape_get_data: - :ref:`Variant` **shape_get_data** **(** :ref:`RID` shape **)** const Returns the shape data. +---- + .. _class_PhysicsServer_method_shape_get_type: - :ref:`ShapeType` **shape_get_type** **(** :ref:`RID` shape **)** const Returns the type of shape (see SHAPE\_\* constants). +---- + .. _class_PhysicsServer_method_shape_set_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_method_slider_joint_get_param: - :ref:`float` **slider_joint_get_param** **(** :ref:`RID` joint, :ref:`SliderJointParam` param **)** const Gets a slider_joint parameter (see SLIDER_JOINT\* constants). +---- + .. _class_PhysicsServer_method_slider_joint_set_param: - void **slider_joint_set_param** **(** :ref:`RID` joint, :ref:`SliderJointParam` param, :ref:`float` value **)** Gets a slider_joint parameter (see SLIDER_JOINT\* constants). +---- + .. _class_PhysicsServer_method_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_method_space_get_direct_state: - :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_method_space_get_param: - :ref:`float` **space_get_param** **(** :ref:`RID` space, :ref:`SpaceParameter` param **)** const Returns the value of a space parameter. +---- + .. _class_PhysicsServer_method_space_is_active: - :ref:`bool` **space_is_active** **(** :ref:`RID` space **)** const Returns whether the space is active. +---- + .. _class_PhysicsServer_method_space_set_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_method_space_set_param: - void **space_set_param** **(** :ref:`RID` space, :ref:`SpaceParameter` param, :ref:`float` value **)** diff --git a/classes/class_physicsshapequeryparameters.rst b/classes/class_physicsshapequeryparameters.rst index 72ada9f49..4d37258d5 100644 --- a/classes/class_physicsshapequeryparameters.rst +++ b/classes/class_physicsshapequeryparameters.rst @@ -57,6 +57,8 @@ Property Descriptions | *Getter* | is_collide_with_areas_enabled() | +----------+---------------------------------+ +---- + .. _class_PhysicsShapeQueryParameters_property_collide_with_bodies: - :ref:`bool` **collide_with_bodies** @@ -67,6 +69,8 @@ Property Descriptions | *Getter* | is_collide_with_bodies_enabled() | +----------+----------------------------------+ +---- + .. _class_PhysicsShapeQueryParameters_property_collision_mask: - :ref:`int` **collision_mask** @@ -77,6 +81,8 @@ Property Descriptions | *Getter* | get_collision_mask() | +----------+---------------------------+ +---- + .. _class_PhysicsShapeQueryParameters_property_exclude: - :ref:`Array` **exclude** @@ -87,6 +93,8 @@ Property Descriptions | *Getter* | get_exclude() | +----------+--------------------+ +---- + .. _class_PhysicsShapeQueryParameters_property_margin: - :ref:`float` **margin** @@ -97,6 +105,8 @@ Property Descriptions | *Getter* | get_margin() | +----------+-------------------+ +---- + .. _class_PhysicsShapeQueryParameters_property_shape_rid: - :ref:`RID` **shape_rid** @@ -107,6 +117,8 @@ Property Descriptions | *Getter* | get_shape_rid() | +----------+----------------------+ +---- + .. _class_PhysicsShapeQueryParameters_property_transform: - :ref:`Transform` **transform** diff --git a/classes/class_physicsshapequeryresult.rst b/classes/class_physicsshapequeryresult.rst index 1e22370b4..13c3522f6 100644 --- a/classes/class_physicsshapequeryresult.rst +++ b/classes/class_physicsshapequeryresult.rst @@ -40,18 +40,26 @@ Method Descriptions - :ref:`int` **get_result_count** **(** **)** const +---- + .. _class_PhysicsShapeQueryResult_method_get_result_object: - :ref:`Object` **get_result_object** **(** :ref:`int` idx **)** const +---- + .. _class_PhysicsShapeQueryResult_method_get_result_object_id: - :ref:`int` **get_result_object_id** **(** :ref:`int` idx **)** const +---- + .. _class_PhysicsShapeQueryResult_method_get_result_object_shape: - :ref:`int` **get_result_object_shape** **(** :ref:`int` idx **)** const +---- + .. _class_PhysicsShapeQueryResult_method_get_result_rid: - :ref:`RID` **get_result_rid** **(** :ref:`int` idx **)** const diff --git a/classes/class_pinjoint.rst b/classes/class_pinjoint.rst index 4e0949116..736232643 100644 --- a/classes/class_pinjoint.rst +++ b/classes/class_pinjoint.rst @@ -74,6 +74,8 @@ The force with which the pinned objects stay in positional relation to each othe The higher, the stronger. +---- + .. _class_PinJoint_property_params/damping: - :ref:`float` **params/damping** @@ -88,6 +90,8 @@ The force with which the pinned objects stay in velocity relation to each other. The higher, the stronger. +---- + .. _class_PinJoint_property_params/impulse_clamp: - :ref:`float` **params/impulse_clamp** diff --git a/classes/class_plane.rst b/classes/class_plane.rst index a7b9df067..e3a33c2f9 100644 --- a/classes/class_plane.rst +++ b/classes/class_plane.rst @@ -94,18 +94,26 @@ Property Descriptions - :ref:`float` **d** +---- + .. _class_Plane_property_normal: - :ref:`Vector3` **normal** +---- + .. _class_Plane_property_x: - :ref:`float` **x** +---- + .. _class_Plane_property_y: - :ref:`float` **y** +---- + .. _class_Plane_property_z: - :ref:`float` **z** @@ -119,68 +127,92 @@ Method Descriptions Creates a plane from the four parameters "a", "b", "c" and "d". +---- + - :ref:`Plane` **Plane** **(** :ref:`Vector3` v1, :ref:`Vector3` v2, :ref:`Vector3` v3 **)** Creates a plane from three points. +---- + - :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_method_center: - :ref:`Vector3` **center** **(** **)** Returns the center of the plane. +---- + .. _class_Plane_method_distance_to: - :ref:`float` **distance_to** **(** :ref:`Vector3` point **)** Returns the shortest distance from the plane to the position "point". +---- + .. _class_Plane_method_get_any_point: - :ref:`Vector3` **get_any_point** **(** **)** Returns a point on the plane. +---- + .. _class_Plane_method_has_point: - :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_method_intersect_3: - :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_method_intersects_ray: - :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_method_intersects_segment: - :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_method_is_point_over: - :ref:`bool` **is_point_over** **(** :ref:`Vector3` point **)** Returns ``true`` if "point" is located above the plane. +---- + .. _class_Plane_method_normalized: - :ref:`Plane` **normalized** **(** **)** Returns a copy of the plane, normalized. +---- + .. _class_Plane_method_project: - :ref:`Vector3` **project** **(** :ref:`Vector3` point **)** diff --git a/classes/class_planemesh.rst b/classes/class_planemesh.rst index 368644c97..bf59fa19a 100644 --- a/classes/class_planemesh.rst +++ b/classes/class_planemesh.rst @@ -49,6 +49,8 @@ Property Descriptions Size of the generated plane. Defaults to (2.0, 2.0). +---- + .. _class_PlaneMesh_property_subdivide_depth: - :ref:`int` **subdivide_depth** @@ -61,6 +63,8 @@ Size of the generated plane. Defaults to (2.0, 2.0). Number of subdivision along the Z axis. Defaults to 0. +---- + .. _class_PlaneMesh_property_subdivide_width: - :ref:`int` **subdivide_width** diff --git a/classes/class_polygon2d.rst b/classes/class_polygon2d.rst index 6acf0526b..c1f380092 100644 --- a/classes/class_polygon2d.rst +++ b/classes/class_polygon2d.rst @@ -98,10 +98,14 @@ Property Descriptions If ``true``, polygon edges will be anti-aliased. Default value: ``false``. +---- + .. _class_Polygon2D_property_bones: - :ref:`Array` **bones** +---- + .. _class_Polygon2D_property_color: - :ref:`Color` **color** @@ -114,6 +118,8 @@ If ``true``, polygon edges will be anti-aliased. Default value: ``false``. The polygon's fill color. If ``texture`` is defined, it will be multiplied by this color. It will also be the default color for vertices not set in ``vertex_colors``. +---- + .. _class_Polygon2D_property_internal_vertex_count: - :ref:`int` **internal_vertex_count** @@ -124,6 +130,8 @@ The polygon's fill color. If ``texture`` is defined, it will be multiplied by th | *Getter* | get_internal_vertex_count() | +----------+----------------------------------+ +---- + .. _class_Polygon2D_property_invert_border: - :ref:`float` **invert_border** @@ -136,6 +144,8 @@ The polygon's fill color. If ``texture`` is defined, it will be multiplied by th Added padding applied to the bounding box when using ``invert``. Setting this value too small may result in a "Bad Polygon" error. Default value: ``100``. +---- + .. _class_Polygon2D_property_invert_enable: - :ref:`bool` **invert_enable** @@ -148,6 +158,8 @@ Added padding applied to the bounding box when using ``invert``. Setting this va If ``true``, polygon will be inverted, containing the area outside the defined points and extending to the ``invert_border``. Default value: ``false``. +---- + .. _class_Polygon2D_property_offset: - :ref:`Vector2` **offset** @@ -160,6 +172,8 @@ If ``true``, polygon will be inverted, containing the area outside the defined p The offset applied to each vertex. +---- + .. _class_Polygon2D_property_polygon: - :ref:`PoolVector2Array` **polygon** @@ -172,6 +186,8 @@ The offset applied to each vertex. The polygon's list of vertices. The final point will be connected to the first. Note that this returns a copy of the :ref:`PoolVector2Array` rather than a reference. +---- + .. _class_Polygon2D_property_polygons: - :ref:`Array` **polygons** @@ -182,6 +198,8 @@ The polygon's list of vertices. The final point will be connected to the first. | *Getter* | get_polygons() | +----------+---------------------+ +---- + .. _class_Polygon2D_property_skeleton: - :ref:`NodePath` **skeleton** @@ -192,6 +210,8 @@ The polygon's list of vertices. The final point will be connected to the first. | *Getter* | get_skeleton() | +----------+---------------------+ +---- + .. _class_Polygon2D_property_texture: - :ref:`Texture` **texture** @@ -204,6 +224,8 @@ The polygon's list of vertices. The final point will be connected to the first. The polygon's fill texture. Use ``uv`` to set texture coordinates. +---- + .. _class_Polygon2D_property_texture_offset: - :ref:`Vector2` **texture_offset** @@ -216,6 +238,8 @@ The polygon's fill texture. Use ``uv`` to set texture coordinates. Amount to offset the polygon's ``texture``. If ``(0, 0)`` the texture's origin (its top-left corner) will be placed at the polygon's ``position``. +---- + .. _class_Polygon2D_property_texture_rotation: - :ref:`float` **texture_rotation** @@ -228,6 +252,8 @@ Amount to offset the polygon's ``texture``. If ``(0, 0)`` the texture's origin ( The texture's rotation in radians. +---- + .. _class_Polygon2D_property_texture_rotation_degrees: - :ref:`float` **texture_rotation_degrees** @@ -240,6 +266,8 @@ The texture's rotation in radians. The texture's rotation in degrees. +---- + .. _class_Polygon2D_property_texture_scale: - :ref:`Vector2` **texture_scale** @@ -252,6 +280,8 @@ The texture's rotation in degrees. Amount to multiply the ``uv`` coordinates when using a ``texture``. Larger values make the texture smaller, and vice versa. +---- + .. _class_Polygon2D_property_uv: - :ref:`PoolVector2Array` **uv** @@ -264,6 +294,8 @@ Amount to multiply the ``uv`` coordinates when using a ``texture``. Larger value Texture coordinates for each vertex of the polygon. There should be one ``uv`` per polygon vertex. If there are fewer, undefined vertices will use ``(0, 0)``. +---- + .. _class_Polygon2D_property_vertex_colors: - :ref:`PoolColorArray` **vertex_colors** @@ -283,30 +315,44 @@ Method Descriptions - void **add_bone** **(** :ref:`NodePath` path, :ref:`PoolRealArray` weights **)** +---- + .. _class_Polygon2D_method_clear_bones: - void **clear_bones** **(** **)** +---- + .. _class_Polygon2D_method_erase_bone: - void **erase_bone** **(** :ref:`int` index **)** +---- + .. _class_Polygon2D_method_get_bone_count: - :ref:`int` **get_bone_count** **(** **)** const +---- + .. _class_Polygon2D_method_get_bone_path: - :ref:`NodePath` **get_bone_path** **(** :ref:`int` index **)** const +---- + .. _class_Polygon2D_method_get_bone_weights: - :ref:`PoolRealArray` **get_bone_weights** **(** :ref:`int` index **)** const +---- + .. _class_Polygon2D_method_set_bone_path: - void **set_bone_path** **(** :ref:`int` index, :ref:`NodePath` path **)** +---- + .. _class_Polygon2D_method_set_bone_weights: - void **set_bone_weights** **(** :ref:`int` index, :ref:`PoolRealArray` weights **)** diff --git a/classes/class_polygonpathfinder.rst b/classes/class_polygonpathfinder.rst index 758cbec8e..005ab557a 100644 --- a/classes/class_polygonpathfinder.rst +++ b/classes/class_polygonpathfinder.rst @@ -46,30 +46,44 @@ Method Descriptions - :ref:`PoolVector2Array` **find_path** **(** :ref:`Vector2` from, :ref:`Vector2` to **)** +---- + .. _class_PolygonPathFinder_method_get_bounds: - :ref:`Rect2` **get_bounds** **(** **)** const +---- + .. _class_PolygonPathFinder_method_get_closest_point: - :ref:`Vector2` **get_closest_point** **(** :ref:`Vector2` point **)** const +---- + .. _class_PolygonPathFinder_method_get_intersections: - :ref:`PoolVector2Array` **get_intersections** **(** :ref:`Vector2` from, :ref:`Vector2` to **)** const +---- + .. _class_PolygonPathFinder_method_get_point_penalty: - :ref:`float` **get_point_penalty** **(** :ref:`int` idx **)** const +---- + .. _class_PolygonPathFinder_method_is_point_inside: - :ref:`bool` **is_point_inside** **(** :ref:`Vector2` point **)** const +---- + .. _class_PolygonPathFinder_method_set_point_penalty: - void **set_point_penalty** **(** :ref:`int` idx, :ref:`float` penalty **)** +---- + .. _class_PolygonPathFinder_method_setup: - void **setup** **(** :ref:`PoolVector2Array` points, :ref:`PoolIntArray` connections **)** diff --git a/classes/class_poolbytearray.rst b/classes/class_poolbytearray.rst index 94525be45..5ea74f266 100644 --- a/classes/class_poolbytearray.rst +++ b/classes/class_poolbytearray.rst @@ -65,84 +65,112 @@ Method Descriptions Construct a new ``PoolByteArray``. Optionally, you can pass in a generic :ref:`Array` that will be converted. +---- + .. _class_PoolByteArray_method_append: - void **append** **(** :ref:`int` byte **)** Append an element at the end of the array (alias of :ref:`push_back`). +---- + .. _class_PoolByteArray_method_append_array: - void **append_array** **(** :ref:`PoolByteArray` array **)** Append a ``PoolByteArray`` at the end of this array. +---- + .. _class_PoolByteArray_method_compress: - :ref:`PoolByteArray` **compress** **(** :ref:`int` compression_mode=0 **)** Returns a new ``PoolByteArray`` with the data compressed. Set the compression mode using one of :ref:`CompressionMode`'s constants. +---- + .. _class_PoolByteArray_method_decompress: - :ref:`PoolByteArray` **decompress** **(** :ref:`int` buffer_size, :ref:`int` compression_mode=0 **)** Returns a new ``PoolByteArray`` with the data decompressed. Set ``buffer_size`` to the size of the uncompressed data. Set the compression mode using one of :ref:`CompressionMode`'s constants. +---- + .. _class_PoolByteArray_method_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:`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:`get_string_from_utf8`. +---- + .. _class_PoolByteArray_method_get_string_from_utf8: - :ref:`String` **get_string_from_utf8** **(** **)** Returns a copy of the array's contents as :ref:`String`. Slower than :ref:`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_method_insert: - :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 (``idx == size()``). +---- + .. _class_PoolByteArray_method_invert: - void **invert** **(** **)** Reverse the order of the elements in the array. +---- + .. _class_PoolByteArray_method_push_back: - void **push_back** **(** :ref:`int` byte **)** Append an element at the end of the array. +---- + .. _class_PoolByteArray_method_remove: - void **remove** **(** :ref:`int` idx **)** Remove an element from the array by index. +---- + .. _class_PoolByteArray_method_resize: - 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_method_set: - void **set** **(** :ref:`int` idx, :ref:`int` byte **)** Change the byte at the given index. +---- + .. _class_PoolByteArray_method_size: - :ref:`int` **size** **(** **)** Returns the size of the array. +---- + .. _class_PoolByteArray_method_subarray: - :ref:`PoolByteArray` **subarray** **(** :ref:`int` from, :ref:`int` to **)** diff --git a/classes/class_poolcolorarray.rst b/classes/class_poolcolorarray.rst index 12525312c..077aca566 100644 --- a/classes/class_poolcolorarray.rst +++ b/classes/class_poolcolorarray.rst @@ -55,54 +55,72 @@ Method Descriptions Construct a new ``PoolColorArray``. Optionally, you can pass in a generic :ref:`Array` that will be converted. +---- + .. _class_PoolColorArray_method_append: - void **append** **(** :ref:`Color` color **)** Append an element at the end of the array (alias of :ref:`push_back`). +---- + .. _class_PoolColorArray_method_append_array: - void **append_array** **(** :ref:`PoolColorArray` array **)** Append a ``PoolColorArray`` at the end of this array. +---- + .. _class_PoolColorArray_method_insert: - :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 (``idx == size()``). +---- + .. _class_PoolColorArray_method_invert: - void **invert** **(** **)** Reverse the order of the elements in the array. +---- + .. _class_PoolColorArray_method_push_back: - void **push_back** **(** :ref:`Color` color **)** Append a value to the array. +---- + .. _class_PoolColorArray_method_remove: - void **remove** **(** :ref:`int` idx **)** Remove an element from the array by index. +---- + .. _class_PoolColorArray_method_resize: - 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_method_set: - void **set** **(** :ref:`int` idx, :ref:`Color` color **)** Change the :ref:`Color` at the given index. +---- + .. _class_PoolColorArray_method_size: - :ref:`int` **size** **(** **)** diff --git a/classes/class_poolintarray.rst b/classes/class_poolintarray.rst index c0c5ff68d..a3c5af1fc 100644 --- a/classes/class_poolintarray.rst +++ b/classes/class_poolintarray.rst @@ -44,7 +44,11 @@ Methods Description ----------- -An :ref:`Array` specifically designed to hold integer values (:ref:`int`). Optimized for memory usage, does not fragment the memory. Note that this type is passed by value and not by reference. +An :ref:`Array` specifically designed to hold integer values (:ref:`int`). Optimized for memory usage, does not fragment the memory. + +**Note:** This type is passed by value and not by reference. + +**Note:** This type is limited to signed 32-bit integers, which means it can only take values in the interval ``[-2^31, 2^31 - 1]``, i.e. ``[-2147483648, 2147483647]``. Exceeding those bounds will wrap around. In comparison, :ref:`int` uses signed 64-bit integers which can hold much larger values. Method Descriptions ------------------- @@ -55,54 +59,72 @@ Method Descriptions Construct a new ``PoolIntArray``. Optionally, you can pass in a generic :ref:`Array` that will be converted. +---- + .. _class_PoolIntArray_method_append: - void **append** **(** :ref:`int` integer **)** Append an element at the end of the array (alias of :ref:`push_back`). +---- + .. _class_PoolIntArray_method_append_array: - void **append_array** **(** :ref:`PoolIntArray` array **)** Append a ``PoolIntArray`` at the end of this array. +---- + .. _class_PoolIntArray_method_insert: - :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 (``idx == size()``). +---- + .. _class_PoolIntArray_method_invert: - void **invert** **(** **)** Reverse the order of the elements in the array. +---- + .. _class_PoolIntArray_method_push_back: - void **push_back** **(** :ref:`int` integer **)** Append a value to the array. +---- + .. _class_PoolIntArray_method_remove: - void **remove** **(** :ref:`int` idx **)** Remove an element from the array by index. +---- + .. _class_PoolIntArray_method_resize: - 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_method_set: - void **set** **(** :ref:`int` idx, :ref:`int` integer **)** Change the int at the given index. +---- + .. _class_PoolIntArray_method_size: - :ref:`int` **size** **(** **)** diff --git a/classes/class_poolrealarray.rst b/classes/class_poolrealarray.rst index 27e59377c..12473d6d8 100644 --- a/classes/class_poolrealarray.rst +++ b/classes/class_poolrealarray.rst @@ -55,54 +55,72 @@ Method Descriptions Construct a new ``PoolRealArray``. Optionally, you can pass in a generic :ref:`Array` that will be converted. +---- + .. _class_PoolRealArray_method_append: - void **append** **(** :ref:`float` value **)** Append an element at the end of the array (alias of :ref:`push_back`). +---- + .. _class_PoolRealArray_method_append_array: - void **append_array** **(** :ref:`PoolRealArray` array **)** Append a ``PoolRealArray`` at the end of this array. +---- + .. _class_PoolRealArray_method_insert: - :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 (``idx == size()``). +---- + .. _class_PoolRealArray_method_invert: - void **invert** **(** **)** Reverse the order of the elements in the array. +---- + .. _class_PoolRealArray_method_push_back: - void **push_back** **(** :ref:`float` value **)** Append an element at the end of the array. +---- + .. _class_PoolRealArray_method_remove: - void **remove** **(** :ref:`int` idx **)** Remove an element from the array by index. +---- + .. _class_PoolRealArray_method_resize: - 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_method_set: - void **set** **(** :ref:`int` idx, :ref:`float` value **)** Change the float at the given index. +---- + .. _class_PoolRealArray_method_size: - :ref:`int` **size** **(** **)** diff --git a/classes/class_poolstringarray.rst b/classes/class_poolstringarray.rst index 586379b3e..48e5c7e82 100644 --- a/classes/class_poolstringarray.rst +++ b/classes/class_poolstringarray.rst @@ -57,60 +57,80 @@ Method Descriptions Construct a new ``PoolStringArray``. Optionally, you can pass in a generic :ref:`Array` that will be converted. +---- + .. _class_PoolStringArray_method_append: - void **append** **(** :ref:`String` string **)** Append an element at the end of the array (alias of :ref:`push_back`). +---- + .. _class_PoolStringArray_method_append_array: - void **append_array** **(** :ref:`PoolStringArray` array **)** Append a ``PoolStringArray`` at the end of this array. +---- + .. _class_PoolStringArray_method_insert: - :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 (``idx == size()``). +---- + .. _class_PoolStringArray_method_invert: - void **invert** **(** **)** Reverse the order of the elements in the array. +---- + .. _class_PoolStringArray_method_join: - :ref:`String` **join** **(** :ref:`String` delimiter **)** Returns a :ref:`String` with each element of the array joined with the given ``delimiter``. +---- + .. _class_PoolStringArray_method_push_back: - void **push_back** **(** :ref:`String` string **)** Append a string element at end of the array. +---- + .. _class_PoolStringArray_method_remove: - void **remove** **(** :ref:`int` idx **)** Remove an element from the array by index. +---- + .. _class_PoolStringArray_method_resize: - 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_method_set: - void **set** **(** :ref:`int` idx, :ref:`String` string **)** Change the :ref:`String` at the given index. +---- + .. _class_PoolStringArray_method_size: - :ref:`int` **size** **(** **)** diff --git a/classes/class_poolvector2array.rst b/classes/class_poolvector2array.rst index 3cae3271e..7cd6adfe9 100644 --- a/classes/class_poolvector2array.rst +++ b/classes/class_poolvector2array.rst @@ -55,54 +55,72 @@ Method Descriptions Construct a new ``PoolVector2Array``. Optionally, you can pass in a generic :ref:`Array` that will be converted. +---- + .. _class_PoolVector2Array_method_append: - void **append** **(** :ref:`Vector2` vector2 **)** Append an element at the end of the array (alias of :ref:`push_back`). +---- + .. _class_PoolVector2Array_method_append_array: - void **append_array** **(** :ref:`PoolVector2Array` array **)** Append a ``PoolVector2Array`` at the end of this array. +---- + .. _class_PoolVector2Array_method_insert: - :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 (``idx == size()``). +---- + .. _class_PoolVector2Array_method_invert: - void **invert** **(** **)** Reverse the order of the elements in the array. +---- + .. _class_PoolVector2Array_method_push_back: - void **push_back** **(** :ref:`Vector2` vector2 **)** Insert a :ref:`Vector2` at the end. +---- + .. _class_PoolVector2Array_method_remove: - void **remove** **(** :ref:`int` idx **)** Remove an element from the array by index. +---- + .. _class_PoolVector2Array_method_resize: - 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_method_set: - void **set** **(** :ref:`int` idx, :ref:`Vector2` vector2 **)** Change the :ref:`Vector2` at the given index. +---- + .. _class_PoolVector2Array_method_size: - :ref:`int` **size** **(** **)** diff --git a/classes/class_poolvector3array.rst b/classes/class_poolvector3array.rst index 4050f3a15..3ac66ecb7 100644 --- a/classes/class_poolvector3array.rst +++ b/classes/class_poolvector3array.rst @@ -55,54 +55,72 @@ Method Descriptions Construct a new ``PoolVector3Array``. Optionally, you can pass in a generic :ref:`Array` that will be converted. +---- + .. _class_PoolVector3Array_method_append: - void **append** **(** :ref:`Vector3` vector3 **)** Append an element at the end of the array (alias of :ref:`push_back`). +---- + .. _class_PoolVector3Array_method_append_array: - void **append_array** **(** :ref:`PoolVector3Array` array **)** Append a ``PoolVector3Array`` at the end of this array. +---- + .. _class_PoolVector3Array_method_insert: - :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 (``idx == size()``). +---- + .. _class_PoolVector3Array_method_invert: - void **invert** **(** **)** Reverse the order of the elements in the array. +---- + .. _class_PoolVector3Array_method_push_back: - void **push_back** **(** :ref:`Vector3` vector3 **)** Insert a :ref:`Vector3` at the end. +---- + .. _class_PoolVector3Array_method_remove: - void **remove** **(** :ref:`int` idx **)** Remove an element from the array by index. +---- + .. _class_PoolVector3Array_method_resize: - 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_method_set: - void **set** **(** :ref:`int` idx, :ref:`Vector3` vector3 **)** Change the :ref:`Vector3` at the given index. +---- + .. _class_PoolVector3Array_method_size: - :ref:`int` **size** **(** **)** diff --git a/classes/class_popup.rst b/classes/class_popup.rst index 2a9b36bef..05797dda5 100644 --- a/classes/class_popup.rst +++ b/classes/class_popup.rst @@ -49,6 +49,8 @@ Signals 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_signal_popup_hide: - **popup_hide** **(** **)** @@ -95,18 +97,24 @@ Method Descriptions Popup (show the control in modal form). +---- + .. _class_Popup_method_popup_centered: - void **popup_centered** **(** :ref:`Vector2` size=Vector2( 0, 0 ) **)** Popup (show the control in modal form) in the center of the screen relative to its current canvas transform, at the current size, or at a size determined by "size". +---- + .. _class_Popup_method_popup_centered_minsize: - void **popup_centered_minsize** **(** :ref:`Vector2` minsize=Vector2( 0, 0 ) **)** Popup (show the control in modal form) in the center of the screen relative to the current canvas transform, ensuring the size is never smaller than ``minsize``. +---- + .. _class_Popup_method_popup_centered_ratio: - void **popup_centered_ratio** **(** :ref:`float` ratio=0.75 **)** diff --git a/classes/class_popupmenu.rst b/classes/class_popupmenu.rst index b4ab03d65..28ab9a831 100644 --- a/classes/class_popupmenu.rst +++ b/classes/class_popupmenu.rst @@ -184,12 +184,16 @@ Signals This event is emitted when user navigated to an item of some id using ``ui_up`` or ``ui_down`` action. +---- + .. _class_PopupMenu_signal_id_pressed: - **id_pressed** **(** :ref:`int` ID **)** This event is emitted when an item of some id is pressed or its accelerator is activated. +---- + .. _class_PopupMenu_signal_index_pressed: - **index_pressed** **(** :ref:`int` index **)** @@ -216,6 +220,8 @@ Property Descriptions If ``true``, hides the :ref:`PopupMenu` when a checkbox or radio button is selected. +---- + .. _class_PopupMenu_property_hide_on_item_selection: - :ref:`bool` **hide_on_item_selection** @@ -228,6 +234,8 @@ If ``true``, hides the :ref:`PopupMenu` when a checkbox or radi If ``true``, hides the :ref:`PopupMenu` when an item is selected. +---- + .. _class_PopupMenu_property_hide_on_state_item_selection: - :ref:`bool` **hide_on_state_item_selection** @@ -240,6 +248,8 @@ If ``true``, hides the :ref:`PopupMenu` when an item is selecte If ``true``, hides the :ref:`PopupMenu` when a state item is selected. +---- + .. _class_PopupMenu_property_submenu_popup_delay: - :ref:`float` **submenu_popup_delay** @@ -265,6 +275,8 @@ An ``id`` can optionally be provided, as well as an accelerator (``accel``). If **Note:** Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See :ref:`set_item_checked` for more info on how to control it. +---- + .. _class_PopupMenu_method_add_check_shortcut: - void **add_check_shortcut** **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** @@ -275,6 +287,8 @@ An ``id`` can optionally be provided. If no ``id`` is provided, one will be crea **Note:** Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See :ref:`set_item_checked` for more info on how to control it. +---- + .. _class_PopupMenu_method_add_icon_check_item: - void **add_icon_check_item** **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** @@ -285,6 +299,8 @@ An ``id`` can optionally be provided, as well as an accelerator (``accel``). If **Note:** Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See :ref:`set_item_checked` for more info on how to control it. +---- + .. _class_PopupMenu_method_add_icon_check_shortcut: - void **add_icon_check_shortcut** **(** :ref:`Texture` texture, :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** @@ -295,6 +311,8 @@ An ``id`` can optionally be provided. If no ``id`` is provided, one will be crea **Note:** Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See :ref:`set_item_checked` for more info on how to control it. +---- + .. _class_PopupMenu_method_add_icon_item: - void **add_icon_item** **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** @@ -303,6 +321,8 @@ Adds a new item with text ``label`` and icon ``texture``. An ``id`` can optionally be provided, as well as an accelerator (``accel``). If no ``id`` is provided, one will be created from the index. If no ``accel`` is provided then the default ``0`` will be assigned to it. See :ref:`get_item_accelerator` for more info on accelerators. +---- + .. _class_PopupMenu_method_add_icon_shortcut: - void **add_icon_shortcut** **(** :ref:`Texture` texture, :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** @@ -311,6 +331,8 @@ Adds a new item and assigns the specified :ref:`ShortCut` and ic An ``id`` can optionally be provided. If no ``id`` is provided, one will be created from the index. +---- + .. _class_PopupMenu_method_add_item: - void **add_item** **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** @@ -319,6 +341,8 @@ Adds a new item with text ``label``. An ``id`` can optionally be provided, as well as an accelerator (``accel``). If no ``id`` is provided, one will be created from the index. If no ``accel`` is provided then the default ``0`` will be assigned to it. See :ref:`get_item_accelerator` for more info on accelerators. +---- + .. _class_PopupMenu_method_add_radio_check_item: - void **add_radio_check_item** **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** @@ -329,6 +353,8 @@ An ``id`` can optionally be provided, as well as an accelerator (``accel``). If **Note:** Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See :ref:`set_item_checked` for more info on how to control it. +---- + .. _class_PopupMenu_method_add_radio_check_shortcut: - void **add_radio_check_shortcut** **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** @@ -339,12 +365,16 @@ An ``id`` can optionally be provided. If no ``id`` is provided, one will be crea **Note:** Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See :ref:`set_item_checked` for more info on how to control it. +---- + .. _class_PopupMenu_method_add_separator: - void **add_separator** **(** :ref:`String` label="" **)** Add a separator between items. Separators also occupy an index. +---- + .. _class_PopupMenu_method_add_shortcut: - void **add_shortcut** **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** @@ -353,6 +383,8 @@ Adds a :ref:`ShortCut`. An ``id`` can optionally be provided. If no ``id`` is provided, one will be created from the index. +---- + .. _class_PopupMenu_method_add_submenu_item: - void **add_submenu_item** **(** :ref:`String` label, :ref:`String` submenu, :ref:`int` id=-1 **)** @@ -361,90 +393,120 @@ Adds an item that will act as a submenu of the parent :ref:`PopupMenu`. +---- + .. _class_PopupMenu_method_get_item_accelerator: - :ref:`int` **get_item_accelerator** **(** :ref:`int` idx **)** const Returns 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_method_get_item_count: - :ref:`int` **get_item_count** **(** **)** const Returns the number of items in the :ref:`PopupMenu`. +---- + .. _class_PopupMenu_method_get_item_icon: - :ref:`Texture` **get_item_icon** **(** :ref:`int` idx **)** const Returns the icon of the item at index "idx". +---- + .. _class_PopupMenu_method_get_item_id: - :ref:`int` **get_item_id** **(** :ref:`int` idx **)** const Returns the id of the item at index ``idx``. ``id`` can be manually assigned, while index can not. +---- + .. _class_PopupMenu_method_get_item_index: - :ref:`int` **get_item_index** **(** :ref:`int` id **)** const Returns the index of the item containing the specified ``id``. Index is automatically assigned to each item by the engine. Index can not be set manualy. +---- + .. _class_PopupMenu_method_get_item_metadata: - :ref:`Variant` **get_item_metadata** **(** :ref:`int` idx **)** const Returns the metadata of the specified 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_method_get_item_shortcut: - :ref:`ShortCut` **get_item_shortcut** **(** :ref:`int` idx **)** const Returns the :ref:`ShortCut` associated with the specified ``idx`` item. +---- + .. _class_PopupMenu_method_get_item_submenu: - :ref:`String` **get_item_submenu** **(** :ref:`int` idx **)** const Returns the submenu name of the item at index ``idx``. See :ref:`add_submenu_item` for more info on how to add a submenu. +---- + .. _class_PopupMenu_method_get_item_text: - :ref:`String` **get_item_text** **(** :ref:`int` idx **)** const Returns the text of the item at index "idx". +---- + .. _class_PopupMenu_method_get_item_tooltip: - :ref:`String` **get_item_tooltip** **(** :ref:`int` idx **)** const Returns the tooltip associated with the specified index index ``idx``. +---- + .. _class_PopupMenu_method_is_hide_on_window_lose_focus: - :ref:`bool` **is_hide_on_window_lose_focus** **(** **)** const Returns whether the popup will be hidden when the window loses focus or not. +---- + .. _class_PopupMenu_method_is_item_checkable: - :ref:`bool` **is_item_checkable** **(** :ref:`int` idx **)** const Returns whether the item at index "idx" is checkable in some way, i.e., whether has a checkbox or radio button. Note that checkable items just display a checkmark or radio button, but don't have any built-in checking behavior and must be checked/unchecked manually. +---- + .. _class_PopupMenu_method_is_item_checked: - :ref:`bool` **is_item_checked** **(** :ref:`int` idx **)** const Returns whether the item at index "idx" is checked. +---- + .. _class_PopupMenu_method_is_item_disabled: - :ref:`bool` **is_item_disabled** **(** :ref:`int` idx **)** const @@ -453,6 +515,8 @@ Returns ``true`` if the item at index ``idx`` is disabled. When it is disabled i See :ref:`set_item_disabled` for more info on how to disable an item. +---- + .. _class_PopupMenu_method_is_item_radio_checkable: - :ref:`bool` **is_item_radio_checkable** **(** :ref:`int` idx **)** const @@ -461,36 +525,48 @@ Returns ``true`` if the item at index ``idx`` has radio button-style checkabilit **Note:** This is purely cosmetic; you must add the logic for checking/unchecking items in radio groups. +---- + .. _class_PopupMenu_method_is_item_separator: - :ref:`bool` **is_item_separator** **(** :ref:`int` idx **)** const Returns ``true`` if the item is a separator. If it is, it will be displayed as a line. See :ref:`add_separator` for more info on how to add a separator. +---- + .. _class_PopupMenu_method_is_item_shortcut_disabled: - :ref:`bool` **is_item_shortcut_disabled** **(** :ref:`int` idx **)** const Returns whether the shortcut of the specified item ``idx`` is disabled or not. +---- + .. _class_PopupMenu_method_remove_item: - 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_method_set_hide_on_window_lose_focus: - void **set_hide_on_window_lose_focus** **(** :ref:`bool` enable **)** Hides the :ref:`PopupMenu` when the window loses focus. +---- + .. _class_PopupMenu_method_set_item_accelerator: - 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_method_set_item_as_checkable: - void **set_item_as_checkable** **(** :ref:`int` idx, :ref:`bool` enable **)** @@ -499,88 +575,118 @@ Sets whether the item at index ``idx`` has a checkbox. If ``false``, sets the ty **Note:** Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. +---- + .. _class_PopupMenu_method_set_item_as_radio_checkable: - void **set_item_as_radio_checkable** **(** :ref:`int` idx, :ref:`bool` enable **)** Sets the type of the item at the specified index ``idx`` to radio button. If false, sets the type of the item to plain text. +---- + .. _class_PopupMenu_method_set_item_as_separator: - void **set_item_as_separator** **(** :ref:`int` idx, :ref:`bool` enable **)** Mark the item at index ``idx`` as a separator, which means that it would be displayed as a line. If ``false``, sets the type of the item to plain text. +---- + .. _class_PopupMenu_method_set_item_checked: - void **set_item_checked** **(** :ref:`int` idx, :ref:`bool` checked **)** Set the checkstate status of the item at index "idx". +---- + .. _class_PopupMenu_method_set_item_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_method_set_item_icon: - void **set_item_icon** **(** :ref:`int` idx, :ref:`Texture` icon **)** Replaces the :ref:`Texture` icon of the specified ``idx``. +---- + .. _class_PopupMenu_method_set_item_id: - void **set_item_id** **(** :ref:`int` idx, :ref:`int` id **)** Set the id of the item at index "idx". +---- + .. _class_PopupMenu_method_set_item_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_method_set_item_multistate: - void **set_item_multistate** **(** :ref:`int` idx, :ref:`int` state **)** +---- + .. _class_PopupMenu_method_set_item_shortcut: - void **set_item_shortcut** **(** :ref:`int` idx, :ref:`ShortCut` shortcut, :ref:`bool` global=false **)** Sets a :ref:`ShortCut` for the specified item ``idx``. +---- + .. _class_PopupMenu_method_set_item_shortcut_disabled: - void **set_item_shortcut_disabled** **(** :ref:`int` idx, :ref:`bool` disabled **)** Disables the :ref:`ShortCut` of the specified index ``idx``. +---- + .. _class_PopupMenu_method_set_item_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 :ref:`PopupMenu` node that would be shown when the item is clicked. +---- + .. _class_PopupMenu_method_set_item_text: - void **set_item_text** **(** :ref:`int` idx, :ref:`String` text **)** Set the text of the item at index "idx". +---- + .. _class_PopupMenu_method_set_item_tooltip: - void **set_item_tooltip** **(** :ref:`int` idx, :ref:`String` tooltip **)** Sets the :ref:`String` tooltip of the item at the specified index ``idx``. +---- + .. _class_PopupMenu_method_toggle_item_checked: - void **toggle_item_checked** **(** :ref:`int` idx **)** Toggles the check state of the item of the specified index ``idx``. +---- + .. _class_PopupMenu_method_toggle_item_multistate: - void **toggle_item_multistate** **(** :ref:`int` idx **)** diff --git a/classes/class_primitivemesh.rst b/classes/class_primitivemesh.rst index dd7c06e5a..51e795c89 100644 --- a/classes/class_primitivemesh.rst +++ b/classes/class_primitivemesh.rst @@ -58,6 +58,8 @@ Property Descriptions Overrides the :ref:`AABB` with one defined by user for use with frustum culling. Especially useful to avoid unnexpected culling when using a shader to offset vertices. +---- + .. _class_PrimitiveMesh_property_flip_faces: - :ref:`bool` **flip_faces** @@ -70,6 +72,8 @@ Overrides the :ref:`AABB` with one defined by user for use with frus If set, the order of the vertices in each triangle are reversed resulting in the backside of the mesh being drawn. Result is the same as using \*CULL_BACK\* in :ref:`SpatialMaterial`. Default is false. +---- + .. _class_PrimitiveMesh_property_material: - :ref:`Material` **material** diff --git a/classes/class_prismmesh.rst b/classes/class_prismmesh.rst index 86e1af330..aa1e7e655 100644 --- a/classes/class_prismmesh.rst +++ b/classes/class_prismmesh.rst @@ -53,6 +53,8 @@ Property Descriptions Displacement of the upper edge along the X axis. 0.0 positions edge straight above the bottom-left edge. Defaults to 0.5 (positioned on the midpoint). +---- + .. _class_PrismMesh_property_size: - :ref:`Vector3` **size** @@ -65,6 +67,8 @@ Displacement of the upper edge along the X axis. 0.0 positions edge straight abo Size of the prism. Defaults to (2.0, 2.0, 2.0). +---- + .. _class_PrismMesh_property_subdivide_depth: - :ref:`int` **subdivide_depth** @@ -77,6 +81,8 @@ Size of the prism. Defaults to (2.0, 2.0, 2.0). Number of added edge loops along the Z axis. Defaults to 0. +---- + .. _class_PrismMesh_property_subdivide_height: - :ref:`int` **subdivide_height** @@ -89,6 +95,8 @@ Number of added edge loops along the Z axis. Defaults to 0. Number of added edge loops along the Y axis. Defaults to 0. +---- + .. _class_PrismMesh_property_subdivide_width: - :ref:`int` **subdivide_width** diff --git a/classes/class_proceduralsky.rst b/classes/class_proceduralsky.rst index 349c6f989..373aa74ab 100644 --- a/classes/class_proceduralsky.rst +++ b/classes/class_proceduralsky.rst @@ -108,6 +108,8 @@ Property Descriptions Color of the ground at the bottom. +---- + .. _class_ProceduralSky_property_ground_curve: - :ref:`float` **ground_curve** @@ -120,6 +122,8 @@ Color of the ground at the bottom. How quickly the :ref:`ground_horizon_color` fades into the :ref:`ground_bottom_color`. +---- + .. _class_ProceduralSky_property_ground_energy: - :ref:`float` **ground_energy** @@ -132,6 +136,8 @@ How quickly the :ref:`ground_horizon_color` **ground_horizon_color** @@ -144,6 +150,8 @@ Amount of energy contribution from the ground. Color of the ground at the horizon. +---- + .. _class_ProceduralSky_property_sky_curve: - :ref:`float` **sky_curve** @@ -156,6 +164,8 @@ Color of the ground at the horizon. How quickly the :ref:`sky_horizon_color` fades into the :ref:`sky_top_color`. +---- + .. _class_ProceduralSky_property_sky_energy: - :ref:`float` **sky_energy** @@ -168,6 +178,8 @@ How quickly the :ref:`sky_horizon_color` **sky_horizon_color** @@ -180,6 +192,8 @@ Amount of energy contribution from the sky. Color of the sky at the horizon. +---- + .. _class_ProceduralSky_property_sky_top_color: - :ref:`Color` **sky_top_color** @@ -192,6 +206,8 @@ Color of the sky at the horizon. Color of the sky at the top. +---- + .. _class_ProceduralSky_property_sun_angle_max: - :ref:`float` **sun_angle_max** @@ -204,6 +220,8 @@ Color of the sky at the top. Distance from center of sun where it fades out completely. +---- + .. _class_ProceduralSky_property_sun_angle_min: - :ref:`float` **sun_angle_min** @@ -216,6 +234,8 @@ Distance from center of sun where it fades out completely. Distance from sun where it goes from solid to starting to fade. +---- + .. _class_ProceduralSky_property_sun_color: - :ref:`Color` **sun_color** @@ -228,6 +248,8 @@ Distance from sun where it goes from solid to starting to fade. Color of the sun. +---- + .. _class_ProceduralSky_property_sun_curve: - :ref:`float` **sun_curve** @@ -240,6 +262,8 @@ Color of the sun. How quickly the sun fades away between :ref:`sun_angle_min` and :ref:`sun_angle_max`. +---- + .. _class_ProceduralSky_property_sun_energy: - :ref:`float` **sun_energy** @@ -252,6 +276,8 @@ How quickly the sun fades away between :ref:`sun_angle_min` **sun_latitude** @@ -264,6 +290,8 @@ Amount of energy contribution from the sun. The suns height using polar coordinates. +---- + .. _class_ProceduralSky_property_sun_longitude: - :ref:`float` **sun_longitude** @@ -276,6 +304,8 @@ The suns height using polar coordinates. The direction of the sun using polar coordinates. +---- + .. _class_ProceduralSky_property_texture_size: - :ref:`TextureSize` **texture_size** diff --git a/classes/class_projectsettings.rst b/classes/class_projectsettings.rst index f4c4ab55f..7ad76e992 100644 --- a/classes/class_projectsettings.rst +++ b/classes/class_projectsettings.rst @@ -84,6 +84,8 @@ Properties +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`debug/gdscript/warnings/enable` | +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/exclude_addons` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`debug/gdscript/warnings/function_conflicts_constant` | +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`debug/gdscript/warnings/function_conflicts_variable` | @@ -102,6 +104,8 @@ Properties +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`debug/gdscript/warnings/return_value_discarded` | +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/shadowed_variable` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`debug/gdscript/warnings/standalone_expression` | +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`debug/gdscript/warnings/treat_warnings_as_errors` | @@ -458,6 +462,10 @@ Properties +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rendering/limits/rendering/max_renderable_elements` | +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/limits/rendering/max_renderable_lights` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/limits/rendering/max_renderable_reflections` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`rendering/limits/time/time_rollover_secs` | +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`rendering/quality/2d/gles2_use_nvidia_rect_flicker_workaround` | @@ -594,24 +602,32 @@ Property Descriptions Comma-separated list of custom Android modules (which must have been built in the Android export templates) using their Java package path, e.g. ``org/godotengine/org/GodotPaymentV3,org/godotengine/godot/MyCustomSingleton"``. +---- + .. _class_ProjectSettings_property_application/boot_splash/bg_color: - :ref:`Color` **application/boot_splash/bg_color** Background color for the boot splash. +---- + .. _class_ProjectSettings_property_application/boot_splash/fullsize: - :ref:`bool` **application/boot_splash/fullsize** If ``true``, scale the boot splash image to the full window length when engine starts. If ``false``, the engine will leave it at the default pixel size. +---- + .. _class_ProjectSettings_property_application/boot_splash/image: - :ref:`String` **application/boot_splash/image** Path to an image used as the boot splash. +---- + .. _class_ProjectSettings_property_application/config/custom_user_dir_name: - :ref:`String` **application/config/custom_user_dir_name** @@ -620,1074 +636,1532 @@ This user directory is used for storing persistent data (``user://`` filesystem) The :ref:`application/config/use_custom_user_dir` setting must be enabled for this to take effect. +---- + .. _class_ProjectSettings_property_application/config/icon: - :ref:`String` **application/config/icon** Icon used for the project, set when project loads. Exporters will also use this icon when possible. +---- + .. _class_ProjectSettings_property_application/config/name: - :ref:`String` **application/config/name** The project's name. It is used both by the Project Manager and by exporters. The project name can be translated by translating its value in localization files. +---- + .. _class_ProjectSettings_property_application/config/project_settings_override: - :ref:`String` **application/config/project_settings_override** Specifies a file to override project settings. For example: ``user://custom_settings.cfg``. +---- + .. _class_ProjectSettings_property_application/config/use_custom_user_dir: - :ref:`bool` **application/config/use_custom_user_dir** If ``true``, the project will save user data to its own user directory (see :ref:`application/config/custom_user_dir_name`). This setting is only effective on desktop platforms. A name must be set in the :ref:`application/config/custom_user_dir_name` setting for this to take effect. If ``false``, the project will save user data to ``(OS user data directory)/Godot/app_userdata/(project name)``. +---- + .. _class_ProjectSettings_property_application/run/disable_stderr: - :ref:`bool` **application/run/disable_stderr** If ``true``, disables printing to standard error in an exported build. +---- + .. _class_ProjectSettings_property_application/run/disable_stdout: - :ref:`bool` **application/run/disable_stdout** If ``true``, disables printing to standard output in an exported build. +---- + .. _class_ProjectSettings_property_application/run/frame_delay_msec: - :ref:`int` **application/run/frame_delay_msec** Forces a delay between frames in the main loop (in milliseconds). This may be useful if you plan to disable vertical synchronization. +---- + .. _class_ProjectSettings_property_application/run/low_processor_mode: - :ref:`bool` **application/run/low_processor_mode** If ``true``, enables low-processor usage mode. This setting only works on desktop platforms. The screen is not redrawn if nothing changes visually. This is meant for writing applications and editors, but is pretty useless (and can hurt performance) in most games. +---- + .. _class_ProjectSettings_property_application/run/low_processor_mode_sleep_usec: - :ref:`int` **application/run/low_processor_mode_sleep_usec** Amount of sleeping between frames when the low-processor usage mode is enabled (in microseconds). Higher values will result in lower CPU usage. +---- + .. _class_ProjectSettings_property_application/run/main_scene: - :ref:`String` **application/run/main_scene** Path to the main scene file that will be loaded when the project runs. +---- + .. _class_ProjectSettings_property_audio/channel_disable_threshold_db: - :ref:`float` **audio/channel_disable_threshold_db** Audio buses will disable automatically when sound goes below a given dB threshold for a given time. This saves CPU as effects assigned to that bus will no longer do any processing. +---- + .. _class_ProjectSettings_property_audio/channel_disable_time: - :ref:`float` **audio/channel_disable_time** Audio buses will disable automatically when sound goes below a given dB threshold for a given time. This saves CPU as effects assigned to that bus will no longer do any processing. +---- + .. _class_ProjectSettings_property_audio/driver: - :ref:`String` **audio/driver** Specifies the audio driver to use. This setting is platform-dependent as each platform supports different audio drivers. If left empty, the default audio driver will be used. +---- + .. _class_ProjectSettings_property_audio/enable_audio_input: - :ref:`bool` **audio/enable_audio_input** If ``true``, microphone input will be allowed. This requires appropriate permissions to be set when exporting to Android or iOS. +---- + .. _class_ProjectSettings_property_audio/mix_rate: - :ref:`int` **audio/mix_rate** Mixing rate used for audio. In general, it's better to not touch this and leave it to the host operating system. +---- + .. _class_ProjectSettings_property_audio/output_latency: - :ref:`int` **audio/output_latency** Output latency in milliseconds for audio. Lower values will result in lower audio latency at the cost of increased CPU usage. Low values may result in audible cracking on slower hardware. +---- + .. _class_ProjectSettings_property_audio/video_delay_compensation_ms: - :ref:`int` **audio/video_delay_compensation_ms** Setting to hardcode audio delay when playing video. Best to leave this untouched unless you know what you are doing. +---- + .. _class_ProjectSettings_property_compression/formats/gzip/compression_level: - :ref:`int` **compression/formats/gzip/compression_level** Default compression level for gzip. Affects compressed scenes and resources. +---- + .. _class_ProjectSettings_property_compression/formats/zlib/compression_level: - :ref:`int` **compression/formats/zlib/compression_level** Default compression level for Zlib. Affects compressed scenes and resources. +---- + .. _class_ProjectSettings_property_compression/formats/zstd/compression_level: - :ref:`int` **compression/formats/zstd/compression_level** Default compression level for Zstandard. Affects compressed scenes and resources. +---- + .. _class_ProjectSettings_property_compression/formats/zstd/long_distance_matching: - :ref:`bool` **compression/formats/zstd/long_distance_matching** Enables long-distance matching in Zstandard. +---- + .. _class_ProjectSettings_property_compression/formats/zstd/window_log_size: - :ref:`int` **compression/formats/zstd/window_log_size** +---- + .. _class_ProjectSettings_property_debug/gdscript/completion/autocomplete_setters_and_getters: - :ref:`bool` **debug/gdscript/completion/autocomplete_setters_and_getters** If ``true``, displays getters and setters in autocompletion results in the script editor. This setting is meant to be used when porting old projects (Godot 2), as using member variables is the preferred style from Godot 3 onwards. +---- + .. _class_ProjectSettings_property_debug/gdscript/warnings/constant_used_as_function: - :ref:`bool` **debug/gdscript/warnings/constant_used_as_function** If ``true``, enables warnings when a constant is used as a function. +---- + .. _class_ProjectSettings_property_debug/gdscript/warnings/deprecated_keyword: - :ref:`bool` **debug/gdscript/warnings/deprecated_keyword** If ``true``, enables warnings when deprecated keywords such as ``slave`` are used. +---- + .. _class_ProjectSettings_property_debug/gdscript/warnings/enable: - :ref:`bool` **debug/gdscript/warnings/enable** If ``true``, enables specific GDScript warnings (see ``debug/gdscript/warnings/*`` settings). If ``false``, disables all GDScript warnings. +---- + +.. _class_ProjectSettings_property_debug/gdscript/warnings/exclude_addons: + +- :ref:`bool` **debug/gdscript/warnings/exclude_addons** + +---- + .. _class_ProjectSettings_property_debug/gdscript/warnings/function_conflicts_constant: - :ref:`bool` **debug/gdscript/warnings/function_conflicts_constant** If ``true``, enables warnings when a function is declared with the same name as a constant. +---- + .. _class_ProjectSettings_property_debug/gdscript/warnings/function_conflicts_variable: - :ref:`bool` **debug/gdscript/warnings/function_conflicts_variable** If ``true``, enables warnings when a function is declared with the same name as a variable. This will turn into an error in a future version when first-class functions become supported in GDScript. +---- + .. _class_ProjectSettings_property_debug/gdscript/warnings/function_may_yield: - :ref:`bool` **debug/gdscript/warnings/function_may_yield** If ``true``, enables warnings when a function assigned to a variable may yield and return a function state instead of a value. +---- + .. _class_ProjectSettings_property_debug/gdscript/warnings/function_used_as_property: - :ref:`bool` **debug/gdscript/warnings/function_used_as_property** If ``true``, enables warnings when using a function as if it was a property. +---- + .. _class_ProjectSettings_property_debug/gdscript/warnings/incompatible_ternary: - :ref:`bool` **debug/gdscript/warnings/incompatible_ternary** If ``true``, enables warnings when a ternary operator may emit values with incompatible types. +---- + .. _class_ProjectSettings_property_debug/gdscript/warnings/integer_division: - :ref:`bool` **debug/gdscript/warnings/integer_division** If ``true``, enables warnings when dividing an integer by another integer (the decimal part will be discarded). +---- + .. _class_ProjectSettings_property_debug/gdscript/warnings/narrowing_conversion: - :ref:`bool` **debug/gdscript/warnings/narrowing_conversion** If ``true``, enables warnings when passing a floating-point value to a function that expects an integer (it will be converted and lose precision). +---- + .. _class_ProjectSettings_property_debug/gdscript/warnings/property_used_as_function: - :ref:`bool` **debug/gdscript/warnings/property_used_as_function** If ``true``, enables warnings when using a property as if it was a function. +---- + .. _class_ProjectSettings_property_debug/gdscript/warnings/return_value_discarded: - :ref:`bool` **debug/gdscript/warnings/return_value_discarded** If ``true``, enables warnings when calling a function without using its return value (by assigning it to a variable or using it as a function argument). Such return values are sometimes used to denote possible errors using the :ref:`Error` enum. +---- + +.. _class_ProjectSettings_property_debug/gdscript/warnings/shadowed_variable: + +- :ref:`bool` **debug/gdscript/warnings/shadowed_variable** + +---- + .. _class_ProjectSettings_property_debug/gdscript/warnings/standalone_expression: - :ref:`bool` **debug/gdscript/warnings/standalone_expression** If ``true``, enables warnings when calling an expression that has no effect on the surrounding code, such as writing ``2 + 2`` as a statement. +---- + .. _class_ProjectSettings_property_debug/gdscript/warnings/treat_warnings_as_errors: - :ref:`bool` **debug/gdscript/warnings/treat_warnings_as_errors** If ``true``, all warnings will be reported as if they were errors. +---- + .. _class_ProjectSettings_property_debug/gdscript/warnings/unassigned_variable: - :ref:`bool` **debug/gdscript/warnings/unassigned_variable** If ``true``, enables warnings when using a variable that wasn't previously assigned. +---- + .. _class_ProjectSettings_property_debug/gdscript/warnings/unassigned_variable_op_assign: - :ref:`bool` **debug/gdscript/warnings/unassigned_variable_op_assign** If ``true``, enables warnings when assigning a variable using an assignment operator like ``+=`` if the variable wasn't previously assigned. +---- + .. _class_ProjectSettings_property_debug/gdscript/warnings/unreachable_code: - :ref:`bool` **debug/gdscript/warnings/unreachable_code** If ``true``, enables warnings when unreachable code is detected (such as after a ``return`` statement that will always be executed). +---- + .. _class_ProjectSettings_property_debug/gdscript/warnings/unsafe_call_argument: - :ref:`bool` **debug/gdscript/warnings/unsafe_call_argument** If ``true``, enables warnings when using an expression whose type may not be compatible with the function parameter expected. +---- + .. _class_ProjectSettings_property_debug/gdscript/warnings/unsafe_cast: - :ref:`bool` **debug/gdscript/warnings/unsafe_cast** If ``true``, enables warnings when performing an unsafe cast. +---- + .. _class_ProjectSettings_property_debug/gdscript/warnings/unsafe_method_access: - :ref:`bool` **debug/gdscript/warnings/unsafe_method_access** If ``true``, enables warnings when calling a method whose presence is not guaranteed at compile-time in the class. +---- + .. _class_ProjectSettings_property_debug/gdscript/warnings/unsafe_property_access: - :ref:`bool` **debug/gdscript/warnings/unsafe_property_access** If ``true``, enables warnings when accessing a property whose presence is not guaranteed at compile-time in the class. +---- + .. _class_ProjectSettings_property_debug/gdscript/warnings/unused_argument: - :ref:`bool` **debug/gdscript/warnings/unused_argument** If ``true``, enables warnings when a function parameter is unused. +---- + .. _class_ProjectSettings_property_debug/gdscript/warnings/unused_class_variable: - :ref:`bool` **debug/gdscript/warnings/unused_class_variable** If ``true``, enables warnings when a member variable is unused. +---- + .. _class_ProjectSettings_property_debug/gdscript/warnings/unused_signal: - :ref:`bool` **debug/gdscript/warnings/unused_signal** If ``true``, enables warnings when a signal is unused. +---- + .. _class_ProjectSettings_property_debug/gdscript/warnings/unused_variable: - :ref:`bool` **debug/gdscript/warnings/unused_variable** If ``true``, enables warnings when a local variable is unused. +---- + .. _class_ProjectSettings_property_debug/gdscript/warnings/variable_conflicts_function: - :ref:`bool` **debug/gdscript/warnings/variable_conflicts_function** If ``true``, enables warnings when a variable is declared with the same name as a function. This will turn into an error in a future version when first-class functions become supported in GDScript. +---- + .. _class_ProjectSettings_property_debug/gdscript/warnings/void_assignment: - :ref:`bool` **debug/gdscript/warnings/void_assignment** If ``true``, enables warnings when assigning the result of a function that returns ``void`` to a variable. +---- + .. _class_ProjectSettings_property_debug/settings/crash_handler/message: - :ref:`String` **debug/settings/crash_handler/message** Message to be displayed before the backtrace when the engine crashes. +---- + .. _class_ProjectSettings_property_debug/settings/fps/force_fps: - :ref:`int` **debug/settings/fps/force_fps** +---- + .. _class_ProjectSettings_property_debug/settings/gdscript/max_call_stack: - :ref:`int` **debug/settings/gdscript/max_call_stack** Maximum call stack allowed for debugging GDScript. +---- + .. _class_ProjectSettings_property_debug/settings/profiler/max_functions: - :ref:`int` **debug/settings/profiler/max_functions** Maximum amount of functions per frame allowed when profiling. +---- + .. _class_ProjectSettings_property_debug/settings/stdout/print_fps: - :ref:`bool` **debug/settings/stdout/print_fps** Print frames per second to standard output every second. +---- + .. _class_ProjectSettings_property_debug/settings/stdout/verbose_stdout: - :ref:`bool` **debug/settings/stdout/verbose_stdout** Print more information to standard output when running. It displays information such as memory leaks, which scenes and resources are being loaded, etc. +---- + .. _class_ProjectSettings_property_debug/settings/visual_script/max_call_stack: - :ref:`int` **debug/settings/visual_script/max_call_stack** Maximum call stack in visual scripting, to avoid infinite recursion. +---- + .. _class_ProjectSettings_property_display/mouse_cursor/custom_image: - :ref:`String` **display/mouse_cursor/custom_image** Custom image for the mouse cursor (limited to 256x256). +---- + .. _class_ProjectSettings_property_display/mouse_cursor/custom_image_hotspot: - :ref:`Vector2` **display/mouse_cursor/custom_image_hotspot** Hotspot for the custom mouse cursor image. +---- + .. _class_ProjectSettings_property_display/mouse_cursor/tooltip_position_offset: - :ref:`Vector2` **display/mouse_cursor/tooltip_position_offset** Position offset for tooltips, relative to the mouse cursor's hotspot. +---- + .. _class_ProjectSettings_property_display/window/dpi/allow_hidpi: - :ref:`bool` **display/window/dpi/allow_hidpi** If ``true``, allows HiDPI display on Windows and macOS. This setting has no effect on desktop Linux, as DPI-awareness fallbacks are not supported there. +---- + .. _class_ProjectSettings_property_display/window/energy_saving/keep_screen_on: - :ref:`bool` **display/window/energy_saving/keep_screen_on** If ``true``, keeps the screen on (even in case of inactivity), so the screensaver does not take over. Works on desktop and mobile platforms. +---- + .. _class_ProjectSettings_property_display/window/handheld/orientation: - :ref:`String` **display/window/handheld/orientation** Default orientation on mobile devices. +---- + .. _class_ProjectSettings_property_display/window/per_pixel_transparency/allowed: - :ref:`bool` **display/window/per_pixel_transparency/allowed** If ``true``, allows per-pixel transparency in a desktop window. This affects performance if not needed, so leave it on ``false`` unless you need it. +---- + .. _class_ProjectSettings_property_display/window/per_pixel_transparency/enabled: - :ref:`bool` **display/window/per_pixel_transparency/enabled** +---- + .. _class_ProjectSettings_property_display/window/per_pixel_transparency/splash: - :ref:`bool` **display/window/per_pixel_transparency/splash** +---- + .. _class_ProjectSettings_property_display/window/size/always_on_top: - :ref:`bool` **display/window/size/always_on_top** Force the window to be always on top. +---- + .. _class_ProjectSettings_property_display/window/size/borderless: - :ref:`bool` **display/window/size/borderless** Force the window to be borderless. +---- + .. _class_ProjectSettings_property_display/window/size/fullscreen: - :ref:`bool` **display/window/size/fullscreen** Set the window to full screen when it starts. +---- + .. _class_ProjectSettings_property_display/window/size/height: - :ref:`int` **display/window/size/height** Set the main window height. On desktop, this is the default window size. Stretch mode settings use this also as a reference when enabled. +---- + .. _class_ProjectSettings_property_display/window/size/resizable: - :ref:`bool` **display/window/size/resizable** Allows the window to be resizable by default. +---- + .. _class_ProjectSettings_property_display/window/size/test_height: - :ref:`int` **display/window/size/test_height** If greater than zero, uses a different height for the window when running from the editor. The main use for this is to test with stretch modes. +---- + .. _class_ProjectSettings_property_display/window/size/test_width: - :ref:`int` **display/window/size/test_width** If greater than zero, uses a different width for the window when running from the editor. The main use for this is to test with stretch modes. +---- + .. _class_ProjectSettings_property_display/window/size/width: - :ref:`int` **display/window/size/width** Sets the main window width. On desktop platforms, this is the default window size. Stretch mode settings use this also as a reference when enabled. +---- + .. _class_ProjectSettings_property_display/window/vsync/use_vsync: - :ref:`bool` **display/window/vsync/use_vsync** If ``true``, enables vertical synchronization. This eliminates tearing that may appear in moving scenes, at the cost of higher input latency and stuttering at lower framerates. If ``false``, vertical synchronization will be disabled, however, many platforms will enforce it regardless (such as mobile platforms and HTML5). +---- + .. _class_ProjectSettings_property_editor/active: - :ref:`bool` **editor/active** Internal editor setting, don't touch. +---- + .. _class_ProjectSettings_property_gui/common/default_scroll_deadzone: - :ref:`int` **gui/common/default_scroll_deadzone** +---- + .. _class_ProjectSettings_property_gui/common/swap_ok_cancel: - :ref:`bool` **gui/common/swap_ok_cancel** If ``true``, swaps OK and Cancel buttons in dialogs on Windows and UWP to follow interface conventions. +---- + .. _class_ProjectSettings_property_gui/theme/custom: - :ref:`String` **gui/theme/custom** Use a custom theme resource, set a path to it here. +---- + .. _class_ProjectSettings_property_gui/theme/custom_font: - :ref:`String` **gui/theme/custom_font** Use a custom default font resource, set a path to it here. +---- + .. _class_ProjectSettings_property_gui/theme/use_hidpi: - :ref:`bool` **gui/theme/use_hidpi** If ``true``, makes sure the theme used works with HiDPI. +---- + .. _class_ProjectSettings_property_gui/timers/incremental_search_max_interval_msec: - :ref:`int` **gui/timers/incremental_search_max_interval_msec** Timer setting for incremental search in Tree, IntemList, etc. controls (in milliseconds). +---- + .. _class_ProjectSettings_property_gui/timers/text_edit_idle_detect_sec: - :ref:`float` **gui/timers/text_edit_idle_detect_sec** Timer for detecting idle in the editor (in seconds). +---- + .. _class_ProjectSettings_property_input/ui_accept: - :ref:`Dictionary` **input/ui_accept** +---- + .. _class_ProjectSettings_property_input/ui_cancel: - :ref:`Dictionary` **input/ui_cancel** +---- + .. _class_ProjectSettings_property_input/ui_down: - :ref:`Dictionary` **input/ui_down** +---- + .. _class_ProjectSettings_property_input/ui_end: - :ref:`Dictionary` **input/ui_end** +---- + .. _class_ProjectSettings_property_input/ui_focus_next: - :ref:`Dictionary` **input/ui_focus_next** +---- + .. _class_ProjectSettings_property_input/ui_focus_prev: - :ref:`Dictionary` **input/ui_focus_prev** +---- + .. _class_ProjectSettings_property_input/ui_home: - :ref:`Dictionary` **input/ui_home** +---- + .. _class_ProjectSettings_property_input/ui_left: - :ref:`Dictionary` **input/ui_left** +---- + .. _class_ProjectSettings_property_input/ui_page_down: - :ref:`Dictionary` **input/ui_page_down** +---- + .. _class_ProjectSettings_property_input/ui_page_up: - :ref:`Dictionary` **input/ui_page_up** +---- + .. _class_ProjectSettings_property_input/ui_right: - :ref:`Dictionary` **input/ui_right** +---- + .. _class_ProjectSettings_property_input/ui_select: - :ref:`Dictionary` **input/ui_select** +---- + .. _class_ProjectSettings_property_input/ui_up: - :ref:`Dictionary` **input/ui_up** +---- + .. _class_ProjectSettings_property_input_devices/pointing/emulate_mouse_from_touch: - :ref:`bool` **input_devices/pointing/emulate_mouse_from_touch** If ``true``, sends mouse input events when tapping or swiping on the touchscreen. +---- + .. _class_ProjectSettings_property_input_devices/pointing/emulate_touch_from_mouse: - :ref:`bool` **input_devices/pointing/emulate_touch_from_mouse** If ``true``, sends touch input events when clicking or dragging the mouse. +---- + .. _class_ProjectSettings_property_layer_names/2d_physics/layer_1: - :ref:`String` **layer_names/2d_physics/layer_1** +---- + .. _class_ProjectSettings_property_layer_names/2d_physics/layer_10: - :ref:`String` **layer_names/2d_physics/layer_10** +---- + .. _class_ProjectSettings_property_layer_names/2d_physics/layer_11: - :ref:`String` **layer_names/2d_physics/layer_11** +---- + .. _class_ProjectSettings_property_layer_names/2d_physics/layer_12: - :ref:`String` **layer_names/2d_physics/layer_12** +---- + .. _class_ProjectSettings_property_layer_names/2d_physics/layer_13: - :ref:`String` **layer_names/2d_physics/layer_13** +---- + .. _class_ProjectSettings_property_layer_names/2d_physics/layer_14: - :ref:`String` **layer_names/2d_physics/layer_14** +---- + .. _class_ProjectSettings_property_layer_names/2d_physics/layer_15: - :ref:`String` **layer_names/2d_physics/layer_15** +---- + .. _class_ProjectSettings_property_layer_names/2d_physics/layer_16: - :ref:`String` **layer_names/2d_physics/layer_16** +---- + .. _class_ProjectSettings_property_layer_names/2d_physics/layer_17: - :ref:`String` **layer_names/2d_physics/layer_17** +---- + .. _class_ProjectSettings_property_layer_names/2d_physics/layer_18: - :ref:`String` **layer_names/2d_physics/layer_18** +---- + .. _class_ProjectSettings_property_layer_names/2d_physics/layer_19: - :ref:`String` **layer_names/2d_physics/layer_19** +---- + .. _class_ProjectSettings_property_layer_names/2d_physics/layer_2: - :ref:`String` **layer_names/2d_physics/layer_2** +---- + .. _class_ProjectSettings_property_layer_names/2d_physics/layer_20: - :ref:`String` **layer_names/2d_physics/layer_20** +---- + .. _class_ProjectSettings_property_layer_names/2d_physics/layer_3: - :ref:`String` **layer_names/2d_physics/layer_3** +---- + .. _class_ProjectSettings_property_layer_names/2d_physics/layer_4: - :ref:`String` **layer_names/2d_physics/layer_4** +---- + .. _class_ProjectSettings_property_layer_names/2d_physics/layer_5: - :ref:`String` **layer_names/2d_physics/layer_5** +---- + .. _class_ProjectSettings_property_layer_names/2d_physics/layer_6: - :ref:`String` **layer_names/2d_physics/layer_6** +---- + .. _class_ProjectSettings_property_layer_names/2d_physics/layer_7: - :ref:`String` **layer_names/2d_physics/layer_7** +---- + .. _class_ProjectSettings_property_layer_names/2d_physics/layer_8: - :ref:`String` **layer_names/2d_physics/layer_8** +---- + .. _class_ProjectSettings_property_layer_names/2d_physics/layer_9: - :ref:`String` **layer_names/2d_physics/layer_9** +---- + .. _class_ProjectSettings_property_layer_names/2d_render/layer_1: - :ref:`String` **layer_names/2d_render/layer_1** +---- + .. _class_ProjectSettings_property_layer_names/2d_render/layer_10: - :ref:`String` **layer_names/2d_render/layer_10** +---- + .. _class_ProjectSettings_property_layer_names/2d_render/layer_11: - :ref:`String` **layer_names/2d_render/layer_11** +---- + .. _class_ProjectSettings_property_layer_names/2d_render/layer_12: - :ref:`String` **layer_names/2d_render/layer_12** +---- + .. _class_ProjectSettings_property_layer_names/2d_render/layer_13: - :ref:`String` **layer_names/2d_render/layer_13** +---- + .. _class_ProjectSettings_property_layer_names/2d_render/layer_14: - :ref:`String` **layer_names/2d_render/layer_14** +---- + .. _class_ProjectSettings_property_layer_names/2d_render/layer_15: - :ref:`String` **layer_names/2d_render/layer_15** +---- + .. _class_ProjectSettings_property_layer_names/2d_render/layer_16: - :ref:`String` **layer_names/2d_render/layer_16** +---- + .. _class_ProjectSettings_property_layer_names/2d_render/layer_17: - :ref:`String` **layer_names/2d_render/layer_17** +---- + .. _class_ProjectSettings_property_layer_names/2d_render/layer_18: - :ref:`String` **layer_names/2d_render/layer_18** +---- + .. _class_ProjectSettings_property_layer_names/2d_render/layer_19: - :ref:`String` **layer_names/2d_render/layer_19** +---- + .. _class_ProjectSettings_property_layer_names/2d_render/layer_2: - :ref:`String` **layer_names/2d_render/layer_2** +---- + .. _class_ProjectSettings_property_layer_names/2d_render/layer_20: - :ref:`String` **layer_names/2d_render/layer_20** +---- + .. _class_ProjectSettings_property_layer_names/2d_render/layer_3: - :ref:`String` **layer_names/2d_render/layer_3** +---- + .. _class_ProjectSettings_property_layer_names/2d_render/layer_4: - :ref:`String` **layer_names/2d_render/layer_4** +---- + .. _class_ProjectSettings_property_layer_names/2d_render/layer_5: - :ref:`String` **layer_names/2d_render/layer_5** +---- + .. _class_ProjectSettings_property_layer_names/2d_render/layer_6: - :ref:`String` **layer_names/2d_render/layer_6** +---- + .. _class_ProjectSettings_property_layer_names/2d_render/layer_7: - :ref:`String` **layer_names/2d_render/layer_7** +---- + .. _class_ProjectSettings_property_layer_names/2d_render/layer_8: - :ref:`String` **layer_names/2d_render/layer_8** +---- + .. _class_ProjectSettings_property_layer_names/2d_render/layer_9: - :ref:`String` **layer_names/2d_render/layer_9** +---- + .. _class_ProjectSettings_property_layer_names/3d_physics/layer_1: - :ref:`String` **layer_names/3d_physics/layer_1** +---- + .. _class_ProjectSettings_property_layer_names/3d_physics/layer_10: - :ref:`String` **layer_names/3d_physics/layer_10** +---- + .. _class_ProjectSettings_property_layer_names/3d_physics/layer_11: - :ref:`String` **layer_names/3d_physics/layer_11** +---- + .. _class_ProjectSettings_property_layer_names/3d_physics/layer_12: - :ref:`String` **layer_names/3d_physics/layer_12** +---- + .. _class_ProjectSettings_property_layer_names/3d_physics/layer_13: - :ref:`String` **layer_names/3d_physics/layer_13** +---- + .. _class_ProjectSettings_property_layer_names/3d_physics/layer_14: - :ref:`String` **layer_names/3d_physics/layer_14** +---- + .. _class_ProjectSettings_property_layer_names/3d_physics/layer_15: - :ref:`String` **layer_names/3d_physics/layer_15** +---- + .. _class_ProjectSettings_property_layer_names/3d_physics/layer_16: - :ref:`String` **layer_names/3d_physics/layer_16** +---- + .. _class_ProjectSettings_property_layer_names/3d_physics/layer_17: - :ref:`String` **layer_names/3d_physics/layer_17** +---- + .. _class_ProjectSettings_property_layer_names/3d_physics/layer_18: - :ref:`String` **layer_names/3d_physics/layer_18** +---- + .. _class_ProjectSettings_property_layer_names/3d_physics/layer_19: - :ref:`String` **layer_names/3d_physics/layer_19** +---- + .. _class_ProjectSettings_property_layer_names/3d_physics/layer_2: - :ref:`String` **layer_names/3d_physics/layer_2** +---- + .. _class_ProjectSettings_property_layer_names/3d_physics/layer_20: - :ref:`String` **layer_names/3d_physics/layer_20** +---- + .. _class_ProjectSettings_property_layer_names/3d_physics/layer_3: - :ref:`String` **layer_names/3d_physics/layer_3** +---- + .. _class_ProjectSettings_property_layer_names/3d_physics/layer_4: - :ref:`String` **layer_names/3d_physics/layer_4** +---- + .. _class_ProjectSettings_property_layer_names/3d_physics/layer_5: - :ref:`String` **layer_names/3d_physics/layer_5** +---- + .. _class_ProjectSettings_property_layer_names/3d_physics/layer_6: - :ref:`String` **layer_names/3d_physics/layer_6** +---- + .. _class_ProjectSettings_property_layer_names/3d_physics/layer_7: - :ref:`String` **layer_names/3d_physics/layer_7** +---- + .. _class_ProjectSettings_property_layer_names/3d_physics/layer_8: - :ref:`String` **layer_names/3d_physics/layer_8** +---- + .. _class_ProjectSettings_property_layer_names/3d_physics/layer_9: - :ref:`String` **layer_names/3d_physics/layer_9** +---- + .. _class_ProjectSettings_property_layer_names/3d_render/layer_1: - :ref:`String` **layer_names/3d_render/layer_1** +---- + .. _class_ProjectSettings_property_layer_names/3d_render/layer_10: - :ref:`String` **layer_names/3d_render/layer_10** +---- + .. _class_ProjectSettings_property_layer_names/3d_render/layer_11: - :ref:`String` **layer_names/3d_render/layer_11** +---- + .. _class_ProjectSettings_property_layer_names/3d_render/layer_12: - :ref:`String` **layer_names/3d_render/layer_12** +---- + .. _class_ProjectSettings_property_layer_names/3d_render/layer_13: - :ref:`String` **layer_names/3d_render/layer_13** +---- + .. _class_ProjectSettings_property_layer_names/3d_render/layer_14: - :ref:`String` **layer_names/3d_render/layer_14** +---- + .. _class_ProjectSettings_property_layer_names/3d_render/layer_15: - :ref:`String` **layer_names/3d_render/layer_15** +---- + .. _class_ProjectSettings_property_layer_names/3d_render/layer_16: - :ref:`String` **layer_names/3d_render/layer_16** +---- + .. _class_ProjectSettings_property_layer_names/3d_render/layer_17: - :ref:`String` **layer_names/3d_render/layer_17** +---- + .. _class_ProjectSettings_property_layer_names/3d_render/layer_18: - :ref:`String` **layer_names/3d_render/layer_18** +---- + .. _class_ProjectSettings_property_layer_names/3d_render/layer_19: - :ref:`String` **layer_names/3d_render/layer_19** +---- + .. _class_ProjectSettings_property_layer_names/3d_render/layer_2: - :ref:`String` **layer_names/3d_render/layer_2** +---- + .. _class_ProjectSettings_property_layer_names/3d_render/layer_20: - :ref:`String` **layer_names/3d_render/layer_20** +---- + .. _class_ProjectSettings_property_layer_names/3d_render/layer_3: - :ref:`String` **layer_names/3d_render/layer_3** +---- + .. _class_ProjectSettings_property_layer_names/3d_render/layer_4: - :ref:`String` **layer_names/3d_render/layer_4** +---- + .. _class_ProjectSettings_property_layer_names/3d_render/layer_5: - :ref:`String` **layer_names/3d_render/layer_5** +---- + .. _class_ProjectSettings_property_layer_names/3d_render/layer_6: - :ref:`String` **layer_names/3d_render/layer_6** +---- + .. _class_ProjectSettings_property_layer_names/3d_render/layer_7: - :ref:`String` **layer_names/3d_render/layer_7** +---- + .. _class_ProjectSettings_property_layer_names/3d_render/layer_8: - :ref:`String` **layer_names/3d_render/layer_8** +---- + .. _class_ProjectSettings_property_layer_names/3d_render/layer_9: - :ref:`String` **layer_names/3d_render/layer_9** +---- + .. _class_ProjectSettings_property_locale/fallback: - :ref:`String` **locale/fallback** The locale to fall back to if a translation isn't available in a given language. If left empty, ``en`` (English) will be used. +---- + .. _class_ProjectSettings_property_locale/test: - :ref:`String` **locale/test** If non-empty, this locale will be used when running the project from the editor. +---- + .. _class_ProjectSettings_property_logging/file_logging/enable_file_logging: - :ref:`bool` **logging/file_logging/enable_file_logging** If ``true``, logs all output to files. +---- + .. _class_ProjectSettings_property_logging/file_logging/log_path: - :ref:`String` **logging/file_logging/log_path** Path to logs within the project. Using an ``user://`` path is recommended. +---- + .. _class_ProjectSettings_property_logging/file_logging/max_log_files: - :ref:`int` **logging/file_logging/max_log_files** Specifies the maximum amount of log files allowed (used for rotation). +---- + .. _class_ProjectSettings_property_memory/limits/message_queue/max_size_kb: - :ref:`int` **memory/limits/message_queue/max_size_kb** Godot uses a message queue to defer some function calls. If you run out of space on it (you will see an error), you can increase the size here. +---- + .. _class_ProjectSettings_property_memory/limits/multithreaded_server/rid_pool_prealloc: - :ref:`int` **memory/limits/multithreaded_server/rid_pool_prealloc** This is used by servers when used in multi-threading mode (servers and visual). RIDs are preallocated to avoid stalling the server requesting them on threads. If servers get stalled too often when loading resources in a thread, increase this number. +---- + .. _class_ProjectSettings_property_network/limits/debugger_stdout/max_chars_per_second: - :ref:`int` **network/limits/debugger_stdout/max_chars_per_second** Maximum amount of characters allowed to send as output from the debugger. Over this value, content is dropped. This helps not to stall the debugger connection. +---- + .. _class_ProjectSettings_property_network/limits/debugger_stdout/max_errors_per_frame: - :ref:`int` **network/limits/debugger_stdout/max_errors_per_frame** Maximum amount of errors allowed to send as output from the debugger. Over this value, content is dropped. This helps not to stall the debugger connection. +---- + .. _class_ProjectSettings_property_network/limits/debugger_stdout/max_messages_per_frame: - :ref:`int` **network/limits/debugger_stdout/max_messages_per_frame** Maximum amount of messages allowed to send as output from the debugger. Over this value, content is dropped. This helps not to stall the debugger connection. +---- + .. _class_ProjectSettings_property_network/limits/packet_peer_stream/max_buffer_po2: - :ref:`int` **network/limits/packet_peer_stream/max_buffer_po2** Default size of packet peer stream for deserializing Godot data. Over this size, data is dropped. +---- + .. _class_ProjectSettings_property_network/limits/websocket_client/max_in_buffer_kb: - :ref:`int` **network/limits/websocket_client/max_in_buffer_kb** +---- + .. _class_ProjectSettings_property_network/limits/websocket_client/max_in_packets: - :ref:`int` **network/limits/websocket_client/max_in_packets** +---- + .. _class_ProjectSettings_property_network/limits/websocket_client/max_out_buffer_kb: - :ref:`int` **network/limits/websocket_client/max_out_buffer_kb** +---- + .. _class_ProjectSettings_property_network/limits/websocket_client/max_out_packets: - :ref:`int` **network/limits/websocket_client/max_out_packets** +---- + .. _class_ProjectSettings_property_network/limits/websocket_server/max_in_buffer_kb: - :ref:`int` **network/limits/websocket_server/max_in_buffer_kb** +---- + .. _class_ProjectSettings_property_network/limits/websocket_server/max_in_packets: - :ref:`int` **network/limits/websocket_server/max_in_packets** +---- + .. _class_ProjectSettings_property_network/limits/websocket_server/max_out_buffer_kb: - :ref:`int` **network/limits/websocket_server/max_out_buffer_kb** +---- + .. _class_ProjectSettings_property_network/limits/websocket_server/max_out_packets: - :ref:`int` **network/limits/websocket_server/max_out_packets** +---- + .. _class_ProjectSettings_property_network/remote_fs/page_read_ahead: - :ref:`int` **network/remote_fs/page_read_ahead** Amount of read ahead used by remote filesystem. Higher values decrease the effects of latency at the cost of higher bandwidth usage. +---- + .. _class_ProjectSettings_property_network/remote_fs/page_size: - :ref:`int` **network/remote_fs/page_size** Page size used by remote filesystem (in bytes). +---- + .. _class_ProjectSettings_property_node/name_casing: - :ref:`int` **node/name_casing** When creating node names automatically, set the type of casing in this project. This is mostly an editor setting. +---- + .. _class_ProjectSettings_property_node/name_num_separator: - :ref:`int` **node/name_num_separator** What to use to separate node name from number. This is mostly an editor setting. +---- + .. _class_ProjectSettings_property_physics/2d/physics_engine: - :ref:`String` **physics/2d/physics_engine** +---- + .. _class_ProjectSettings_property_physics/2d/thread_model: - :ref:`int` **physics/2d/thread_model** Sets whether physics is run on the main thread or a separate one. Running the server on a thread increases performance, but restricts API access to only physics process. +---- + .. _class_ProjectSettings_property_physics/3d/active_soft_world: - :ref:`bool` **physics/3d/active_soft_world** +---- + .. _class_ProjectSettings_property_physics/3d/physics_engine: - :ref:`String` **physics/3d/physics_engine** Sets which physics engine to use. +---- + .. _class_ProjectSettings_property_physics/common/physics_fps: - :ref:`int` **physics/common/physics_fps** Frames per second used in the physics. Physics always needs a fixed amount of frames per second. +---- + .. _class_ProjectSettings_property_physics/common/physics_jitter_fix: - :ref:`float` **physics/common/physics_jitter_fix** Fix to improve physics jitter, specially on monitors where refresh rate is different than the physics FPS. +---- + .. _class_ProjectSettings_property_rendering/environment/default_clear_color: - :ref:`Color` **rendering/environment/default_clear_color** Default background clear color. Overriddable per :ref:`Viewport` using its :ref:`Environment`. See :ref:`Environment.background_mode` and :ref:`Environment.background_color` in particular. To change this default color programmatically, use :ref:`VisualServer.set_default_clear_color`. +---- + .. _class_ProjectSettings_property_rendering/limits/buffers/blend_shape_max_buffer_size_kb: - :ref:`int` **rendering/limits/buffers/blend_shape_max_buffer_size_kb** Max buffer size for blend shapes. Any blend shape bigger than this will not work. +---- + .. _class_ProjectSettings_property_rendering/limits/buffers/canvas_polygon_buffer_size_kb: - :ref:`int` **rendering/limits/buffers/canvas_polygon_buffer_size_kb** Max buffer size for drawing polygons. Any polygon bigger than this will not work. +---- + .. _class_ProjectSettings_property_rendering/limits/buffers/canvas_polygon_index_buffer_size_kb: - :ref:`int` **rendering/limits/buffers/canvas_polygon_index_buffer_size_kb** Max index buffer size for drawing polygons. Any polygon bigger than this will not work. +---- + .. _class_ProjectSettings_property_rendering/limits/buffers/immediate_buffer_size_kb: - :ref:`int` **rendering/limits/buffers/immediate_buffer_size_kb** Max buffer size for drawing immediate objects (ImmediateGeometry nodes). Nodes using more than this size will not work. +---- + .. _class_ProjectSettings_property_rendering/limits/rendering/max_renderable_elements: - :ref:`int` **rendering/limits/rendering/max_renderable_elements** Max amount of elements renderable in a frame. If more than this are visible per frame, they will be dropped. Keep in mind elements refer to mesh surfaces and not meshes themselves. +---- + +.. _class_ProjectSettings_property_rendering/limits/rendering/max_renderable_lights: + +- :ref:`int` **rendering/limits/rendering/max_renderable_lights** + +Max number of lights renderable in a frame. If more than this number are used, they will be ignored. On some systems (particularly web) setting this number as low as possible can increase the speed of shader compilation. + +---- + +.. _class_ProjectSettings_property_rendering/limits/rendering/max_renderable_reflections: + +- :ref:`int` **rendering/limits/rendering/max_renderable_reflections** + +Max number of reflection probes renderable in a frame. If more than this number are used, they will be ignored. On some systems (particularly web) setting this number as low as possible can increase the speed of shader compilation. + +---- + .. _class_ProjectSettings_property_rendering/limits/time/time_rollover_secs: - :ref:`float` **rendering/limits/time/time_rollover_secs** Shaders have a time variable that constantly increases. At some point, it needs to be rolled back to zero to avoid precision errors on shader animations. This setting specifies when (in seconds). +---- + .. _class_ProjectSettings_property_rendering/quality/2d/gles2_use_nvidia_rect_flicker_workaround: - :ref:`bool` **rendering/quality/2d/gles2_use_nvidia_rect_flicker_workaround** @@ -1696,34 +2170,46 @@ Some NVIDIA GPU drivers have a bug which produces flickering issues for the ``dr If ``true``, this option enables a "safe" code path for such NVIDIA GPUs at the cost of performance. This option only impacts the GLES2 rendering backend (so the bug stays if you use GLES3), and only desktop platforms. +---- + .. _class_ProjectSettings_property_rendering/quality/2d/use_pixel_snap: - :ref:`bool` **rendering/quality/2d/use_pixel_snap** If ``true``, forces snapping of polygons to pixels in 2D rendering. May help in some pixel art styles. +---- + .. _class_ProjectSettings_property_rendering/quality/depth_prepass/disable_for_vendors: - :ref:`String` **rendering/quality/depth_prepass/disable_for_vendors** Disable depth pre-pass for some GPU vendors (usually mobile), as their architecture already does this. +---- + .. _class_ProjectSettings_property_rendering/quality/depth_prepass/enable: - :ref:`bool` **rendering/quality/depth_prepass/enable** If ``true``, performs a previous depth pass before rendering materials. This increases performance in scenes with high overdraw, when complex materials and lighting are used. +---- + .. _class_ProjectSettings_property_rendering/quality/directional_shadow/size: - :ref:`int` **rendering/quality/directional_shadow/size** The directional shadow's size in pixels. Higher values will result in sharper shadows, at the cost of performance. +---- + .. _class_ProjectSettings_property_rendering/quality/directional_shadow/size.mobile: - :ref:`int` **rendering/quality/directional_shadow/size.mobile** +---- + .. _class_ProjectSettings_property_rendering/quality/driver/driver_name: - :ref:`String` **rendering/quality/driver/driver_name** @@ -1732,6 +2218,8 @@ The video driver to use ("GLES2" or "GLES3"). Note that the backend in use can be overridden at runtime via the ``--video-driver`` command line argument, or by the :ref:`rendering/quality/driver/fallback_to_gles2` option if the target system does not support GLES3 and falls back to GLES2. In such cases, this property is not updated, so use :ref:`OS.get_current_video_driver` to query it at run-time. +---- + .. _class_ProjectSettings_property_rendering/quality/driver/fallback_to_gles2: - :ref:`bool` **rendering/quality/driver/fallback_to_gles2** @@ -1740,186 +2228,254 @@ If ``true``, allows falling back to the GLES2 driver if the GLES3 driver is not Note that the two video drivers are not drop-in replacements for each other, so a game designed for GLES3 might not work properly when falling back to GLES2. In particular, some features of the GLES3 backend are not available in GLES2. Enabling this setting also means that both ETC and ETC2 VRAM-compressed textures will be exported on Android and iOS, increasing the data pack's size. +---- + .. _class_ProjectSettings_property_rendering/quality/filters/anisotropic_filter_level: - :ref:`int` **rendering/quality/filters/anisotropic_filter_level** Maximum anisotropic filter level used for textures with anisotropy enabled. Higher values will result in sharper textures when viewed from oblique angles, at the cost of performance. Only power-of-two values are valid (2, 4, 8, 16). +---- + .. _class_ProjectSettings_property_rendering/quality/filters/use_nearest_mipmap_filter: - :ref:`bool` **rendering/quality/filters/use_nearest_mipmap_filter** If ``true``, uses nearest-neighbor mipmap filtering when using mipmaps (also called "bilinear filtering"), which will result in visible seams appearing between mipmap stages. This may increase performance in mobile as less memory bandwidth is used. If ``false``, linear mipmap filtering (also called "trilinear filtering") is used. +---- + .. _class_ProjectSettings_property_rendering/quality/intended_usage/framebuffer_allocation: - :ref:`int` **rendering/quality/intended_usage/framebuffer_allocation** Strategy used for framebuffer allocation. The simpler it is, the less resources it uses (but the less features it supports). +---- + .. _class_ProjectSettings_property_rendering/quality/intended_usage/framebuffer_allocation.mobile: - :ref:`int` **rendering/quality/intended_usage/framebuffer_allocation.mobile** +---- + .. _class_ProjectSettings_property_rendering/quality/reflections/high_quality_ggx: - :ref:`bool` **rendering/quality/reflections/high_quality_ggx** If ``true``, uses a high amount of samples to create blurred variants of reflection probes and panorama backgrounds (sky). Those blurred variants are used by rough materials. +---- + .. _class_ProjectSettings_property_rendering/quality/reflections/high_quality_ggx.mobile: - :ref:`bool` **rendering/quality/reflections/high_quality_ggx.mobile** +---- + .. _class_ProjectSettings_property_rendering/quality/reflections/texture_array_reflections: - :ref:`bool` **rendering/quality/reflections/texture_array_reflections** If ``true``, uses texture arrays instead of mipmaps for reflection probes and panorama backgrounds (sky). This reduces jitter noise on reflections, but costs more performance and memory. +---- + .. _class_ProjectSettings_property_rendering/quality/reflections/texture_array_reflections.mobile: - :ref:`bool` **rendering/quality/reflections/texture_array_reflections.mobile** +---- + .. _class_ProjectSettings_property_rendering/quality/shading/force_blinn_over_ggx: - :ref:`bool` **rendering/quality/shading/force_blinn_over_ggx** If ``true``, uses faster but lower-quality Blinn model to generate blurred reflections instead of the GGX model. +---- + .. _class_ProjectSettings_property_rendering/quality/shading/force_blinn_over_ggx.mobile: - :ref:`bool` **rendering/quality/shading/force_blinn_over_ggx.mobile** +---- + .. _class_ProjectSettings_property_rendering/quality/shading/force_lambert_over_burley: - :ref:`bool` **rendering/quality/shading/force_lambert_over_burley** If ``true``, uses faster but lower-quality Lambert material lighting model instead of Burley. +---- + .. _class_ProjectSettings_property_rendering/quality/shading/force_lambert_over_burley.mobile: - :ref:`bool` **rendering/quality/shading/force_lambert_over_burley.mobile** +---- + .. _class_ProjectSettings_property_rendering/quality/shading/force_vertex_shading: - :ref:`bool` **rendering/quality/shading/force_vertex_shading** If ``true``, forces vertex shading for all rendering. This can increase performance a lot, but also reduces quality immensely. Can be used to optimize performance on low-end mobile devices. +---- + .. _class_ProjectSettings_property_rendering/quality/shading/force_vertex_shading.mobile: - :ref:`bool` **rendering/quality/shading/force_vertex_shading.mobile** +---- + .. _class_ProjectSettings_property_rendering/quality/shadow_atlas/quadrant_0_subdiv: - :ref:`int` **rendering/quality/shadow_atlas/quadrant_0_subdiv** Subdivision quadrant size for shadow mapping. See shadow mapping documentation. +---- + .. _class_ProjectSettings_property_rendering/quality/shadow_atlas/quadrant_1_subdiv: - :ref:`int` **rendering/quality/shadow_atlas/quadrant_1_subdiv** Subdivision quadrant size for shadow mapping. See shadow mapping documentation. +---- + .. _class_ProjectSettings_property_rendering/quality/shadow_atlas/quadrant_2_subdiv: - :ref:`int` **rendering/quality/shadow_atlas/quadrant_2_subdiv** Subdivision quadrant size for shadow mapping. See shadow mapping documentation. +---- + .. _class_ProjectSettings_property_rendering/quality/shadow_atlas/quadrant_3_subdiv: - :ref:`int` **rendering/quality/shadow_atlas/quadrant_3_subdiv** Subdivision quadrant size for shadow mapping. See shadow mapping documentation. +---- + .. _class_ProjectSettings_property_rendering/quality/shadow_atlas/size: - :ref:`int` **rendering/quality/shadow_atlas/size** Size for shadow atlas (used for OmniLights and SpotLights). See documentation. +---- + .. _class_ProjectSettings_property_rendering/quality/shadow_atlas/size.mobile: - :ref:`int` **rendering/quality/shadow_atlas/size.mobile** +---- + .. _class_ProjectSettings_property_rendering/quality/shadows/filter_mode: - :ref:`int` **rendering/quality/shadows/filter_mode** Shadow filter mode. Higher-quality settings result in smoother shadows that flicker less when moving. "Disabled" is the fastest option, but also has the lowest quality. "PCF5" is smoother but is also slower. "PCF13" is the smoothest option, but is also the slowest. +---- + .. _class_ProjectSettings_property_rendering/quality/shadows/filter_mode.mobile: - :ref:`int` **rendering/quality/shadows/filter_mode.mobile** +---- + .. _class_ProjectSettings_property_rendering/quality/subsurface_scattering/follow_surface: - :ref:`bool` **rendering/quality/subsurface_scattering/follow_surface** Improves quality of subsurface scattering, but cost significantly increases. +---- + .. _class_ProjectSettings_property_rendering/quality/subsurface_scattering/quality: - :ref:`int` **rendering/quality/subsurface_scattering/quality** Quality setting for subsurface scaterring (samples taken). +---- + .. _class_ProjectSettings_property_rendering/quality/subsurface_scattering/scale: - :ref:`int` **rendering/quality/subsurface_scattering/scale** +---- + .. _class_ProjectSettings_property_rendering/quality/subsurface_scattering/weight_samples: - :ref:`bool` **rendering/quality/subsurface_scattering/weight_samples** Weight subsurface scattering samples. Helps to avoid reading samples from unrelated parts of the screen. +---- + .. _class_ProjectSettings_property_rendering/quality/voxel_cone_tracing/high_quality: - :ref:`bool` **rendering/quality/voxel_cone_tracing/high_quality** Use high-quality voxel cone tracing. This results in better-looking reflections, but is much more expensive on the GPU. +---- + .. _class_ProjectSettings_property_rendering/threads/thread_model: - :ref:`int` **rendering/threads/thread_model** Thread model for rendering. Rendering on a thread can vastly improve performance, but synchronizing to the main thread can cause a bit more jitter. +---- + .. _class_ProjectSettings_property_rendering/vram_compression/import_bptc: - :ref:`bool` **rendering/vram_compression/import_bptc** If ``true``, the texture importer will import VRAM-compressed textures using the BPTC algorithm. This texture compression algorithm is only supported on desktop platforms, and only when using the GLES3 renderer. +---- + .. _class_ProjectSettings_property_rendering/vram_compression/import_etc: - :ref:`bool` **rendering/vram_compression/import_etc** If ``true``, the texture importer will import VRAM-compressed textures using the Ericsson Texture Compression algorithm. This algorithm doesn't support alpha channels in textures. +---- + .. _class_ProjectSettings_property_rendering/vram_compression/import_etc2: - :ref:`bool` **rendering/vram_compression/import_etc2** If ``true``, the texture importer will import VRAM-compressed textures using the Ericsson Texture Compression 2 algorithm. This texture compression algorithm is only supported when using the GLES3 renderer. +---- + .. _class_ProjectSettings_property_rendering/vram_compression/import_pvrtc: - :ref:`bool` **rendering/vram_compression/import_pvrtc** If ``true``, the texture importer will import VRAM-compressed textures using the PowerVR Texture Compression algorithm. This texture compression algorithm is only supported on iOS. +---- + .. _class_ProjectSettings_property_rendering/vram_compression/import_s3tc: - :ref:`bool` **rendering/vram_compression/import_s3tc** If ``true``, the texture importer will import VRAM-compressed textures using the S3 Texture Compression algorithm. This algorithm is only supported on desktop platforms and consoles. +---- + .. _class_ProjectSettings_property_script: - :ref:`Script` **script** @@ -1948,34 +2504,46 @@ Example: ProjectSettings.add_property_info(property_info) +---- + .. _class_ProjectSettings_method_clear: - void **clear** **(** :ref:`String` name **)** Clears the whole configuration (not recommended, may break things). +---- + .. _class_ProjectSettings_method_get_order: - :ref:`int` **get_order** **(** :ref:`String` name **)** const Returns the order of a configuration value (influences when saved to the config file). +---- + .. _class_ProjectSettings_method_get_setting: - :ref:`Variant` **get_setting** **(** :ref:`String` name **)** const +---- + .. _class_ProjectSettings_method_globalize_path: - :ref:`String` **globalize_path** **(** :ref:`String` path **)** const Converts a localized path (``res://``) to a full native OS path. +---- + .. _class_ProjectSettings_method_has_setting: - :ref:`bool` **has_setting** **(** :ref:`String` name **)** const Returns ``true`` if a configuration value is present. +---- + .. _class_ProjectSettings_method_load_resource_pack: - :ref:`bool` **load_resource_pack** **(** :ref:`String` pack **)** @@ -1984,46 +2552,62 @@ Loads the contents of the .pck or .zip file specified by ``pack`` into the resou Note: If a file from ``pack`` shares the same path as a file already in the resource filesystem, any attempts to load that file will use the file from ``pack``. +---- + .. _class_ProjectSettings_method_localize_path: - :ref:`String` **localize_path** **(** :ref:`String` path **)** const Convert a path to a localized path (``res://`` path). +---- + .. _class_ProjectSettings_method_property_can_revert: - :ref:`bool` **property_can_revert** **(** :ref:`String` name **)** Returns ``true`` if the specified property exists and its initial value differs from the current value. +---- + .. _class_ProjectSettings_method_property_get_revert: - :ref:`Variant` **property_get_revert** **(** :ref:`String` name **)** Returns the specified property's initial value. Returns ``null`` if the property does not exist. +---- + .. _class_ProjectSettings_method_save: - :ref:`Error` **save** **(** **)** Saves the configuration to the ``project.godot`` file. +---- + .. _class_ProjectSettings_method_save_custom: - :ref:`Error` **save_custom** **(** :ref:`String` file **)** Saves the configuration to a custom file. +---- + .. _class_ProjectSettings_method_set_initial_value: - void **set_initial_value** **(** :ref:`String` name, :ref:`Variant` value **)** +---- + .. _class_ProjectSettings_method_set_order: - void **set_order** **(** :ref:`String` name, :ref:`int` position **)** Sets the order of a configuration value (influences when saved to the config file). +---- + .. _class_ProjectSettings_method_set_setting: - void **set_setting** **(** :ref:`String` name, :ref:`Variant` value **)** diff --git a/classes/class_proximitygroup.rst b/classes/class_proximitygroup.rst index 1eff213cc..9e455ee7f 100644 --- a/classes/class_proximitygroup.rst +++ b/classes/class_proximitygroup.rst @@ -76,6 +76,8 @@ Property Descriptions | *Getter* | get_dispatch_mode() | +----------+--------------------------+ +---- + .. _class_ProximityGroup_property_grid_radius: - :ref:`Vector3` **grid_radius** @@ -86,6 +88,8 @@ Property Descriptions | *Getter* | get_grid_radius() | +----------+------------------------+ +---- + .. _class_ProximityGroup_property_group_name: - :ref:`String` **group_name** diff --git a/classes/class_quat.rst b/classes/class_quat.rst index d6c7de7b7..295f88c95 100644 --- a/classes/class_quat.rst +++ b/classes/class_quat.rst @@ -98,18 +98,24 @@ Property Descriptions W component of the quaternion. Default value: ``1`` +---- + .. _class_Quat_property_x: - :ref:`float` **x** X component of the quaternion. Default value: ``0`` +---- + .. _class_Quat_property_y: - :ref:`float` **y** Y component of the quaternion. Default value: ``0`` +---- + .. _class_Quat_property_z: - :ref:`float` **z** @@ -125,90 +131,122 @@ Method Descriptions Returns the rotation matrix corresponding to the given quaternion. +---- + - :ref:`Quat` **Quat** **(** :ref:`Vector3` euler **)** Returns a quaternion that will perform a rotation specified by Euler angles (in the YXZ convention: first Z, then X, and Y last), given in the vector format as (X-angle, Y-angle, Z-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. +---- + - :ref:`Quat` **Quat** **(** :ref:`float` x, :ref:`float` y, :ref:`float` z, :ref:`float` w **)** Returns a quaternion defined by these values. +---- + .. _class_Quat_method_cubic_slerp: - :ref:`Quat` **cubic_slerp** **(** :ref:`Quat` b, :ref:`Quat` pre_a, :ref:`Quat` post_b, :ref:`float` t **)** Performs a cubic spherical-linear interpolation with another quaternion. +---- + .. _class_Quat_method_dot: - :ref:`float` **dot** **(** :ref:`Quat` b **)** Returns the dot product of two quaternions. +---- + .. _class_Quat_method_get_euler: - :ref:`Vector3` **get_euler** **(** **)** Returns Euler angles (in the YXZ convention: first Z, then X, and Y last) corresponding to the rotation represented by the unit quaternion. Returned vector contains the rotation angles in the format (X-angle, Y-angle, Z-angle). +---- + .. _class_Quat_method_inverse: - :ref:`Quat` **inverse** **(** **)** Returns the inverse of the quaternion. +---- + .. _class_Quat_method_is_normalized: - :ref:`bool` **is_normalized** **(** **)** Returns whether the quaternion is normalized or not. +---- + .. _class_Quat_method_length: - :ref:`float` **length** **(** **)** Returns the length of the quaternion. +---- + .. _class_Quat_method_length_squared: - :ref:`float` **length_squared** **(** **)** Returns the length of the quaternion, squared. +---- + .. _class_Quat_method_normalized: - :ref:`Quat` **normalized** **(** **)** Returns a copy of the quaternion, normalized to unit length. +---- + .. _class_Quat_method_set_axis_angle: - void **set_axis_angle** **(** :ref:`Vector3` axis, :ref:`float` angle **)** Set the quaternion to a rotation which rotates around axis by the specified angle, in radians. The axis must be a normalized vector. +---- + .. _class_Quat_method_set_euler: - void **set_euler** **(** :ref:`Vector3` euler **)** Set the quaternion to a rotation specified by Euler angles (in the YXZ convention: first Z, then X, and Y last), given in the vector format as (X-angle, Y-angle, Z-angle). +---- + .. _class_Quat_method_slerp: - :ref:`Quat` **slerp** **(** :ref:`Quat` b, :ref:`float` t **)** Performs a spherical-linear interpolation with another quaternion. +---- + .. _class_Quat_method_slerpni: - :ref:`Quat` **slerpni** **(** :ref:`Quat` b, :ref:`float` t **)** Performs a spherical-linear interpolation with another quaterion without checking if the rotation path is not bigger than 90Β°. +---- + .. _class_Quat_method_xform: - :ref:`Vector3` **xform** **(** :ref:`Vector3` v **)** diff --git a/classes/class_randomnumbergenerator.rst b/classes/class_randomnumbergenerator.rst index ad3a64a00..6b8b24b5b 100644 --- a/classes/class_randomnumbergenerator.rst +++ b/classes/class_randomnumbergenerator.rst @@ -84,30 +84,40 @@ Method Descriptions Generates pseudo-random float between '0.0' and '1.0', inclusive. +---- + .. _class_RandomNumberGenerator_method_randf_range: - :ref:`float` **randf_range** **(** :ref:`float` from, :ref:`float` to **)** Generates pseudo-random float between ``from`` and ``to``, inclusive. +---- + .. _class_RandomNumberGenerator_method_randfn: - :ref:`float` **randfn** **(** :ref:`float` mean=0.0, :ref:`float` deviation=1.0 **)** Generates normally(gaussian) distributed pseudo-random number, using Box-Muller transform with the specified ``mean`` and a standard ``deviation``. +---- + .. _class_RandomNumberGenerator_method_randi: - :ref:`int` **randi** **(** **)** Generates pseudo-random 32-bit unsigned integer between '0' and '4294967295', inclusive. +---- + .. _class_RandomNumberGenerator_method_randi_range: - :ref:`int` **randi_range** **(** :ref:`int` from, :ref:`int` to **)** Generates pseudo-random 32-bit signed integer between ``from`` and ``to`` (inclusive). +---- + .. _class_RandomNumberGenerator_method_randomize: - void **randomize** **(** **)** diff --git a/classes/class_range.rst b/classes/class_range.rst index b8fd7becc..9cc65a049 100644 --- a/classes/class_range.rst +++ b/classes/class_range.rst @@ -59,10 +59,12 @@ Signals .. _class_Range_signal_changed: -- **changed** **(** **)** +- **changed** **(** :ref:`float` value **)** Emitted when :ref:`min_value`, :ref:`max_value`, :ref:`page`, or :ref:`step` change. +---- + .. _class_Range_signal_value_changed: - **value_changed** **(** :ref:`float` value **)** @@ -89,6 +91,8 @@ Property Descriptions If ``true``, :ref:`value` may be greater than :ref:`max_value`. Default value: ``false``. +---- + .. _class_Range_property_allow_lesser: - :ref:`bool` **allow_lesser** @@ -101,6 +105,8 @@ If ``true``, :ref:`value` may be greater than :ref:` If ``true``, :ref:`value` may be less than :ref:`min_value`. Default value: ``false``. +---- + .. _class_Range_property_exp_edit: - :ref:`bool` **exp_edit** @@ -113,6 +119,8 @@ If ``true``, :ref:`value` may be less than :ref:`min If ``true``, and ``min_value`` is greater than 0, ``value`` will be represented exponentially rather than linearly. +---- + .. _class_Range_property_max_value: - :ref:`float` **max_value** @@ -125,6 +133,8 @@ If ``true``, and ``min_value`` is greater than 0, ``value`` will be represented Maximum value. Range is clamped if ``value`` is greater than ``max_value``. Default value: ``100``. +---- + .. _class_Range_property_min_value: - :ref:`float` **min_value** @@ -137,6 +147,8 @@ Maximum value. Range is clamped if ``value`` is greater than ``max_value``. Defa Minimum value. Range is clamped if ``value`` is less than ``min_value``. Default value: ``0``. +---- + .. _class_Range_property_page: - :ref:`float` **page** @@ -149,6 +161,8 @@ Minimum value. Range is clamped if ``value`` is less than ``min_value``. Default Page size. Used mainly for :ref:`ScrollBar`. ScrollBar's length is its size multiplied by ``page`` over the difference between ``min_value`` and ``max_value``. +---- + .. _class_Range_property_ratio: - :ref:`float` **ratio** @@ -161,6 +175,8 @@ Page size. Used mainly for :ref:`ScrollBar`. ScrollBar's length The value mapped between 0 and 1. +---- + .. _class_Range_property_rounded: - :ref:`bool` **rounded** @@ -173,6 +189,8 @@ The value mapped between 0 and 1. If ``true``, ``value`` will always be rounded to the nearest integer. Default value: ``false``. +---- + .. _class_Range_property_step: - :ref:`float` **step** @@ -185,6 +203,8 @@ If ``true``, ``value`` will always be rounded to the nearest integer. Default va If greater than 0, ``value`` will always be rounded to a multiple of ``step``. If ``rounded`` is also ``true``, ``value`` will first be rounded to a multiple of ``step`` then rounded to the nearest integer. +---- + .. _class_Range_property_value: - :ref:`float` **value** @@ -206,6 +226,8 @@ Method Descriptions 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_method_unshare: - void **unshare** **(** **)** diff --git a/classes/class_raycast.rst b/classes/class_raycast.rst index f83b42457..d88a5697c 100644 --- a/classes/class_raycast.rst +++ b/classes/class_raycast.rst @@ -94,6 +94,8 @@ Property Descriptions The ray's destination point, relative to the RayCast's ``position``. +---- + .. _class_RayCast_property_collide_with_areas: - :ref:`bool` **collide_with_areas** @@ -106,6 +108,8 @@ The ray's destination point, relative to the RayCast's ``position``. If ``true``, collision with :ref:`Area`\ s will be reported. Default value: ``false``. +---- + .. _class_RayCast_property_collide_with_bodies: - :ref:`bool` **collide_with_bodies** @@ -118,6 +122,8 @@ If ``true``, collision with :ref:`Area`\ s will be reported. Default If ``true``, collision with :ref:`PhysicsBody`\ s will be reported. Default value: ``true``. +---- + .. _class_RayCast_property_collision_mask: - :ref:`int` **collision_mask** @@ -130,6 +136,8 @@ If ``true``, collision with :ref:`PhysicsBody`\ s will be rep The ray's collision mask. Only objects in at least one collision layer enabled in the mask will be detected. +---- + .. _class_RayCast_property_enabled: - :ref:`bool` **enabled** @@ -142,6 +150,8 @@ The ray's collision mask. Only objects in at least one collision layer enabled i If ``true``, collisions will be reported. Default value: ``false``. +---- + .. _class_RayCast_property_exclude_parent: - :ref:`bool` **exclude_parent** @@ -163,18 +173,24 @@ Method Descriptions Adds a collision exception so the ray does not report collisions with the specified node. +---- + .. _class_RayCast_method_add_exception_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_method_clear_exceptions: - void **clear_exceptions** **(** **)** Removes all collision exceptions for this ray. +---- + .. _class_RayCast_method_force_raycast_update: - void **force_raycast_update** **(** **)** @@ -183,54 +199,72 @@ 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_RayCast_method_get_collider: - :ref:`Object` **get_collider** **(** **)** const Returns the first object that the ray intersects, or ``null`` if no object is intersecting the ray (i.e. :ref:`is_colliding` returns ``false``). +---- + .. _class_RayCast_method_get_collider_shape: - :ref:`int` **get_collider_shape** **(** **)** const Returns the shape ID of the first object that the ray intersects, or ``0`` if no object is intersecting the ray (i.e. :ref:`is_colliding` returns ``false``). +---- + .. _class_RayCast_method_get_collision_mask_bit: - :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const Returns ``true`` if the bit index passed is turned on. Note that bit indexes range from 0-19. +---- + .. _class_RayCast_method_get_collision_normal: - :ref:`Vector3` **get_collision_normal** **(** **)** const Returns the normal of the intersecting object's shape at the collision point. +---- + .. _class_RayCast_method_get_collision_point: - :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_method_is_colliding: - :ref:`bool` **is_colliding** **(** **)** const Returns whether any object is intersecting with the ray's vector (considering the vector length). +---- + .. _class_RayCast_method_remove_exception: - void **remove_exception** **(** :ref:`Object` node **)** Removes a collision exception so the ray does report collisions with the specified node. +---- + .. _class_RayCast_method_remove_exception_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_method_set_collision_mask_bit: - void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** diff --git a/classes/class_raycast2d.rst b/classes/class_raycast2d.rst index afe720a57..3ae7cbab6 100644 --- a/classes/class_raycast2d.rst +++ b/classes/class_raycast2d.rst @@ -94,6 +94,8 @@ Property Descriptions The ray's destination point, relative to the RayCast's ``position``. +---- + .. _class_RayCast2D_property_collide_with_areas: - :ref:`bool` **collide_with_areas** @@ -106,6 +108,8 @@ The ray's destination point, relative to the RayCast's ``position``. If ``true``, collision with :ref:`Area2D`\ s will be reported. Default value: ``false``. +---- + .. _class_RayCast2D_property_collide_with_bodies: - :ref:`bool` **collide_with_bodies** @@ -118,6 +122,8 @@ If ``true``, collision with :ref:`Area2D`\ s will be reported. Def If ``true``, collision with :ref:`PhysicsBody2D`\ s will be reported. Default value: ``true``. +---- + .. _class_RayCast2D_property_collision_mask: - :ref:`int` **collision_mask** @@ -130,6 +136,8 @@ If ``true``, collision with :ref:`PhysicsBody2D`\ s will be The ray's collision mask. Only objects in at least one collision layer enabled in the mask will be detected. +---- + .. _class_RayCast2D_property_enabled: - :ref:`bool` **enabled** @@ -142,6 +150,8 @@ The ray's collision mask. Only objects in at least one collision layer enabled i If ``true``, collisions will be reported. Default value: ``false``. +---- + .. _class_RayCast2D_property_exclude_parent: - :ref:`bool` **exclude_parent** @@ -163,72 +173,96 @@ Method Descriptions Adds a collision exception so the ray does not report collisions with the specified node. +---- + .. _class_RayCast2D_method_add_exception_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_method_clear_exceptions: - void **clear_exceptions** **(** **)** Removes all collision exceptions for this ray. +---- + .. _class_RayCast2D_method_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_method_get_collider: - :ref:`Object` **get_collider** **(** **)** const Returns the first object that the ray intersects, or ``null`` if no object is intersecting the ray (i.e. :ref:`is_colliding` returns ``false``). +---- + .. _class_RayCast2D_method_get_collider_shape: - :ref:`int` **get_collider_shape** **(** **)** const Returns the shape ID of the first object that the ray intersects, or ``0`` if no object is intersecting the ray (i.e. :ref:`is_colliding` returns ``false``). +---- + .. _class_RayCast2D_method_get_collision_mask_bit: - :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const Returns an individual bit on the collision mask. +---- + .. _class_RayCast2D_method_get_collision_normal: - :ref:`Vector2` **get_collision_normal** **(** **)** const Returns the normal of the intersecting object's shape at the collision point. +---- + .. _class_RayCast2D_method_get_collision_point: - :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_method_is_colliding: - :ref:`bool` **is_colliding** **(** **)** const Returns whether any object is intersecting with the ray's vector (considering the vector length). +---- + .. _class_RayCast2D_method_remove_exception: - void **remove_exception** **(** :ref:`Object` node **)** Removes a collision exception so the ray does report collisions with the specified node. +---- + .. _class_RayCast2D_method_remove_exception_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_method_set_collision_mask_bit: - void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** diff --git a/classes/class_rayshape.rst b/classes/class_rayshape.rst index 4fa38ba0e..ffa3810b3 100644 --- a/classes/class_rayshape.rst +++ b/classes/class_rayshape.rst @@ -47,6 +47,8 @@ Property Descriptions The ray's length. +---- + .. _class_RayShape_property_slips_on_slope: - :ref:`bool` **slips_on_slope** diff --git a/classes/class_rayshape2d.rst b/classes/class_rayshape2d.rst index b4a997547..797fa6c63 100644 --- a/classes/class_rayshape2d.rst +++ b/classes/class_rayshape2d.rst @@ -47,6 +47,8 @@ Property Descriptions The ray's length. +---- + .. _class_RayShape2D_property_slips_on_slope: - :ref:`bool` **slips_on_slope** diff --git a/classes/class_rect2.rst b/classes/class_rect2.rst index 36351329f..516771a86 100644 --- a/classes/class_rect2.rst +++ b/classes/class_rect2.rst @@ -79,12 +79,16 @@ Property Descriptions Ending corner. +---- + .. _class_Rect2_property_position: - :ref:`Vector2` **position** Position (starting corner). +---- + .. _class_Rect2_property_size: - :ref:`Vector2` **size** @@ -100,76 +104,102 @@ Method Descriptions Constructs a ``Rect2`` by position and size. +---- + - :ref:`Rect2` **Rect2** **(** :ref:`float` x, :ref:`float` y, :ref:`float` width, :ref:`float` height **)** Constructs a ``Rect2`` by x, y, width, and height. +---- + .. _class_Rect2_method_abs: - :ref:`Rect2` **abs** **(** **)** Returns a ``Rect2`` with equivalent position and area, modified so that the top-left corner is the origin and ``width`` and ``height`` are positive. +---- + .. _class_Rect2_method_clip: - :ref:`Rect2` **clip** **(** :ref:`Rect2` b **)** Returns the intersection of this ``Rect2`` and b. +---- + .. _class_Rect2_method_encloses: - :ref:`bool` **encloses** **(** :ref:`Rect2` b **)** Returns ``true`` if this ``Rect2`` completely encloses another one. +---- + .. _class_Rect2_method_expand: - :ref:`Rect2` **expand** **(** :ref:`Vector2` to **)** Returns this ``Rect2`` expanded to include a given point. +---- + .. _class_Rect2_method_get_area: - :ref:`float` **get_area** **(** **)** Returns the area of the ``Rect2``. +---- + .. _class_Rect2_method_grow: - :ref:`Rect2` **grow** **(** :ref:`float` by **)** Returns a copy of the ``Rect2`` grown a given amount of units towards all the sides. +---- + .. _class_Rect2_method_grow_individual: - :ref:`Rect2` **grow_individual** **(** :ref:`float` left, :ref:`float` top, :ref:`float` right, :ref:`float` bottom **)** Returns a copy of the ``Rect2`` grown a given amount of units towards each direction individually. +---- + .. _class_Rect2_method_grow_margin: - :ref:`Rect2` **grow_margin** **(** :ref:`int` margin, :ref:`float` by **)** Returns a copy of the ``Rect2`` grown a given amount of units towards the :ref:`Margin` direction. +---- + .. _class_Rect2_method_has_no_area: - :ref:`bool` **has_no_area** **(** **)** Returns ``true`` if the ``Rect2`` is flat or empty. +---- + .. _class_Rect2_method_has_point: - :ref:`bool` **has_point** **(** :ref:`Vector2` point **)** Returns ``true`` if the ``Rect2`` contains a point. +---- + .. _class_Rect2_method_intersects: - :ref:`bool` **intersects** **(** :ref:`Rect2` b **)** Returns ``true`` if the ``Rect2`` overlaps with another. +---- + .. _class_Rect2_method_merge: - :ref:`Rect2` **merge** **(** :ref:`Rect2` b **)** diff --git a/classes/class_reference.rst b/classes/class_reference.rst index d1becef9d..50346cc4c 100644 --- a/classes/class_reference.rst +++ b/classes/class_reference.rst @@ -51,6 +51,8 @@ Initializes the internal reference counter. Use this only if you really know wha Returns whether the initialization was successful. +---- + .. _class_Reference_method_reference: - :ref:`bool` **reference** **(** **)** @@ -59,6 +61,8 @@ Increments the internal reference counter. Use this only if you really know what Returns whether the increment was successful. +---- + .. _class_Reference_method_unreference: - :ref:`bool` **unreference** **(** **)** diff --git a/classes/class_reflectionprobe.rst b/classes/class_reflectionprobe.rst index d1afbdd2c..e7b7373a6 100644 --- a/classes/class_reflectionprobe.rst +++ b/classes/class_reflectionprobe.rst @@ -80,6 +80,8 @@ Property Descriptions | *Getter* | is_box_projection_enabled() | +----------+----------------------------------+ +---- + .. _class_ReflectionProbe_property_cull_mask: - :ref:`int` **cull_mask** @@ -90,6 +92,8 @@ Property Descriptions | *Getter* | get_cull_mask() | +----------+----------------------+ +---- + .. _class_ReflectionProbe_property_enable_shadows: - :ref:`bool` **enable_shadows** @@ -100,6 +104,8 @@ Property Descriptions | *Getter* | are_shadows_enabled() | +----------+---------------------------+ +---- + .. _class_ReflectionProbe_property_extents: - :ref:`Vector3` **extents** @@ -110,6 +116,8 @@ Property Descriptions | *Getter* | get_extents() | +----------+--------------------+ +---- + .. _class_ReflectionProbe_property_intensity: - :ref:`float` **intensity** @@ -120,6 +128,8 @@ Property Descriptions | *Getter* | get_intensity() | +----------+----------------------+ +---- + .. _class_ReflectionProbe_property_interior_ambient_color: - :ref:`Color` **interior_ambient_color** @@ -130,6 +140,8 @@ Property Descriptions | *Getter* | get_interior_ambient() | +----------+-----------------------------+ +---- + .. _class_ReflectionProbe_property_interior_ambient_contrib: - :ref:`float` **interior_ambient_contrib** @@ -140,6 +152,8 @@ Property Descriptions | *Getter* | get_interior_ambient_probe_contribution() | +----------+------------------------------------------------+ +---- + .. _class_ReflectionProbe_property_interior_ambient_energy: - :ref:`float` **interior_ambient_energy** @@ -150,6 +164,8 @@ Property Descriptions | *Getter* | get_interior_ambient_energy() | +----------+------------------------------------+ +---- + .. _class_ReflectionProbe_property_interior_enable: - :ref:`bool` **interior_enable** @@ -160,6 +176,8 @@ Property Descriptions | *Getter* | is_set_as_interior() | +----------+------------------------+ +---- + .. _class_ReflectionProbe_property_max_distance: - :ref:`float` **max_distance** @@ -170,6 +188,8 @@ Property Descriptions | *Getter* | get_max_distance() | +----------+-------------------------+ +---- + .. _class_ReflectionProbe_property_origin_offset: - :ref:`Vector3` **origin_offset** @@ -180,6 +200,8 @@ Property Descriptions | *Getter* | get_origin_offset() | +----------+--------------------------+ +---- + .. _class_ReflectionProbe_property_update_mode: - :ref:`UpdateMode` **update_mode** diff --git a/classes/class_regex.rst b/classes/class_regex.rst index d8c02fb25..79c686970 100644 --- a/classes/class_regex.rst +++ b/classes/class_regex.rst @@ -95,48 +95,64 @@ Method Descriptions This method resets the state of the object, as it was freshly created. Namely, it unassigns the regular expression of this object. +---- + .. _class_RegEx_method_compile: - :ref:`Error` **compile** **(** :ref:`String` pattern **)** Compiles and assign the search pattern to use. Returns OK if the compilation is successful. If an error is encountered the details are printed to STDOUT and FAILED is returned. +---- + .. _class_RegEx_method_get_group_count: - :ref:`int` **get_group_count** **(** **)** const Returns the number of capturing groups in compiled pattern. +---- + .. _class_RegEx_method_get_names: - :ref:`Array` **get_names** **(** **)** const Returns an array of names of named capturing groups in the compiled pattern. They are ordered by appearance. +---- + .. _class_RegEx_method_get_pattern: - :ref:`String` **get_pattern** **(** **)** const Returns the original search pattern that was compiled. +---- + .. _class_RegEx_method_is_valid: - :ref:`bool` **is_valid** **(** **)** const Returns whether this object has a valid search pattern assigned. +---- + .. _class_RegEx_method_search: - :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_method_search_all: - :ref:`Array` **search_all** **(** :ref:`String` subject, :ref:`int` offset=0, :ref:`int` end=-1 **)** const Searches the text for the compiled pattern. Returns an array of :ref:`RegExMatch` containers for each non-overlapping result. If no results were found an empty array is returned instead. The region to search within can be specified without modifying where the start and end anchor would be. +---- + .. _class_RegEx_method_sub: - :ref:`String` **sub** **(** :ref:`String` subject, :ref:`String` replacement, :ref:`bool` all=false, :ref:`int` offset=0, :ref:`int` end=-1 **)** const diff --git a/classes/class_regexmatch.rst b/classes/class_regexmatch.rst index 17fc17199..6a633de6a 100644 --- a/classes/class_regexmatch.rst +++ b/classes/class_regexmatch.rst @@ -60,6 +60,8 @@ Property Descriptions A dictionary of named groups and its corresponding group number. Only groups with that were matched are included. If multiple groups have the same name, that name would refer to the first matching one. +---- + .. _class_RegExMatch_property_strings: - :ref:`Array` **strings** @@ -70,6 +72,8 @@ A dictionary of named groups and its corresponding group number. Only groups wit An :ref:`Array` of the match and its capturing groups. +---- + .. _class_RegExMatch_property_subject: - :ref:`String` **subject** @@ -91,12 +95,16 @@ Returns the end position of the match within the source string. The end position Returns -1 if the group did not match or doesn't exist. +---- + .. _class_RegExMatch_method_get_group_count: - :ref:`int` **get_group_count** **(** **)** const Returns the number of capturing groups. +---- + .. _class_RegExMatch_method_get_start: - :ref:`int` **get_start** **(** :ref:`Variant` name=0 **)** const @@ -105,6 +113,8 @@ Returns the starting position of the match within the source string. The startin Returns -1 if the group did not match or doesn't exist. +---- + .. _class_RegExMatch_method_get_string: - :ref:`String` **get_string** **(** :ref:`Variant` name=0 **)** const diff --git a/classes/class_remotetransform.rst b/classes/class_remotetransform.rst index 52c5df6df..e3f8a3a4e 100644 --- a/classes/class_remotetransform.rst +++ b/classes/class_remotetransform.rst @@ -55,6 +55,8 @@ Property Descriptions The :ref:`NodePath` to the remote node, relative to the RemoteTransform's position in the scene. +---- + .. _class_RemoteTransform_property_update_position: - :ref:`bool` **update_position** @@ -67,6 +69,8 @@ The :ref:`NodePath` to the remote node, relative to the RemoteTr If ``true``, the remote node's position is updated. Default value: ``true``. +---- + .. _class_RemoteTransform_property_update_rotation: - :ref:`bool` **update_rotation** @@ -79,6 +83,8 @@ If ``true``, the remote node's position is updated. Default value: ``true``. If ``true``, the remote node's rotation is updated. Default value: ``true``. +---- + .. _class_RemoteTransform_property_update_scale: - :ref:`bool` **update_scale** @@ -91,6 +97,8 @@ If ``true``, the remote node's rotation is updated. Default value: ``true``. If ``true``, the remote node's scale is updated. Default value: ``true``. +---- + .. _class_RemoteTransform_property_use_global_coordinates: - :ref:`bool` **use_global_coordinates** diff --git a/classes/class_remotetransform2d.rst b/classes/class_remotetransform2d.rst index c31d3b462..7b64711b7 100644 --- a/classes/class_remotetransform2d.rst +++ b/classes/class_remotetransform2d.rst @@ -55,6 +55,8 @@ Property Descriptions The :ref:`NodePath` to the remote node, relative to the RemoteTransform2D's position in the scene. +---- + .. _class_RemoteTransform2D_property_update_position: - :ref:`bool` **update_position** @@ -67,6 +69,8 @@ The :ref:`NodePath` to the remote node, relative to the RemoteTr If ``true``, the remote node's position is updated. Default value: ``true``. +---- + .. _class_RemoteTransform2D_property_update_rotation: - :ref:`bool` **update_rotation** @@ -79,6 +83,8 @@ If ``true``, the remote node's position is updated. Default value: ``true``. If ``true``, the remote node's rotation is updated. Default value: ``true``. +---- + .. _class_RemoteTransform2D_property_update_scale: - :ref:`bool` **update_scale** @@ -91,6 +97,8 @@ If ``true``, the remote node's rotation is updated. Default value: ``true``. If ``true``, the remote node's scale is updated. Default value: ``true``. +---- + .. _class_RemoteTransform2D_property_use_global_coordinates: - :ref:`bool` **use_global_coordinates** diff --git a/classes/class_resource.rst b/classes/class_resource.rst index c023a6a89..5b03ccb80 100644 --- a/classes/class_resource.rst +++ b/classes/class_resource.rst @@ -82,6 +82,8 @@ Property Descriptions If ``true``, the resource will be made unique in each instance of its local scene. It can thus be modified in a scene instance without impacting other instances of that same scene. +---- + .. _class_Resource_property_resource_name: - :ref:`String` **resource_name** @@ -94,6 +96,8 @@ If ``true``, the resource will be made unique in each instance of its local scen The name of the resource. This is an optional identifier. +---- + .. _class_Resource_property_resource_path: - :ref:`String` **resource_path** @@ -115,24 +119,32 @@ Method Descriptions Virtual function which can be overridden to customize the behavior value of :ref:`setup_local_to_scene`. +---- + .. _class_Resource_method_duplicate: - :ref:`Resource` **duplicate** **(** :ref:`bool` subresources=false **)** const Duplicates the resource, returning a new resource. By default, sub-resources are shared between resource copies for efficiency, this can be changed by passing ``true`` to the ``subresources`` argument. +---- + .. _class_Resource_method_get_local_scene: - :ref:`Node` **get_local_scene** **(** **)** const If :ref:`resource_local_to_scene` is enabled and the resource was loaded from a :ref:`PackedScene` instantiation, returns the local scene where this resource's unique copy is in use. Otherwise, returns ``null``. +---- + .. _class_Resource_method_get_rid: - :ref:`RID` **get_rid** **(** **)** const Returns 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_method_setup_local_to_scene: - void **setup_local_to_scene** **(** **)** @@ -141,6 +153,8 @@ This method is called when a resource with :ref:`resource_local_to_scene` performs custom logic to properly set the proxy texture and flags in the local viewport. +---- + .. _class_Resource_method_take_over_path: - void **take_over_path** **(** :ref:`String` path **)** diff --git a/classes/class_resourceformatloader.rst b/classes/class_resourceformatloader.rst index 1d585b74e..74614a79b 100644 --- a/classes/class_resourceformatloader.rst +++ b/classes/class_resourceformatloader.rst @@ -55,30 +55,40 @@ Method Descriptions If implemented, gets the dependencies of a given resource. If ``add_types`` is ``true``, paths should be appended ``::TypeName``, where ``TypeName`` is the class name of the dependency. Note that custom resource types defined by scripts aren't known by the :ref:`ClassDB`, so you might just return ``"Resource"`` for them. +---- + .. _class_ResourceFormatLoader_method_get_recognized_extensions: - :ref:`PoolStringArray` **get_recognized_extensions** **(** **)** virtual Gets the list of extensions for files this loader is able to read. +---- + .. _class_ResourceFormatLoader_method_get_resource_type: - :ref:`String` **get_resource_type** **(** :ref:`String` path **)** virtual Gets the class name of the resource associated with the given path. If the loader cannot handle it, it should return ``""``. Note that custom resource types defined by scripts aren't known by the :ref:`ClassDB`, so you might just return ``"Resource"`` for them. +---- + .. _class_ResourceFormatLoader_method_handles_type: - :ref:`bool` **handles_type** **(** :ref:`String` typename **)** virtual Tells which resource class this loader can load. Note that custom resource types defined by scripts aren't known by the :ref:`ClassDB`, so you might just handle ``"Resource"`` for them. +---- + .. _class_ResourceFormatLoader_method_load: - :ref:`Variant` **load** **(** :ref:`String` path, :ref:`String` original_path **)** virtual Loads a resource when the engine finds this loader to be compatible. If the loaded resource is the result of an import, ``original_path`` will target the source file. Returns a :ref:`Resource` object on success, or an :ref:`Error` constant in case of failure. +---- + .. _class_ResourceFormatLoader_method_rename_dependencies: - :ref:`int` **rename_dependencies** **(** :ref:`String` path, :ref:`String` renames **)** virtual diff --git a/classes/class_resourceformatsaver.rst b/classes/class_resourceformatsaver.rst index b3d68eb9a..75da94f0e 100644 --- a/classes/class_resourceformatsaver.rst +++ b/classes/class_resourceformatsaver.rst @@ -47,12 +47,16 @@ Method Descriptions Returns the list of extensions available for saving the resource object, provided it is recognized (see :ref:`recognize`). +---- + .. _class_ResourceFormatSaver_method_recognize: - :ref:`bool` **recognize** **(** :ref:`Resource` resource **)** virtual Returns whether the given resource object can be saved by this saver. +---- + .. _class_ResourceFormatSaver_method_save: - :ref:`int` **save** **(** :ref:`String` path, :ref:`Resource` resource, :ref:`int` flags **)** virtual diff --git a/classes/class_resourceinteractiveloader.rst b/classes/class_resourceinteractiveloader.rst index 1f9e453e1..d5ec209f9 100644 --- a/classes/class_resourceinteractiveloader.rst +++ b/classes/class_resourceinteractiveloader.rst @@ -47,18 +47,24 @@ Method Descriptions Returns the loaded resource if the load operation completed successfully, ``null`` otherwise. +---- + .. _class_ResourceInteractiveLoader_method_get_stage: - :ref:`int` **get_stage** **(** **)** const Returns the load stage. The total amount of stages can be queried with :ref:`get_stage_count`. +---- + .. _class_ResourceInteractiveLoader_method_get_stage_count: - :ref:`int` **get_stage_count** **(** **)** const Returns the total amount of stages (calls to :ref:`poll`) needed to completely load this resource. +---- + .. _class_ResourceInteractiveLoader_method_poll: - :ref:`Error` **poll** **(** **)** @@ -71,6 +77,8 @@ Returns :ref:`@GlobalScope.ERR_FILE_EOF` code if the poll has failed. +---- + .. _class_ResourceInteractiveLoader_method_wait: - :ref:`Error` **wait** **(** **)** diff --git a/classes/class_resourceloader.rst b/classes/class_resourceloader.rst index c01261978..82d7beab5 100644 --- a/classes/class_resourceloader.rst +++ b/classes/class_resourceloader.rst @@ -59,24 +59,32 @@ Returns whether a recognized resource exists for the given ``path``. An optional ``type_hint`` can be used to further specify the :ref:`Resource` type that should be handled by the :ref:`ResourceFormatLoader`. +---- + .. _class_ResourceLoader_method_get_dependencies: - :ref:`PoolStringArray` **get_dependencies** **(** :ref:`String` path **)** Returns the dependencies for the resource at the given ``path``. +---- + .. _class_ResourceLoader_method_get_recognized_extensions_for_type: - :ref:`PoolStringArray` **get_recognized_extensions_for_type** **(** :ref:`String` type **)** Returns the list of recognized extensions for a resource type. +---- + .. _class_ResourceLoader_method_has: - :ref:`bool` **has** **(** :ref:`String` path **)** Deprecated method. Use :ref:`has_cached` or :ref:`exists` instead. +---- + .. _class_ResourceLoader_method_has_cached: - :ref:`bool` **has_cached** **(** :ref:`String` path **)** @@ -85,6 +93,8 @@ Returns whether a cached resource is available for the given ``path``. Once a resource has been loaded by the engine, it is cached in memory for faster access, and future calls to the :ref:`load` or :ref:`load_interactive` methods will use the cached version. The cached resource can be overridden by using :ref:`Resource.take_over_path` on a new resource for that same path. +---- + .. _class_ResourceLoader_method_load: - :ref:`Resource` **load** **(** :ref:`String` path, :ref:`String` type_hint="", :ref:`bool` no_cache=false **)** @@ -99,6 +109,8 @@ If ``no_cache`` is ``true``, the resource cache will be bypassed and the resourc Returns an empty resource if no ResourceFormatLoader could handle the file. +---- + .. _class_ResourceLoader_method_load_interactive: - :ref:`ResourceInteractiveLoader` **load_interactive** **(** :ref:`String` path, :ref:`String` type_hint="" **)** @@ -107,6 +119,8 @@ Starts loading a resource interactively. The returned :ref:`ResourceInteractiveL An optional ``type_hint`` can be used to further specify the :ref:`Resource` type that should be handled by the :ref:`ResourceFormatLoader`. +---- + .. _class_ResourceLoader_method_set_abort_on_missing_resources: - void **set_abort_on_missing_resources** **(** :ref:`bool` abort **)** diff --git a/classes/class_resourcepreloader.rst b/classes/class_resourcepreloader.rst index 0591dad84..e880b0a94 100644 --- a/classes/class_resourcepreloader.rst +++ b/classes/class_resourcepreloader.rst @@ -51,30 +51,40 @@ Method Descriptions Adds a resource to the preloader with the given ``name``. If a resource with the given ``name`` already exists, the new resource will be renamed to "``name`` N" where N is an incrementing number starting from 2. +---- + .. _class_ResourcePreloader_method_get_resource: - :ref:`Resource` **get_resource** **(** :ref:`String` name **)** const Returns the resource associated to ``name``. +---- + .. _class_ResourcePreloader_method_get_resource_list: - :ref:`PoolStringArray` **get_resource_list** **(** **)** const Returns the list of resources inside the preloader. +---- + .. _class_ResourcePreloader_method_has_resource: - :ref:`bool` **has_resource** **(** :ref:`String` name **)** const Returns ``true`` if the preloader contains a resource associated to ``name``. +---- + .. _class_ResourcePreloader_method_remove_resource: - void **remove_resource** **(** :ref:`String` name **)** Removes the resource associated to ``name`` from the preloader. +---- + .. _class_ResourcePreloader_method_rename_resource: - void **rename_resource** **(** :ref:`String` name, :ref:`String` newname **)** diff --git a/classes/class_resourcesaver.rst b/classes/class_resourcesaver.rst index 5d6d33c7e..9a6658cce 100644 --- a/classes/class_resourcesaver.rst +++ b/classes/class_resourcesaver.rst @@ -78,6 +78,8 @@ Method Descriptions Returns the list of extensions available for saving a resource of a given type. +---- + .. _class_ResourceSaver_method_save: - :ref:`Error` **save** **(** :ref:`String` path, :ref:`Resource` resource, :ref:`int` flags=0 **)** diff --git a/classes/class_richtextlabel.rst b/classes/class_richtextlabel.rst index 5ba2f6e07..50e806c65 100644 --- a/classes/class_richtextlabel.rst +++ b/classes/class_richtextlabel.rst @@ -148,12 +148,16 @@ Signals Triggered when the user clicks on content between ``[url]`` tags. If the meta is defined in text, e.g. ``[url={"data"="hi"}]hi[/url]``, then the parameter for this signal will be a :ref:`String` type. If a particular type or an object is desired, the :ref:`push_meta` method must be used to manually insert the data into the tag stack. +---- + .. _class_RichTextLabel_signal_meta_hover_ended: - **meta_hover_ended** **(** :ref:`Nil` meta **)** Triggers when the mouse exits a meta tag. +---- + .. _class_RichTextLabel_signal_meta_hover_started: - **meta_hover_started** **(** :ref:`Nil` meta **)** @@ -183,6 +187,8 @@ enum **Align**: - **ALIGN_FILL** = **3** +---- + .. _enum_RichTextLabel_ListType: .. _class_RichTextLabel_constant_LIST_NUMBERS: @@ -199,6 +205,8 @@ enum **ListType**: - **LIST_DOTS** = **2** +---- + .. _enum_RichTextLabel_ItemType: .. _class_RichTextLabel_constant_ITEM_FRAME: @@ -282,6 +290,8 @@ Property Descriptions If ``true``, the label uses BBCode formatting. Default value: ``false``. +---- + .. _class_RichTextLabel_property_bbcode_text: - :ref:`String` **bbcode_text** @@ -294,6 +304,8 @@ If ``true``, the label uses BBCode formatting. Default value: ``false``. The label's text in BBCode format. Is not representative of manual modifications to the internal tag stack. Erases changes made by other methods when edited. +---- + .. _class_RichTextLabel_property_meta_underlined: - :ref:`bool` **meta_underlined** @@ -306,6 +318,8 @@ The label's text in BBCode format. Is not representative of manual modifications If ``true``, the label underlines meta tags such as ``[url]{text}[/url]``. Default value: ``true``. +---- + .. _class_RichTextLabel_property_override_selected_font_color: - :ref:`bool` **override_selected_font_color** @@ -318,6 +332,8 @@ If ``true``, the label underlines meta tags such as ``[url]{text}[/url]``. Defau If ``true``, the label uses the custom font color. Default value: ``false``. +---- + .. _class_RichTextLabel_property_percent_visible: - :ref:`float` **percent_visible** @@ -330,6 +346,8 @@ If ``true``, the label uses the custom font color. Default value: ``false``. The text's visibility, as a :ref:`float` between 0.0 and 1.0. +---- + .. _class_RichTextLabel_property_scroll_active: - :ref:`bool` **scroll_active** @@ -342,6 +360,8 @@ The text's visibility, as a :ref:`float` between 0.0 and 1.0. If ``true``, the scrollbar is visible. Does not block scrolling completely. See :ref:`scroll_to_line`. Default value: ``true``. +---- + .. _class_RichTextLabel_property_scroll_following: - :ref:`bool` **scroll_following** @@ -354,6 +374,8 @@ If ``true``, the scrollbar is visible. Does not block scrolling completely. See If ``true``, the window scrolls down to display new content automatically. Default value: ``false``. +---- + .. _class_RichTextLabel_property_selection_enabled: - :ref:`bool` **selection_enabled** @@ -366,6 +388,8 @@ If ``true``, the window scrolls down to display new content automatically. Defau If ``true``, the label allows text selection. +---- + .. _class_RichTextLabel_property_tab_size: - :ref:`int` **tab_size** @@ -378,6 +402,8 @@ If ``true``, the label allows text selection. The number of spaces associated with a single tab length. Does not affect "\\t" in text tags, only indent tags. +---- + .. _class_RichTextLabel_property_text: - :ref:`String` **text** @@ -392,6 +418,8 @@ The raw text of the label. When set, clears the tag stack and adds a raw text tag to the top of it. Does not parse bbcodes. Does not modify :ref:`bbcode_text`. +---- + .. _class_RichTextLabel_property_visible_characters: - :ref:`int` **visible_characters** @@ -413,144 +441,192 @@ Method Descriptions Adds an image's opening and closing tags to the tag stack. +---- + .. _class_RichTextLabel_method_add_text: - void **add_text** **(** :ref:`String` text **)** Adds raw non-bbcode-parsed text to the tag stack. +---- + .. _class_RichTextLabel_method_append_bbcode: - :ref:`Error` **append_bbcode** **(** :ref:`String` bbcode **)** Parses ``bbcode`` and adds tags to the tag stack as needed. Returns the result of the parsing, :ref:`@GlobalScope.OK` if successful. +---- + .. _class_RichTextLabel_method_clear: - void **clear** **(** **)** Clears the tag stack and sets :ref:`bbcode_text` to an empty string. +---- + .. _class_RichTextLabel_method_get_content_height: - :ref:`int` **get_content_height** **(** **)** Returns the height of the content. +---- + .. _class_RichTextLabel_method_get_line_count: - :ref:`int` **get_line_count** **(** **)** const Returns the total number of newlines in the tag stack's text tags. Considers wrapped text as one line. +---- + .. _class_RichTextLabel_method_get_total_character_count: - :ref:`int` **get_total_character_count** **(** **)** const Returns the total number of characters from text tags. Does not include bbcodes. +---- + .. _class_RichTextLabel_method_get_v_scroll: - :ref:`VScrollBar` **get_v_scroll** **(** **)** Returns the vertical scrollbar. +---- + .. _class_RichTextLabel_method_get_visible_line_count: - :ref:`int` **get_visible_line_count** **(** **)** const Returns the number of visible lines. +---- + .. _class_RichTextLabel_method_newline: - void **newline** **(** **)** Adds a newline tag to the tag stack. +---- + .. _class_RichTextLabel_method_parse_bbcode: - :ref:`Error` **parse_bbcode** **(** :ref:`String` bbcode **)** The assignment version of :ref:`append_bbcode`. Clears the tag stack and inserts the new content. Returns :ref:`@GlobalScope.OK` if parses ``bbcode`` successfully. +---- + .. _class_RichTextLabel_method_pop: - void **pop** **(** **)** Terminates the current tag. Use after ``push_*`` methods to close bbcodes manually. Does not need to follow ``add_*`` methods. +---- + .. _class_RichTextLabel_method_push_align: - void **push_align** **(** :ref:`Align` align **)** Adds an alignment tag based on the given ``align`` value. See :ref:`Align` for possible values. +---- + .. _class_RichTextLabel_method_push_cell: - void **push_cell** **(** **)** Adds a ``[cell]`` tag to the tag stack. Must be inside a ``[table]`` tag. See :ref:`push_table` for details. +---- + .. _class_RichTextLabel_method_push_color: - void **push_color** **(** :ref:`Color` color **)** Adds a ``[color]`` tag to the tag stack. +---- + .. _class_RichTextLabel_method_push_font: - void **push_font** **(** :ref:`Font` font **)** Adds a ``[font]`` tag to the tag stack. Overrides default fonts for its duration. +---- + .. _class_RichTextLabel_method_push_indent: - void **push_indent** **(** :ref:`int` level **)** Adds an ``[indent]`` tag to the tag stack. Multiplies "level" by current tab_size to determine new margin length. +---- + .. _class_RichTextLabel_method_push_list: - void **push_list** **(** :ref:`ListType` type **)** Adds a list tag to the tag stack. Similar to the bbcodes ``[ol]`` or ``[ul]``, but supports more list types. Not fully implemented! +---- + .. _class_RichTextLabel_method_push_meta: - void **push_meta** **(** :ref:`Variant` data **)** Adds a meta tag to the tag stack. Similar to the bbcode ``[url=something]{text}[/url]``, but supports non-:ref:`String` metadata types. +---- + .. _class_RichTextLabel_method_push_strikethrough: - void **push_strikethrough** **(** **)** Adds a ``[s]`` tag to the tag stack. +---- + .. _class_RichTextLabel_method_push_table: - void **push_table** **(** :ref:`int` columns **)** Adds a ``[table=columns]`` tag to the tag stack. +---- + .. _class_RichTextLabel_method_push_underline: - void **push_underline** **(** **)** Adds a ``[u]`` tag to the tag stack. +---- + .. _class_RichTextLabel_method_remove_line: - :ref:`bool` **remove_line** **(** :ref:`int` line **)** Removes a line of content from the label. Returns ``true`` if the line exists. +---- + .. _class_RichTextLabel_method_scroll_to_line: - void **scroll_to_line** **(** :ref:`int` line **)** Scrolls the window's top line to match ``line``. +---- + .. _class_RichTextLabel_method_set_table_column_expand: - void **set_table_column_expand** **(** :ref:`int` column, :ref:`bool` expand, :ref:`int` ratio **)** diff --git a/classes/class_rid.rst b/classes/class_rid.rst index a10cfe39c..aa1c1e39f 100644 --- a/classes/class_rid.rst +++ b/classes/class_rid.rst @@ -39,6 +39,8 @@ Method Descriptions Creates 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_method_get_id: - :ref:`int` **get_id** **(** **)** diff --git a/classes/class_rigidbody.rst b/classes/class_rigidbody.rst index 824d9240b..a5755e880 100644 --- a/classes/class_rigidbody.rst +++ b/classes/class_rigidbody.rst @@ -103,12 +103,16 @@ Signals Emitted when a body enters into contact with this one. Contact monitor and contacts reported must be enabled for this to work. +---- + .. _class_RigidBody_signal_body_exited: - **body_exited** **(** :ref:`Node` 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_signal_body_shape_entered: - **body_shape_entered** **(** :ref:`int` body_id, :ref:`Node` body, :ref:`int` body_shape, :ref:`int` local_shape **)** @@ -117,6 +121,8 @@ Emitted when a body enters into contact with this one. Contact monitor and conta This signal not only receives the body that collided with this one, but also its :ref:`RID` (body_id), the shape index from the colliding body (body_shape), and the shape index from this body (local_shape) the other body collided with. +---- + .. _class_RigidBody_signal_body_shape_exited: - **body_shape_exited** **(** :ref:`int` body_id, :ref:`Node` body, :ref:`int` body_shape, :ref:`int` local_shape **)** @@ -125,6 +131,8 @@ Emitted when a body shape exits contact with this one. Contact monitor and conta This signal not only receives the body that stopped colliding with this one, but also its :ref:`RID` (body_id), the shape index from the colliding body (body_shape), and the shape index from this body (local_shape) the other body stopped colliding with. +---- + .. _class_RigidBody_signal_sleeping_state_changed: - **sleeping_state_changed** **(** **)** @@ -185,6 +193,8 @@ Property Descriptions Damps RigidBody's rotational forces. +---- + .. _class_RigidBody_property_angular_velocity: - :ref:`Vector3` **angular_velocity** @@ -197,6 +207,8 @@ Damps RigidBody's rotational forces. RigidBody's rotational velocity. +---- + .. _class_RigidBody_property_axis_lock_angular_x: - :ref:`bool` **axis_lock_angular_x** @@ -209,6 +221,8 @@ RigidBody's rotational velocity. Lock the body's rotation in the x-axis. +---- + .. _class_RigidBody_property_axis_lock_angular_y: - :ref:`bool` **axis_lock_angular_y** @@ -221,6 +235,8 @@ Lock the body's rotation in the x-axis. Lock the body's rotation in the y-axis. +---- + .. _class_RigidBody_property_axis_lock_angular_z: - :ref:`bool` **axis_lock_angular_z** @@ -233,6 +249,8 @@ Lock the body's rotation in the y-axis. Lock the body's rotation in the z-axis. +---- + .. _class_RigidBody_property_axis_lock_linear_x: - :ref:`bool` **axis_lock_linear_x** @@ -245,6 +263,8 @@ Lock the body's rotation in the z-axis. Lock the body's movement in the x-axis. +---- + .. _class_RigidBody_property_axis_lock_linear_y: - :ref:`bool` **axis_lock_linear_y** @@ -257,6 +277,8 @@ Lock the body's movement in the x-axis. Lock the body's movement in the y-axis. +---- + .. _class_RigidBody_property_axis_lock_linear_z: - :ref:`bool` **axis_lock_linear_z** @@ -269,6 +291,8 @@ Lock the body's movement in the y-axis. Lock the body's movement in the z-axis. +---- + .. _class_RigidBody_property_bounce: - :ref:`float` **bounce** @@ -281,6 +305,8 @@ Lock the body's movement in the z-axis. RigidBody's bounciness. +---- + .. _class_RigidBody_property_can_sleep: - :ref:`bool` **can_sleep** @@ -293,6 +319,8 @@ RigidBody's bounciness. If ``true``, the RigidBody will not calculate forces and will act as a static body while there is no movement. It will wake up when forces are applied through other collisions or when the ``apply_impulse`` method is used. +---- + .. _class_RigidBody_property_contact_monitor: - :ref:`bool` **contact_monitor** @@ -305,6 +333,8 @@ If ``true``, the RigidBody will not calculate forces and will act as a static bo If ``true``, the RigidBody will emit signals when it collides with another RigidBody. +---- + .. _class_RigidBody_property_contacts_reported: - :ref:`int` **contacts_reported** @@ -317,6 +347,8 @@ If ``true``, the RigidBody will emit signals when it collides with another Rigid 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_property_continuous_cd: - :ref:`bool` **continuous_cd** @@ -331,6 +363,8 @@ If ``true``, continuous collision detection is used. Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. Continuous collision detection is more precise, and misses less impacts by small, fast-moving objects. Not using continuous collision detection is faster to compute, but can miss small, fast-moving objects. +---- + .. _class_RigidBody_property_custom_integrator: - :ref:`bool` **custom_integrator** @@ -343,6 +377,8 @@ Continuous collision detection tries to predict where a moving body will collide If ``true``, internal force integration will be disabled (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_property_friction: - :ref:`float` **friction** @@ -355,6 +391,8 @@ If ``true``, internal force integration will be disabled (like gravity or air fr The body's friction, from 0 (frictionless) to 1 (max friction). +---- + .. _class_RigidBody_property_gravity_scale: - :ref:`float` **gravity_scale** @@ -367,6 +405,8 @@ The body's friction, from 0 (frictionless) to 1 (max friction). This is multiplied by the global 3D gravity setting found in "Project > Project Settings > Physics > 3d" to produce RigidBody's gravity. E.g. a value of 1 will be normal gravity, 2 will apply double gravity, and 0.5 will apply half gravity to this object. +---- + .. _class_RigidBody_property_linear_damp: - :ref:`float` **linear_damp** @@ -379,6 +419,8 @@ This is multiplied by the global 3D gravity setting found in "Project > Project The body's linear damp. Default value: -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_property_linear_velocity: - :ref:`Vector3` **linear_velocity** @@ -391,6 +433,8 @@ The body's linear damp. Default value: -1, cannot be less than -1. If this value The body's linear velocity. Can be used sporadically, but **DON'T SET THIS IN EVERY FRAME**, because physics may run in another thread and runs at a different granularity. Use :ref:`_integrate_forces` as your process loop for precise control of the body state. +---- + .. _class_RigidBody_property_mass: - :ref:`float` **mass** @@ -403,6 +447,8 @@ The body's linear velocity. Can be used sporadically, but **DON'T SET THIS IN EV The body's mass. +---- + .. _class_RigidBody_property_mode: - :ref:`Mode` **mode** @@ -415,6 +461,8 @@ The body's mass. The body mode from the MODE\_\* enum. Modes include: MODE_STATIC, MODE_KINEMATIC, MODE_RIGID, and MODE_CHARACTER. +---- + .. _class_RigidBody_property_physics_material_override: - :ref:`PhysicsMaterial` **physics_material_override** @@ -425,6 +473,8 @@ The body mode from the MODE\_\* enum. Modes include: MODE_STATIC, MODE_KINEMATIC | *Getter* | get_physics_material_override() | +----------+--------------------------------------+ +---- + .. _class_RigidBody_property_sleeping: - :ref:`bool` **sleeping** @@ -437,6 +487,8 @@ The body mode from the MODE\_\* enum. Modes include: MODE_STATIC, MODE_KINEMATIC If ``true``, the body is sleeping and will not calculate forces until woken up by a collision or the ``apply_impulse`` method. +---- + .. _class_RigidBody_property_weight: - :ref:`float` **weight** @@ -458,6 +510,8 @@ Method Descriptions 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 the :ref:`custom_integrator` property allows you to disable the default behavior and do fully custom force integration for a body. +---- + .. _class_RigidBody_method_add_central_force: - void **add_central_force** **(** :ref:`Vector3` force **)** @@ -466,18 +520,24 @@ Adds a constant directional force without affecting rotation. This is equivalent to ``add_force(force, Vector3(0,0,0))``. +---- + .. _class_RigidBody_method_add_force: - void **add_force** **(** :ref:`Vector3` force, :ref:`Vector3` position **)** Adds a constant force (i.e. acceleration). +---- + .. _class_RigidBody_method_add_torque: - void **add_torque** **(** :ref:`Vector3` torque **)** Adds a constant rotational force (i.e. a motor) without affecting position. +---- + .. _class_RigidBody_method_apply_central_impulse: - void **apply_central_impulse** **(** :ref:`Vector3` impulse **)** @@ -486,24 +546,32 @@ Applies a directional impulse without affecting rotation. This is equivalent to ``apply_impulse(Vector3(0,0,0), impulse)``. +---- + .. _class_RigidBody_method_apply_impulse: - void **apply_impulse** **(** :ref:`Vector3` position, :ref:`Vector3` impulse **)** Applies a positioned impulse to the body. An impulse is time independent! Applying an impulse every frame would result in a framerate dependent force. For this reason it should only be used when simulating one-time impacts. The position uses the rotation of the global coordinate system, but is centered at the object's origin. +---- + .. _class_RigidBody_method_apply_torque_impulse: - void **apply_torque_impulse** **(** :ref:`Vector3` impulse **)** Applies a torque impulse which will be affected by the body mass and shape. This will rotate the body around the passed in vector. +---- + .. _class_RigidBody_method_get_colliding_bodies: - :ref:`Array` **get_colliding_bodies** **(** **)** const Returns a list of the bodies colliding with this one. By default, number of max contacts reported is at 0, see the :ref:`contacts_reported` property to increase it. Note that the result of this test is not immediate after moving objects. For performance, list of collisions is updated once per frame and before the physics step. Consider using signals instead. +---- + .. _class_RigidBody_method_set_axis_velocity: - void **set_axis_velocity** **(** :ref:`Vector3` axis_velocity **)** diff --git a/classes/class_rigidbody2d.rst b/classes/class_rigidbody2d.rst index 51ba7d1f2..ab7ce37aa 100644 --- a/classes/class_rigidbody2d.rst +++ b/classes/class_rigidbody2d.rst @@ -97,24 +97,32 @@ Signals 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_signal_body_exited: - **body_exited** **(** :ref:`Node` 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_signal_body_shape_entered: - **body_shape_entered** **(** :ref:`int` body_id, :ref:`Node` 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_signal_body_shape_exited: - **body_shape_exited** **(** :ref:`int` body_id, :ref:`Node` 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_signal_sleeping_state_changed: - **sleeping_state_changed** **(** **)** @@ -144,6 +152,8 @@ enum **Mode**: - **MODE_KINEMATIC** = **3** --- Kinematic mode. The body behaves like a :ref:`KinematicBody2D`, and must be moved by code. +---- + .. _enum_RigidBody2D_CCDMode: .. _class_RigidBody2D_constant_CCD_MODE_DISABLED: @@ -188,6 +198,8 @@ Property Descriptions Damps the body's :ref:`angular_velocity`. If ``-1`` the body will use the "Default Angular Damp" in "Project > Project Settings > Physics > 2d". Default value: ``-1``. +---- + .. _class_RigidBody2D_property_angular_velocity: - :ref:`float` **angular_velocity** @@ -200,6 +212,8 @@ Damps the body's :ref:`angular_velocity` **applied_force** @@ -212,6 +226,8 @@ The body's rotational velocity. The body's total applied force. +---- + .. _class_RigidBody2D_property_applied_torque: - :ref:`float` **applied_torque** @@ -224,6 +240,8 @@ The body's total applied force. The body's total applied torque. +---- + .. _class_RigidBody2D_property_bounce: - :ref:`float` **bounce** @@ -236,6 +254,8 @@ The body's total applied torque. The body's bounciness. Default value: ``0``. +---- + .. _class_RigidBody2D_property_can_sleep: - :ref:`bool` **can_sleep** @@ -248,6 +268,8 @@ The body's bounciness. Default value: ``0``. If ``true``, the body will not calculate forces and will act as a static body if there is no movement. The body will wake up when other forces are applied via collisions or by using :ref:`apply_impulse` or :ref:`add_force`. Default value: ``true``. +---- + .. _class_RigidBody2D_property_contact_monitor: - :ref:`bool` **contact_monitor** @@ -260,6 +282,8 @@ If ``true``, the body will not calculate forces and will act as a static body if If ``true``, the body will emit signals when it collides with another RigidBody2D. See also :ref:`contacts_reported`. Default value: ``false``. +---- + .. _class_RigidBody2D_property_contacts_reported: - :ref:`int` **contacts_reported** @@ -272,6 +296,8 @@ If ``true``, the body will emit signals when it collides with another RigidBody2 The maximum number of contacts to report. Default value: ``0``. +---- + .. _class_RigidBody2D_property_continuous_cd: - :ref:`CCDMode` **continuous_cd** @@ -286,6 +312,8 @@ Continuous collision detection mode. Default value: :ref:`CCD_MODE_DISABLED` for details. +---- + .. _class_RigidBody2D_property_custom_integrator: - :ref:`bool` **custom_integrator** @@ -298,6 +326,8 @@ Continuous collision detection tries to predict where a moving body will collide If ``true``, internal force integration is disabled for this body. Aside from collision response, the body will only move as determined by the :ref:`_integrate_forces` function. +---- + .. _class_RigidBody2D_property_friction: - :ref:`float` **friction** @@ -310,6 +340,8 @@ If ``true``, internal force integration is disabled for this body. Aside from co The body's friction. Values range from ``0`` (frictionless) to ``1`` (maximum friction). Default value: ``1``. +---- + .. _class_RigidBody2D_property_gravity_scale: - :ref:`float` **gravity_scale** @@ -322,6 +354,8 @@ The body's friction. Values range from ``0`` (frictionless) to ``1`` (maximum fr Multiplies the gravity applied to the body. The body's gravity is calculated from the "Default Gravity" value in "Project > Project Settings > Physics > 2d" and/or any additional gravity vector applied by :ref:`Area2D`\ s. Default value: ``1``. +---- + .. _class_RigidBody2D_property_inertia: - :ref:`float` **inertia** @@ -334,6 +368,8 @@ Multiplies the gravity applied to the body. The body's gravity is calculated fro 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_property_linear_damp: - :ref:`float` **linear_damp** @@ -346,6 +382,8 @@ The body's moment of inertia. This is like mass, but for rotation: it determines Damps the body's :ref:`linear_velocity`. If ``-1`` the body will use the "Default Linear Damp" in "Project > Project Settings > Physics > 2d". Default value: ``-1``. +---- + .. _class_RigidBody2D_property_linear_velocity: - :ref:`Vector2` **linear_velocity** @@ -358,6 +396,8 @@ Damps the body's :ref:`linear_velocity` **mass** @@ -370,6 +410,8 @@ The body's linear velocity. The body's mass. Default value: ``1``. +---- + .. _class_RigidBody2D_property_mode: - :ref:`Mode` **mode** @@ -382,6 +424,8 @@ The body's mass. Default value: ``1``. The body's mode. See ``MODE_*`` constants. Default value: :ref:`MODE_RIGID`. +---- + .. _class_RigidBody2D_property_physics_material_override: - :ref:`PhysicsMaterial` **physics_material_override** @@ -392,6 +436,8 @@ The body's mode. See ``MODE_*`` constants. Default value: :ref:`MODE_RIGID` **sleeping** @@ -404,6 +450,8 @@ The body's mode. See ``MODE_*`` constants. Default value: :ref:`MODE_RIGID` or :ref:`add_force`. +---- + .. _class_RigidBody2D_property_weight: - :ref:`float` **weight** @@ -425,54 +473,72 @@ Method Descriptions Allows you to read and safely modify the simulation state for the object. Use this instead of :ref:`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_method_add_central_force: - void **add_central_force** **(** :ref:`Vector2` force **)** Adds a constant directional force without affecting rotation. +---- + .. _class_RigidBody2D_method_add_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_method_add_torque: - void **add_torque** **(** :ref:`float` torque **)** Adds a constant rotational force. +---- + .. _class_RigidBody2D_method_apply_central_impulse: - void **apply_central_impulse** **(** :ref:`Vector2` impulse **)** Applies a directional impulse without affecting rotation. +---- + .. _class_RigidBody2D_method_apply_impulse: - void **apply_impulse** **(** :ref:`Vector2` offset, :ref:`Vector2` impulse **)** Applies a positioned impulse to the body. An impulse is time independent! Applying an impulse every frame would result in a framerate dependent force. For this reason it should only be used when simulating one-time impacts (use the "_force" functions otherwise). The position uses the rotation of the global coordinate system, but is centered at the object's origin. +---- + .. _class_RigidBody2D_method_apply_torque_impulse: - void **apply_torque_impulse** **(** :ref:`float` torque **)** Applies a rotational impulse to the body. +---- + .. _class_RigidBody2D_method_get_colliding_bodies: - :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``. Note that the result of this test is not immediate after moving objects. For performance, list of collisions is updated once per frame and before the physics step. Consider using signals instead. +---- + .. _class_RigidBody2D_method_set_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_method_test_motion: - :ref:`bool` **test_motion** **(** :ref:`Vector2` motion, :ref:`bool` infinite_inertia=true, :ref:`float` margin=0.08, :ref:`Physics2DTestMotionResult` result=null **)** diff --git a/classes/class_rootmotionview.rst b/classes/class_rootmotionview.rst index 1bae5712b..6bbcdfc96 100644 --- a/classes/class_rootmotionview.rst +++ b/classes/class_rootmotionview.rst @@ -46,6 +46,8 @@ Property Descriptions | *Getter* | get_animation_path() | +----------+---------------------------+ +---- + .. _class_RootMotionView_property_cell_size: - :ref:`float` **cell_size** @@ -56,6 +58,8 @@ Property Descriptions | *Getter* | get_cell_size() | +----------+----------------------+ +---- + .. _class_RootMotionView_property_color: - :ref:`Color` **color** @@ -66,6 +70,8 @@ Property Descriptions | *Getter* | get_color() | +----------+------------------+ +---- + .. _class_RootMotionView_property_radius: - :ref:`float` **radius** @@ -76,6 +82,8 @@ Property Descriptions | *Getter* | get_radius() | +----------+-------------------+ +---- + .. _class_RootMotionView_property_zero_y: - :ref:`bool` **zero_y** diff --git a/classes/class_scenestate.rst b/classes/class_scenestate.rst index e8eae3dbc..6d16d0911 100644 --- a/classes/class_scenestate.rst +++ b/classes/class_scenestate.rst @@ -98,6 +98,8 @@ Method Descriptions Returns the list of bound parameters for the signal at ``idx``. +---- + .. _class_SceneState_method_get_connection_count: - :ref:`int` **get_connection_count** **(** **)** const @@ -106,36 +108,48 @@ Returns the number of signal connections in the scene. The ``idx`` argument used to query connection metadata in other ``get_connection_*`` methods in the interval ``[0, get_connection_count() - 1]``. +---- + .. _class_SceneState_method_get_connection_flags: - :ref:`int` **get_connection_flags** **(** :ref:`int` idx **)** const Returns the connection flags for the signal at ``idx``. See :ref:`ConnectFlags` constants. +---- + .. _class_SceneState_method_get_connection_method: - :ref:`String` **get_connection_method** **(** :ref:`int` idx **)** const Returns the method connected to the signal at ``idx``. +---- + .. _class_SceneState_method_get_connection_signal: - :ref:`String` **get_connection_signal** **(** :ref:`int` idx **)** const Returns the name of the signal at ``idx``. +---- + .. _class_SceneState_method_get_connection_source: - :ref:`NodePath` **get_connection_source** **(** :ref:`int` idx **)** const Returns the path to the node that owns the signal at ``idx``, relative to the root node. +---- + .. _class_SceneState_method_get_connection_target: - :ref:`NodePath` **get_connection_target** **(** :ref:`int` idx **)** const Returns the path to the node that owns the method connected to the signal at ``idx``, relative to the root node. +---- + .. _class_SceneState_method_get_node_count: - :ref:`int` **get_node_count** **(** **)** const @@ -144,42 +158,56 @@ Returns the number of nodes in the scene. The ``idx`` argument used to query node data in other ``get_node_*`` methods in the interval ``[0, get_node_count() - 1]``. +---- + .. _class_SceneState_method_get_node_groups: - :ref:`PoolStringArray` **get_node_groups** **(** :ref:`int` idx **)** const Returns the list of group names associated with the node at ``idx``. +---- + .. _class_SceneState_method_get_node_index: - :ref:`int` **get_node_index** **(** :ref:`int` idx **)** const Returns the node's index, which is its position relative to its siblings. This is only relevant and saved in scenes for cases where new nodes are added to an instanced or inherited scene among siblings from the base scene. Despite the name, this index is not related to the ``idx`` argument used here and in other methods. +---- + .. _class_SceneState_method_get_node_instance: - :ref:`PackedScene` **get_node_instance** **(** :ref:`int` idx **)** const Returns a :ref:`PackedScene` for the node at ``idx`` (i.e. the whole branch starting at this node, with its child nodes and resources), or ``null`` if the node is not an instance. +---- + .. _class_SceneState_method_get_node_instance_placeholder: - :ref:`String` **get_node_instance_placeholder** **(** :ref:`int` idx **)** const Returns the path to the represented scene file if the node at ``idx`` is an :ref:`InstancePlaceholder`. +---- + .. _class_SceneState_method_get_node_name: - :ref:`String` **get_node_name** **(** :ref:`int` idx **)** const Returns the name of the node at ``idx``. +---- + .. _class_SceneState_method_get_node_owner_path: - :ref:`NodePath` **get_node_owner_path** **(** :ref:`int` idx **)** const Returns the path to the owner of the node at ``idx``, relative to the root node. +---- + .. _class_SceneState_method_get_node_path: - :ref:`NodePath` **get_node_path** **(** :ref:`int` idx, :ref:`bool` for_parent=false **)** const @@ -188,6 +216,8 @@ Returns the path to the node at ``idx``. If ``for_parent`` is ``true``, returns the path of the ``idx`` node's parent instead. +---- + .. _class_SceneState_method_get_node_property_count: - :ref:`int` **get_node_property_count** **(** :ref:`int` idx **)** const @@ -196,24 +226,32 @@ Returns the number of exported or overridden properties for the node at ``idx``. The ``prop_idx`` argument used to query node property data in other ``get_node_property_*`` methods in the interval ``[0, get_node_property_count() - 1]``. +---- + .. _class_SceneState_method_get_node_property_name: - :ref:`String` **get_node_property_name** **(** :ref:`int` idx, :ref:`int` prop_idx **)** const Returns the name of the property at ``prop_idx`` for the node at ``idx``. +---- + .. _class_SceneState_method_get_node_property_value: - :ref:`Variant` **get_node_property_value** **(** :ref:`int` idx, :ref:`int` prop_idx **)** const Returns the value of the property at ``prop_idx`` for the node at ``idx``. +---- + .. _class_SceneState_method_get_node_type: - :ref:`String` **get_node_type** **(** :ref:`int` idx **)** const Returns the type of the node at ``idx``. +---- + .. _class_SceneState_method_is_node_instance_placeholder: - :ref:`bool` **is_node_instance_placeholder** **(** :ref:`int` idx **)** const diff --git a/classes/class_scenetree.rst b/classes/class_scenetree.rst index a14569023..94c9511a4 100644 --- a/classes/class_scenetree.rst +++ b/classes/class_scenetree.rst @@ -111,72 +111,96 @@ Signals Emitted whenever this ``SceneTree``'s :ref:`network_peer` successfully connected to a server. Only emitted on clients. +---- + .. _class_SceneTree_signal_connection_failed: - **connection_failed** **(** **)** Emitted whenever this ``SceneTree``'s :ref:`network_peer` fails to establish a connection to a server. Only emitted on clients. +---- + .. _class_SceneTree_signal_files_dropped: - **files_dropped** **(** :ref:`PoolStringArray` files, :ref:`int` screen **)** Emitted when files are dragged from the OS file manager and dropped in the game window. The arguments are a list of file paths and the identifier of the screen where the drag originated. +---- + .. _class_SceneTree_signal_idle_frame: - **idle_frame** **(** **)** Emitted immediately before :ref:`Node._process` is called on every node in the ``SceneTree``. +---- + .. _class_SceneTree_signal_network_peer_connected: - **network_peer_connected** **(** :ref:`int` id **)** Emitted whenever this ``SceneTree``'s :ref:`network_peer` connects with a new peer. ID is the peer ID of the new peer. Clients get notified when other clients connect to the same server. Upon connecting to a server, a client also receives this signal for the server (with ID being 1). +---- + .. _class_SceneTree_signal_network_peer_disconnected: - **network_peer_disconnected** **(** :ref:`int` id **)** Emitted whenever this ``SceneTree``'s :ref:`network_peer` disconnects from a peer. Clients get notified when other clients disconnect from the same server. +---- + .. _class_SceneTree_signal_node_added: - **node_added** **(** :ref:`Node` node **)** Emitted whenever a node is added to the ``SceneTree``. +---- + .. _class_SceneTree_signal_node_configuration_warning_changed: - **node_configuration_warning_changed** **(** :ref:`Node` node **)** Emitted when a node's configuration changed. Only emitted in tool mode. +---- + .. _class_SceneTree_signal_node_removed: - **node_removed** **(** :ref:`Node` node **)** Emitted whenever a node is removed from the ``SceneTree``. +---- + .. _class_SceneTree_signal_physics_frame: - **physics_frame** **(** **)** Emitted immediately before :ref:`Node._physics_process` is called on every node in the ``SceneTree``. +---- + .. _class_SceneTree_signal_screen_resized: - **screen_resized** **(** **)** Emitted whenever the screen resolution (fullscreen) or window size (windowed) changes. +---- + .. _class_SceneTree_signal_server_disconnected: - **server_disconnected** **(** **)** Emitted whenever this ``SceneTree``'s :ref:`network_peer` disconnected from server. Only emitted on clients. +---- + .. _class_SceneTree_signal_tree_changed: - **tree_changed** **(** **)** @@ -206,6 +230,8 @@ enum **GroupCallFlags**: - **GROUP_CALL_UNIQUE** = **4** --- Call a group only once even if the call is executed many times. +---- + .. _enum_SceneTree_StretchMode: .. _class_SceneTree_constant_STRETCH_MODE_DISABLED: @@ -222,6 +248,8 @@ enum **StretchMode**: - **STRETCH_MODE_VIEWPORT** = **2** --- Keep the specified display resolution. No interpolation. Content may appear pixelated. +---- + .. _enum_SceneTree_StretchAspect: .. _class_SceneTree_constant_STRETCH_ASPECT_IGNORE: @@ -277,6 +305,8 @@ Property Descriptions The current scene. +---- + .. _class_SceneTree_property_debug_collisions_hint: - :ref:`bool` **debug_collisions_hint** @@ -289,6 +319,8 @@ The current scene. If ``true``, collision shapes will be visible when running the game from the editor for debugging purposes. +---- + .. _class_SceneTree_property_debug_navigation_hint: - :ref:`bool` **debug_navigation_hint** @@ -301,6 +333,8 @@ If ``true``, collision shapes will be visible when running the game from the edi If ``true``, navigation polygons will be visible when running the game from the editor for debugging purposes. +---- + .. _class_SceneTree_property_edited_scene_root: - :ref:`Node` **edited_scene_root** @@ -313,6 +347,8 @@ If ``true``, navigation polygons will be visible when running the game from the The root of the edited scene. +---- + .. _class_SceneTree_property_multiplayer: - :ref:`MultiplayerAPI` **multiplayer** @@ -325,6 +361,8 @@ The root of the edited scene. The default :ref:`MultiplayerAPI` instance for this ``SceneTree``. +---- + .. _class_SceneTree_property_multiplayer_poll: - :ref:`bool` **multiplayer_poll** @@ -339,6 +377,8 @@ If ``true`` (default value), enable the automatic polling of the :ref:`Multiplay When ``false`` you need to manually call :ref:`MultiplayerAPI.poll` for processing network packets and delivering RPCs/RSETs. This allows to run RPCs/RSETs in a different loop (e.g. physics, thread, specific time step) and for manual :ref:`Mutex` protection when accessing the :ref:`MultiplayerAPI` from threads. +---- + .. _class_SceneTree_property_network_peer: - :ref:`NetworkedMultiplayerPeer` **network_peer** @@ -351,6 +391,8 @@ When ``false`` you need to manually call :ref:`MultiplayerAPI.poll`) 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 puppet. 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_property_paused: - :ref:`bool` **paused** @@ -367,6 +409,8 @@ If ``true``, the ``SceneTree`` is paused. Doing so will have the following behav - :ref:`Node._process`, :ref:`Node._physics_process` and :ref:`Node._input` will not be called anymore in nodes. +---- + .. _class_SceneTree_property_refuse_new_network_connections: - :ref:`bool` **refuse_new_network_connections** @@ -379,6 +423,8 @@ If ``true``, the ``SceneTree`` is paused. Doing so will have the following behav If ``true``, the ``SceneTree``'s :ref:`network_peer` refuses new incoming connections. +---- + .. _class_SceneTree_property_root: - :ref:`Viewport` **root** @@ -389,6 +435,8 @@ If ``true``, the ``SceneTree``'s :ref:`network_peer`. +---- + .. _class_SceneTree_property_use_font_oversampling: - :ref:`bool` **use_font_oversampling** @@ -410,12 +458,16 @@ Method Descriptions Calls ``method`` on each member of the given group. +---- + .. _class_SceneTree_method_call_group_flags: - :ref:`Variant` **call_group_flags** **(** :ref:`int` flags, :ref:`String` group, :ref:`String` method, ... **)** vararg Calls ``method`` on each member of the given group, respecting the given :ref:`GroupCallFlags`. +---- + .. _class_SceneTree_method_change_scene: - :ref:`Error` **change_scene** **(** :ref:`String` path **)** @@ -424,6 +476,8 @@ Changes the running scene to the one at the given ``path``, after loading it int Returns :ref:`@GlobalScope.OK` on success, :ref:`@GlobalScope.ERR_CANT_OPEN` if the ``path`` cannot be loaded into a :ref:`PackedScene`, or :ref:`@GlobalScope.ERR_CANT_CREATE` if that scene cannot be instantiated. +---- + .. _class_SceneTree_method_change_scene_to: - :ref:`Error` **change_scene_to** **(** :ref:`PackedScene` packed_scene **)** @@ -432,6 +486,8 @@ Changes the running scene to a new instance of the given :ref:`PackedScene` on success or :ref:`@GlobalScope.ERR_CANT_CREATE` if the scene cannot be instantiated. +---- + .. _class_SceneTree_method_create_timer: - :ref:`SceneTreeTimer` **create_timer** **(** :ref:`float` time_sec, :ref:`bool` pause_mode_process=true **)** @@ -447,90 +503,120 @@ Commonly used to create a one-shot delay timer as in the following example: yield(get_tree().create_timer(1.0), "timeout") print("end") +---- + .. _class_SceneTree_method_get_frame: - :ref:`int` **get_frame** **(** **)** const Returns the current frame number, i.e. the total frame count since the application started. +---- + .. _class_SceneTree_method_get_network_connected_peers: - :ref:`PoolIntArray` **get_network_connected_peers** **(** **)** const Returns the peer IDs of all connected peers of this ``SceneTree``'s :ref:`network_peer`. +---- + .. _class_SceneTree_method_get_network_unique_id: - :ref:`int` **get_network_unique_id** **(** **)** const Returns the unique peer ID of this ``SceneTree``'s :ref:`network_peer`. +---- + .. _class_SceneTree_method_get_node_count: - :ref:`int` **get_node_count** **(** **)** const Returns the number of nodes in this ``SceneTree``. +---- + .. _class_SceneTree_method_get_nodes_in_group: - :ref:`Array` **get_nodes_in_group** **(** :ref:`String` group **)** Returns a list of all nodes assigned to the given group. +---- + .. _class_SceneTree_method_get_rpc_sender_id: - :ref:`int` **get_rpc_sender_id** **(** **)** const Returns the sender's peer ID for the most recently received RPC call. +---- + .. _class_SceneTree_method_has_group: - :ref:`bool` **has_group** **(** :ref:`String` name **)** const Returns ``true`` if the given group exists. +---- + .. _class_SceneTree_method_has_network_peer: - :ref:`bool` **has_network_peer** **(** **)** const Returns ``true`` if there is a :ref:`network_peer` set. +---- + .. _class_SceneTree_method_is_input_handled: - :ref:`bool` **is_input_handled** **(** **)** Returns ``true`` if the most recent :ref:`InputEvent` was marked as handled with :ref:`set_input_as_handled`. +---- + .. _class_SceneTree_method_is_network_server: - :ref:`bool` **is_network_server** **(** **)** const Returns ``true`` if this ``SceneTree``'s :ref:`network_peer` is in server mode (listening for connections). +---- + .. _class_SceneTree_method_notify_group: - void **notify_group** **(** :ref:`String` group, :ref:`int` notification **)** Sends the given notification to all members of the ``group``. +---- + .. _class_SceneTree_method_notify_group_flags: - void **notify_group_flags** **(** :ref:`int` call_flags, :ref:`String` group, :ref:`int` notification **)** Sends the given notification to all members of the ``group``, respecting the given :ref:`GroupCallFlags`. +---- + .. _class_SceneTree_method_queue_delete: - void **queue_delete** **(** :ref:`Object` obj **)** Queues the given object for deletion, delaying the call to :ref:`Object.free` to after the current frame. +---- + .. _class_SceneTree_method_quit: - void **quit** **(** **)** Quits the application. +---- + .. _class_SceneTree_method_reload_current_scene: - :ref:`Error` **reload_current_scene** **(** **)** @@ -539,36 +625,48 @@ Reloads the currently active scene. Returns an :ref:`Error` code as described in :ref:`change_scene`, with the addition of :ref:`@GlobalScope.ERR_UNCONFIGURED` if no :ref:`current_scene` was defined yet. +---- + .. _class_SceneTree_method_set_auto_accept_quit: - void **set_auto_accept_quit** **(** :ref:`bool` enabled **)** If ``true``, the application automatically accepts quitting. Defaults to ``true``. +---- + .. _class_SceneTree_method_set_group: - void **set_group** **(** :ref:`String` group, :ref:`String` property, :ref:`Variant` value **)** Sets the given ``property`` to ``value`` on all members of the given group. +---- + .. _class_SceneTree_method_set_group_flags: - void **set_group_flags** **(** :ref:`int` call_flags, :ref:`String` group, :ref:`String` property, :ref:`Variant` value **)** Sets the given ``property`` to ``value`` on all members of the given group, respecting the given :ref:`GroupCallFlags`. +---- + .. _class_SceneTree_method_set_input_as_handled: - void **set_input_as_handled** **(** **)** Marks the most recent :ref:`InputEvent` as handled. +---- + .. _class_SceneTree_method_set_quit_on_go_back: - void **set_quit_on_go_back** **(** :ref:`bool` enabled **)** If ``true``, the application quits automatically on going back (e.g. on Android). Defaults to ``true``. +---- + .. _class_SceneTree_method_set_screen_stretch: - void **set_screen_stretch** **(** :ref:`StretchMode` mode, :ref:`StretchAspect` aspect, :ref:`Vector2` minsize, :ref:`float` shrink=1 **)** diff --git a/classes/class_script.rst b/classes/class_script.rst index 55cee37ec..c4b915a9a 100644 --- a/classes/class_script.rst +++ b/classes/class_script.rst @@ -84,42 +84,56 @@ Method Descriptions Returns ``true`` if the script can be instanced. +---- + .. _class_Script_method_get_base_script: - :ref:`Script` **get_base_script** **(** **)** const Returns the script directly inherited by this script. +---- + .. _class_Script_method_get_instance_base_type: - :ref:`String` **get_instance_base_type** **(** **)** const Returns the script's base type. +---- + .. _class_Script_method_has_script_signal: - :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_method_has_source_code: - :ref:`bool` **has_source_code** **(** **)** const Returns ``true`` if the script contains non-empty source code. +---- + .. _class_Script_method_instance_has: - :ref:`bool` **instance_has** **(** :ref:`Object` base_object **)** const Returns ``true`` if ``base_object`` is an instance of this script. +---- + .. _class_Script_method_is_tool: - :ref:`bool` **is_tool** **(** **)** const Returns ``true`` if the script is a tool script. A tool script can run in the editor. +---- + .. _class_Script_method_reload: - :ref:`Error` **reload** **(** :ref:`bool` keep_state=false **)** diff --git a/classes/class_scripteditor.rst b/classes/class_scripteditor.rst index f1201b8c5..e7cfb3f39 100644 --- a/classes/class_scripteditor.rst +++ b/classes/class_scripteditor.rst @@ -44,6 +44,8 @@ Signals Emitted when user changed active script. Argument is a freshly activated :ref:`Script`. +---- + .. _class_ScriptEditor_signal_script_close: - **script_close** **(** :ref:`Script` script **)** @@ -57,26 +59,36 @@ Method Descriptions - :ref:`bool` **can_drop_data_fw** **(** :ref:`Vector2` point, :ref:`Variant` data, :ref:`Control` from **)** const +---- + .. _class_ScriptEditor_method_drop_data_fw: - void **drop_data_fw** **(** :ref:`Vector2` point, :ref:`Variant` data, :ref:`Control` from **)** +---- + .. _class_ScriptEditor_method_get_current_script: - :ref:`Script` **get_current_script** **(** **)** Returns a :ref:`Script` that is currently active in editor. +---- + .. _class_ScriptEditor_method_get_drag_data_fw: - :ref:`Variant` **get_drag_data_fw** **(** :ref:`Vector2` point, :ref:`Control` from **)** +---- + .. _class_ScriptEditor_method_get_open_scripts: - :ref:`Array` **get_open_scripts** **(** **)** const Returns an array with all :ref:`Script` objects which are currently open in editor. +---- + .. _class_ScriptEditor_method_open_script_create_dialog: - void **open_script_create_dialog** **(** :ref:`String` base_name, :ref:`String` base_path **)** diff --git a/classes/class_scrollcontainer.rst b/classes/class_scrollcontainer.rst index c898d5104..9d5a60d2c 100644 --- a/classes/class_scrollcontainer.rst +++ b/classes/class_scrollcontainer.rst @@ -60,6 +60,8 @@ Signals Emitted whenever scrolling stops. +---- + .. _class_ScrollContainer_signal_scroll_started: - **scroll_started** **(** **)** @@ -84,6 +86,8 @@ Property Descriptions | *Getter* | get_deadzone() | +----------+---------------------+ +---- + .. _class_ScrollContainer_property_scroll_horizontal: - :ref:`int` **scroll_horizontal** @@ -96,6 +100,8 @@ Property Descriptions The current horizontal scroll value. +---- + .. _class_ScrollContainer_property_scroll_horizontal_enabled: - :ref:`bool` **scroll_horizontal_enabled** @@ -108,6 +114,8 @@ The current horizontal scroll value. If ``true``, enables horizontal scrolling. +---- + .. _class_ScrollContainer_property_scroll_vertical: - :ref:`int` **scroll_vertical** @@ -120,6 +128,8 @@ If ``true``, enables horizontal scrolling. The current vertical scroll value. +---- + .. _class_ScrollContainer_property_scroll_vertical_enabled: - :ref:`bool` **scroll_vertical_enabled** @@ -139,6 +149,8 @@ Method Descriptions - :ref:`HScrollBar` **get_h_scrollbar** **(** **)** +---- + .. _class_ScrollContainer_method_get_v_scrollbar: - :ref:`VScrollBar` **get_v_scrollbar** **(** **)** diff --git a/classes/class_segmentshape2d.rst b/classes/class_segmentshape2d.rst index a39a7d567..06a0c2fc0 100644 --- a/classes/class_segmentshape2d.rst +++ b/classes/class_segmentshape2d.rst @@ -47,6 +47,8 @@ Property Descriptions The segment's first point position. +---- + .. _class_SegmentShape2D_property_b: - :ref:`Vector2` **b** diff --git a/classes/class_semaphore.rst b/classes/class_semaphore.rst index 03241dfba..15cba7ebe 100644 --- a/classes/class_semaphore.rst +++ b/classes/class_semaphore.rst @@ -41,6 +41,8 @@ Method Descriptions Lowers the ``Semaphore``, allowing one more thread in. Returns :ref:`@GlobalScope.OK` on success, :ref:`@GlobalScope.ERR_BUSY` otherwise. +---- + .. _class_Semaphore_method_wait: - :ref:`Error` **wait** **(** **)** diff --git a/classes/class_shader.rst b/classes/class_shader.rst index a7ebbfeaf..68b4f4621 100644 --- a/classes/class_shader.rst +++ b/classes/class_shader.rst @@ -89,16 +89,22 @@ Method Descriptions - :ref:`Texture` **get_default_texture_param** **(** :ref:`String` param **)** const +---- + .. _class_Shader_method_get_mode: - :ref:`Mode` **get_mode** **(** **)** const Returns the shader mode for the shader, either :ref:`MODE_CANVAS_ITEM`, :ref:`MODE_SPATIAL` or :ref:`MODE_PARTICLES` +---- + .. _class_Shader_method_has_param: - :ref:`bool` **has_param** **(** :ref:`String` name **)** const +---- + .. _class_Shader_method_set_default_texture_param: - void **set_default_texture_param** **(** :ref:`String` param, :ref:`Texture` texture **)** diff --git a/classes/class_shadermaterial.rst b/classes/class_shadermaterial.rst index 7b6f37807..33557fe6b 100644 --- a/classes/class_shadermaterial.rst +++ b/classes/class_shadermaterial.rst @@ -72,14 +72,20 @@ Method Descriptions Returns the current value set for this material of a uniform in the shader. +---- + .. _class_ShaderMaterial_method_property_can_revert: - :ref:`bool` **property_can_revert** **(** :ref:`String` name **)** +---- + .. _class_ShaderMaterial_method_property_get_revert: - :ref:`Variant` **property_get_revert** **(** :ref:`String` name **)** +---- + .. _class_ShaderMaterial_method_set_shader_param: - void **set_shader_param** **(** :ref:`String` param, :ref:`Variant` value **)** diff --git a/classes/class_shape2d.rst b/classes/class_shape2d.rst index 7dc5fde30..b4e52901d 100644 --- a/classes/class_shape2d.rst +++ b/classes/class_shape2d.rst @@ -74,6 +74,8 @@ Returns ``true`` if this shape is colliding with another. This method needs the transformation matrix for this shape (``local_xform``), the shape to check collisions with (``with_shape``), and the transformation matrix of that shape (``shape_xform``). +---- + .. _class_Shape2D_method_collide_and_get_contacts: - :ref:`Array` **collide_and_get_contacts** **(** :ref:`Transform2D` local_xform, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform **)** @@ -82,6 +84,8 @@ Returns a list of the points where this shape touches another. If there are no c This method needs the transformation matrix for this shape (``local_xform``), the shape to check collisions with (``with_shape``), and the transformation matrix of that shape (``shape_xform``). +---- + .. _class_Shape2D_method_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 **)** @@ -90,6 +94,8 @@ Returns whether this shape would collide with another, if a given movement was a This method needs the transformation matrix for this shape (``local_xform``), the movement to test on this shape (``local_motion``), the shape to check collisions with (``with_shape``), the transformation matrix of that shape (``shape_xform``), and the movement to test onto the other object (``shape_motion``). +---- + .. _class_Shape2D_method_collide_with_motion_and_get_contacts: - :ref:`Array` **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 **)** diff --git a/classes/class_shortcut.rst b/classes/class_shortcut.rst index 1b3a100bc..e4bffaa1b 100644 --- a/classes/class_shortcut.rst +++ b/classes/class_shortcut.rst @@ -69,12 +69,16 @@ Method Descriptions Returns the shortcut's :ref:`InputEvent` as a :ref:`String`. +---- + .. _class_ShortCut_method_is_shortcut: - :ref:`bool` **is_shortcut** **(** :ref:`InputEvent` event **)** const Returns ``true`` if the shortcut's :ref:`InputEvent` equals ``event``. +---- + .. _class_ShortCut_method_is_valid: - :ref:`bool` **is_valid** **(** **)** const diff --git a/classes/class_skeleton.rst b/classes/class_skeleton.rst index c675af38f..aa26cd7cf 100644 --- a/classes/class_skeleton.rst +++ b/classes/class_skeleton.rst @@ -122,138 +122,190 @@ Method Descriptions Add a bone, with name "name". :ref:`get_bone_count` will become the bone index. +---- + .. _class_Skeleton_method_bind_child_node_to_bone: - void **bind_child_node_to_bone** **(** :ref:`int` bone_idx, :ref:`Node` node **)** Deprecated soon. +---- + .. _class_Skeleton_method_clear_bones: - void **clear_bones** **(** **)** Clear all the bones in this skeleton. +---- + .. _class_Skeleton_method_find_bone: - :ref:`int` **find_bone** **(** :ref:`String` name **)** const Returns the bone index that matches "name" as its name. +---- + .. _class_Skeleton_method_get_bone_count: - :ref:`int` **get_bone_count** **(** **)** const Returns the amount of bones in the skeleton. +---- + .. _class_Skeleton_method_get_bone_custom_pose: - :ref:`Transform` **get_bone_custom_pose** **(** :ref:`int` bone_idx **)** const Returns the custom pose of the specified bone. Custom pose is applied on top of the rest pose. +---- + .. _class_Skeleton_method_get_bone_global_pose: - :ref:`Transform` **get_bone_global_pose** **(** :ref:`int` bone_idx **)** const Returns the overall transform of the specified bone, with respect to the skeleton. Being relative to the skeleton frame, this is not the actual "global" transform of the bone. +---- + .. _class_Skeleton_method_get_bone_name: - :ref:`String` **get_bone_name** **(** :ref:`int` bone_idx **)** const Returns the name of the bone at index "index". +---- + .. _class_Skeleton_method_get_bone_parent: - :ref:`int` **get_bone_parent** **(** :ref:`int` bone_idx **)** const Returns 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_method_get_bone_pose: - :ref:`Transform` **get_bone_pose** **(** :ref:`int` bone_idx **)** const Returns the pose transform of the specified bone. Pose is applied on top of the custom pose, which is applied on top the rest pose. +---- + .. _class_Skeleton_method_get_bone_rest: - :ref:`Transform` **get_bone_rest** **(** :ref:`int` bone_idx **)** const Returns the rest transform for a bone "bone_idx". +---- + .. _class_Skeleton_method_get_bone_transform: - :ref:`Transform` **get_bone_transform** **(** :ref:`int` bone_idx **)** const Returns the combination of custom pose and pose. The returned transform is in skeleton's reference frame. +---- + .. _class_Skeleton_method_get_bound_child_nodes_to_bone: - :ref:`Array` **get_bound_child_nodes_to_bone** **(** :ref:`int` bone_idx **)** const Deprecated soon. +---- + .. _class_Skeleton_method_is_bone_rest_disabled: - :ref:`bool` **is_bone_rest_disabled** **(** :ref:`int` bone_idx **)** const +---- + .. _class_Skeleton_method_physical_bones_add_collision_exception: - void **physical_bones_add_collision_exception** **(** :ref:`RID` exception **)** +---- + .. _class_Skeleton_method_physical_bones_remove_collision_exception: - void **physical_bones_remove_collision_exception** **(** :ref:`RID` exception **)** +---- + .. _class_Skeleton_method_physical_bones_start_simulation: - void **physical_bones_start_simulation** **(** :ref:`Array` bones=[ ] **)** +---- + .. _class_Skeleton_method_physical_bones_stop_simulation: - void **physical_bones_stop_simulation** **(** **)** +---- + .. _class_Skeleton_method_set_bone_custom_pose: - void **set_bone_custom_pose** **(** :ref:`int` bone_idx, :ref:`Transform` custom_pose **)** +---- + .. _class_Skeleton_method_set_bone_disable_rest: - void **set_bone_disable_rest** **(** :ref:`int` bone_idx, :ref:`bool` disable **)** +---- + .. _class_Skeleton_method_set_bone_global_pose: - void **set_bone_global_pose** **(** :ref:`int` bone_idx, :ref:`Transform` pose **)** +---- + .. _class_Skeleton_method_set_bone_ignore_animation: - void **set_bone_ignore_animation** **(** :ref:`int` bone, :ref:`bool` ignore **)** +---- + .. _class_Skeleton_method_set_bone_parent: - 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_method_set_bone_pose: - void **set_bone_pose** **(** :ref:`int` bone_idx, :ref:`Transform` pose **)** Returns the pose transform for bone "bone_idx". +---- + .. _class_Skeleton_method_set_bone_rest: - void **set_bone_rest** **(** :ref:`int` bone_idx, :ref:`Transform` rest **)** Set the rest transform for bone "bone_idx" +---- + .. _class_Skeleton_method_unbind_child_node_from_bone: - void **unbind_child_node_from_bone** **(** :ref:`int` bone_idx, :ref:`Node` node **)** Deprecated soon. +---- + .. _class_Skeleton_method_unparent_bone_and_rest: - void **unparent_bone_and_rest** **(** :ref:`int` bone_idx **)** diff --git a/classes/class_skeleton2d.rst b/classes/class_skeleton2d.rst index 14ee32135..dbc7845ab 100644 --- a/classes/class_skeleton2d.rst +++ b/classes/class_skeleton2d.rst @@ -48,10 +48,14 @@ Method Descriptions - :ref:`Bone2D` **get_bone** **(** :ref:`int` idx **)** +---- + .. _class_Skeleton2D_method_get_bone_count: - :ref:`int` **get_bone_count** **(** **)** const +---- + .. _class_Skeleton2D_method_get_skeleton: - :ref:`RID` **get_skeleton** **(** **)** const diff --git a/classes/class_skeletonik.rst b/classes/class_skeletonik.rst index 993a9f387..fda9882a7 100644 --- a/classes/class_skeletonik.rst +++ b/classes/class_skeletonik.rst @@ -69,6 +69,8 @@ Property Descriptions | *Getter* | get_interpolation() | +----------+--------------------------+ +---- + .. _class_SkeletonIK_property_magnet: - :ref:`Vector3` **magnet** @@ -79,6 +81,8 @@ Property Descriptions | *Getter* | get_magnet_position() | +----------+----------------------------+ +---- + .. _class_SkeletonIK_property_max_iterations: - :ref:`int` **max_iterations** @@ -89,6 +93,8 @@ Property Descriptions | *Getter* | get_max_iterations() | +----------+---------------------------+ +---- + .. _class_SkeletonIK_property_min_distance: - :ref:`float` **min_distance** @@ -99,6 +105,8 @@ Property Descriptions | *Getter* | get_min_distance() | +----------+-------------------------+ +---- + .. _class_SkeletonIK_property_override_tip_basis: - :ref:`bool` **override_tip_basis** @@ -109,6 +117,8 @@ Property Descriptions | *Getter* | is_override_tip_basis() | +----------+-------------------------------+ +---- + .. _class_SkeletonIK_property_root_bone: - :ref:`String` **root_bone** @@ -119,6 +129,8 @@ Property Descriptions | *Getter* | get_root_bone() | +----------+----------------------+ +---- + .. _class_SkeletonIK_property_target: - :ref:`Transform` **target** @@ -129,6 +141,8 @@ Property Descriptions | *Getter* | get_target_transform() | +----------+-----------------------------+ +---- + .. _class_SkeletonIK_property_target_node: - :ref:`NodePath` **target_node** @@ -139,6 +153,8 @@ Property Descriptions | *Getter* | get_target_node() | +----------+------------------------+ +---- + .. _class_SkeletonIK_property_tip_bone: - :ref:`String` **tip_bone** @@ -149,6 +165,8 @@ Property Descriptions | *Getter* | get_tip_bone() | +----------+---------------------+ +---- + .. _class_SkeletonIK_property_use_magnet: - :ref:`bool` **use_magnet** @@ -166,14 +184,20 @@ Method Descriptions - :ref:`Skeleton` **get_parent_skeleton** **(** **)** const +---- + .. _class_SkeletonIK_method_is_running: - :ref:`bool` **is_running** **(** **)** +---- + .. _class_SkeletonIK_method_start: - void **start** **(** :ref:`bool` one_time=false **)** +---- + .. _class_SkeletonIK_method_stop: - void **stop** **(** **)** diff --git a/classes/class_slider.rst b/classes/class_slider.rst index bda25485f..2de1efae9 100644 --- a/classes/class_slider.rst +++ b/classes/class_slider.rst @@ -55,6 +55,8 @@ Property Descriptions If ``true``, the slider can be interacted with. If ``false``, the value can be changed only by code. +---- + .. _class_Slider_property_focus_mode: - :ref:`FocusMode` **focus_mode** @@ -65,6 +67,8 @@ If ``true``, the slider can be interacted with. If ``false``, the value can be c | *Getter* | get_focus_mode() | +----------+-----------------------+ +---- + .. _class_Slider_property_scrollable: - :ref:`bool` **scrollable** @@ -77,6 +81,8 @@ If ``true``, the slider can be interacted with. If ``false``, the value can be c If ``true``, the value can be changed using the mouse wheel. +---- + .. _class_Slider_property_tick_count: - :ref:`int` **tick_count** @@ -89,6 +95,8 @@ If ``true``, the value can be changed using the mouse wheel. Number of ticks displayed on the slider, including border ticks. Ticks are uniformly-distributed value markers. +---- + .. _class_Slider_property_ticks_on_borders: - :ref:`bool` **ticks_on_borders** diff --git a/classes/class_sliderjoint.rst b/classes/class_sliderjoint.rst index 54b4b7247..efcf8bdde 100644 --- a/classes/class_sliderjoint.rst +++ b/classes/class_sliderjoint.rst @@ -188,12 +188,16 @@ The amount of damping of the rotation when the limit is surpassed. A lower damping value allows a rotation initiated by body A to travel to body B slower. +---- + .. _class_SliderJoint_property_angular_limit/lower_angle: - :ref:`float` **angular_limit/lower_angle** The lower limit of rotation in the slider. +---- + .. _class_SliderJoint_property_angular_limit/restitution: - :ref:`float` **angular_limit/restitution** @@ -208,6 +212,8 @@ The amount of restitution of the rotation when the limit is surpassed. Does not affect damping. +---- + .. _class_SliderJoint_property_angular_limit/softness: - :ref:`float` **angular_limit/softness** @@ -222,12 +228,16 @@ A factor applied to the all rotation once the limit is surpassed. Makes all rotation slower when between 0 and 1. +---- + .. _class_SliderJoint_property_angular_limit/upper_angle: - :ref:`float` **angular_limit/upper_angle** The upper limit of rotation in the slider. +---- + .. _class_SliderJoint_property_angular_motion/damping: - :ref:`float` **angular_motion/damping** @@ -240,6 +250,8 @@ The upper limit of rotation in the slider. The amount of damping of the rotation in the limits. +---- + .. _class_SliderJoint_property_angular_motion/restitution: - :ref:`float` **angular_motion/restitution** @@ -252,6 +264,8 @@ The amount of damping of the rotation in the limits. The amount of restitution of the rotation in the limits. +---- + .. _class_SliderJoint_property_angular_motion/softness: - :ref:`float` **angular_motion/softness** @@ -264,6 +278,8 @@ The amount of restitution of the rotation in the limits. A factor applied to the all rotation in the limits. +---- + .. _class_SliderJoint_property_angular_ortho/damping: - :ref:`float` **angular_ortho/damping** @@ -276,6 +292,8 @@ A factor applied to the all rotation in the limits. The amount of damping of the rotation across axes orthogonal to the slider. +---- + .. _class_SliderJoint_property_angular_ortho/restitution: - :ref:`float` **angular_ortho/restitution** @@ -288,6 +306,8 @@ The amount of damping of the rotation across axes orthogonal to the slider. The amount of restitution of the rotation across axes orthogonal to the slider. +---- + .. _class_SliderJoint_property_angular_ortho/softness: - :ref:`float` **angular_ortho/softness** @@ -300,6 +320,8 @@ The amount of restitution of the rotation across axes orthogonal to the slider. A factor applied to the all rotation across axes orthogonal to the slider. +---- + .. _class_SliderJoint_property_linear_limit/damping: - :ref:`float` **linear_limit/damping** @@ -312,6 +334,8 @@ A factor applied to the all rotation across axes orthogonal to the slider. The amount of damping that happens once the limit defined by :ref:`linear_limit/lower_distance` and :ref:`linear_limit/upper_distance` is surpassed. +---- + .. _class_SliderJoint_property_linear_limit/lower_distance: - :ref:`float` **linear_limit/lower_distance** @@ -324,6 +348,8 @@ The amount of damping that happens once the limit defined by :ref:`linear_limit/ The minimum difference between the pivot points on their x-axis before damping happens. +---- + .. _class_SliderJoint_property_linear_limit/restitution: - :ref:`float` **linear_limit/restitution** @@ -336,6 +362,8 @@ The minimum difference between the pivot points on their x-axis before damping h The amount of restitution once the limits are surpassed. The lower, the more velocity-energy gets lost. +---- + .. _class_SliderJoint_property_linear_limit/softness: - :ref:`float` **linear_limit/softness** @@ -348,6 +376,8 @@ The amount of restitution once the limits are surpassed. The lower, the more vel A factor applied to the movement across the slider axis once the limits get surpassed. The lower, the slower the movement. +---- + .. _class_SliderJoint_property_linear_limit/upper_distance: - :ref:`float` **linear_limit/upper_distance** @@ -360,6 +390,8 @@ A factor applied to the movement across the slider axis once the limits get surp The maximum difference between the pivot points on their x-axis before damping happens. +---- + .. _class_SliderJoint_property_linear_motion/damping: - :ref:`float` **linear_motion/damping** @@ -372,6 +404,8 @@ The maximum difference between the pivot points on their x-axis before damping h The amount of damping inside the slider limits. +---- + .. _class_SliderJoint_property_linear_motion/restitution: - :ref:`float` **linear_motion/restitution** @@ -384,6 +418,8 @@ The amount of damping inside the slider limits. The amount of restitution inside the slider limits. +---- + .. _class_SliderJoint_property_linear_motion/softness: - :ref:`float` **linear_motion/softness** @@ -396,6 +432,8 @@ The amount of restitution inside the slider limits. A factor applied to the movement across the slider axis as long as the slider is in the limits. The lower, the slower the movement. +---- + .. _class_SliderJoint_property_linear_ortho/damping: - :ref:`float` **linear_ortho/damping** @@ -408,6 +446,8 @@ A factor applied to the movement across the slider axis as long as the slider is The amount of damping when movement is across axes orthogonal to the slider. +---- + .. _class_SliderJoint_property_linear_ortho/restitution: - :ref:`float` **linear_ortho/restitution** @@ -420,6 +460,8 @@ The amount of damping when movement is across axes orthogonal to the slider. The amount of restitution when movement is across axes orthogonal to the slider. +---- + .. _class_SliderJoint_property_linear_ortho/softness: - :ref:`float` **linear_ortho/softness** diff --git a/classes/class_softbody.rst b/classes/class_softbody.rst index d384b17e7..baf3dfe8e 100644 --- a/classes/class_softbody.rst +++ b/classes/class_softbody.rst @@ -88,6 +88,8 @@ Property Descriptions | *Getter* | get_areaAngular_stiffness() | +----------+----------------------------------+ +---- + .. _class_SoftBody_property_collision_layer: - :ref:`int` **collision_layer** @@ -104,6 +106,8 @@ Collidable objects can exist in any of 32 different layers. These layers work li A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. +---- + .. _class_SoftBody_property_collision_mask: - :ref:`int` **collision_mask** @@ -116,6 +120,8 @@ A contact is detected if object A is in any of the layers that object B scans, o The physics layers this area scans for collisions. +---- + .. _class_SoftBody_property_damping_coefficient: - :ref:`float` **damping_coefficient** @@ -126,6 +132,8 @@ The physics layers this area scans for collisions. | *Getter* | get_damping_coefficient() | +----------+--------------------------------+ +---- + .. _class_SoftBody_property_drag_coefficient: - :ref:`float` **drag_coefficient** @@ -136,6 +144,8 @@ The physics layers this area scans for collisions. | *Getter* | get_drag_coefficient() | +----------+-----------------------------+ +---- + .. _class_SoftBody_property_linear_stiffness: - :ref:`float` **linear_stiffness** @@ -146,6 +156,8 @@ The physics layers this area scans for collisions. | *Getter* | get_linear_stiffness() | +----------+-----------------------------+ +---- + .. _class_SoftBody_property_parent_collision_ignore: - :ref:`NodePath` **parent_collision_ignore** @@ -156,6 +168,8 @@ The physics layers this area scans for collisions. | *Getter* | get_parent_collision_ignore() | +----------+------------------------------------+ +---- + .. _class_SoftBody_property_pose_matching_coefficient: - :ref:`float` **pose_matching_coefficient** @@ -166,6 +180,8 @@ The physics layers this area scans for collisions. | *Getter* | get_pose_matching_coefficient() | +----------+--------------------------------------+ +---- + .. _class_SoftBody_property_pressure_coefficient: - :ref:`float` **pressure_coefficient** @@ -176,6 +192,8 @@ The physics layers this area scans for collisions. | *Getter* | get_pressure_coefficient() | +----------+---------------------------------+ +---- + .. _class_SoftBody_property_simulation_precision: - :ref:`int` **simulation_precision** @@ -188,6 +206,8 @@ The physics layers this area scans for collisions. Increasing this value will improve the resulting simulation, but can affect performance. Use with care. +---- + .. _class_SoftBody_property_total_mass: - :ref:`float` **total_mass** @@ -198,6 +218,8 @@ Increasing this value will improve the resulting simulation, but can affect perf | *Getter* | get_total_mass() | +----------+-----------------------+ +---- + .. _class_SoftBody_property_volume_stiffness: - :ref:`float` **volume_stiffness** @@ -217,46 +239,62 @@ Method Descriptions Adds a body to the list of bodies that this body can't collide with. +---- + .. _class_SoftBody_method_get_collision_exceptions: - :ref:`Array` **get_collision_exceptions** **(** **)** Returns an array of nodes that were added as collision exceptions for this body. +---- + .. _class_SoftBody_method_get_collision_layer_bit: - :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const Returns an individual bit on the collision mask. +---- + .. _class_SoftBody_method_get_collision_mask_bit: - :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const Returns an individual bit on the collision mask. +---- + .. _class_SoftBody_method_is_ray_pickable: - :ref:`bool` **is_ray_pickable** **(** **)** const +---- + .. _class_SoftBody_method_remove_collision_exception_with: - void **remove_collision_exception_with** **(** :ref:`Node` body **)** Removes a body from the list of bodies that this body can't collide with. +---- + .. _class_SoftBody_method_set_collision_layer_bit: - void **set_collision_layer_bit** **(** :ref:`int` bit, :ref:`bool` value **)** Sets individual bits on the layer mask. Use this if you only need to change one layer's value. +---- + .. _class_SoftBody_method_set_collision_mask_bit: - void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** Sets individual bits on the collision mask. Use this if you only need to change one layer's value. +---- + .. _class_SoftBody_method_set_ray_pickable: - void **set_ray_pickable** **(** :ref:`bool` ray_pickable **)** diff --git a/classes/class_spatial.rst b/classes/class_spatial.rst index f90b335e6..b89a8d5e8 100644 --- a/classes/class_spatial.rst +++ b/classes/class_spatial.rst @@ -169,6 +169,8 @@ Property Descriptions The :ref:`SpatialGizmo` for this node. Used for example in :ref:`EditorSpatialGizmo` as custom visualization and editing handles in Editor. +---- + .. _class_Spatial_property_global_transform: - :ref:`Transform` **global_transform** @@ -181,6 +183,8 @@ The :ref:`SpatialGizmo` for this node. Used for example in : World space (global) :ref:`Transform` of this node. +---- + .. _class_Spatial_property_rotation: - :ref:`Vector3` **rotation** @@ -195,6 +199,8 @@ Rotation part of the local transformation in radians, specified in terms of YXZ- Note that in the mathematical sense, rotation is a matrix and not a vector. The three Euler angles, which are the three independent parameters of the Euler-angle parametrization of the rotation matrix, are stored in a :ref:`Vector3` data structure not because the rotation is a vector, but only because :ref:`Vector3` exists as a convenient data-structure to store 3 floating point numbers. Therefore, applying affine operations on the rotation "vector" is not meaningful. +---- + .. _class_Spatial_property_rotation_degrees: - :ref:`Vector3` **rotation_degrees** @@ -207,6 +213,8 @@ Note that in the mathematical sense, rotation is a matrix and not a vector. The Rotation part of the local transformation in degrees, specified in terms of YXZ-Euler angles in the format (X-angle, Y-angle, Z-angle). +---- + .. _class_Spatial_property_scale: - :ref:`Vector3` **scale** @@ -219,6 +227,8 @@ Rotation part of the local transformation in degrees, specified in terms of YXZ- Scale part of the local transformation. +---- + .. _class_Spatial_property_transform: - :ref:`Transform` **transform** @@ -231,6 +241,8 @@ Scale part of the local transformation. Local space :ref:`Transform` of this node, with respect to the parent node. +---- + .. _class_Spatial_property_translation: - :ref:`Vector3` **translation** @@ -243,6 +255,8 @@ Local space :ref:`Transform` of this node, with respect to the Local translation of this node. +---- + .. _class_Spatial_property_visible: - :ref:`bool` **visible** @@ -262,68 +276,92 @@ Method Descriptions - void **force_update_transform** **(** **)** +---- + .. _class_Spatial_method_get_parent_spatial: - :ref:`Spatial` **get_parent_spatial** **(** **)** const Returns the parent ``Spatial``, or an empty :ref:`Object` if no parent exists or parent is not of type ``Spatial``. +---- + .. _class_Spatial_method_get_world: - :ref:`World` **get_world** **(** **)** const Returns the current :ref:`World` resource this ``Spatial`` node is registered to. +---- + .. _class_Spatial_method_global_rotate: - void **global_rotate** **(** :ref:`Vector3` axis, :ref:`float` angle **)** Rotates the global (world) transformation around axis, a unit :ref:`Vector3`, by specified angle in radians. The rotation axis is in global coordinate system. +---- + .. _class_Spatial_method_global_scale: - void **global_scale** **(** :ref:`Vector3` scale **)** +---- + .. _class_Spatial_method_global_translate: - void **global_translate** **(** :ref:`Vector3` offset **)** Moves the global (world) transformation by :ref:`Vector3` offset. The offset is in global coordinate system. +---- + .. _class_Spatial_method_hide: - void **hide** **(** **)** Disables rendering of this node. Changes :ref:`visible` to ``false``. +---- + .. _class_Spatial_method_is_local_transform_notification_enabled: - :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_method_is_scale_disabled: - :ref:`bool` **is_scale_disabled** **(** **)** const +---- + .. _class_Spatial_method_is_set_as_toplevel: - :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_method_is_transform_notification_enabled: - :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_method_is_visible_in_tree: - :ref:`bool` **is_visible_in_tree** **(** **)** const Returns whether the node is visible, taking into consideration that its parents visibility. +---- + .. _class_Spatial_method_look_at: - void **look_at** **(** :ref:`Vector3` target, :ref:`Vector3` up **)** @@ -334,106 +372,142 @@ The transform will first be rotated around the given ``up`` vector, and then ful Operations take place in global space. +---- + .. _class_Spatial_method_look_at_from_position: - void **look_at_from_position** **(** :ref:`Vector3` position, :ref:`Vector3` target, :ref:`Vector3` up **)** Moves the node to the specified ``position``, and then rotates itself to point toward the ``target`` as per :ref:`look_at`. Operations take place in global space. +---- + .. _class_Spatial_method_orthonormalize: - void **orthonormalize** **(** **)** Resets this node's transformations (like scale, skew and taper) preserving its rotation and translation by performing Gram-Schmidt orthonormalization on this node's :ref:`Transform`. +---- + .. _class_Spatial_method_rotate: - void **rotate** **(** :ref:`Vector3` axis, :ref:`float` angle **)** Rotates the local transformation around axis, a unit :ref:`Vector3`, by specified angle in radians. +---- + .. _class_Spatial_method_rotate_object_local: - void **rotate_object_local** **(** :ref:`Vector3` axis, :ref:`float` angle **)** Rotates the local transformation around axis, a unit :ref:`Vector3`, by specified angle in radians. The rotation axis is in object-local coordinate system. +---- + .. _class_Spatial_method_rotate_x: - void **rotate_x** **(** :ref:`float` angle **)** Rotates the local transformation around the X axis by angle in radians +---- + .. _class_Spatial_method_rotate_y: - void **rotate_y** **(** :ref:`float` angle **)** Rotates the local transformation around the Y axis by angle in radians. +---- + .. _class_Spatial_method_rotate_z: - void **rotate_z** **(** :ref:`float` angle **)** Rotates the local transformation around the Z axis by angle in radians. +---- + .. _class_Spatial_method_scale_object_local: - void **scale_object_local** **(** :ref:`Vector3` scale **)** Scales the local transformation by given 3D scale factors in object-local coordinate system. +---- + .. _class_Spatial_method_set_as_toplevel: - void **set_as_toplevel** **(** :ref:`bool` enable **)** Makes the node ignore its parents transformations. Node transformations are only in global space. +---- + .. _class_Spatial_method_set_disable_scale: - void **set_disable_scale** **(** :ref:`bool` disable **)** +---- + .. _class_Spatial_method_set_identity: - void **set_identity** **(** **)** Reset all transformations for this node. Set its :ref:`Transform` to identity matrix. +---- + .. _class_Spatial_method_set_ignore_transform_notification: - void **set_ignore_transform_notification** **(** :ref:`bool` enabled **)** Set whether the node ignores notification that its transformation (global or local) changed. +---- + .. _class_Spatial_method_set_notify_local_transform: - 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_method_set_notify_transform: - 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_method_show: - void **show** **(** **)** Enables rendering of this node. Changes :ref:`visible` to ``true``. +---- + .. _class_Spatial_method_to_global: - :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_method_to_local: - :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_method_translate: - void **translate** **(** :ref:`Vector3` offset **)** @@ -442,10 +516,14 @@ Changes the node's position by given offset :ref:`Vector3`. Note that the translation ``offset`` is affected by the node's scale, so if scaled by e.g. ``(10, 1, 1)``, a translation by an offset of ``(2, 0, 0)`` would actually add 20 (``2 * 10``) to the X coordinate. +---- + .. _class_Spatial_method_translate_object_local: - void **translate_object_local** **(** :ref:`Vector3` offset **)** +---- + .. _class_Spatial_method_update_gizmo: - void **update_gizmo** **(** **)** diff --git a/classes/class_spatialmaterial.rst b/classes/class_spatialmaterial.rst index 045ac23c6..faeca8ddb 100644 --- a/classes/class_spatialmaterial.rst +++ b/classes/class_spatialmaterial.rst @@ -298,6 +298,8 @@ enum **TextureParam**: - **TEXTURE_MAX** = **16** --- Represents the size of the :ref:`TextureParam` enum. +---- + .. _enum_SpatialMaterial_DetailUV: .. _class_SpatialMaterial_constant_DETAIL_UV_1: @@ -310,6 +312,8 @@ enum **DetailUV**: - **DETAIL_UV_2** = **1** +---- + .. _enum_SpatialMaterial_Feature: .. _class_SpatialMaterial_constant_FEATURE_TRANSPARENT: @@ -366,6 +370,8 @@ enum **Feature**: - **FEATURE_MAX** = **12** --- Represents the size of the :ref:`Feature` enum. +---- + .. _enum_SpatialMaterial_BlendMode: .. _class_SpatialMaterial_constant_BLEND_MODE_MIX: @@ -386,6 +392,8 @@ enum **BlendMode**: - **BLEND_MODE_MUL** = **3** +---- + .. _enum_SpatialMaterial_DepthDrawMode: .. _class_SpatialMaterial_constant_DEPTH_DRAW_OPAQUE_ONLY: @@ -406,6 +414,8 @@ enum **DepthDrawMode**: - **DEPTH_DRAW_ALPHA_OPAQUE_PREPASS** = **3** --- For transparent objects, an opaque pass is made first with the opaque parts, then transparency is drawn. +---- + .. _enum_SpatialMaterial_CullMode: .. _class_SpatialMaterial_constant_CULL_BACK: @@ -422,6 +432,8 @@ enum **CullMode**: - **CULL_DISABLED** = **2** --- No culling is performed. +---- + .. _enum_SpatialMaterial_Flags: .. _class_SpatialMaterial_constant_FLAG_UNSHADED: @@ -502,6 +514,8 @@ enum **Flags**: - **FLAG_MAX** = **18** --- Represents the size of the :ref:`Flags` enum. +---- + .. _enum_SpatialMaterial_DiffuseMode: .. _class_SpatialMaterial_constant_DIFFUSE_BURLEY: @@ -526,6 +540,8 @@ enum **DiffuseMode**: - **DIFFUSE_TOON** = **4** --- Uses a hard cut for lighting, with smoothing affected by roughness. +---- + .. _enum_SpatialMaterial_SpecularMode: .. _class_SpatialMaterial_constant_SPECULAR_SCHLICK_GGX: @@ -550,6 +566,8 @@ enum **SpecularMode**: - **SPECULAR_DISABLED** = **4** --- No specular blob. +---- + .. _enum_SpatialMaterial_BillboardMode: .. _class_SpatialMaterial_constant_BILLBOARD_DISABLED: @@ -570,6 +588,8 @@ enum **BillboardMode**: - **BILLBOARD_PARTICLES** = **3** --- Used for particle systems. Enables particle animation options. +---- + .. _enum_SpatialMaterial_TextureChannel: .. _class_SpatialMaterial_constant_TEXTURE_CHANNEL_RED: @@ -594,6 +614,8 @@ enum **TextureChannel**: - **TEXTURE_CHANNEL_GRAYSCALE** = **4** +---- + .. _enum_SpatialMaterial_EmissionOperator: .. _class_SpatialMaterial_constant_EMISSION_OP_ADD: @@ -606,6 +628,8 @@ enum **EmissionOperator**: - **EMISSION_OP_MULTIPLY** = **1** +---- + .. _enum_SpatialMaterial_DistanceFadeMode: .. _class_SpatialMaterial_constant_DISTANCE_FADE_DISABLED: @@ -651,6 +675,8 @@ Property Descriptions The material's base color. +---- + .. _class_SpatialMaterial_property_albedo_texture: - :ref:`Texture` **albedo_texture** @@ -661,6 +687,8 @@ The material's base color. | *Getter* | get_texture() | +----------+--------------------+ +---- + .. _class_SpatialMaterial_property_anisotropy: - :ref:`float` **anisotropy** @@ -673,6 +701,8 @@ The material's base color. The strength of the anisotropy effect. +---- + .. _class_SpatialMaterial_property_anisotropy_enabled: - :ref:`bool` **anisotropy_enabled** @@ -685,6 +715,8 @@ The strength of the anisotropy effect. If ``true``, anisotropy is enabled. Changes the shape of the specular blob and aligns it to tangent space. Default value: ``false``. +---- + .. _class_SpatialMaterial_property_anisotropy_flowmap: - :ref:`Texture` **anisotropy_flowmap** @@ -695,6 +727,8 @@ If ``true``, anisotropy is enabled. Changes the shape of the specular blob and a | *Getter* | get_texture() | +----------+--------------------+ +---- + .. _class_SpatialMaterial_property_ao_enabled: - :ref:`bool` **ao_enabled** @@ -707,6 +741,8 @@ If ``true``, anisotropy is enabled. Changes the shape of the specular blob and a If ``true``, ambient occlusion is enabled. +---- + .. _class_SpatialMaterial_property_ao_light_affect: - :ref:`float` **ao_light_affect** @@ -717,6 +753,8 @@ If ``true``, ambient occlusion is enabled. | *Getter* | get_ao_light_affect() | +----------+----------------------------+ +---- + .. _class_SpatialMaterial_property_ao_on_uv2: - :ref:`bool` **ao_on_uv2** @@ -727,6 +765,8 @@ If ``true``, ambient occlusion is enabled. | *Getter* | get_flag() | +----------+-----------------+ +---- + .. _class_SpatialMaterial_property_ao_texture: - :ref:`Texture` **ao_texture** @@ -737,6 +777,8 @@ If ``true``, ambient occlusion is enabled. | *Getter* | get_texture() | +----------+--------------------+ +---- + .. _class_SpatialMaterial_property_ao_texture_channel: - :ref:`TextureChannel` **ao_texture_channel** @@ -747,6 +789,8 @@ If ``true``, ambient occlusion is enabled. | *Getter* | get_ao_texture_channel() | +----------+-------------------------------+ +---- + .. _class_SpatialMaterial_property_clearcoat: - :ref:`float` **clearcoat** @@ -757,6 +801,8 @@ If ``true``, ambient occlusion is enabled. | *Getter* | get_clearcoat() | +----------+----------------------+ +---- + .. _class_SpatialMaterial_property_clearcoat_enabled: - :ref:`bool` **clearcoat_enabled** @@ -769,6 +815,8 @@ If ``true``, ambient occlusion is enabled. If ``true``, clearcoat rendering is enabled. Adds a secondary transparent pass to the material. Default value: ``false``. +---- + .. _class_SpatialMaterial_property_clearcoat_gloss: - :ref:`float` **clearcoat_gloss** @@ -779,6 +827,8 @@ If ``true``, clearcoat rendering is enabled. Adds a secondary transparent pass t | *Getter* | get_clearcoat_gloss() | +----------+----------------------------+ +---- + .. _class_SpatialMaterial_property_clearcoat_texture: - :ref:`Texture` **clearcoat_texture** @@ -789,6 +839,8 @@ If ``true``, clearcoat rendering is enabled. Adds a secondary transparent pass t | *Getter* | get_texture() | +----------+--------------------+ +---- + .. _class_SpatialMaterial_property_depth_deep_parallax: - :ref:`bool` **depth_deep_parallax** @@ -799,6 +851,8 @@ If ``true``, clearcoat rendering is enabled. Adds a secondary transparent pass t | *Getter* | is_depth_deep_parallax_enabled() | +----------+----------------------------------+ +---- + .. _class_SpatialMaterial_property_depth_enabled: - :ref:`bool` **depth_enabled** @@ -811,6 +865,8 @@ If ``true``, clearcoat rendering is enabled. Adds a secondary transparent pass t If ``true``, Depth mapping is enabled. See also :ref:`normal_enabled`. +---- + .. _class_SpatialMaterial_property_depth_flip_binormal: - :ref:`bool` **depth_flip_binormal** @@ -821,6 +877,8 @@ If ``true``, Depth mapping is enabled. See also :ref:`normal_enabled` **depth_flip_tangent** @@ -831,6 +889,8 @@ If ``true``, Depth mapping is enabled. See also :ref:`normal_enabled` **depth_max_layers** @@ -841,6 +901,8 @@ If ``true``, Depth mapping is enabled. See also :ref:`normal_enabled` **depth_min_layers** @@ -851,6 +913,8 @@ If ``true``, Depth mapping is enabled. See also :ref:`normal_enabled` **depth_scale** @@ -861,6 +925,8 @@ If ``true``, Depth mapping is enabled. See also :ref:`normal_enabled` **depth_texture** @@ -871,6 +937,8 @@ If ``true``, Depth mapping is enabled. See also :ref:`normal_enabled` **detail_albedo** @@ -881,6 +949,8 @@ If ``true``, Depth mapping is enabled. See also :ref:`normal_enabled` **detail_blend_mode** @@ -891,6 +961,8 @@ If ``true``, Depth mapping is enabled. See also :ref:`normal_enabled` **detail_enabled** @@ -901,6 +973,8 @@ If ``true``, Depth mapping is enabled. See also :ref:`normal_enabled` **detail_mask** @@ -911,6 +985,8 @@ If ``true``, Depth mapping is enabled. See also :ref:`normal_enabled` **detail_normal** @@ -921,6 +997,8 @@ If ``true``, Depth mapping is enabled. See also :ref:`normal_enabled` **detail_uv_layer** @@ -931,6 +1009,8 @@ If ``true``, Depth mapping is enabled. See also :ref:`normal_enabled` **distance_fade_max_distance** @@ -941,6 +1021,8 @@ If ``true``, Depth mapping is enabled. See also :ref:`normal_enabled` **distance_fade_min_distance** @@ -951,6 +1033,8 @@ If ``true``, Depth mapping is enabled. See also :ref:`normal_enabled` **distance_fade_mode** @@ -961,6 +1045,8 @@ If ``true``, Depth mapping is enabled. See also :ref:`normal_enabled` **emission** @@ -973,6 +1059,8 @@ If ``true``, Depth mapping is enabled. See also :ref:`normal_enabled`. +---- + .. _class_SpatialMaterial_property_emission_enabled: - :ref:`bool` **emission_enabled** @@ -985,6 +1073,8 @@ The emitted light's color. See :ref:`emission_enabled` **emission_energy** @@ -997,6 +1087,8 @@ If ``true``, the body emits light. The emitted light's strength. See :ref:`emission_enabled`. +---- + .. _class_SpatialMaterial_property_emission_on_uv2: - :ref:`bool` **emission_on_uv2** @@ -1007,6 +1099,8 @@ The emitted light's strength. See :ref:`emission_enabled` **emission_operator** @@ -1017,6 +1111,8 @@ The emitted light's strength. See :ref:`emission_enabled` **emission_texture** @@ -1027,6 +1123,8 @@ The emitted light's strength. See :ref:`emission_enabled` **flags_albedo_tex_force_srgb** @@ -1037,6 +1135,8 @@ The emitted light's strength. See :ref:`emission_enabled` **flags_disable_ambient_light** @@ -1049,6 +1149,8 @@ The emitted light's strength. See :ref:`emission_enabled` **flags_do_not_receive_shadows** @@ -1061,6 +1163,8 @@ If ``true``, the object receives no ambient light. Default value: ``false``. If ``true``, the object receives no shadow that would otherwise be cast onto it. Default value: ``false``. +---- + .. _class_SpatialMaterial_property_flags_ensure_correct_normals: - :ref:`bool` **flags_ensure_correct_normals** @@ -1071,6 +1175,8 @@ If ``true``, the object receives no shadow that would otherwise be cast onto it. | *Getter* | get_flag() | +----------+-----------------+ +---- + .. _class_SpatialMaterial_property_flags_fixed_size: - :ref:`bool` **flags_fixed_size** @@ -1083,6 +1189,8 @@ If ``true``, the object receives no shadow that would otherwise be cast onto it. If ``true``, the object is rendered at the same size regardless of distance. Default value: ``false``. +---- + .. _class_SpatialMaterial_property_flags_no_depth_test: - :ref:`bool` **flags_no_depth_test** @@ -1095,6 +1203,8 @@ If ``true``, the object is rendered at the same size regardless of distance. Def If ``true``, depth testing is disabled and the object will be drawn in render order. +---- + .. _class_SpatialMaterial_property_flags_transparent: - :ref:`bool` **flags_transparent** @@ -1107,6 +1217,8 @@ If ``true``, depth testing is disabled and the object will be drawn in render or If ``true``, transparency is enabled on the body. Default value: ``false``. See also :ref:`params_blend_mode`. +---- + .. _class_SpatialMaterial_property_flags_unshaded: - :ref:`bool` **flags_unshaded** @@ -1119,6 +1231,8 @@ If ``true``, transparency is enabled on the body. Default value: ``false``. See If ``true``, the object is unaffected by lighting. Default value: ``false``. +---- + .. _class_SpatialMaterial_property_flags_use_point_size: - :ref:`bool` **flags_use_point_size** @@ -1131,6 +1245,8 @@ If ``true``, the object is unaffected by lighting. Default value: ``false``. If ``true``, render point size can be changed. Note: this is only effective for objects whose geometry is point-based rather than triangle-based. See also :ref:`params_point_size`. +---- + .. _class_SpatialMaterial_property_flags_vertex_lighting: - :ref:`bool` **flags_vertex_lighting** @@ -1143,6 +1259,8 @@ If ``true``, render point size can be changed. Note: this is only effective for If ``true``, lighting is calculated per vertex rather than per pixel. This may increase performance on low-end devices. Default value: ``false``. +---- + .. _class_SpatialMaterial_property_flags_world_triplanar: - :ref:`bool` **flags_world_triplanar** @@ -1155,6 +1273,8 @@ If ``true``, lighting is calculated per vertex rather than per pixel. This may i If ``true``, triplanar mapping is calculated in world space rather than object local space. See also :ref:`uv1_triplanar`. Default value: ``false``. +---- + .. _class_SpatialMaterial_property_metallic: - :ref:`float` **metallic** @@ -1167,6 +1287,8 @@ If ``true``, triplanar mapping is calculated in world space rather than object l The reflectivity of the object's surface. The higher the value the more light is reflected. +---- + .. _class_SpatialMaterial_property_metallic_specular: - :ref:`float` **metallic_specular** @@ -1179,6 +1301,8 @@ The reflectivity of the object's surface. The higher the value the more light is General reflectivity amount. Note: unlike :ref:`metallic`, this is not energy-conserving, so it should be left at ``0.5`` in most cases. See also :ref:`roughness`. +---- + .. _class_SpatialMaterial_property_metallic_texture: - :ref:`Texture` **metallic_texture** @@ -1189,6 +1313,8 @@ General reflectivity amount. Note: unlike :ref:`metallic` **metallic_texture_channel** @@ -1199,6 +1325,8 @@ General reflectivity amount. Note: unlike :ref:`metallic` **normal_enabled** @@ -1211,6 +1339,8 @@ General reflectivity amount. Note: unlike :ref:`metallic` **normal_scale** @@ -1223,6 +1353,8 @@ If ``true``, normal mapping is enabled. The strength of the normal map's effect. +---- + .. _class_SpatialMaterial_property_normal_texture: - :ref:`Texture` **normal_texture** @@ -1233,6 +1365,8 @@ The strength of the normal map's effect. | *Getter* | get_texture() | +----------+--------------------+ +---- + .. _class_SpatialMaterial_property_params_alpha_scissor_threshold: - :ref:`float` **params_alpha_scissor_threshold** @@ -1243,6 +1377,8 @@ The strength of the normal map's effect. | *Getter* | get_alpha_scissor_threshold() | +----------+------------------------------------+ +---- + .. _class_SpatialMaterial_property_params_billboard_keep_scale: - :ref:`bool` **params_billboard_keep_scale** @@ -1253,6 +1389,8 @@ The strength of the normal map's effect. | *Getter* | get_flag() | +----------+-----------------+ +---- + .. _class_SpatialMaterial_property_params_billboard_mode: - :ref:`BillboardMode` **params_billboard_mode** @@ -1265,6 +1403,8 @@ The strength of the normal map's effect. Controls how the object faces the camera. See :ref:`BillboardMode`. +---- + .. _class_SpatialMaterial_property_params_blend_mode: - :ref:`BlendMode` **params_blend_mode** @@ -1277,6 +1417,8 @@ Controls how the object faces the camera. See :ref:`BillboardMode`. +---- + .. _class_SpatialMaterial_property_params_cull_mode: - :ref:`CullMode` **params_cull_mode** @@ -1289,6 +1431,8 @@ The material's blend mode. Note that values other than ``Mix`` force the object Which side of the object is not drawn when backfaces are rendered. See :ref:`CullMode`. +---- + .. _class_SpatialMaterial_property_params_depth_draw_mode: - :ref:`DepthDrawMode` **params_depth_draw_mode** @@ -1301,6 +1445,8 @@ Which side of the object is not drawn when backfaces are rendered. See :ref:`Cul Determines when depth rendering takes place. See :ref:`DepthDrawMode`. See also :ref:`flags_transparent`. +---- + .. _class_SpatialMaterial_property_params_diffuse_mode: - :ref:`DiffuseMode` **params_diffuse_mode** @@ -1313,6 +1459,8 @@ Determines when depth rendering takes place. See :ref:`DepthDrawMode`. +---- + .. _class_SpatialMaterial_property_params_grow: - :ref:`bool` **params_grow** @@ -1325,6 +1473,8 @@ The algorithm used for diffuse light scattering. See :ref:`DiffuseMode`. +---- + .. _class_SpatialMaterial_property_params_grow_amount: - :ref:`float` **params_grow_amount** @@ -1337,6 +1487,8 @@ If ``true``, enables the vertex grow setting. See :ref:`params_grow_amount` **params_line_width** @@ -1347,6 +1499,8 @@ Grows object vertices in the direction of their normals. | *Getter* | get_line_width() | +----------+-----------------------+ +---- + .. _class_SpatialMaterial_property_params_point_size: - :ref:`float` **params_point_size** @@ -1359,6 +1513,8 @@ Grows object vertices in the direction of their normals. The point size in pixels. See :ref:`flags_use_point_size`. +---- + .. _class_SpatialMaterial_property_params_specular_mode: - :ref:`SpecularMode` **params_specular_mode** @@ -1371,6 +1527,8 @@ The point size in pixels. See :ref:`flags_use_point_size`. +---- + .. _class_SpatialMaterial_property_params_use_alpha_scissor: - :ref:`bool` **params_use_alpha_scissor** @@ -1381,6 +1539,8 @@ The method for rendering the specular blob. See :ref:`SpecularMode` **particles_anim_h_frames** @@ -1393,6 +1553,8 @@ The method for rendering the specular blob. See :ref:`SpecularMode`. +---- + .. _class_SpatialMaterial_property_particles_anim_loop: - :ref:`bool` **particles_anim_loop** @@ -1405,6 +1567,8 @@ The number of horizontal frames in the particle spritesheet. Only enabled when u If ``true``, particle animations are looped. Only enabled when using ``BillboardMode.BILLBOARD_PARTICLES``. See :ref:`params_billboard_mode`. +---- + .. _class_SpatialMaterial_property_particles_anim_v_frames: - :ref:`int` **particles_anim_v_frames** @@ -1417,6 +1581,8 @@ If ``true``, particle animations are looped. Only enabled when using ``Billboard The number of vertical frames in the particle spritesheet. Only enabled when using ``BillboardMode.BILLBOARD_PARTICLES``. See :ref:`params_billboard_mode`. +---- + .. _class_SpatialMaterial_property_proximity_fade_distance: - :ref:`float` **proximity_fade_distance** @@ -1427,6 +1593,8 @@ The number of vertical frames in the particle spritesheet. Only enabled when usi | *Getter* | get_proximity_fade_distance() | +----------+------------------------------------+ +---- + .. _class_SpatialMaterial_property_proximity_fade_enable: - :ref:`bool` **proximity_fade_enable** @@ -1439,6 +1607,8 @@ The number of vertical frames in the particle spritesheet. Only enabled when usi If ``true``, the proximity and distance fade effect is enabled. Default value: ``false``. +---- + .. _class_SpatialMaterial_property_refraction_enabled: - :ref:`bool` **refraction_enabled** @@ -1451,6 +1621,8 @@ If ``true``, the proximity and distance fade effect is enabled. Default value: ` If ``true``, the refraction effect is enabled. Distorts transparency based on light from behind the object. Default value: ``false``. +---- + .. _class_SpatialMaterial_property_refraction_scale: - :ref:`float` **refraction_scale** @@ -1463,6 +1635,8 @@ If ``true``, the refraction effect is enabled. Distorts transparency based on li The strength of the refraction effect. +---- + .. _class_SpatialMaterial_property_refraction_texture: - :ref:`Texture` **refraction_texture** @@ -1473,6 +1647,8 @@ The strength of the refraction effect. | *Getter* | get_texture() | +----------+--------------------+ +---- + .. _class_SpatialMaterial_property_refraction_texture_channel: - :ref:`TextureChannel` **refraction_texture_channel** @@ -1483,6 +1659,8 @@ The strength of the refraction effect. | *Getter* | get_refraction_texture_channel() | +----------+---------------------------------------+ +---- + .. _class_SpatialMaterial_property_rim: - :ref:`float` **rim** @@ -1493,6 +1671,8 @@ The strength of the refraction effect. | *Getter* | get_rim() | +----------+----------------+ +---- + .. _class_SpatialMaterial_property_rim_enabled: - :ref:`bool` **rim_enabled** @@ -1505,6 +1685,8 @@ The strength of the refraction effect. If ``true``, rim effect is enabled. Default value: ``false``. +---- + .. _class_SpatialMaterial_property_rim_texture: - :ref:`Texture` **rim_texture** @@ -1515,6 +1697,8 @@ If ``true``, rim effect is enabled. Default value: ``false``. | *Getter* | get_texture() | +----------+--------------------+ +---- + .. _class_SpatialMaterial_property_rim_tint: - :ref:`float` **rim_tint** @@ -1527,6 +1711,8 @@ If ``true``, rim effect is enabled. Default value: ``false``. The amount of to blend light and albedo color when rendering rim effect. If ``0`` the light color is used, while ``1`` means albedo color is used. An intermediate value generally works best. +---- + .. _class_SpatialMaterial_property_roughness: - :ref:`float` **roughness** @@ -1539,6 +1725,8 @@ The amount of to blend light and albedo color when rendering rim effect. If ``0` Surface reflection. A value of ``0`` represents a perfect mirror while a value of ``1`` completely blurs the reflection. See also :ref:`metallic`. +---- + .. _class_SpatialMaterial_property_roughness_texture: - :ref:`Texture` **roughness_texture** @@ -1549,6 +1737,8 @@ Surface reflection. A value of ``0`` represents a perfect mirror while a value o | *Getter* | get_texture() | +----------+--------------------+ +---- + .. _class_SpatialMaterial_property_roughness_texture_channel: - :ref:`TextureChannel` **roughness_texture_channel** @@ -1559,6 +1749,8 @@ Surface reflection. A value of ``0`` represents a perfect mirror while a value o | *Getter* | get_roughness_texture_channel() | +----------+--------------------------------------+ +---- + .. _class_SpatialMaterial_property_subsurf_scatter_enabled: - :ref:`bool` **subsurf_scatter_enabled** @@ -1571,6 +1763,8 @@ Surface reflection. A value of ``0`` represents a perfect mirror while a value o If ``true``, subsurface scattering is enabled. Emulates light that penetrates an object's surface, is scattered, and then emerges. +---- + .. _class_SpatialMaterial_property_subsurf_scatter_strength: - :ref:`float` **subsurf_scatter_strength** @@ -1583,6 +1777,8 @@ If ``true``, subsurface scattering is enabled. Emulates light that penetrates an The strength of the subsurface scattering effect. +---- + .. _class_SpatialMaterial_property_subsurf_scatter_texture: - :ref:`Texture` **subsurf_scatter_texture** @@ -1593,6 +1789,8 @@ The strength of the subsurface scattering effect. | *Getter* | get_texture() | +----------+--------------------+ +---- + .. _class_SpatialMaterial_property_transmission: - :ref:`Color` **transmission** @@ -1605,6 +1803,8 @@ The strength of the subsurface scattering effect. The color used by the transmission effect. Represents the light passing through an object. +---- + .. _class_SpatialMaterial_property_transmission_enabled: - :ref:`bool` **transmission_enabled** @@ -1617,6 +1817,8 @@ The color used by the transmission effect. Represents the light passing through If ``true``, the transmission effect is enabled. Default value: ``false``. +---- + .. _class_SpatialMaterial_property_transmission_texture: - :ref:`Texture` **transmission_texture** @@ -1627,6 +1829,8 @@ If ``true``, the transmission effect is enabled. Default value: ``false``. | *Getter* | get_texture() | +----------+--------------------+ +---- + .. _class_SpatialMaterial_property_uv1_offset: - :ref:`Vector3` **uv1_offset** @@ -1637,6 +1841,8 @@ If ``true``, the transmission effect is enabled. Default value: ``false``. | *Getter* | get_uv1_offset() | +----------+-----------------------+ +---- + .. _class_SpatialMaterial_property_uv1_scale: - :ref:`Vector3` **uv1_scale** @@ -1647,6 +1853,8 @@ If ``true``, the transmission effect is enabled. Default value: ``false``. | *Getter* | get_uv1_scale() | +----------+----------------------+ +---- + .. _class_SpatialMaterial_property_uv1_triplanar: - :ref:`bool` **uv1_triplanar** @@ -1657,6 +1865,8 @@ If ``true``, the transmission effect is enabled. Default value: ``false``. | *Getter* | get_flag() | +----------+-----------------+ +---- + .. _class_SpatialMaterial_property_uv1_triplanar_sharpness: - :ref:`float` **uv1_triplanar_sharpness** @@ -1667,6 +1877,8 @@ If ``true``, the transmission effect is enabled. Default value: ``false``. | *Getter* | get_uv1_triplanar_blend_sharpness() | +----------+------------------------------------------+ +---- + .. _class_SpatialMaterial_property_uv2_offset: - :ref:`Vector3` **uv2_offset** @@ -1677,6 +1889,8 @@ If ``true``, the transmission effect is enabled. Default value: ``false``. | *Getter* | get_uv2_offset() | +----------+-----------------------+ +---- + .. _class_SpatialMaterial_property_uv2_scale: - :ref:`Vector3` **uv2_scale** @@ -1687,6 +1901,8 @@ If ``true``, the transmission effect is enabled. Default value: ``false``. | *Getter* | get_uv2_scale() | +----------+----------------------+ +---- + .. _class_SpatialMaterial_property_uv2_triplanar: - :ref:`bool` **uv2_triplanar** @@ -1697,6 +1913,8 @@ If ``true``, the transmission effect is enabled. Default value: ``false``. | *Getter* | get_flag() | +----------+-----------------+ +---- + .. _class_SpatialMaterial_property_uv2_triplanar_sharpness: - :ref:`float` **uv2_triplanar_sharpness** @@ -1707,6 +1925,8 @@ If ``true``, the transmission effect is enabled. Default value: ``false``. | *Getter* | get_uv2_triplanar_blend_sharpness() | +----------+------------------------------------------+ +---- + .. _class_SpatialMaterial_property_vertex_color_is_srgb: - :ref:`bool` **vertex_color_is_srgb** @@ -1719,6 +1939,8 @@ If ``true``, the transmission effect is enabled. Default value: ``false``. If ``true``, the model's vertex colors are processed as sRGB mode. Default value: ``false``. +---- + .. _class_SpatialMaterial_property_vertex_color_use_as_albedo: - :ref:`bool` **vertex_color_use_as_albedo** diff --git a/classes/class_spatialvelocitytracker.rst b/classes/class_spatialvelocitytracker.rst index c095c6455..06c70d178 100644 --- a/classes/class_spatialvelocitytracker.rst +++ b/classes/class_spatialvelocitytracker.rst @@ -56,10 +56,14 @@ Method Descriptions - :ref:`Vector3` **get_tracked_linear_velocity** **(** **)** const +---- + .. _class_SpatialVelocityTracker_method_reset: - void **reset** **(** :ref:`Vector3` position **)** +---- + .. _class_SpatialVelocityTracker_method_update_position: - void **update_position** **(** :ref:`Vector3` position **)** diff --git a/classes/class_spheremesh.rst b/classes/class_spheremesh.rst index 705a3bdf7..840d061fd 100644 --- a/classes/class_spheremesh.rst +++ b/classes/class_spheremesh.rst @@ -53,6 +53,8 @@ Property Descriptions Full height of the sphere. Defaults to 2.0. +---- + .. _class_SphereMesh_property_is_hemisphere: - :ref:`bool` **is_hemisphere** @@ -65,6 +67,8 @@ Full height of the sphere. Defaults to 2.0. Determines whether a full sphere or a hemisphere is created. Attention: To get a regular hemisphere, the height and radius of the sphere have to equal. Defaults to ``false``. +---- + .. _class_SphereMesh_property_radial_segments: - :ref:`int` **radial_segments** @@ -77,6 +81,8 @@ Determines whether a full sphere or a hemisphere is created. Attention: To get a Number of radial segments on the sphere. Defaults to 64. +---- + .. _class_SphereMesh_property_radius: - :ref:`float` **radius** @@ -89,6 +95,8 @@ Number of radial segments on the sphere. Defaults to 64. Radius of sphere. Defaults to 1.0. +---- + .. _class_SphereMesh_property_rings: - :ref:`int` **rings** diff --git a/classes/class_spinbox.rst b/classes/class_spinbox.rst index f8a246a3e..1a687d061 100644 --- a/classes/class_spinbox.rst +++ b/classes/class_spinbox.rst @@ -79,6 +79,8 @@ Property Descriptions Sets the text alignment of the :ref:`SpinBox`. +---- + .. _class_SpinBox_property_editable: - :ref:`bool` **editable** @@ -91,6 +93,8 @@ Sets the text alignment of the :ref:`SpinBox`. If ``true``, the :ref:`SpinBox` will be editable. Otherwise, it will be read only. +---- + .. _class_SpinBox_property_prefix: - :ref:`String` **prefix** @@ -103,6 +107,8 @@ If ``true``, the :ref:`SpinBox` will be editable. Otherwise, it w Adds the specified ``prefix`` string before the numerical value of the :ref:`SpinBox`. +---- + .. _class_SpinBox_property_suffix: - :ref:`String` **suffix** diff --git a/classes/class_splitcontainer.rst b/classes/class_splitcontainer.rst index 95aa981dd..cfd411c3b 100644 --- a/classes/class_splitcontainer.rst +++ b/classes/class_splitcontainer.rst @@ -84,6 +84,8 @@ Property Descriptions | *Getter* | is_collapsed() | +----------+----------------------+ +---- + .. _class_SplitContainer_property_dragger_visibility: - :ref:`DraggerVisibility` **dragger_visibility** @@ -96,6 +98,8 @@ Property Descriptions Determines whether the dragger is visible. +---- + .. _class_SplitContainer_property_split_offset: - :ref:`int` **split_offset** diff --git a/classes/class_spotlight.rst b/classes/class_spotlight.rst index 2564f9312..44176c3e7 100644 --- a/classes/class_spotlight.rst +++ b/classes/class_spotlight.rst @@ -54,6 +54,8 @@ Property Descriptions | *Getter* | get_param() | +----------+------------------+ +---- + .. _class_SpotLight_property_spot_angle_attenuation: - :ref:`float` **spot_angle_attenuation** @@ -64,6 +66,8 @@ Property Descriptions | *Getter* | get_param() | +----------+------------------+ +---- + .. _class_SpotLight_property_spot_attenuation: - :ref:`float` **spot_attenuation** @@ -74,6 +78,8 @@ Property Descriptions | *Getter* | get_param() | +----------+------------------+ +---- + .. _class_SpotLight_property_spot_range: - :ref:`float` **spot_range** diff --git a/classes/class_springarm.rst b/classes/class_springarm.rst index cb4cf70ea..626245d33 100644 --- a/classes/class_springarm.rst +++ b/classes/class_springarm.rst @@ -57,6 +57,8 @@ Property Descriptions | *Getter* | get_collision_mask() | +----------+---------------------------+ +---- + .. _class_SpringArm_property_margin: - :ref:`float` **margin** @@ -67,6 +69,8 @@ Property Descriptions | *Getter* | get_margin() | +----------+-------------------+ +---- + .. _class_SpringArm_property_shape: - :ref:`Shape` **shape** @@ -77,6 +81,8 @@ Property Descriptions | *Getter* | get_shape() | +----------+------------------+ +---- + .. _class_SpringArm_property_spring_length: - :ref:`float` **spring_length** @@ -94,14 +100,20 @@ Method Descriptions - void **add_excluded_object** **(** :ref:`RID` RID **)** +---- + .. _class_SpringArm_method_clear_excluded_objects: - void **clear_excluded_objects** **(** **)** +---- + .. _class_SpringArm_method_get_hit_length: - :ref:`float` **get_hit_length** **(** **)** +---- + .. _class_SpringArm_method_remove_excluded_object: - :ref:`bool` **remove_excluded_object** **(** :ref:`RID` RID **)** diff --git a/classes/class_sprite.rst b/classes/class_sprite.rst index e8ddb778a..0c19e521e 100644 --- a/classes/class_sprite.rst +++ b/classes/class_sprite.rst @@ -65,6 +65,8 @@ Signals Emitted when the :ref:`frame` changes. +---- + .. _class_Sprite_signal_texture_changed: - **texture_changed** **(** **)** @@ -91,6 +93,8 @@ Property Descriptions If ``true``, texture is centered. Default value: ``true``. +---- + .. _class_Sprite_property_flip_h: - :ref:`bool` **flip_h** @@ -103,6 +107,8 @@ If ``true``, texture is centered. Default value: ``true``. If ``true``, texture is flipped horizontally. Default value: ``false``. +---- + .. _class_Sprite_property_flip_v: - :ref:`bool` **flip_v** @@ -115,6 +121,8 @@ If ``true``, texture is flipped horizontally. Default value: ``false``. If ``true``, texture is flipped vertically. Default value: ``false``. +---- + .. _class_Sprite_property_frame: - :ref:`int` **frame** @@ -127,6 +135,8 @@ If ``true``, texture is flipped vertically. Default value: ``false``. Current frame to display from sprite sheet. :ref:`vframes` or :ref:`hframes` must be greater than 1. +---- + .. _class_Sprite_property_hframes: - :ref:`int` **hframes** @@ -139,6 +149,8 @@ Current frame to display from sprite sheet. :ref:`vframes` **normal_map** @@ -151,6 +163,8 @@ The number of columns in the sprite sheet. The normal map gives depth to the Sprite. +---- + .. _class_Sprite_property_offset: - :ref:`Vector2` **offset** @@ -163,6 +177,8 @@ The normal map gives depth to the Sprite. The texture's drawing offset. +---- + .. _class_Sprite_property_region_enabled: - :ref:`bool` **region_enabled** @@ -175,6 +191,8 @@ The texture's drawing offset. If ``true``, texture is cut from a larger atlas texture. See :ref:`region_rect`. Default value: ``false``. +---- + .. _class_Sprite_property_region_filter_clip: - :ref:`bool` **region_filter_clip** @@ -187,6 +205,8 @@ If ``true``, texture is cut from a larger atlas texture. See :ref:`region_rect` **region_rect** @@ -199,6 +219,8 @@ If ``true``, the outermost pixels get blurred out. The region of the atlas texture to display. :ref:`region_enabled` must be ``true``. +---- + .. _class_Sprite_property_texture: - :ref:`Texture` **texture** @@ -211,6 +233,8 @@ The region of the atlas texture to display. :ref:`region_enabled` object to draw. +---- + .. _class_Sprite_property_vframes: - :ref:`int` **vframes** @@ -239,6 +263,8 @@ Returns a :ref:`Rect2` representing the Sprite's boundary in local if get_rect().has_point(to_local(event.position)): print("A click!") +---- + .. _class_Sprite_method_is_pixel_opaque: - :ref:`bool` **is_pixel_opaque** **(** :ref:`Vector2` pos **)** const diff --git a/classes/class_sprite3d.rst b/classes/class_sprite3d.rst index 5e6d5b5ef..2a5a797f1 100644 --- a/classes/class_sprite3d.rst +++ b/classes/class_sprite3d.rst @@ -64,6 +64,8 @@ Property Descriptions Current frame to display from sprite sheet. :ref:`vframes` or :ref:`hframes` must be greater than 1. +---- + .. _class_Sprite3D_property_hframes: - :ref:`int` **hframes** @@ -76,6 +78,8 @@ Current frame to display from sprite sheet. :ref:`vframes` **region_enabled** @@ -88,6 +92,8 @@ The number of columns in the sprite sheet. If ``true``, texture will be cut from a larger atlas texture. See :ref:`region_rect`. Default value: ``false``. +---- + .. _class_Sprite3D_property_region_rect: - :ref:`Rect2` **region_rect** @@ -100,6 +106,8 @@ If ``true``, texture will be cut from a larger atlas texture. See :ref:`region_r The region of the atlas texture to display. :ref:`region_enabled` must be ``true``. +---- + .. _class_Sprite3D_property_texture: - :ref:`Texture` **texture** @@ -112,6 +120,8 @@ The region of the atlas texture to display. :ref:`region_enabled` object to draw. +---- + .. _class_Sprite3D_property_vframes: - :ref:`int` **vframes** diff --git a/classes/class_spritebase3d.rst b/classes/class_spritebase3d.rst index 70a968e2d..4648c2f48 100644 --- a/classes/class_spritebase3d.rst +++ b/classes/class_spritebase3d.rst @@ -81,6 +81,8 @@ enum **DrawFlags**: - **FLAG_MAX** = **3** --- Represents the size of the :ref:`DrawFlags` enum. +---- + .. _enum_SpriteBase3D_AlphaCutMode: .. _class_SpriteBase3D_constant_ALPHA_CUT_DISABLED: @@ -115,6 +117,8 @@ Property Descriptions | *Getter* | get_alpha_cut_mode() | +----------+---------------------------+ +---- + .. _class_SpriteBase3D_property_axis: - Vector3.Axis **axis** @@ -127,6 +131,8 @@ Property Descriptions The direction in which the front of the texture faces. +---- + .. _class_SpriteBase3D_property_centered: - :ref:`bool` **centered** @@ -139,6 +145,8 @@ The direction in which the front of the texture faces. If ``true``, texture will be centered. Default value: ``true``. +---- + .. _class_SpriteBase3D_property_double_sided: - :ref:`bool` **double_sided** @@ -151,6 +159,8 @@ If ``true``, texture will be centered. Default value: ``true``. If ``true``, texture can be seen from the back as well, if ``false``, it is invisible when looking at it from behind. Default value: ``true``. +---- + .. _class_SpriteBase3D_property_flip_h: - :ref:`bool` **flip_h** @@ -163,6 +173,8 @@ If ``true``, texture can be seen from the back as well, if ``false``, it is invi If ``true``, texture is flipped horizontally. Default value: ``false``. +---- + .. _class_SpriteBase3D_property_flip_v: - :ref:`bool` **flip_v** @@ -175,6 +187,8 @@ If ``true``, texture is flipped horizontally. Default value: ``false``. If ``true``, texture is flipped vertically. Default value: ``false``. +---- + .. _class_SpriteBase3D_property_modulate: - :ref:`Color` **modulate** @@ -187,6 +201,8 @@ If ``true``, texture is flipped vertically. Default value: ``false``. A color value that gets multiplied on, could be used for mood-coloring or to simulate the color of light. +---- + .. _class_SpriteBase3D_property_offset: - :ref:`Vector2` **offset** @@ -199,6 +215,8 @@ A color value that gets multiplied on, could be used for mood-coloring or to sim The texture's drawing offset. +---- + .. _class_SpriteBase3D_property_opacity: - :ref:`float` **opacity** @@ -211,6 +229,8 @@ The texture's drawing offset. The objects visibility on a scale from ``0`` fully invisible to ``1`` fully visible. +---- + .. _class_SpriteBase3D_property_pixel_size: - :ref:`float` **pixel_size** @@ -223,6 +243,8 @@ The objects visibility on a scale from ``0`` fully invisible to ``1`` fully visi The size of one pixel's width on the Sprite to scale it in 3D. +---- + .. _class_SpriteBase3D_property_shaded: - :ref:`bool` **shaded** @@ -235,6 +257,8 @@ The size of one pixel's width on the Sprite to scale it in 3D. If ``true``, the :ref:`Light` in the :ref:`Environment` has effects on the Sprite. Default value: ``false``. +---- + .. _class_SpriteBase3D_property_transparent: - :ref:`bool` **transparent** @@ -254,6 +278,8 @@ Method Descriptions - :ref:`TriangleMesh` **generate_triangle_mesh** **(** **)** const +---- + .. _class_SpriteBase3D_method_get_item_rect: - :ref:`Rect2` **get_item_rect** **(** **)** const diff --git a/classes/class_spriteframes.rst b/classes/class_spriteframes.rst index fda262d2f..88e4f3dc7 100644 --- a/classes/class_spriteframes.rst +++ b/classes/class_spriteframes.rst @@ -83,90 +83,120 @@ Method Descriptions Adds a new animation to the library. +---- + .. _class_SpriteFrames_method_add_frame: - void **add_frame** **(** :ref:`String` anim, :ref:`Texture` frame, :ref:`int` at_position=-1 **)** Adds a frame to the given animation. +---- + .. _class_SpriteFrames_method_clear: - void **clear** **(** :ref:`String` anim **)** Removes all frames from the given animation. +---- + .. _class_SpriteFrames_method_clear_all: - void **clear_all** **(** **)** Removes all animations. A "default" animation will be created. +---- + .. _class_SpriteFrames_method_get_animation_loop: - :ref:`bool` **get_animation_loop** **(** :ref:`String` anim **)** const If ``true``, the given animation will loop. +---- + .. _class_SpriteFrames_method_get_animation_names: - :ref:`PoolStringArray` **get_animation_names** **(** **)** const Returns an array containing the names associated to each animation. Values are placed in alphabetical order. +---- + .. _class_SpriteFrames_method_get_animation_speed: - :ref:`float` **get_animation_speed** **(** :ref:`String` anim **)** const The animation's speed in frames per second. +---- + .. _class_SpriteFrames_method_get_frame: - :ref:`Texture` **get_frame** **(** :ref:`String` anim, :ref:`int` idx **)** const Returns the animation's selected frame. +---- + .. _class_SpriteFrames_method_get_frame_count: - :ref:`int` **get_frame_count** **(** :ref:`String` anim **)** const Returns the number of frames in the animation. +---- + .. _class_SpriteFrames_method_has_animation: - :ref:`bool` **has_animation** **(** :ref:`String` anim **)** const If ``true``, the named animation exists. +---- + .. _class_SpriteFrames_method_remove_animation: - void **remove_animation** **(** :ref:`String` anim **)** Removes the given animation. +---- + .. _class_SpriteFrames_method_remove_frame: - void **remove_frame** **(** :ref:`String` anim, :ref:`int` idx **)** Removes the animation's selected frame. +---- + .. _class_SpriteFrames_method_rename_animation: - void **rename_animation** **(** :ref:`String` anim, :ref:`String` newname **)** Changes the animation's name to ``newname``. +---- + .. _class_SpriteFrames_method_set_animation_loop: - void **set_animation_loop** **(** :ref:`String` anim, :ref:`bool` loop **)** If ``true``, the animation will loop. +---- + .. _class_SpriteFrames_method_set_animation_speed: - void **set_animation_speed** **(** :ref:`String` anim, :ref:`float` speed **)** The animation's speed in frames per second. +---- + .. _class_SpriteFrames_method_set_frame: - void **set_frame** **(** :ref:`String` anim, :ref:`int` idx, :ref:`Texture` txt **)** diff --git a/classes/class_staticbody.rst b/classes/class_staticbody.rst index 06e491512..ad21141ed 100644 --- a/classes/class_staticbody.rst +++ b/classes/class_staticbody.rst @@ -57,6 +57,8 @@ Property Descriptions The body bounciness. +---- + .. _class_StaticBody_property_constant_angular_velocity: - :ref:`Vector3` **constant_angular_velocity** @@ -69,6 +71,8 @@ The body bounciness. The constant angular velocity for the body. This does not rotate the body, but affects other bodies that touch it, as if it was in a state of rotation. +---- + .. _class_StaticBody_property_constant_linear_velocity: - :ref:`Vector3` **constant_linear_velocity** @@ -81,6 +85,8 @@ The constant angular velocity for the body. This does not rotate the body, but a The constant linear velocity for the body. This does not move the body, but affects other bodies that touch it, as if it was in a state of movement. +---- + .. _class_StaticBody_property_friction: - :ref:`float` **friction** @@ -93,6 +99,8 @@ The constant linear velocity for the body. This does not move the body, but affe The body friction, from 0 (frictionless) to 1 (full friction). +---- + .. _class_StaticBody_property_physics_material_override: - :ref:`PhysicsMaterial` **physics_material_override** diff --git a/classes/class_staticbody2d.rst b/classes/class_staticbody2d.rst index 328fbb5b0..d4e30cf81 100644 --- a/classes/class_staticbody2d.rst +++ b/classes/class_staticbody2d.rst @@ -55,6 +55,8 @@ Property Descriptions The body's bounciness. Values range from ``0`` (no bounce) to ``1`` (full bounciness). +---- + .. _class_StaticBody2D_property_constant_angular_velocity: - :ref:`float` **constant_angular_velocity** @@ -67,6 +69,8 @@ The body's bounciness. Values range from ``0`` (no bounce) to ``1`` (full bounci Constant angular velocity for the body. This does not rotate the body, but affects colliding bodies, as if it were rotating. +---- + .. _class_StaticBody2D_property_constant_linear_velocity: - :ref:`Vector2` **constant_linear_velocity** @@ -79,6 +83,8 @@ Constant angular velocity for the body. This does not rotate the body, but affec Constant linear velocity for the body. This does not move the body, but affects colliding bodies, as if it were moving. +---- + .. _class_StaticBody2D_property_friction: - :ref:`float` **friction** @@ -91,6 +97,8 @@ Constant linear velocity for the body. This does not move the body, but affects The body's friction. Values range from ``0`` (no friction) to ``1`` (full friction). +---- + .. _class_StaticBody2D_property_physics_material_override: - :ref:`PhysicsMaterial` **physics_material_override** diff --git a/classes/class_streampeer.rst b/classes/class_streampeer.rst index 9fc1b99bb..4ab7d21ee 100644 --- a/classes/class_streampeer.rst +++ b/classes/class_streampeer.rst @@ -123,90 +123,120 @@ Method Descriptions Get a signed 16 bit value from the stream. +---- + .. _class_StreamPeer_method_get_32: - :ref:`int` **get_32** **(** **)** Get a signed 32 bit value from the stream. +---- + .. _class_StreamPeer_method_get_64: - :ref:`int` **get_64** **(** **)** Get a signed 64 bit value from the stream. +---- + .. _class_StreamPeer_method_get_8: - :ref:`int` **get_8** **(** **)** Get a signed byte from the stream. +---- + .. _class_StreamPeer_method_get_available_bytes: - :ref:`int` **get_available_bytes** **(** **)** const Returns the amount of bytes this ``StreamPeer`` has available. +---- + .. _class_StreamPeer_method_get_data: - :ref:`Array` **get_data** **(** :ref:`int` bytes **)** Returns 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_method_get_double: - :ref:`float` **get_double** **(** **)** Get a double-precision float from the stream. +---- + .. _class_StreamPeer_method_get_float: - :ref:`float` **get_float** **(** **)** Get a single-precision float from the stream. +---- + .. _class_StreamPeer_method_get_partial_data: - :ref:`Array` **get_partial_data** **(** :ref:`int` bytes **)** Returns 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_method_get_string: - :ref:`String` **get_string** **(** :ref:`int` bytes=-1 **)** Get a string with byte-length ``bytes`` from the stream. If ``bytes`` is negative (default) the length will be read from the stream using the reverse process of :ref:`put_string`. +---- + .. _class_StreamPeer_method_get_u16: - :ref:`int` **get_u16** **(** **)** Get an unsigned 16 bit value from the stream. +---- + .. _class_StreamPeer_method_get_u32: - :ref:`int` **get_u32** **(** **)** Get an unsigned 32 bit value from the stream. +---- + .. _class_StreamPeer_method_get_u64: - :ref:`int` **get_u64** **(** **)** Get an unsigned 64 bit value from the stream. +---- + .. _class_StreamPeer_method_get_u8: - :ref:`int` **get_u8** **(** **)** Get an unsigned byte from the stream. +---- + .. _class_StreamPeer_method_get_utf8_string: - :ref:`String` **get_utf8_string** **(** :ref:`int` bytes=-1 **)** Get a utf8 string with byte-length ``bytes`` from the stream (this decodes the string sent as utf8). If ``bytes`` is negative (default) the length will be read from the stream using the reverse process of :ref:`put_utf8_string`. +---- + .. _class_StreamPeer_method_get_var: - :ref:`Variant` **get_var** **(** :ref:`bool` allow_objects=false **)** @@ -215,90 +245,120 @@ Get a Variant from the stream. When ``allow_objects`` is ``true`` decoding objec **WARNING:** Deserialized object can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats (remote code execution). +---- + .. _class_StreamPeer_method_put_16: - void **put_16** **(** :ref:`int` value **)** Put a signed 16 bit value into the stream. +---- + .. _class_StreamPeer_method_put_32: - void **put_32** **(** :ref:`int` value **)** Put a signed 32 bit value into the stream. +---- + .. _class_StreamPeer_method_put_64: - void **put_64** **(** :ref:`int` value **)** Put a signed 64 bit value into the stream. +---- + .. _class_StreamPeer_method_put_8: - void **put_8** **(** :ref:`int` value **)** Put a signed byte into the stream. +---- + .. _class_StreamPeer_method_put_data: - :ref:`Error` **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_method_put_double: - void **put_double** **(** :ref:`float` value **)** Put a double-precision float into the stream. +---- + .. _class_StreamPeer_method_put_float: - void **put_float** **(** :ref:`float` value **)** Put a single-precision float into the stream. +---- + .. _class_StreamPeer_method_put_partial_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_method_put_string: - void **put_string** **(** :ref:`String` value **)** Put a zero-terminated ascii string into the stream prepended by a 32 bits unsigned integer representing its size. +---- + .. _class_StreamPeer_method_put_u16: - void **put_u16** **(** :ref:`int` value **)** Put an unsigned 16 bit value into the stream. +---- + .. _class_StreamPeer_method_put_u32: - void **put_u32** **(** :ref:`int` value **)** Put an unsigned 32 bit value into the stream. +---- + .. _class_StreamPeer_method_put_u64: - void **put_u64** **(** :ref:`int` value **)** Put an unsigned 64 bit value into the stream. +---- + .. _class_StreamPeer_method_put_u8: - void **put_u8** **(** :ref:`int` value **)** Put an unsigned byte into the stream. +---- + .. _class_StreamPeer_method_put_utf8_string: - void **put_utf8_string** **(** :ref:`String` value **)** Put a zero-terminated utf8 string into the stream prepended by a 32 bits unsigned integer representing its size. +---- + .. _class_StreamPeer_method_put_var: - void **put_var** **(** :ref:`Variant` value, :ref:`bool` full_objects=false **)** diff --git a/classes/class_streampeerbuffer.rst b/classes/class_streampeerbuffer.rst index e2431932b..9d7880405 100644 --- a/classes/class_streampeerbuffer.rst +++ b/classes/class_streampeerbuffer.rst @@ -62,22 +62,32 @@ Method Descriptions - void **clear** **(** **)** +---- + .. _class_StreamPeerBuffer_method_duplicate: - :ref:`StreamPeerBuffer` **duplicate** **(** **)** const +---- + .. _class_StreamPeerBuffer_method_get_position: - :ref:`int` **get_position** **(** **)** const +---- + .. _class_StreamPeerBuffer_method_get_size: - :ref:`int` **get_size** **(** **)** const +---- + .. _class_StreamPeerBuffer_method_resize: - void **resize** **(** :ref:`int` size **)** +---- + .. _class_StreamPeerBuffer_method_seek: - void **seek** **(** :ref:`int` position **)** diff --git a/classes/class_streampeerssl.rst b/classes/class_streampeerssl.rst index 388c2e008..5988fa3b5 100644 --- a/classes/class_streampeerssl.rst +++ b/classes/class_streampeerssl.rst @@ -97,24 +97,32 @@ Method Descriptions - :ref:`Error` **accept_stream** **(** :ref:`StreamPeer` base **)** +---- + .. _class_StreamPeerSSL_method_connect_to_stream: - :ref:`Error` **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``, ``StreamPeerSSL`` will validate that the certificate presented by the peer matches the "for_hostname". +---- + .. _class_StreamPeerSSL_method_disconnect_from_stream: - void **disconnect_from_stream** **(** **)** Disconnect from host. +---- + .. _class_StreamPeerSSL_method_get_status: - :ref:`Status` **get_status** **(** **)** const Returns the status of the connection, one of STATUS\_\* enum. +---- + .. _class_StreamPeerSSL_method_poll: - void **poll** **(** **)** diff --git a/classes/class_streampeertcp.rst b/classes/class_streampeertcp.rst index f5e0940b1..28a6679bb 100644 --- a/classes/class_streampeertcp.rst +++ b/classes/class_streampeertcp.rst @@ -74,36 +74,48 @@ Method Descriptions Connect to the specified host:port pair. A hostname will be resolved if valid. Returns :ref:`@GlobalScope.OK` on success or :ref:`@GlobalScope.FAILED` on failure. +---- + .. _class_StreamPeerTCP_method_disconnect_from_host: - void **disconnect_from_host** **(** **)** Disconnect from host. +---- + .. _class_StreamPeerTCP_method_get_connected_host: - :ref:`String` **get_connected_host** **(** **)** const Returns the IP of this peer. +---- + .. _class_StreamPeerTCP_method_get_connected_port: - :ref:`int` **get_connected_port** **(** **)** const Returns the port of this peer. +---- + .. _class_StreamPeerTCP_method_get_status: - :ref:`Status` **get_status** **(** **)** Returns the status of the connection, see :ref:`Status`. +---- + .. _class_StreamPeerTCP_method_is_connected_to_host: - :ref:`bool` **is_connected_to_host** **(** **)** const Returns ``true`` if this peer is currently connected to a host, ``false`` otherwise. +---- + .. _class_StreamPeerTCP_method_set_no_delay: - void **set_no_delay** **(** :ref:`bool` enabled **)** diff --git a/classes/class_string.rst b/classes/class_string.rst index b3342c1d0..a8bafd885 100644 --- a/classes/class_string.rst +++ b/classes/class_string.rst @@ -228,212 +228,298 @@ Method Descriptions Constructs a new String from the given :ref:`bool`. +---- + - :ref:`String` **String** **(** :ref:`int` from **)** Constructs a new String from the given :ref:`int`. +---- + - :ref:`String` **String** **(** :ref:`float` from **)** Constructs a new String from the given :ref:`float`. +---- + - :ref:`String` **String** **(** :ref:`Vector2` from **)** Constructs a new String from the given :ref:`Vector2`. +---- + - :ref:`String` **String** **(** :ref:`Rect2` from **)** Constructs a new String from the given :ref:`Rect2`. +---- + - :ref:`String` **String** **(** :ref:`Vector3` from **)** Constructs a new String from the given :ref:`Vector3`. +---- + - :ref:`String` **String** **(** :ref:`Transform2D` from **)** Constructs a new String from the given :ref:`Transform2D`. +---- + - :ref:`String` **String** **(** :ref:`Plane` from **)** Constructs a new String from the given :ref:`Plane`. +---- + - :ref:`String` **String** **(** :ref:`Quat` from **)** Constructs a new String from the given :ref:`Quat`. +---- + - :ref:`String` **String** **(** :ref:`AABB` from **)** Constructs a new String from the given :ref:`AABB`. +---- + - :ref:`String` **String** **(** :ref:`Basis` from **)** Constructs a new String from the given :ref:`Basis`. +---- + - :ref:`String` **String** **(** :ref:`Transform` from **)** Constructs a new String from the given :ref:`Transform`. +---- + - :ref:`String` **String** **(** :ref:`Color` from **)** Constructs a new String from the given :ref:`Color`. +---- + - :ref:`String` **String** **(** :ref:`NodePath` from **)** Constructs a new String from the given :ref:`NodePath`. +---- + - :ref:`String` **String** **(** :ref:`RID` from **)** Constructs a new String from the given :ref:`RID`. +---- + - :ref:`String` **String** **(** :ref:`Dictionary` from **)** Constructs a new String from the given :ref:`Dictionary`. +---- + - :ref:`String` **String** **(** :ref:`Array` from **)** Constructs a new String from the given :ref:`Array`. +---- + - :ref:`String` **String** **(** :ref:`PoolByteArray` from **)** Constructs a new String from the given :ref:`PoolByteArray`. +---- + - :ref:`String` **String** **(** :ref:`PoolIntArray` from **)** Constructs a new String from the given :ref:`PoolIntArray`. +---- + - :ref:`String` **String** **(** :ref:`PoolRealArray` from **)** Constructs a new String from the given :ref:`PoolRealArray`. +---- + - :ref:`String` **String** **(** :ref:`PoolStringArray` from **)** Constructs a new String from the given :ref:`PoolStringArray`. +---- + - :ref:`String` **String** **(** :ref:`PoolVector2Array` from **)** Constructs a new String from the given :ref:`PoolVector2Array`. +---- + - :ref:`String` **String** **(** :ref:`PoolVector3Array` from **)** Constructs a new String from the given :ref:`PoolVector3Array`. +---- + - :ref:`String` **String** **(** :ref:`PoolColorArray` from **)** Constructs a new String from the given :ref:`PoolColorArray`. +---- + .. _class_String_method_begins_with: - :ref:`bool` **begins_with** **(** :ref:`String` text **)** Returns ``true`` if the string begins with the given string. +---- + .. _class_String_method_bigrams: - :ref:`PoolStringArray` **bigrams** **(** **)** Returns the bigrams (pairs of consecutive letters) of this string. +---- + .. _class_String_method_c_escape: - :ref:`String` **c_escape** **(** **)** Returns a copy of the string with special characters escaped using the C language standard. +---- + .. _class_String_method_c_unescape: - :ref:`String` **c_unescape** **(** **)** Returns a copy of the string with escaped characters replaced by their meanings according to the C language standard. +---- + .. _class_String_method_capitalize: - :ref:`String` **capitalize** **(** **)** Changes the case of some letters. Replaces underscores with spaces, converts all letters to lowercase, then capitalizes first and every letter following the space character. For ``capitalize camelCase mixed_with_underscores`` it will return ``Capitalize Camelcase Mixed With Underscores``. +---- + .. _class_String_method_casecmp_to: - :ref:`int` **casecmp_to** **(** :ref:`String` to **)** Performs a case-sensitive comparison to another string. Returns ``-1`` if less than, ``+1`` if greater than, or ``0`` if equal. +---- + .. _class_String_method_dedent: - :ref:`String` **dedent** **(** **)** Removes indentation from string. +---- + .. _class_String_method_empty: - :ref:`bool` **empty** **(** **)** Returns ``true`` if the string is empty. +---- + .. _class_String_method_ends_with: - :ref:`bool` **ends_with** **(** :ref:`String` text **)** Returns ``true`` if the string ends with the given string. +---- + .. _class_String_method_erase: - void **erase** **(** :ref:`int` position, :ref:`int` chars **)** Erases ``chars`` characters from the string starting from ``position``. +---- + .. _class_String_method_find: - :ref:`int` **find** **(** :ref:`String` what, :ref:`int` from=0 **)** Finds the first occurrence of a substring. Returns the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed. +---- + .. _class_String_method_find_last: - :ref:`int` **find_last** **(** :ref:`String` what **)** Finds the last occurrence of a substring. Returns the starting position of the substring or -1 if not found. +---- + .. _class_String_method_findn: - :ref:`int` **findn** **(** :ref:`String` what, :ref:`int` from=0 **)** Finds the first occurrence of a substring, ignoring case. Returns the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed. +---- + .. _class_String_method_format: - :ref:`String` **format** **(** :ref:`Variant` values, :ref:`String` placeholder={_} **)** Formats the string by replacing all occurrences of ``placeholder`` with ``values``. +---- + .. _class_String_method_get_base_dir: - :ref:`String` **get_base_dir** **(** **)** If the string is a valid file path, returns the base directory name. +---- + .. _class_String_method_get_basename: - :ref:`String` **get_basename** **(** **)** If the string is a valid file path, returns the full file path without the extension. +---- + .. _class_String_method_get_extension: - :ref:`String` **get_extension** **(** **)** If the string is a valid file path, returns the extension. +---- + .. _class_String_method_get_file: - :ref:`String` **get_file** **(** **)** If the string is a valid file path, returns the filename. +---- + .. _class_String_method_hash: - :ref:`int` **hash** **(** **)** Hashes the string and returns a 32-bit integer. +---- + .. _class_String_method_hex_to_int: - :ref:`int` **hex_to_int** **(** **)** @@ -444,192 +530,256 @@ Converts a string containing a hexadecimal number into an integer. Hexadecimal s print("0xff".hex_to_int()) # Print "255" +---- + .. _class_String_method_insert: - :ref:`String` **insert** **(** :ref:`int` position, :ref:`String` what **)** Inserts a substring at a given position. +---- + .. _class_String_method_is_abs_path: - :ref:`bool` **is_abs_path** **(** **)** If the string is a path to a file or directory, returns ``true`` if the path is absolute. +---- + .. _class_String_method_is_rel_path: - :ref:`bool` **is_rel_path** **(** **)** If the string is a path to a file or directory, returns ``true`` if the path is relative. +---- + .. _class_String_method_is_subsequence_of: - :ref:`bool` **is_subsequence_of** **(** :ref:`String` text **)** Returns ``true`` if this string is a subsequence of the given string. +---- + .. _class_String_method_is_subsequence_ofi: - :ref:`bool` **is_subsequence_ofi** **(** :ref:`String` text **)** Returns ``true`` if this string is a subsequence of the given string, without considering case. +---- + .. _class_String_method_is_valid_float: - :ref:`bool` **is_valid_float** **(** **)** Returns ``true`` if this string contains a valid float. +---- + .. _class_String_method_is_valid_hex_number: - :ref:`bool` **is_valid_hex_number** **(** :ref:`bool` with_prefix=False **)** Returns ``true`` if this string contains a valid hexadecimal number. If ``with_prefix`` is ``true``, then a validity of the hexadecimal number is determined by ``0x`` prefix, for instance: ``0xDEADC0DE``. +---- + .. _class_String_method_is_valid_html_color: - :ref:`bool` **is_valid_html_color** **(** **)** Returns ``true`` if this string contains a valid color in HTML notation. +---- + .. _class_String_method_is_valid_identifier: - :ref:`bool` **is_valid_identifier** **(** **)** Returns ``true`` if this string is a valid identifier. A valid identifier may contain only letters, digits and underscores (``_``) and the first character may not be a digit. +---- + .. _class_String_method_is_valid_integer: - :ref:`bool` **is_valid_integer** **(** **)** Returns ``true`` if this string contains a valid integer. +---- + .. _class_String_method_is_valid_ip_address: - :ref:`bool` **is_valid_ip_address** **(** **)** Returns ``true`` if this string contains a valid IP address. +---- + .. _class_String_method_json_escape: - :ref:`String` **json_escape** **(** **)** Returns a copy of the string with special characters escaped using the JSON standard. +---- + .. _class_String_method_left: - :ref:`String` **left** **(** :ref:`int` position **)** Returns a number of characters from the left of the string. +---- + .. _class_String_method_length: - :ref:`int` **length** **(** **)** Returns the string's amount of characters. +---- + .. _class_String_method_lstrip: - :ref:`String` **lstrip** **(** :ref:`String` chars **)** Returns a copy of the string with characters removed from the left. +---- + .. _class_String_method_match: - :ref:`bool` **match** **(** :ref:`String` expr **)** Does a simple expression match, where ``*`` matches zero or more arbitrary characters and ``?`` matches any single character except '.'. +---- + .. _class_String_method_matchn: - :ref:`bool` **matchn** **(** :ref:`String` expr **)** Does a simple case insensitive expression match, using ``?`` and ``*`` wildcards (see :ref:`match`). +---- + .. _class_String_method_md5_buffer: - :ref:`PoolByteArray` **md5_buffer** **(** **)** Returns the MD5 hash of the string as an array of bytes. +---- + .. _class_String_method_md5_text: - :ref:`String` **md5_text** **(** **)** Returns the MD5 hash of the string as a string. +---- + .. _class_String_method_nocasecmp_to: - :ref:`int` **nocasecmp_to** **(** :ref:`String` to **)** Performs a case-insensitive comparison to another string. Returns ``-1`` if less than, ``+1`` if greater than, or ``0`` if equal. +---- + .. _class_String_method_ord_at: - :ref:`int` **ord_at** **(** :ref:`int` at **)** Returns the character code at position ``at``. +---- + .. _class_String_method_pad_decimals: - :ref:`String` **pad_decimals** **(** :ref:`int` digits **)** Formats a number to have an exact number of ``digits`` after the decimal point. +---- + .. _class_String_method_pad_zeros: - :ref:`String` **pad_zeros** **(** :ref:`int` digits **)** Formats a number to have an exact number of ``digits`` before the decimal point. +---- + .. _class_String_method_percent_decode: - :ref:`String` **percent_decode** **(** **)** Decode a percent-encoded string. See :ref:`percent_encode`. +---- + .. _class_String_method_percent_encode: - :ref:`String` **percent_encode** **(** **)** Percent-encodes a string. Encodes parameters in a URL when sending a HTTP GET request (and bodies of form-urlencoded POST requests). +---- + .. _class_String_method_plus_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_method_replace: - :ref:`String` **replace** **(** :ref:`String` what, :ref:`String` forwhat **)** Replaces occurrences of a substring with the given one inside the string. +---- + .. _class_String_method_replacen: - :ref:`String` **replacen** **(** :ref:`String` what, :ref:`String` forwhat **)** Replaces occurrences of a substring with the given one inside the string. Ignores case. +---- + .. _class_String_method_rfind: - :ref:`int` **rfind** **(** :ref:`String` what, :ref:`int` from=-1 **)** Performs a search for a substring, but starts from the end of the string instead of the beginning. +---- + .. _class_String_method_rfindn: - :ref:`int` **rfindn** **(** :ref:`String` what, :ref:`int` from=-1 **)** Performs a search for a substring, but starts from the end of the string instead of the beginning. Ignores case. +---- + .. _class_String_method_right: - :ref:`String` **right** **(** :ref:`int` position **)** Returns the right side of the string from a given position. +---- + .. _class_String_method_rsplit: - :ref:`PoolStringArray` **rsplit** **(** :ref:`String` delimiter, :ref:`bool` allow_empty=True, :ref:`int` maxsplit=0 **)** @@ -640,7 +790,17 @@ The splits in the returned array are sorted in the same order as the original st If ``maxsplit`` is specified, it defines the number of splits to do from the right up to ``maxsplit``. The default value of 0 means that all items are split, thus giving the same result as :ref:`split`. -**Example:** ``"One,Two,Three,Four"`` will return ``["Three","Four"]`` if split by ``","`` with ``maxsplit`` of 2. +Example: + +:: + + var some_string = "One,Two,Three,Four" + var some_array = some_string.rsplit(",", true, 1) + print(some_array.size()) # Prints 2 + print(some_array[0]) # Prints "Four" + print(some_array[1]) # Prints "Three,Two,One" + +---- .. _class_String_method_rstrip: @@ -648,24 +808,32 @@ If ``maxsplit`` is specified, it defines the number of splits to do from the rig Returns a copy of the string with characters removed from the right. +---- + .. _class_String_method_sha256_buffer: - :ref:`PoolByteArray` **sha256_buffer** **(** **)** Returns the SHA-256 hash of the string as an array of bytes. +---- + .. _class_String_method_sha256_text: - :ref:`String` **sha256_text** **(** **)** Returns the SHA-256 hash of the string as a string. +---- + .. _class_String_method_similarity: - :ref:`float` **similarity** **(** :ref:`String` text **)** Returns the similarity index of the text compared to this string. 1 means totally similar and 0 means totally dissimilar. +---- + .. _class_String_method_split: - :ref:`PoolStringArray` **split** **(** :ref:`String` delimiter, :ref:`bool` allow_empty=True, :ref:`int` maxsplit=0 **)** @@ -674,7 +842,17 @@ Splits the string by a ``delimiter`` string and returns an array of the substrin If ``maxsplit`` is specified, it defines the number of splits to do from the left up to ``maxsplit``. The default value of 0 means that all items are split. -**Example:** ``"One,Two,Three"`` will return ``["One","Two"]`` if split by ``","`` with ``maxsplit`` of 2. +Example: + +:: + + var some_string = "One,Two,Three,Four" + var some_array = some_string.split(",", true, 1) + print(some_array.size()) # Prints 2 + print(some_array[0]) # Prints "One" + print(some_array[1]) # Prints "Two,Three,Four" + +---- .. _class_String_method_split_floats: @@ -684,72 +862,96 @@ Splits the string in floats by using a delimiter string and returns an array of **Example:** ``"1,2.5,3"`` will return ``[1,2.5,3]`` if split by ``","``. +---- + .. _class_String_method_strip_edges: - :ref:`String` **strip_edges** **(** :ref:`bool` left=True, :ref:`bool` right=True **)** Returns 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_method_substr: - :ref:`String` **substr** **(** :ref:`int` from, :ref:`int` len **)** Returns part of the string from the position ``from`` with length ``len``. +---- + .. _class_String_method_to_ascii: - :ref:`PoolByteArray` **to_ascii** **(** **)** Converts the String (which is a character array) to :ref:`PoolByteArray` (which is an array of bytes). The conversion is sped up in comparison to :ref:`to_utf8` with the assumption that all the characters the String contains are only ASCII characters. +---- + .. _class_String_method_to_float: - :ref:`float` **to_float** **(** **)** Converts a string containing a decimal number into a ``float``. +---- + .. _class_String_method_to_int: - :ref:`int` **to_int** **(** **)** Converts a string containing an integer number into an ``int``. +---- + .. _class_String_method_to_lower: - :ref:`String` **to_lower** **(** **)** Returns the string converted to lowercase. +---- + .. _class_String_method_to_upper: - :ref:`String` **to_upper** **(** **)** Returns the string converted to uppercase. +---- + .. _class_String_method_to_utf8: - :ref:`PoolByteArray` **to_utf8** **(** **)** Converts the String (which is an array of characters) to :ref:`PoolByteArray` (which is an array of bytes). The conversion is a bit slower than :ref:`to_ascii`, but supports all UTF-8 characters. Therefore, you should prefer this function over :ref:`to_ascii`. +---- + .. _class_String_method_trim_prefix: - :ref:`String` **trim_prefix** **(** :ref:`String` prefix **)** Removes a given string from the start if it starts with it or leaves the string unchanged. +---- + .. _class_String_method_trim_suffix: - :ref:`String` **trim_suffix** **(** :ref:`String` suffix **)** Removes a given string from the end if it ends with it or leaves the string unchanged. +---- + .. _class_String_method_xml_escape: - :ref:`String` **xml_escape** **(** **)** Returns a copy of the string with special characters escaped using the XML standard. +---- + .. _class_String_method_xml_unescape: - :ref:`String` **xml_unescape** **(** **)** diff --git a/classes/class_stylebox.rst b/classes/class_stylebox.rst index c00822143..f1ce455f5 100644 --- a/classes/class_stylebox.rst +++ b/classes/class_stylebox.rst @@ -78,6 +78,8 @@ It is up to the code using this style box to decide what these contents are: for :ref:`get_margin` should be used to fetch this value as consumer instead of reading these properties directly. This is because it correctly respects negative values and the fallback mentioned above. +---- + .. _class_StyleBox_property_content_margin_left: - :ref:`float` **content_margin_left** @@ -92,6 +94,8 @@ The left margin for the contents of this style box. Increasing this value reduce Refer to :ref:`content_margin_bottom` for extra considerations. +---- + .. _class_StyleBox_property_content_margin_right: - :ref:`float` **content_margin_right** @@ -106,6 +110,8 @@ The right margin for the contents of this style box. Increasing this value reduc Refer to :ref:`content_margin_bottom` for extra considerations. +---- + .. _class_StyleBox_property_content_margin_top: - :ref:`float` **content_margin_top** @@ -127,14 +133,20 @@ Method Descriptions - void **draw** **(** :ref:`RID` canvas_item, :ref:`Rect2` rect **)** const +---- + .. _class_StyleBox_method_get_center_size: - :ref:`Vector2` **get_center_size** **(** **)** const +---- + .. _class_StyleBox_method_get_current_item_drawn: - :ref:`CanvasItem` **get_current_item_drawn** **(** **)** const +---- + .. _class_StyleBox_method_get_margin: - :ref:`float` **get_margin** **(** :ref:`Margin` margin **)** const @@ -143,18 +155,24 @@ Returns the content margin offset for the specified margin Positive values reduce size inwards, unlike :ref:`Control`'s margin values. +---- + .. _class_StyleBox_method_get_minimum_size: - :ref:`Vector2` **get_minimum_size** **(** **)** const Returns the minimum size that this stylebox can be shrunk to. +---- + .. _class_StyleBox_method_get_offset: - :ref:`Vector2` **get_offset** **(** **)** const Returns 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_method_test_mask: - :ref:`bool` **test_mask** **(** :ref:`Vector2` point, :ref:`Rect2` rect **)** const diff --git a/classes/class_styleboxflat.rst b/classes/class_styleboxflat.rst index 327500308..4bde8cba3 100644 --- a/classes/class_styleboxflat.rst +++ b/classes/class_styleboxflat.rst @@ -125,6 +125,8 @@ Property Descriptions Anti Aliasing draws a small ring around edges. This ring fades to transparent. As a result edges look much smoother. This is only noticeable when using rounded corners. +---- + .. _class_StyleBoxFlat_property_anti_aliasing_size: - :ref:`int` **anti_aliasing_size** @@ -137,6 +139,8 @@ Anti Aliasing draws a small ring around edges. This ring fades to transparent. A This changes the size of the faded ring. Higher values can be used to achieve a "blurry" effect. +---- + .. _class_StyleBoxFlat_property_bg_color: - :ref:`Color` **bg_color** @@ -149,6 +153,8 @@ This changes the size of the faded ring. Higher values can be used to achieve a The background color of the stylebox. +---- + .. _class_StyleBoxFlat_property_border_blend: - :ref:`bool` **border_blend** @@ -161,6 +167,8 @@ The background color of the stylebox. When set to ``true``, the border will fade into the background color. +---- + .. _class_StyleBoxFlat_property_border_color: - :ref:`Color` **border_color** @@ -173,6 +181,8 @@ When set to ``true``, the border will fade into the background color. Sets the color of the border. +---- + .. _class_StyleBoxFlat_property_border_width_bottom: - :ref:`int` **border_width_bottom** @@ -185,6 +195,8 @@ Sets the color of the border. Border width for the bottom border. +---- + .. _class_StyleBoxFlat_property_border_width_left: - :ref:`int` **border_width_left** @@ -197,6 +209,8 @@ Border width for the bottom border. Border width for the left border. +---- + .. _class_StyleBoxFlat_property_border_width_right: - :ref:`int` **border_width_right** @@ -209,6 +223,8 @@ Border width for the left border. Border width for the right border. +---- + .. _class_StyleBoxFlat_property_border_width_top: - :ref:`int` **border_width_top** @@ -221,6 +237,8 @@ Border width for the right border. Border width for the top border. +---- + .. _class_StyleBoxFlat_property_corner_detail: - :ref:`int` **corner_detail** @@ -237,6 +255,8 @@ For corner radius smaller than 10, 4-5 should be enough. For corner radius smaller than 30, 8-12 should be enough. +---- + .. _class_StyleBoxFlat_property_corner_radius_bottom_left: - :ref:`int` **corner_radius_bottom_left** @@ -249,6 +269,8 @@ For corner radius smaller than 30, 8-12 should be enough. The corner radius of the bottom left corner. When set to 0 the corner is not rounded. +---- + .. _class_StyleBoxFlat_property_corner_radius_bottom_right: - :ref:`int` **corner_radius_bottom_right** @@ -261,6 +283,8 @@ The corner radius of the bottom left corner. When set to 0 the corner is not rou The corner radius of the bottom right corner. When set to 0 the corner is not rounded. +---- + .. _class_StyleBoxFlat_property_corner_radius_top_left: - :ref:`int` **corner_radius_top_left** @@ -273,6 +297,8 @@ The corner radius of the bottom right corner. When set to 0 the corner is not ro The corner radius of the top left corner. When set to 0 the corner is not rounded. +---- + .. _class_StyleBoxFlat_property_corner_radius_top_right: - :ref:`int` **corner_radius_top_right** @@ -285,6 +311,8 @@ The corner radius of the top left corner. When set to 0 the corner is not rounde The corner radius of the top right corner. When set to 0 the corner is not rounded. +---- + .. _class_StyleBoxFlat_property_draw_center: - :ref:`bool` **draw_center** @@ -297,6 +325,8 @@ The corner radius of the top right corner. When set to 0 the corner is not round Toggels drawing of the inner part of the stylebox. +---- + .. _class_StyleBoxFlat_property_expand_margin_bottom: - :ref:`float` **expand_margin_bottom** @@ -309,6 +339,8 @@ Toggels drawing of the inner part of the stylebox. Expands the stylebox outside of the control rect on the bottom edge. Useful in combination with border_width_bottom. To draw a border outside the control rect. +---- + .. _class_StyleBoxFlat_property_expand_margin_left: - :ref:`float` **expand_margin_left** @@ -321,6 +353,8 @@ Expands the stylebox outside of the control rect on the bottom edge. Useful in c Expands the stylebox outside of the control rect on the left edge. Useful in combination with border_width_left. To draw a border outside the control rect. +---- + .. _class_StyleBoxFlat_property_expand_margin_right: - :ref:`float` **expand_margin_right** @@ -333,6 +367,8 @@ Expands the stylebox outside of the control rect on the left edge. Useful in com Expands the stylebox outside of the control rect on the right edge. Useful in combination with border_width_right. To draw a border outside the control rect. +---- + .. _class_StyleBoxFlat_property_expand_margin_top: - :ref:`float` **expand_margin_top** @@ -345,6 +381,8 @@ Expands the stylebox outside of the control rect on the right edge. Useful in co Expands the stylebox outside of the control rect on the top edge. Useful in combination with border_width_top. To draw a border outside the control rect. +---- + .. _class_StyleBoxFlat_property_shadow_color: - :ref:`Color` **shadow_color** @@ -357,6 +395,8 @@ Expands the stylebox outside of the control rect on the top edge. Useful in comb The color of the shadow. (This has no effect when shadow_size < 1) +---- + .. _class_StyleBoxFlat_property_shadow_size: - :ref:`int` **shadow_size** @@ -376,22 +416,32 @@ Method Descriptions - :ref:`int` **get_border_width_min** **(** **)** const +---- + .. _class_StyleBoxFlat_method_set_border_width_all: - void **set_border_width_all** **(** :ref:`int` width **)** +---- + .. _class_StyleBoxFlat_method_set_corner_radius_all: - void **set_corner_radius_all** **(** :ref:`int` radius **)** +---- + .. _class_StyleBoxFlat_method_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 **)** +---- + .. _class_StyleBoxFlat_method_set_expand_margin_all: - void **set_expand_margin_all** **(** :ref:`float` size **)** +---- + .. _class_StyleBoxFlat_method_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 **)** diff --git a/classes/class_styleboxline.rst b/classes/class_styleboxline.rst index ca92724d8..a1dec5941 100644 --- a/classes/class_styleboxline.rst +++ b/classes/class_styleboxline.rst @@ -46,6 +46,8 @@ Property Descriptions | *Getter* | get_color() | +----------+------------------+ +---- + .. _class_StyleBoxLine_property_grow_begin: - :ref:`float` **grow_begin** @@ -56,6 +58,8 @@ Property Descriptions | *Getter* | get_grow_begin() | +----------+-----------------------+ +---- + .. _class_StyleBoxLine_property_grow_end: - :ref:`float` **grow_end** @@ -66,6 +70,8 @@ Property Descriptions | *Getter* | get_grow_end() | +----------+---------------------+ +---- + .. _class_StyleBoxLine_property_thickness: - :ref:`int` **thickness** @@ -76,6 +82,8 @@ Property Descriptions | *Getter* | get_thickness() | +----------+----------------------+ +---- + .. _class_StyleBoxLine_property_vertical: - :ref:`bool` **vertical** diff --git a/classes/class_styleboxtexture.rst b/classes/class_styleboxtexture.rst index 4a0df352b..cfdbe7377 100644 --- a/classes/class_styleboxtexture.rst +++ b/classes/class_styleboxtexture.rst @@ -106,6 +106,8 @@ Property Descriptions | *Getter* | get_h_axis_stretch_mode() | +----------+--------------------------------+ +---- + .. _class_StyleBoxTexture_property_axis_stretch_vertical: - :ref:`AxisStretchMode` **axis_stretch_vertical** @@ -116,6 +118,8 @@ Property Descriptions | *Getter* | get_v_axis_stretch_mode() | +----------+--------------------------------+ +---- + .. _class_StyleBoxTexture_property_draw_center: - :ref:`bool` **draw_center** @@ -126,6 +130,8 @@ Property Descriptions | *Getter* | is_draw_center_enabled() | +----------+--------------------------+ +---- + .. _class_StyleBoxTexture_property_expand_margin_bottom: - :ref:`float` **expand_margin_bottom** @@ -138,6 +144,8 @@ Property Descriptions Expands the bottom margin of this style box when drawing, causing it be drawn larger than requested. +---- + .. _class_StyleBoxTexture_property_expand_margin_left: - :ref:`float` **expand_margin_left** @@ -150,6 +158,8 @@ Expands the bottom margin of this style box when drawing, causing it be drawn la Expands the left margin of this style box when drawing, causing it be drawn larger than requested. +---- + .. _class_StyleBoxTexture_property_expand_margin_right: - :ref:`float` **expand_margin_right** @@ -162,6 +172,8 @@ Expands the left margin of this style box when drawing, causing it be drawn larg Expands the right margin of this style box when drawing, causing it be drawn larger than requested. +---- + .. _class_StyleBoxTexture_property_expand_margin_top: - :ref:`float` **expand_margin_top** @@ -174,6 +186,8 @@ Expands the right margin of this style box when drawing, causing it be drawn lar Expands the top margin of this style box when drawing, causing it be drawn larger than requested. +---- + .. _class_StyleBoxTexture_property_margin_bottom: - :ref:`float` **margin_bottom** @@ -190,6 +204,8 @@ A higher value means more of the source texture is considered to be part of the This is also the value used as fallback for :ref:`StyleBox.content_margin_bottom` if it is negative. +---- + .. _class_StyleBoxTexture_property_margin_left: - :ref:`float` **margin_left** @@ -206,6 +222,8 @@ A higher value means more of the source texture is considered to be part of the This is also the value used as fallback for :ref:`StyleBox.content_margin_left` if it is negative. +---- + .. _class_StyleBoxTexture_property_margin_right: - :ref:`float` **margin_right** @@ -222,6 +240,8 @@ A higher value means more of the source texture is considered to be part of the This is also the value used as fallback for :ref:`StyleBox.content_margin_right` if it is negative. +---- + .. _class_StyleBoxTexture_property_margin_top: - :ref:`float` **margin_top** @@ -238,6 +258,8 @@ A higher value means more of the source texture is considered to be part of the This is also the value used as fallback for :ref:`StyleBox.content_margin_top` if it is negative. +---- + .. _class_StyleBoxTexture_property_modulate_color: - :ref:`Color` **modulate_color** @@ -250,6 +272,8 @@ This is also the value used as fallback for :ref:`StyleBox.content_margin_top` **normal_map** @@ -262,6 +286,8 @@ Modulates the color of the texture when this style box is drawn. The normal map to use when drawing this style box. +---- + .. _class_StyleBoxTexture_property_region_rect: - :ref:`Rect2` **region_rect** @@ -276,6 +302,8 @@ Species a sub region of the texture to use. This is equivalent to first wrapping the texture in an :ref:`AtlasTexture` with the same region. +---- + .. _class_StyleBoxTexture_property_texture: - :ref:`Texture` **texture** @@ -295,6 +323,8 @@ Method Descriptions - void **set_expand_margin_all** **(** :ref:`float` size **)** +---- + .. _class_StyleBoxTexture_method_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 **)** diff --git a/classes/class_surfacetool.rst b/classes/class_surfacetool.rst index 426e84123..e109f90a0 100644 --- a/classes/class_surfacetool.rst +++ b/classes/class_surfacetool.rst @@ -93,36 +93,48 @@ Method Descriptions Add an array of bones for the next Vertex to use. Array must contain 4 integers. +---- + .. _class_SurfaceTool_method_add_color: - void **add_color** **(** :ref:`Color` color **)** Specify a :ref:`Color` for the next Vertex to use. +---- + .. _class_SurfaceTool_method_add_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_method_add_normal: - void **add_normal** **(** :ref:`Vector3` normal **)** Specify a normal for the next Vertex to use. +---- + .. _class_SurfaceTool_method_add_smooth_group: - 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_method_add_tangent: - void **add_tangent** **(** :ref:`Plane` tangent **)** Specify a Tangent for the next Vertex to use. +---- + .. _class_SurfaceTool_method_add_triangle_fan: - void **add_triangle_fan** **(** :ref:`PoolVector3Array` vertices, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`PoolColorArray` colors=PoolColorArray( ), :ref:`PoolVector2Array` uv2s=PoolVector2Array( ), :ref:`PoolVector3Array` normals=PoolVector3Array( ), :ref:`Array` tangents=[ ] **)** @@ -131,66 +143,88 @@ Insert a triangle fan made of array data into :ref:`Mesh` being cons Requires primitive type be set to :ref:`Mesh.PRIMITIVE_TRIANGLES`. +---- + .. _class_SurfaceTool_method_add_uv: - void **add_uv** **(** :ref:`Vector2` uv **)** Specify UV Coordinate for next Vertex to use. +---- + .. _class_SurfaceTool_method_add_uv2: - void **add_uv2** **(** :ref:`Vector2` uv2 **)** Specify an optional second set of UV coordinates for next Vertex to use. +---- + .. _class_SurfaceTool_method_add_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_method_add_weights: - void **add_weights** **(** :ref:`PoolRealArray` weights **)** Specify weight values for next Vertex to use. Array must contain 4 values. +---- + .. _class_SurfaceTool_method_append_from: - void **append_from** **(** :ref:`Mesh` existing, :ref:`int` surface, :ref:`Transform` transform **)** Append vertices from a given :ref:`Mesh` surface onto the current vertex array with specified :ref:`Transform`. +---- + .. _class_SurfaceTool_method_begin: - void **begin** **(** :ref:`PrimitiveType` primitive **)** Called before adding any Vertices. Takes the primitive type as an argument (e.g. :ref:`Mesh.PRIMITIVE_TRIANGLES`). +---- + .. _class_SurfaceTool_method_clear: - void **clear** **(** **)** Clear all information passed into the surface tool so far. +---- + .. _class_SurfaceTool_method_commit: - :ref:`ArrayMesh` **commit** **(** :ref:`ArrayMesh` existing=null, :ref:`int` flags=97280 **)** 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_method_create_from: - void **create_from** **(** :ref:`Mesh` existing, :ref:`int` surface **)** Creates a vertex array from an existing :ref:`Mesh`. +---- + .. _class_SurfaceTool_method_deindex: - void **deindex** **(** **)** Removes index array by expanding Vertex array. +---- + .. _class_SurfaceTool_method_generate_normals: - void **generate_normals** **(** :ref:`bool` flip=false **)** @@ -201,6 +235,8 @@ Setting ``flip`` to ``true`` inverts the resulting normals. Requires primitive type to be set to :ref:`Mesh.PRIMITIVE_TRIANGLES`. +---- + .. _class_SurfaceTool_method_generate_tangents: - void **generate_tangents** **(** **)** @@ -209,12 +245,16 @@ Generates a tangent vector for each vertex. Requires that each vertex have UVs and normals set already. +---- + .. _class_SurfaceTool_method_index: - void **index** **(** **)** Shrinks Vertex array by creating an index array. Avoids reusing Vertices. +---- + .. _class_SurfaceTool_method_set_material: - void **set_material** **(** :ref:`Material` material **)** diff --git a/classes/class_tabcontainer.rst b/classes/class_tabcontainer.rst index a6d834b91..b56b03fec 100644 --- a/classes/class_tabcontainer.rst +++ b/classes/class_tabcontainer.rst @@ -116,12 +116,16 @@ Signals Emitted when the ``TabContainer``'s :ref:`Popup` button is clicked. See :ref:`set_popup` for details. +---- + .. _class_TabContainer_signal_tab_changed: - **tab_changed** **(** :ref:`int` tab **)** Emitted when switching to another tab. +---- + .. _class_TabContainer_signal_tab_selected: - **tab_selected** **(** :ref:`int` tab **)** @@ -173,6 +177,8 @@ Property Descriptions The current tab index. When set, this index's :ref:`Control` node's ``visible`` property is set to ``true`` and all others are set to ``false``. +---- + .. _class_TabContainer_property_drag_to_rearrange_enabled: - :ref:`bool` **drag_to_rearrange_enabled** @@ -185,6 +191,8 @@ The current tab index. When set, this index's :ref:`Control` node If ``true``, tabs can be rearranged with mouse drag. +---- + .. _class_TabContainer_property_tab_align: - :ref:`TabAlign` **tab_align** @@ -197,6 +205,8 @@ If ``true``, tabs can be rearranged with mouse drag. The alignment of all tabs in the tab container. See the ``ALIGN_*`` constants for details. +---- + .. _class_TabContainer_property_tabs_visible: - :ref:`bool` **tabs_visible** @@ -218,78 +228,104 @@ Method Descriptions Returns the child :ref:`Control` node located at the active tab index. +---- + .. _class_TabContainer_method_get_popup: - :ref:`Popup` **get_popup** **(** **)** const Returns the :ref:`Popup` node instance if one has been set already with :ref:`set_popup`. +---- + .. _class_TabContainer_method_get_previous_tab: - :ref:`int` **get_previous_tab** **(** **)** const Returns the previously active tab index. +---- + .. _class_TabContainer_method_get_tab_control: - :ref:`Control` **get_tab_control** **(** :ref:`int` idx **)** const Returns the currently visible tab's :ref:`Control` node. +---- + .. _class_TabContainer_method_get_tab_count: - :ref:`int` **get_tab_count** **(** **)** const Returns the number of tabs. +---- + .. _class_TabContainer_method_get_tab_disabled: - :ref:`bool` **get_tab_disabled** **(** :ref:`int` tab_idx **)** const Returns ``true`` if the tab at index ``tab_idx`` is disabled. +---- + .. _class_TabContainer_method_get_tab_icon: - :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_method_get_tab_title: - :ref:`String` **get_tab_title** **(** :ref:`int` tab_idx **)** const Returns the title of the tab at index ``tab_idx``. Tab titles default to the name of the indexed child node, but this can be overridden with :ref:`set_tab_title`. +---- + .. _class_TabContainer_method_get_tabs_rearrange_group: - :ref:`int` **get_tabs_rearrange_group** **(** **)** const Returns the ``TabContainer`` rearrange group id. +---- + .. _class_TabContainer_method_set_popup: - void **set_popup** **(** :ref:`Node` popup **)** If set on a :ref:`Popup` node instance, a popup menu icon appears in the top-right corner of the ``TabContainer``. Clicking it will expand the :ref:`Popup` node. +---- + .. _class_TabContainer_method_set_tab_disabled: - void **set_tab_disabled** **(** :ref:`int` tab_idx, :ref:`bool` disabled **)** If ``disabled`` is ``false``, hides the tab at index ``tab_idx``. Note that its title text will remain, unless also removed with :ref:`set_tab_title`. +---- + .. _class_TabContainer_method_set_tab_icon: - void **set_tab_icon** **(** :ref:`int` tab_idx, :ref:`Texture` icon **)** Sets an icon for the tab at index ``tab_idx``. +---- + .. _class_TabContainer_method_set_tab_title: - void **set_tab_title** **(** :ref:`int` tab_idx, :ref:`String` title **)** Sets a title for the tab at index ``tab_idx``. Tab titles default to the name of the indexed child node, but this can be overridden with :ref:`set_tab_title`. +---- + .. _class_TabContainer_method_set_tabs_rearrange_group: - void **set_tabs_rearrange_group** **(** :ref:`int` group_id **)** diff --git a/classes/class_tabs.rst b/classes/class_tabs.rst index 457fdec21..429a984bf 100644 --- a/classes/class_tabs.rst +++ b/classes/class_tabs.rst @@ -124,22 +124,32 @@ Signals - **reposition_active_tab_request** **(** :ref:`int` idx_to **)** +---- + .. _class_Tabs_signal_right_button_pressed: - **right_button_pressed** **(** :ref:`int` tab **)** +---- + .. _class_Tabs_signal_tab_changed: - **tab_changed** **(** :ref:`int` tab **)** +---- + .. _class_Tabs_signal_tab_clicked: - **tab_clicked** **(** :ref:`int` tab **)** +---- + .. _class_Tabs_signal_tab_close: - **tab_close** **(** :ref:`int` tab **)** +---- + .. _class_Tabs_signal_tab_hover: - **tab_hover** **(** :ref:`int` tab **)** @@ -167,6 +177,8 @@ enum **TabAlign**: - **ALIGN_MAX** = **3** --- Represents the size of the :ref:`TabAlign` enum. +---- + .. _enum_Tabs_CloseButtonDisplayPolicy: .. _class_Tabs_constant_CLOSE_BUTTON_SHOW_NEVER: @@ -207,6 +219,8 @@ Property Descriptions Select tab at index ``tab_idx``. +---- + .. _class_Tabs_property_drag_to_rearrange_enabled: - :ref:`bool` **drag_to_rearrange_enabled** @@ -219,6 +233,8 @@ Select tab at index ``tab_idx``. If ``true``, tabs can be rearranged with mouse drag. +---- + .. _class_Tabs_property_scrolling_enabled: - :ref:`bool` **scrolling_enabled** @@ -229,6 +245,8 @@ If ``true``, tabs can be rearranged with mouse drag. | *Getter* | get_scrolling_enabled() | +----------+------------------------------+ +---- + .. _class_Tabs_property_tab_align: - :ref:`TabAlign` **tab_align** @@ -241,6 +259,8 @@ If ``true``, tabs can be rearranged with mouse drag. The alignment of all tabs. See enum ``TabAlign`` constants for details. +---- + .. _class_Tabs_property_tab_close_display_policy: - :ref:`CloseButtonDisplayPolicy` **tab_close_display_policy** @@ -260,98 +280,132 @@ Method Descriptions Adds a new tab. +---- + .. _class_Tabs_method_ensure_tab_visible: - void **ensure_tab_visible** **(** :ref:`int` idx **)** Moves the Scroll view to make the tab visible. +---- + .. _class_Tabs_method_get_offset_buttons_visible: - :ref:`bool` **get_offset_buttons_visible** **(** **)** const +---- + .. _class_Tabs_method_get_select_with_rmb: - :ref:`bool` **get_select_with_rmb** **(** **)** const Returns ``true`` if select with right mouse button is enabled. +---- + .. _class_Tabs_method_get_tab_count: - :ref:`int` **get_tab_count** **(** **)** const Returns the number of tabs. +---- + .. _class_Tabs_method_get_tab_disabled: - :ref:`bool` **get_tab_disabled** **(** :ref:`int` tab_idx **)** const Returns ``true`` if the tab at index ``tab_idx`` is disabled. +---- + .. _class_Tabs_method_get_tab_icon: - :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_Tabs_method_get_tab_offset: - :ref:`int` **get_tab_offset** **(** **)** const +---- + .. _class_Tabs_method_get_tab_rect: - :ref:`Rect2` **get_tab_rect** **(** :ref:`int` tab_idx **)** const Returns tab :ref:`Rect2` with local position and size. +---- + .. _class_Tabs_method_get_tab_title: - :ref:`String` **get_tab_title** **(** :ref:`int` tab_idx **)** const Returns the title of the tab at index ``tab_idx``. Tab titles default to the name of the indexed child node, but this can be overridden with :ref:`set_tab_title`. +---- + .. _class_Tabs_method_get_tabs_rearrange_group: - :ref:`int` **get_tabs_rearrange_group** **(** **)** const Returns the ``Tabs`` rearrange group id. +---- + .. _class_Tabs_method_move_tab: - void **move_tab** **(** :ref:`int` from, :ref:`int` to **)** Rearrange tab. +---- + .. _class_Tabs_method_remove_tab: - void **remove_tab** **(** :ref:`int` tab_idx **)** Removes tab at index ``tab_idx`` +---- + .. _class_Tabs_method_set_select_with_rmb: - void **set_select_with_rmb** **(** :ref:`bool` enabled **)** If ``true``, enables selecting a tab with right mouse button. +---- + .. _class_Tabs_method_set_tab_disabled: - void **set_tab_disabled** **(** :ref:`int` tab_idx, :ref:`bool` disabled **)** If ``disabled`` is ``false``, hides the tab at index ``tab_idx``. Note that its title text will remain, unless also removed with :ref:`set_tab_title`. +---- + .. _class_Tabs_method_set_tab_icon: - void **set_tab_icon** **(** :ref:`int` tab_idx, :ref:`Texture` icon **)** Sets an icon for the tab at index ``tab_idx``. +---- + .. _class_Tabs_method_set_tab_title: - void **set_tab_title** **(** :ref:`int` tab_idx, :ref:`String` title **)** Sets a title for the tab at index ``tab_idx``. +---- + .. _class_Tabs_method_set_tabs_rearrange_group: - void **set_tabs_rearrange_group** **(** :ref:`int` group_id **)** diff --git a/classes/class_tcp_server.rst b/classes/class_tcp_server.rst index de60aacc9..f3f65347d 100644 --- a/classes/class_tcp_server.rst +++ b/classes/class_tcp_server.rst @@ -45,6 +45,8 @@ Method Descriptions Returns ``true`` if a connection is available for taking. +---- + .. _class_TCP_Server_method_listen: - :ref:`Error` **listen** **(** :ref:`int` port, :ref:`String` bind_address="*" **)** @@ -57,12 +59,16 @@ If "bind_address" is set as "0.0.0.0" (for IPv4) or "::" (for IPv6), the server If "bind_address" is set to any valid address (e.g. "192.168.1.101", "::1", etc), the server will only listen on the interface with that addresses (or fail if no interface with the given address exists). +---- + .. _class_TCP_Server_method_stop: - void **stop** **(** **)** Stop listening. +---- + .. _class_TCP_Server_method_take_connection: - :ref:`StreamPeerTCP` **take_connection** **(** **)** diff --git a/classes/class_textedit.rst b/classes/class_textedit.rst index cc55f6232..043e839e3 100644 --- a/classes/class_textedit.rst +++ b/classes/class_textedit.rst @@ -226,20 +226,28 @@ Signals Emitted when a breakpoint is placed via the breakpoint gutter. +---- + .. _class_TextEdit_signal_cursor_changed: - **cursor_changed** **(** **)** Emitted when the cursor changes. +---- + .. _class_TextEdit_signal_request_completion: - **request_completion** **(** **)** +---- + .. _class_TextEdit_signal_symbol_lookup: - **symbol_lookup** **(** :ref:`String` symbol, :ref:`int` row, :ref:`int` column **)** +---- + .. _class_TextEdit_signal_text_changed: - **text_changed** **(** **)** @@ -265,6 +273,8 @@ enum **SearchFlags**: - **SEARCH_BACKWARDS** = **4** --- Search from end to beginning. +---- + .. _enum_TextEdit_MenuItems: .. _class_TextEdit_constant_MENU_CUT: @@ -321,6 +331,8 @@ Property Descriptions If ``true``, the breakpoint gutter is visible. +---- + .. _class_TextEdit_property_caret_blink: - :ref:`bool` **caret_blink** @@ -333,6 +345,8 @@ If ``true``, the breakpoint gutter is visible. If ``true``, the caret (visual cursor) blinks. +---- + .. _class_TextEdit_property_caret_blink_speed: - :ref:`float` **caret_blink_speed** @@ -345,6 +359,8 @@ If ``true``, the caret (visual cursor) blinks. Duration (in seconds) of a caret's blinking cycle. +---- + .. _class_TextEdit_property_caret_block_mode: - :ref:`bool` **caret_block_mode** @@ -359,6 +375,8 @@ If ``true``, the caret displays as a rectangle. If ``false``, the caret displays as a bar. +---- + .. _class_TextEdit_property_caret_moving_by_right_click: - :ref:`bool` **caret_moving_by_right_click** @@ -373,6 +391,8 @@ If ``true``, a right click moves the cursor at the mouse position before display If ``false``, the context menu disregards mouse location. +---- + .. _class_TextEdit_property_context_menu_enabled: - :ref:`bool` **context_menu_enabled** @@ -385,6 +405,8 @@ If ``false``, the context menu disregards mouse location. If ``true``, a right click displays the context menu. +---- + .. _class_TextEdit_property_hiding_enabled: - :ref:`int` **hiding_enabled** @@ -395,6 +417,8 @@ If ``true``, a right click displays the context menu. | *Getter* | is_hiding_enabled() | +----------+---------------------------+ +---- + .. _class_TextEdit_property_highlight_all_occurrences: - :ref:`bool` **highlight_all_occurrences** @@ -407,6 +431,8 @@ If ``true``, a right click displays the context menu. If ``true``, all occurrences of the selected text will be highlighted. +---- + .. _class_TextEdit_property_highlight_current_line: - :ref:`bool` **highlight_current_line** @@ -419,6 +445,8 @@ If ``true``, all occurrences of the selected text will be highlighted. If ``true``, the line containing the cursor is highlighted. +---- + .. _class_TextEdit_property_override_selected_font_color: - :ref:`bool` **override_selected_font_color** @@ -429,6 +457,8 @@ If ``true``, the line containing the cursor is highlighted. | *Getter* | is_overriding_selected_font_color() | +----------+-----------------------------------------+ +---- + .. _class_TextEdit_property_readonly: - :ref:`bool` **readonly** @@ -441,6 +471,8 @@ If ``true``, the line containing the cursor is highlighted. If ``true``, read-only mode is enabled. Existing text cannot be modified and new text cannot be added. +---- + .. _class_TextEdit_property_show_line_numbers: - :ref:`bool` **show_line_numbers** @@ -453,6 +485,8 @@ If ``true``, read-only mode is enabled. Existing text cannot be modified and new If ``true``, line numbers are displayed to the left of the text. +---- + .. _class_TextEdit_property_smooth_scrolling: - :ref:`bool` **smooth_scrolling** @@ -465,6 +499,8 @@ If ``true``, line numbers are displayed to the left of the text. If ``true``, sets the ``step`` of the scrollbars to ``0.25`` which results in smoother scrolling. +---- + .. _class_TextEdit_property_syntax_highlighting: - :ref:`bool` **syntax_highlighting** @@ -477,6 +513,8 @@ If ``true``, sets the ``step`` of the scrollbars to ``0.25`` which results in sm If ``true``, any custom color properties that have been set for this :ref:`TextEdit` will be visible. +---- + .. _class_TextEdit_property_text: - :ref:`String` **text** @@ -489,6 +527,8 @@ If ``true``, any custom color properties that have been set for this :ref:`TextE String value of the :ref:`TextEdit`. +---- + .. _class_TextEdit_property_v_scroll_speed: - :ref:`float` **v_scroll_speed** @@ -501,6 +541,8 @@ String value of the :ref:`TextEdit`. Vertical scroll sensitivity. +---- + .. _class_TextEdit_property_wrap_enabled: - :ref:`bool` **wrap_enabled** @@ -522,46 +564,62 @@ Method Descriptions Add color region (given the delimiters) and its colors. +---- + .. _class_TextEdit_method_add_keyword_color: - void **add_keyword_color** **(** :ref:`String` keyword, :ref:`Color` color **)** Add a ``keyword`` and its :ref:`Color`. +---- + .. _class_TextEdit_method_can_fold: - :ref:`bool` **can_fold** **(** :ref:`int` line **)** const +---- + .. _class_TextEdit_method_clear_colors: - void **clear_colors** **(** **)** Clears all the syntax coloring information. +---- + .. _class_TextEdit_method_clear_undo_history: - void **clear_undo_history** **(** **)** Clears the undo history. +---- + .. _class_TextEdit_method_copy: - void **copy** **(** **)** Copy's the current text selection. +---- + .. _class_TextEdit_method_cursor_get_column: - :ref:`int` **cursor_get_column** **(** **)** const Returns the column the editing cursor is at. +---- + .. _class_TextEdit_method_cursor_get_line: - :ref:`int` **cursor_get_line** **(** **)** const Returns the line the editing cursor is at. +---- + .. _class_TextEdit_method_cursor_set_column: - void **cursor_set_column** **(** :ref:`int` column, :ref:`bool` adjust_viewport=true **)** @@ -570,6 +628,8 @@ Moves the cursor at the specified ``column`` index. If ``adjust_viewport`` is set to true, the viewport will center at the cursor position after the move occurs. Default value is ``true``. +---- + .. _class_TextEdit_method_cursor_set_line: - void **cursor_set_line** **(** :ref:`int` line, :ref:`bool` adjust_viewport=true, :ref:`bool` can_be_hidden=true, :ref:`int` wrap_index=0 **)** @@ -580,184 +640,248 @@ If ``adjust_viewport`` is set to true, the viewport will center at the cursor po If ``can_be_hidden`` is set to true, the specified ``line`` can be hidden using :ref:`set_line_as_hidden`. Default value is ``true``. +---- + .. _class_TextEdit_method_cut: - void **cut** **(** **)** Cut's the current selection. +---- + .. _class_TextEdit_method_deselect: - void **deselect** **(** **)** Deselects the current selection. +---- + .. _class_TextEdit_method_fold_all_lines: - void **fold_all_lines** **(** **)** +---- + .. _class_TextEdit_method_fold_line: - void **fold_line** **(** :ref:`int` line **)** +---- + .. _class_TextEdit_method_get_breakpoints: - :ref:`Array` **get_breakpoints** **(** **)** const Returns an array containing the line number of each breakpoint. +---- + .. _class_TextEdit_method_get_keyword_color: - :ref:`Color` **get_keyword_color** **(** :ref:`String` keyword **)** const Returns the :ref:`Color` of the specified ``keyword``. +---- + .. _class_TextEdit_method_get_line: - :ref:`String` **get_line** **(** :ref:`int` line **)** const Returns the text of a specific line. +---- + .. _class_TextEdit_method_get_line_count: - :ref:`int` **get_line_count** **(** **)** const Returns the amount of total lines in the text. +---- + .. _class_TextEdit_method_get_menu: - :ref:`PopupMenu` **get_menu** **(** **)** const +---- + .. _class_TextEdit_method_get_selection_from_column: - :ref:`int` **get_selection_from_column** **(** **)** const Returns the selection begin column. +---- + .. _class_TextEdit_method_get_selection_from_line: - :ref:`int` **get_selection_from_line** **(** **)** const Returns the selection begin line. +---- + .. _class_TextEdit_method_get_selection_text: - :ref:`String` **get_selection_text** **(** **)** const Returns the text inside the selection. +---- + .. _class_TextEdit_method_get_selection_to_column: - :ref:`int` **get_selection_to_column** **(** **)** const Returns the selection end column. +---- + .. _class_TextEdit_method_get_selection_to_line: - :ref:`int` **get_selection_to_line** **(** **)** const Returns the selection end line. +---- + .. _class_TextEdit_method_get_word_under_cursor: - :ref:`String` **get_word_under_cursor** **(** **)** const Returns a :ref:`String` text with the word under the mouse cursor location. +---- + .. _class_TextEdit_method_has_keyword_color: - :ref:`bool` **has_keyword_color** **(** :ref:`String` keyword **)** const Returns whether the specified ``keyword`` has a color set to it or not. +---- + .. _class_TextEdit_method_insert_text_at_cursor: - void **insert_text_at_cursor** **(** :ref:`String` text **)** Insert the specified text at the cursor position. +---- + .. _class_TextEdit_method_is_folded: - :ref:`bool` **is_folded** **(** :ref:`int` line **)** const Returns whether the line at the specified index is folded or not. +---- + .. _class_TextEdit_method_is_line_hidden: - :ref:`bool` **is_line_hidden** **(** :ref:`int` line **)** const Returns whether the line at the specified index is hidden or not. +---- + .. _class_TextEdit_method_is_selection_active: - :ref:`bool` **is_selection_active** **(** **)** const Returns ``true`` if the selection is active. +---- + .. _class_TextEdit_method_menu_option: - void **menu_option** **(** :ref:`int` option **)** Triggers a right click menu action by the specified index. See :ref:`MenuItems` for a list of available indexes. +---- + .. _class_TextEdit_method_paste: - void **paste** **(** **)** Paste the current selection. +---- + .. _class_TextEdit_method_redo: - void **redo** **(** **)** Perform redo operation. +---- + .. _class_TextEdit_method_remove_breakpoints: - void **remove_breakpoints** **(** **)** Removes all the breakpoints (without firing "breakpoint_toggled" signal). +---- + .. _class_TextEdit_method_search: - :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_method_select: - 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_method_select_all: - void **select_all** **(** **)** Select all the text. +---- + .. _class_TextEdit_method_set_line_as_hidden: - void **set_line_as_hidden** **(** :ref:`int` line, :ref:`bool` enable **)** If ``true``, hides the line of the specified index. +---- + .. _class_TextEdit_method_toggle_fold_line: - void **toggle_fold_line** **(** :ref:`int` line **)** Toggle the folding of the code block at the given line. +---- + .. _class_TextEdit_method_undo: - void **undo** **(** **)** Perform undo operation. +---- + .. _class_TextEdit_method_unfold_line: - void **unfold_line** **(** :ref:`int` line **)** +---- + .. _class_TextEdit_method_unhide_all_lines: - void **unhide_all_lines** **(** **)** diff --git a/classes/class_texture.rst b/classes/class_texture.rst index 4e580cb3b..5aa76186a 100644 --- a/classes/class_texture.rst +++ b/classes/class_texture.rst @@ -118,36 +118,50 @@ Method Descriptions - 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_method_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 +---- + .. _class_Texture_method_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 +---- + .. _class_Texture_method_get_data: - :ref:`Image` **get_data** **(** **)** const +---- + .. _class_Texture_method_get_height: - :ref:`int` **get_height** **(** **)** const Returns the texture height. +---- + .. _class_Texture_method_get_size: - :ref:`Vector2` **get_size** **(** **)** const Returns the texture size. +---- + .. _class_Texture_method_get_width: - :ref:`int` **get_width** **(** **)** const Returns the texture width. +---- + .. _class_Texture_method_has_alpha: - :ref:`bool` **has_alpha** **(** **)** const diff --git a/classes/class_texturebutton.rst b/classes/class_texturebutton.rst index 41395a452..ec98ac15c 100644 --- a/classes/class_texturebutton.rst +++ b/classes/class_texturebutton.rst @@ -96,6 +96,8 @@ Property Descriptions If ``true``, the texture stretches to the edges of the node's bounding rectangle using the :ref:`stretch_mode`. If ``false``, the texture will not scale with the node. Default value: ``false``. +---- + .. _class_TextureButton_property_stretch_mode: - :ref:`StretchMode` **stretch_mode** @@ -108,6 +110,8 @@ If ``true``, the texture stretches to the edges of the node's bounding rectangle Controls the texture's behavior when you resize the node's bounding rectangle, **only if** :ref:`expand` is ``true``. Set it to one of the ``STRETCH_*`` constants. See the constants to learn more. +---- + .. _class_TextureButton_property_texture_click_mask: - :ref:`BitMap` **texture_click_mask** @@ -120,6 +124,8 @@ Controls the texture's behavior when you resize the node's bounding rectangle, * Pure black and white :ref:`BitMap` image to use for click detection. On the mask, white pixels represent the button's clickable area. Use it to create buttons with curved shapes. +---- + .. _class_TextureButton_property_texture_disabled: - :ref:`Texture` **texture_disabled** @@ -132,6 +138,8 @@ Pure black and white :ref:`BitMap` image to use for click detectio Texture to display when the node is disabled. See :ref:`BaseButton.disabled`. +---- + .. _class_TextureButton_property_texture_focused: - :ref:`Texture` **texture_focused** @@ -144,6 +152,8 @@ Texture to display when the node is disabled. See :ref:`BaseButton.disabled` **texture_hover** @@ -156,6 +166,8 @@ Texture to display when the node has mouse or keyboard focus. Texture to display when the mouse hovers the node. +---- + .. _class_TextureButton_property_texture_normal: - :ref:`Texture` **texture_normal** @@ -168,6 +180,8 @@ Texture to display when the mouse hovers the node. Texture to display by default, when the node is **not** in the disabled, focused, hover or pressed state. +---- + .. _class_TextureButton_property_texture_pressed: - :ref:`Texture` **texture_pressed** diff --git a/classes/class_texturelayered.rst b/classes/class_texturelayered.rst index 23d67f979..241eb9e30 100644 --- a/classes/class_texturelayered.rst +++ b/classes/class_texturelayered.rst @@ -80,6 +80,8 @@ Property Descriptions - :ref:`Dictionary` **data** +---- + .. _class_TextureLayered_property_flags: - :ref:`int` **flags** @@ -97,30 +99,44 @@ Method Descriptions - void **create** **(** :ref:`int` width, :ref:`int` height, :ref:`int` depth, :ref:`Format` format, :ref:`int` flags=4 **)** +---- + .. _class_TextureLayered_method_get_depth: - :ref:`int` **get_depth** **(** **)** const +---- + .. _class_TextureLayered_method_get_format: - :ref:`Format` **get_format** **(** **)** const +---- + .. _class_TextureLayered_method_get_height: - :ref:`int` **get_height** **(** **)** const +---- + .. _class_TextureLayered_method_get_layer_data: - :ref:`Image` **get_layer_data** **(** :ref:`int` layer **)** const +---- + .. _class_TextureLayered_method_get_width: - :ref:`int` **get_width** **(** **)** const +---- + .. _class_TextureLayered_method_set_data_partial: - void **set_data_partial** **(** :ref:`Image` image, :ref:`int` x_offset, :ref:`int` y_offset, :ref:`int` layer, :ref:`int` mipmap=0 **)** +---- + .. _class_TextureLayered_method_set_layer_data: - void **set_layer_data** **(** :ref:`Image` image, :ref:`int` layer **)** diff --git a/classes/class_textureprogress.rst b/classes/class_textureprogress.rst index 8d4359e60..1c33e0e09 100644 --- a/classes/class_textureprogress.rst +++ b/classes/class_textureprogress.rst @@ -116,6 +116,8 @@ Property Descriptions The fill direction. Uses FILL\_\* constants. +---- + .. _class_TextureProgress_property_nine_patch_stretch: - :ref:`bool` **nine_patch_stretch** @@ -128,6 +130,8 @@ The fill direction. Uses FILL\_\* constants. If ``true``, Godot treats the bar's textures like :ref:`NinePatchRect`. Use ``stretch_margin_*``, like :ref:`stretch_margin_bottom`, to set up the nine patch's 3x3 grid. Default value: ``false``. +---- + .. _class_TextureProgress_property_radial_center_offset: - :ref:`Vector2` **radial_center_offset** @@ -140,6 +144,8 @@ If ``true``, Godot treats the bar's textures like :ref:`NinePatchRect` if :ref:`fill_mode` is :ref:`FILL_CLOCKWISE` or :ref:`FILL_COUNTER_CLOCKWISE`. +---- + .. _class_TextureProgress_property_radial_fill_degrees: - :ref:`float` **radial_fill_degrees** @@ -154,6 +160,8 @@ Upper limit for the fill of :ref:`texture_progress`, :ref:`Range.max_value`. +---- + .. _class_TextureProgress_property_radial_initial_angle: - :ref:`float` **radial_initial_angle** @@ -166,6 +174,8 @@ See :ref:`Range.value`, :ref:`Range.max_value` if :ref:`fill_mode` is :ref:`FILL_CLOCKWISE` or :ref:`FILL_COUNTER_CLOCKWISE`. When the node's ``value`` is equal to its ``min_value``, the texture doesn't show up at all. When the ``value`` increases, the texture fills and tends towards :ref:`radial_fill_degrees`. +---- + .. _class_TextureProgress_property_stretch_margin_bottom: - :ref:`int` **stretch_margin_bottom** @@ -178,6 +188,8 @@ Starting angle for the fill of :ref:`texture_progress` **stretch_margin_left** @@ -190,6 +202,8 @@ The height of the 9-patch's bottom row. A margin of 16 means the 9-slice's botto The width of the 9-patch's left column. +---- + .. _class_TextureProgress_property_stretch_margin_right: - :ref:`int` **stretch_margin_right** @@ -202,6 +216,8 @@ The width of the 9-patch's left column. The width of the 9-patch's right column. +---- + .. _class_TextureProgress_property_stretch_margin_top: - :ref:`int` **stretch_margin_top** @@ -214,6 +230,8 @@ The width of the 9-patch's right column. The height of the 9-patch's top row. +---- + .. _class_TextureProgress_property_texture_over: - :ref:`Texture` **texture_over** @@ -226,6 +244,8 @@ The height of the 9-patch's top row. :ref:`Texture` that draws over the progress bar. Use it to add highlights or an upper-frame that hides part of :ref:`texture_progress`. +---- + .. _class_TextureProgress_property_texture_progress: - :ref:`Texture` **texture_progress** @@ -240,6 +260,8 @@ The height of the 9-patch's top row. The ``value`` property comes from :ref:`Range`. See :ref:`Range.value`, :ref:`Range.min_value`, :ref:`Range.max_value`. +---- + .. _class_TextureProgress_property_texture_under: - :ref:`Texture` **texture_under** @@ -252,6 +274,8 @@ The ``value`` property comes from :ref:`Range`. See :ref:`Range.val :ref:`Texture` that draws under the progress bar. The bar's background. +---- + .. _class_TextureProgress_property_tint_over: - :ref:`Color` **tint_over** @@ -264,6 +288,8 @@ The ``value`` property comes from :ref:`Range`. See :ref:`Range.val Multiplies the color of the bar's ``texture_over`` texture. The effect is similar to :ref:`CanvasItem.modulate`, except it only affects this specific texture instead of the entire node. +---- + .. _class_TextureProgress_property_tint_progress: - :ref:`Color` **tint_progress** @@ -276,6 +302,8 @@ Multiplies the color of the bar's ``texture_over`` texture. The effect is simila Multiplies the color of the bar's ``texture_progress`` texture. +---- + .. _class_TextureProgress_property_tint_under: - :ref:`Color` **tint_under** diff --git a/classes/class_texturerect.rst b/classes/class_texturerect.rst index 7cc839633..2919771c1 100644 --- a/classes/class_texturerect.rst +++ b/classes/class_texturerect.rst @@ -88,6 +88,8 @@ Property Descriptions If ``true``, the texture scales to fit its bounding rectangle. Default value: ``false``. +---- + .. _class_TextureRect_property_stretch_mode: - :ref:`StretchMode` **stretch_mode** @@ -100,6 +102,8 @@ If ``true``, the texture scales to fit its bounding rectangle. Default value: `` Controls the texture's behavior when resizing the node's bounding rectangle. See :ref:`StretchMode`. +---- + .. _class_TextureRect_property_texture: - :ref:`Texture` **texture** diff --git a/classes/class_theme.rst b/classes/class_theme.rst index ac75acc9a..f4e52be41 100644 --- a/classes/class_theme.rst +++ b/classes/class_theme.rst @@ -124,118 +124,158 @@ Method Descriptions - void **clear** **(** **)** +---- + .. _class_Theme_method_clear_color: - void **clear_color** **(** :ref:`String` name, :ref:`String` type **)** Clears theme :ref:`Color` at ``name`` if Theme has ``type``. +---- + .. _class_Theme_method_clear_constant: - void **clear_constant** **(** :ref:`String` name, :ref:`String` type **)** Clears theme constant at ``name`` if Theme has ``type``. +---- + .. _class_Theme_method_clear_font: - void **clear_font** **(** :ref:`String` name, :ref:`String` type **)** Clears :ref:`Font` at ``name`` if Theme has ``type``. +---- + .. _class_Theme_method_clear_icon: - void **clear_icon** **(** :ref:`String` name, :ref:`String` type **)** Clears icon at ``name`` if Theme has ``type``. +---- + .. _class_Theme_method_clear_stylebox: - void **clear_stylebox** **(** :ref:`String` name, :ref:`String` type **)** Clears :ref:`StyleBox` at ``name`` if Theme has ``type``. +---- + .. _class_Theme_method_copy_default_theme: - void **copy_default_theme** **(** **)** Sets theme values to a copy of the default theme values. +---- + .. _class_Theme_method_copy_theme: - void **copy_theme** **(** :ref:`Theme` other **)** +---- + .. _class_Theme_method_get_color: - :ref:`Color` **get_color** **(** :ref:`String` name, :ref:`String` type **)** const Returns the :ref:`Color` at ``name`` if Theme has ``type``. +---- + .. _class_Theme_method_get_color_list: - :ref:`PoolStringArray` **get_color_list** **(** :ref:`String` type **)** const Returns all of the :ref:`Color`\ s as a :ref:`PoolStringArray` filled with each :ref:`Color`'s name, for use in :ref:`get_color`, if Theme has ``type``. +---- + .. _class_Theme_method_get_constant: - :ref:`int` **get_constant** **(** :ref:`String` name, :ref:`String` type **)** const Returns the constant at ``name`` if Theme has ``type``. +---- + .. _class_Theme_method_get_constant_list: - :ref:`PoolStringArray` **get_constant_list** **(** :ref:`String` type **)** const Returns all of the constants as a :ref:`PoolStringArray` filled with each constant's name, for use in :ref:`get_constant`, if Theme has ``type``. +---- + .. _class_Theme_method_get_font: - :ref:`Font` **get_font** **(** :ref:`String` name, :ref:`String` type **)** const Returns the :ref:`Font` at ``name`` if Theme has ``type``. +---- + .. _class_Theme_method_get_font_list: - :ref:`PoolStringArray` **get_font_list** **(** :ref:`String` type **)** const Returns all of the :ref:`Font`\ s as a :ref:`PoolStringArray` filled with each :ref:`Font`'s name, for use in :ref:`get_font`, if Theme has ``type``. +---- + .. _class_Theme_method_get_icon: - :ref:`Texture` **get_icon** **(** :ref:`String` name, :ref:`String` type **)** const Returns the icon :ref:`Texture` at ``name`` if Theme has ``type``. +---- + .. _class_Theme_method_get_icon_list: - :ref:`PoolStringArray` **get_icon_list** **(** :ref:`String` type **)** const Returns all of the icons as a :ref:`PoolStringArray` filled with each :ref:`Texture`'s name, for use in :ref:`get_icon`, if Theme has ``type``. +---- + .. _class_Theme_method_get_stylebox: - :ref:`StyleBox` **get_stylebox** **(** :ref:`String` name, :ref:`String` type **)** const Returns the icon :ref:`StyleBox` at ``name`` if Theme has ``type``. +---- + .. _class_Theme_method_get_stylebox_list: - :ref:`PoolStringArray` **get_stylebox_list** **(** :ref:`String` type **)** const Returns all of the :ref:`StyleBox`\ s as a :ref:`PoolStringArray` filled with each :ref:`StyleBox`'s name, for use in :ref:`get_stylebox`, if Theme has ``type``. +---- + .. _class_Theme_method_get_stylebox_types: - :ref:`PoolStringArray` **get_stylebox_types** **(** **)** const Returns all of the :ref:`StyleBox` types as a :ref:`PoolStringArray` filled with each :ref:`StyleBox`'s type, for use in :ref:`get_stylebox` and/or :ref:`get_stylebox_list`, if Theme has ``type``. +---- + .. _class_Theme_method_get_type_list: - :ref:`PoolStringArray` **get_type_list** **(** :ref:`String` type **)** const Returns all of the types in ``type`` as a :ref:`PoolStringArray` for use in any of the get\_\* functions, if Theme has ``type``. +---- + .. _class_Theme_method_has_color: - :ref:`bool` **has_color** **(** :ref:`String` name, :ref:`String` type **)** const @@ -244,6 +284,8 @@ Returns ``true`` if :ref:`Color` with ``name`` is in ``type``. Returns ``false`` if Theme does not have ``type``. +---- + .. _class_Theme_method_has_constant: - :ref:`bool` **has_constant** **(** :ref:`String` name, :ref:`String` type **)** const @@ -252,6 +294,8 @@ Returns ``true`` if constant with ``name`` is in ``type``. Returns ``false`` if Theme does not have ``type``. +---- + .. _class_Theme_method_has_font: - :ref:`bool` **has_font** **(** :ref:`String` name, :ref:`String` type **)** const @@ -260,6 +304,8 @@ Returns ``true`` if :ref:`Font` with ``name`` is in ``type``. Returns ``false`` if Theme does not have ``type``. +---- + .. _class_Theme_method_has_icon: - :ref:`bool` **has_icon** **(** :ref:`String` name, :ref:`String` type **)** const @@ -268,6 +314,8 @@ Returns ``true`` if icon :ref:`Texture` with ``name`` is in ``typ Returns ``false`` if Theme does not have ``type``. +---- + .. _class_Theme_method_has_stylebox: - :ref:`bool` **has_stylebox** **(** :ref:`String` name, :ref:`String` type **)** const @@ -276,6 +324,8 @@ Returns ``true`` if :ref:`StyleBox` with ``name`` is in ``type`` Returns ``false`` if Theme does not have ``type``. +---- + .. _class_Theme_method_set_color: - void **set_color** **(** :ref:`String` name, :ref:`String` type, :ref:`Color` color **)** @@ -284,6 +334,8 @@ Sets Theme's :ref:`Color` to ``color`` at ``name`` in ``type``. Does nothing if Theme does not have ``type``. +---- + .. _class_Theme_method_set_constant: - void **set_constant** **(** :ref:`String` name, :ref:`String` type, :ref:`int` constant **)** @@ -292,6 +344,8 @@ Sets Theme's constant to ``constant`` at ``name`` in ``type``. Does nothing if Theme does not have ``type``. +---- + .. _class_Theme_method_set_font: - void **set_font** **(** :ref:`String` name, :ref:`String` type, :ref:`Font` font **)** @@ -300,6 +354,8 @@ Sets Theme's :ref:`Font` to ``font`` at ``name`` in ``type``. Does nothing if Theme does not have ``type``. +---- + .. _class_Theme_method_set_icon: - void **set_icon** **(** :ref:`String` name, :ref:`String` type, :ref:`Texture` texture **)** @@ -308,6 +364,8 @@ Sets Theme's icon :ref:`Texture` to ``texture`` at ``name`` in `` Does nothing if Theme does not have ``type``. +---- + .. _class_Theme_method_set_stylebox: - 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 2826cc630..1da592ab3 100644 --- a/classes/class_thread.rst +++ b/classes/class_thread.rst @@ -64,12 +64,16 @@ Method Descriptions Returns the current ``Thread``\ s id, uniquely identifying it among all threads. +---- + .. _class_Thread_method_is_active: - :ref:`bool` **is_active** **(** **)** const Returns ``true`` if this ``Thread`` is currently active. An active ``Thread`` cannot start work on a new method but can be joined with :ref:`wait_to_finish`. +---- + .. _class_Thread_method_start: - :ref:`Error` **start** **(** :ref:`Object` instance, :ref:`String` method, :ref:`Variant` userdata=null, :ref:`int` priority=1 **)** @@ -78,6 +82,8 @@ Starts a new ``Thread`` that runs "method" on object "instance" with "userdata" Returns OK on success, or ERR_CANT_CREATE on failure. +---- + .. _class_Thread_method_wait_to_finish: - :ref:`Variant` **wait_to_finish** **(** **)** diff --git a/classes/class_tilemap.rst b/classes/class_tilemap.rst index 2fb4abc1c..bea0e65b4 100644 --- a/classes/class_tilemap.rst +++ b/classes/class_tilemap.rst @@ -130,6 +130,8 @@ enum **Mode**: - **MODE_CUSTOM** = **2** --- Custom orientation mode. +---- + .. _enum_TileMap_HalfOffset: .. _class_TileMap_constant_HALF_OFFSET_X: @@ -138,6 +140,10 @@ enum **Mode**: .. _class_TileMap_constant_HALF_OFFSET_DISABLED: +.. _class_TileMap_constant_HALF_OFFSET_NEGATIVE_X: + +.. _class_TileMap_constant_HALF_OFFSET_NEGATIVE_Y: + enum **HalfOffset**: - **HALF_OFFSET_X** = **0** --- Half offset on the X coordinate. @@ -146,6 +152,12 @@ enum **HalfOffset**: - **HALF_OFFSET_DISABLED** = **2** --- Half offset disabled. +- **HALF_OFFSET_NEGATIVE_X** = **3** --- Half offset on the X coordinate (negative). + +- **HALF_OFFSET_NEGATIVE_Y** = **4** --- Half offset on the Y coordinate (negative). + +---- + .. _enum_TileMap_TileOrigin: .. _class_TileMap_constant_TILE_ORIGIN_TOP_LEFT: @@ -192,6 +204,8 @@ Property Descriptions | *Getter* | get_clip_uv() | +----------+--------------------+ +---- + .. _class_TileMap_property_cell_custom_transform: - :ref:`Transform2D` **cell_custom_transform** @@ -204,6 +218,8 @@ Property Descriptions The custom :ref:`Transform2D` to be applied to the TileMap's cells. +---- + .. _class_TileMap_property_cell_half_offset: - :ref:`HalfOffset` **cell_half_offset** @@ -216,6 +232,8 @@ The custom :ref:`Transform2D` to be applied to the TileMap's Amount to offset alternating tiles. Uses HALF_OFFSET\_\* constants. Default value: HALF_OFFSET_DISABLED. +---- + .. _class_TileMap_property_cell_quadrant_size: - :ref:`int` **cell_quadrant_size** @@ -228,6 +246,8 @@ Amount to offset alternating tiles. Uses HALF_OFFSET\_\* constants. Default valu The TileMap's quadrant size. Optimizes drawing by batching, using chunks of this size. Default value: 16. +---- + .. _class_TileMap_property_cell_size: - :ref:`Vector2` **cell_size** @@ -240,6 +260,8 @@ The TileMap's quadrant size. Optimizes drawing by batching, using chunks of this The TileMap's cell size. +---- + .. _class_TileMap_property_cell_tile_origin: - :ref:`TileOrigin` **cell_tile_origin** @@ -252,6 +274,8 @@ The TileMap's cell size. Position for tile origin. Uses TILE_ORIGIN\_\* constants. Default value: TILE_ORIGIN_TOP_LEFT. +---- + .. _class_TileMap_property_cell_y_sort: - :ref:`bool` **cell_y_sort** @@ -264,6 +288,8 @@ Position for tile origin. Uses TILE_ORIGIN\_\* constants. Default value: TILE_OR If ``true``, the TileMap's children will be drawn in order of their Y coordinate. Default value: ``false``. +---- + .. _class_TileMap_property_collision_bounce: - :ref:`float` **collision_bounce** @@ -276,6 +302,8 @@ If ``true``, the TileMap's children will be drawn in order of their Y coordinate Bounce value for static body collisions (see ``collision_use_kinematic``). Default value: 0. +---- + .. _class_TileMap_property_collision_friction: - :ref:`float` **collision_friction** @@ -288,6 +316,8 @@ Bounce value for static body collisions (see ``collision_use_kinematic``). Defau Friction value for static body collisions (see ``collision_use_kinematic``). Default value: 1. +---- + .. _class_TileMap_property_collision_layer: - :ref:`int` **collision_layer** @@ -300,6 +330,8 @@ Friction value for static body collisions (see ``collision_use_kinematic``). Def The collision layer(s) for all colliders in the TileMap. +---- + .. _class_TileMap_property_collision_mask: - :ref:`int` **collision_mask** @@ -312,6 +344,8 @@ The collision layer(s) for all colliders in the TileMap. The collision mask(s) for all colliders in the TileMap. +---- + .. _class_TileMap_property_collision_use_kinematic: - :ref:`bool` **collision_use_kinematic** @@ -324,6 +358,8 @@ The collision mask(s) for all colliders in the TileMap. If ``true``, TileMap collisions will be handled as a kinematic body. If ``false``, collisions will be handled as static body. Default value: ``false``. +---- + .. _class_TileMap_property_mode: - :ref:`Mode` **mode** @@ -336,6 +372,8 @@ If ``true``, TileMap collisions will be handled as a kinematic body. If ``false` The TileMap orientation mode. Uses MODE\_\* constants. Default value: MODE_SQUARE. +---- + .. _class_TileMap_property_occluder_light_mask: - :ref:`int` **occluder_light_mask** @@ -348,6 +386,8 @@ The TileMap orientation mode. Uses MODE\_\* constants. Default value: MODE_SQUAR The light mask assigned to all light occluders in the TileMap. The TileSet's light occluders will cast shadows only from Light2D(s) that have the same light mask(s). +---- + .. _class_TileMap_property_tile_set: - :ref:`TileSet` **tile_set** @@ -369,76 +409,102 @@ Method Descriptions Clears all cells. +---- + .. _class_TileMap_method_fix_invalid_tiles: - void **fix_invalid_tiles** **(** **)** Clears cells that do not exist in the tileset. +---- + .. _class_TileMap_method_get_cell: - :ref:`int` **get_cell** **(** :ref:`int` x, :ref:`int` y **)** const Returns the tile index of the given cell. If no tile exists in the cell, returns :ref:`INVALID_CELL`. +---- + .. _class_TileMap_method_get_cell_autotile_coord: - :ref:`Vector2` **get_cell_autotile_coord** **(** :ref:`int` x, :ref:`int` y **)** const +---- + .. _class_TileMap_method_get_cellv: - :ref:`int` **get_cellv** **(** :ref:`Vector2` position **)** const Returns the tile index of the cell given by a Vector2. If no tile exists in the cell, returns :ref:`INVALID_CELL`. +---- + .. _class_TileMap_method_get_collision_layer_bit: - :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const Returns ``true`` if the given collision layer bit is set. +---- + .. _class_TileMap_method_get_collision_mask_bit: - :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const Returns ``true`` if the given collision mask bit is set. +---- + .. _class_TileMap_method_get_used_cells: - :ref:`Array` **get_used_cells** **(** **)** const Returns a :ref:`Vector2` array with the positions of all cells containing a tile from the tileset (i.e. a tile index different from ``-1``). +---- + .. _class_TileMap_method_get_used_cells_by_id: - :ref:`Array` **get_used_cells_by_id** **(** :ref:`int` id **)** const Returns an array of all cells with the given tile id. +---- + .. _class_TileMap_method_get_used_rect: - :ref:`Rect2` **get_used_rect** **(** **)** Returns a rectangle enclosing the used (non-empty) tiles of the map. +---- + .. _class_TileMap_method_is_cell_transposed: - :ref:`bool` **is_cell_transposed** **(** :ref:`int` x, :ref:`int` y **)** const Returns ``true`` if the given cell is transposed, i.e. the x and y axes are swapped. +---- + .. _class_TileMap_method_is_cell_x_flipped: - :ref:`bool` **is_cell_x_flipped** **(** :ref:`int` x, :ref:`int` y **)** const Returns ``true`` if the given cell is flipped in the x axis. +---- + .. _class_TileMap_method_is_cell_y_flipped: - :ref:`bool` **is_cell_y_flipped** **(** :ref:`int` x, :ref:`int` y **)** const Returns ``true`` if the given cell is flipped in the y axis. +---- + .. _class_TileMap_method_map_to_world: - :ref:`Vector2` **map_to_world** **(** :ref:`Vector2` map_position, :ref:`bool` ignore_half_ofs=false **)** const @@ -447,6 +513,8 @@ Returns the global position corresponding to the given tilemap (grid-based) coor Optionally, the tilemap's half offset can be ignored. +---- + .. _class_TileMap_method_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, :ref:`Vector2` autotile_coord=Vector2( 0, 0 ) **)** @@ -461,6 +529,8 @@ Note that data such as navigation polygons and collision shapes are not immediat If you need these to be immediately updated, you can call :ref:`update_dirty_quadrants`. +---- + .. _class_TileMap_method_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 **)** @@ -475,24 +545,32 @@ Note that data such as navigation polygons and collision shapes are not immediat If you need these to be immediately updated, you can call :ref:`update_dirty_quadrants`. +---- + .. _class_TileMap_method_set_collision_layer_bit: - void **set_collision_layer_bit** **(** :ref:`int` bit, :ref:`bool` value **)** Sets the given collision layer bit. +---- + .. _class_TileMap_method_set_collision_mask_bit: - void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** Sets the given collision mask bit. +---- + .. _class_TileMap_method_update_bitmask_area: - void **update_bitmask_area** **(** :ref:`Vector2` position **)** Applies autotiling rules to the cell (and its adjacent cells) referenced by its grid-based x and y coordinates. +---- + .. _class_TileMap_method_update_bitmask_region: - void **update_bitmask_region** **(** :ref:`Vector2` start=Vector2( 0, 0 ), :ref:`Vector2` end=Vector2( 0, 0 ) **)** @@ -501,12 +579,16 @@ Applies autotiling rules to the cells in the given region (specified by grid-bas Calling with invalid (or missing) parameters applies autotiling rules for the entire tilemap. +---- + .. _class_TileMap_method_update_dirty_quadrants: - void **update_dirty_quadrants** **(** **)** Updates the tile map's quadrants, allowing things such as navigation and collision shapes to be immediately used if modified. +---- + .. _class_TileMap_method_world_to_map: - :ref:`Vector2` **world_to_map** **(** :ref:`Vector2` world_position **)** const diff --git a/classes/class_tileset.rst b/classes/class_tileset.rst index 10f82fe76..da1c55d0c 100644 --- a/classes/class_tileset.rst +++ b/classes/class_tileset.rst @@ -176,6 +176,8 @@ enum **BitmaskMode**: - **BITMASK_3X3** = **2** +---- + .. _enum_TileSet_AutotileBindings: .. _class_TileSet_constant_BIND_TOPLEFT: @@ -212,6 +214,8 @@ enum **AutotileBindings**: - **BIND_BOTTOMRIGHT** = **256** +---- + .. _enum_TileSet_TileMode: .. _class_TileSet_constant_SINGLE_TILE: @@ -242,16 +246,22 @@ Method Descriptions - :ref:`Vector2` **_forward_subtile_selection** **(** :ref:`int` autotile_id, :ref:`int` bitmask, :ref:`Object` tilemap, :ref:`Vector2` tile_location **)** virtual +---- + .. _class_TileSet_method__is_tile_bound: - :ref:`bool` **_is_tile_bound** **(** :ref:`int` drawn_id, :ref:`int` neighbor_id **)** virtual +---- + .. _class_TileSet_method_autotile_clear_bitmask_map: - void **autotile_clear_bitmask_map** **(** :ref:`int` id **)** Clears all bitmask info of the autotile. +---- + .. _class_TileSet_method_autotile_get_bitmask: - :ref:`int` **autotile_get_bitmask** **(** :ref:`int` id, :ref:`Vector2` coord **)** @@ -260,12 +270,16 @@ Returns the bitmask of the subtile from an autotile given its coordinates. The value is the sum of the values in :ref:`AutotileBindings` present in the subtile (e.g. a value of 5 means the bitmask has bindings in both the top left and top right). +---- + .. _class_TileSet_method_autotile_get_bitmask_mode: - :ref:`BitmaskMode` **autotile_get_bitmask_mode** **(** :ref:`int` id **)** const Returns the :ref:`BitmaskMode` of the autotile. +---- + .. _class_TileSet_method_autotile_get_icon_coordinate: - :ref:`Vector2` **autotile_get_icon_coordinate** **(** :ref:`int` id **)** const @@ -274,30 +288,40 @@ Returns the subtile that's being used as an icon in an atlas/autotile given its The subtile defined as the icon will be used as a fallback when the atlas/autotile's bitmask info is incomplete. It will also be used to represent it in the TileSet editor. +---- + .. _class_TileSet_method_autotile_get_light_occluder: - :ref:`OccluderPolygon2D` **autotile_get_light_occluder** **(** :ref:`int` id, :ref:`Vector2` coord **)** const Returns the light occluder of the subtile from an atlas/autotile given its coordinates. +---- + .. _class_TileSet_method_autotile_get_navigation_polygon: - :ref:`NavigationPolygon` **autotile_get_navigation_polygon** **(** :ref:`int` id, :ref:`Vector2` coord **)** const Returns the navigation polygon of the subtile from an atlas/autotile given its coordinates. +---- + .. _class_TileSet_method_autotile_get_size: - :ref:`Vector2` **autotile_get_size** **(** :ref:`int` id **)** const Returns the size of the subtiles in an atlas/autotile. +---- + .. _class_TileSet_method_autotile_get_spacing: - :ref:`int` **autotile_get_spacing** **(** :ref:`int` id **)** const Returns the spacing between subtiles of the atlas/autotile. +---- + .. _class_TileSet_method_autotile_get_subtile_priority: - :ref:`int` **autotile_get_subtile_priority** **(** :ref:`int` id, :ref:`Vector2` coord **)** @@ -306,12 +330,16 @@ Returns the priority of the subtile from an autotile given its coordinates. When more than one subtile has the same bitmask value, one of them will be picked randomly for drawing. Its priority will define how often it will be picked. +---- + .. _class_TileSet_method_autotile_get_z_index: - :ref:`int` **autotile_get_z_index** **(** :ref:`int` id, :ref:`Vector2` coord **)** Returns the drawing index of the subtile from an atlas/autotile given its coordinates. +---- + .. _class_TileSet_method_autotile_set_bitmask: - void **autotile_set_bitmask** **(** :ref:`int` id, :ref:`Vector2` bitmask, :ref:`int` flag **)** @@ -320,12 +348,16 @@ Sets the bitmask of the subtile from an autotile given its coordinates. The value is the sum of the values in :ref:`AutotileBindings` present in the subtile (e.g. a value of 5 means the bitmask has bindings in both the top left and top right). +---- + .. _class_TileSet_method_autotile_set_bitmask_mode: - void **autotile_set_bitmask_mode** **(** :ref:`int` id, :ref:`BitmaskMode` mode **)** Sets the :ref:`BitmaskMode` of the autotile. +---- + .. _class_TileSet_method_autotile_set_icon_coordinate: - void **autotile_set_icon_coordinate** **(** :ref:`int` id, :ref:`Vector2` coord **)** @@ -334,30 +366,40 @@ Sets the subtile that will be used as an icon in an atlas/autotile given its coo The subtile defined as the icon will be used as a fallback when the atlas/autotile's bitmask info is incomplete. It will also be used to represent it in the TileSet editor. +---- + .. _class_TileSet_method_autotile_set_light_occluder: - void **autotile_set_light_occluder** **(** :ref:`int` id, :ref:`OccluderPolygon2D` light_occluder, :ref:`Vector2` coord **)** Sets the light occluder of the subtile from an atlas/autotile given its coordinates. +---- + .. _class_TileSet_method_autotile_set_navigation_polygon: - void **autotile_set_navigation_polygon** **(** :ref:`int` id, :ref:`NavigationPolygon` navigation_polygon, :ref:`Vector2` coord **)** Sets the navigation polygon of the subtile from an atlas/autotile given its coordinates. +---- + .. _class_TileSet_method_autotile_set_size: - void **autotile_set_size** **(** :ref:`int` id, :ref:`Vector2` size **)** Sets the size of the subtiles in an atlas/autotile. +---- + .. _class_TileSet_method_autotile_set_spacing: - void **autotile_set_spacing** **(** :ref:`int` id, :ref:`int` spacing **)** Sets the spacing between subtiles of the atlas/autotile. +---- + .. _class_TileSet_method_autotile_set_subtile_priority: - void **autotile_set_subtile_priority** **(** :ref:`int` id, :ref:`Vector2` coord, :ref:`int` priority **)** @@ -366,278 +408,372 @@ Sets the priority of the subtile from an autotile given its coordinates. When more than one subtile has the same bitmask value, one of them will be picked randomly for drawing. Its priority will define how often it will be picked. +---- + .. _class_TileSet_method_autotile_set_z_index: - void **autotile_set_z_index** **(** :ref:`int` id, :ref:`Vector2` coord, :ref:`int` z_index **)** Sets the drawing index of the subtile from an atlas/autotile given its coordinates. +---- + .. _class_TileSet_method_clear: - void **clear** **(** **)** Clears all tiles. +---- + .. _class_TileSet_method_create_tile: - void **create_tile** **(** :ref:`int` id **)** Creates a new tile with the given ID. +---- + .. _class_TileSet_method_find_tile_by_name: - :ref:`int` **find_tile_by_name** **(** :ref:`String` name **)** const Returns the first tile matching the given name. +---- + .. _class_TileSet_method_get_last_unused_tile_id: - :ref:`int` **get_last_unused_tile_id** **(** **)** const Returns the ID following the last currently used ID, useful when creating a new tile. +---- + .. _class_TileSet_method_get_tiles_ids: - :ref:`Array` **get_tiles_ids** **(** **)** const Returns an array of all currently used tile IDs. +---- + .. _class_TileSet_method_remove_tile: - void **remove_tile** **(** :ref:`int` id **)** Removes the given tile ID. +---- + .. _class_TileSet_method_tile_add_shape: - void **tile_add_shape** **(** :ref:`int` id, :ref:`Shape2D` shape, :ref:`Transform2D` shape_transform, :ref:`bool` one_way=false, :ref:`Vector2` autotile_coord=Vector2( 0, 0 ) **)** Adds a shape to the tile. +---- + .. _class_TileSet_method_tile_get_light_occluder: - :ref:`OccluderPolygon2D` **tile_get_light_occluder** **(** :ref:`int` id **)** const Returns the tile's light occluder. +---- + .. _class_TileSet_method_tile_get_material: - :ref:`ShaderMaterial` **tile_get_material** **(** :ref:`int` id **)** const Returns the tile's material. +---- + .. _class_TileSet_method_tile_get_modulate: - :ref:`Color` **tile_get_modulate** **(** :ref:`int` id **)** const Returns the tile's modulation color. +---- + .. _class_TileSet_method_tile_get_name: - :ref:`String` **tile_get_name** **(** :ref:`int` id **)** const Returns the tile's name. +---- + .. _class_TileSet_method_tile_get_navigation_polygon: - :ref:`NavigationPolygon` **tile_get_navigation_polygon** **(** :ref:`int` id **)** const Returns the navigation polygon of the tile. +---- + .. _class_TileSet_method_tile_get_navigation_polygon_offset: - :ref:`Vector2` **tile_get_navigation_polygon_offset** **(** :ref:`int` id **)** const Returns the offset of the tile's navigation polygon. +---- + .. _class_TileSet_method_tile_get_normal_map: - :ref:`Texture` **tile_get_normal_map** **(** :ref:`int` id **)** const Returns the tile's normal map texture. +---- + .. _class_TileSet_method_tile_get_occluder_offset: - :ref:`Vector2` **tile_get_occluder_offset** **(** :ref:`int` id **)** const Returns the offset of the tile's light occluder. +---- + .. _class_TileSet_method_tile_get_region: - :ref:`Rect2` **tile_get_region** **(** :ref:`int` id **)** const Returns the tile sub-region in the texture. +---- + .. _class_TileSet_method_tile_get_shape: - :ref:`Shape2D` **tile_get_shape** **(** :ref:`int` id, :ref:`int` shape_id **)** const Returns a tile's given shape. +---- + .. _class_TileSet_method_tile_get_shape_count: - :ref:`int` **tile_get_shape_count** **(** :ref:`int` id **)** const Returns the number of shapes assigned to a tile. +---- + .. _class_TileSet_method_tile_get_shape_offset: - :ref:`Vector2` **tile_get_shape_offset** **(** :ref:`int` id, :ref:`int` shape_id **)** const Returns the offset of a tile's shape. +---- + .. _class_TileSet_method_tile_get_shape_one_way: - :ref:`bool` **tile_get_shape_one_way** **(** :ref:`int` id, :ref:`int` shape_id **)** const Returns the one-way collision value of a tile's shape. +---- + .. _class_TileSet_method_tile_get_shape_one_way_margin: - :ref:`float` **tile_get_shape_one_way_margin** **(** :ref:`int` id, :ref:`int` shape_id **)** const +---- + .. _class_TileSet_method_tile_get_shape_transform: - :ref:`Transform2D` **tile_get_shape_transform** **(** :ref:`int` id, :ref:`int` shape_id **)** const Returns the :ref:`Transform2D` of a tile's shape. +---- + .. _class_TileSet_method_tile_get_shapes: - :ref:`Array` **tile_get_shapes** **(** :ref:`int` id **)** const Returns an array of the tile's shapes. +---- + .. _class_TileSet_method_tile_get_texture: - :ref:`Texture` **tile_get_texture** **(** :ref:`int` id **)** const Returns the tile's texture. +---- + .. _class_TileSet_method_tile_get_texture_offset: - :ref:`Vector2` **tile_get_texture_offset** **(** :ref:`int` id **)** const Returns the texture offset of the tile. +---- + .. _class_TileSet_method_tile_get_tile_mode: - :ref:`TileMode` **tile_get_tile_mode** **(** :ref:`int` id **)** const Returns the tile's :ref:`TileMode`. +---- + .. _class_TileSet_method_tile_get_z_index: - :ref:`int` **tile_get_z_index** **(** :ref:`int` id **)** const Returns the tile's z-index (drawing layer). +---- + .. _class_TileSet_method_tile_set_light_occluder: - void **tile_set_light_occluder** **(** :ref:`int` id, :ref:`OccluderPolygon2D` light_occluder **)** Sets a light occluder for the tile. +---- + .. _class_TileSet_method_tile_set_material: - void **tile_set_material** **(** :ref:`int` id, :ref:`ShaderMaterial` material **)** Sets the tile's material. +---- + .. _class_TileSet_method_tile_set_modulate: - void **tile_set_modulate** **(** :ref:`int` id, :ref:`Color` color **)** Sets the tile's modulation color. +---- + .. _class_TileSet_method_tile_set_name: - void **tile_set_name** **(** :ref:`int` id, :ref:`String` name **)** Sets the tile's name. +---- + .. _class_TileSet_method_tile_set_navigation_polygon: - void **tile_set_navigation_polygon** **(** :ref:`int` id, :ref:`NavigationPolygon` navigation_polygon **)** Sets the tile's navigation polygon. +---- + .. _class_TileSet_method_tile_set_navigation_polygon_offset: - void **tile_set_navigation_polygon_offset** **(** :ref:`int` id, :ref:`Vector2` navigation_polygon_offset **)** Sets an offset for the tile's navigation polygon. +---- + .. _class_TileSet_method_tile_set_normal_map: - void **tile_set_normal_map** **(** :ref:`int` id, :ref:`Texture` normal_map **)** Sets the tile's normal map texture. +---- + .. _class_TileSet_method_tile_set_occluder_offset: - void **tile_set_occluder_offset** **(** :ref:`int` id, :ref:`Vector2` occluder_offset **)** Sets an offset for the tile's light occluder. +---- + .. _class_TileSet_method_tile_set_region: - void **tile_set_region** **(** :ref:`int` id, :ref:`Rect2` region **)** Sets the tile's sub-region in the texture. This is common in texture atlases. +---- + .. _class_TileSet_method_tile_set_shape: - void **tile_set_shape** **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Shape2D` shape **)** Sets a shape for the tile, enabling collision. +---- + .. _class_TileSet_method_tile_set_shape_offset: - void **tile_set_shape_offset** **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Vector2` shape_offset **)** Sets the offset of a tile's shape. +---- + .. _class_TileSet_method_tile_set_shape_one_way: - void **tile_set_shape_one_way** **(** :ref:`int` id, :ref:`int` shape_id, :ref:`bool` one_way **)** Enables one-way collision on a tile's shape. +---- + .. _class_TileSet_method_tile_set_shape_one_way_margin: - void **tile_set_shape_one_way_margin** **(** :ref:`int` id, :ref:`int` shape_id, :ref:`float` one_way **)** +---- + .. _class_TileSet_method_tile_set_shape_transform: - void **tile_set_shape_transform** **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Transform2D` shape_transform **)** Sets a :ref:`Transform2D` on a tile's shape. +---- + .. _class_TileSet_method_tile_set_shapes: - void **tile_set_shapes** **(** :ref:`int` id, :ref:`Array` shapes **)** Sets an array of shapes for the tile, enabling collision. +---- + .. _class_TileSet_method_tile_set_texture: - void **tile_set_texture** **(** :ref:`int` id, :ref:`Texture` texture **)** Sets the tile's texture. +---- + .. _class_TileSet_method_tile_set_texture_offset: - void **tile_set_texture_offset** **(** :ref:`int` id, :ref:`Vector2` texture_offset **)** Sets the tile's texture offset. +---- + .. _class_TileSet_method_tile_set_tile_mode: - void **tile_set_tile_mode** **(** :ref:`int` id, :ref:`TileMode` tilemode **)** Sets the tile's :ref:`TileMode`. +---- + .. _class_TileSet_method_tile_set_z_index: - void **tile_set_z_index** **(** :ref:`int` id, :ref:`int` z_index **)** diff --git a/classes/class_timer.rst b/classes/class_timer.rst index beeb291fd..9d6276afe 100644 --- a/classes/class_timer.rst +++ b/classes/class_timer.rst @@ -90,6 +90,8 @@ Property Descriptions If ``true``, the timer will automatically start when entering the scene tree. Default value: ``false``. +---- + .. _class_Timer_property_one_shot: - :ref:`bool` **one_shot** @@ -102,6 +104,8 @@ If ``true``, the timer will automatically start when entering the scene tree. De If ``true``, the timer will stop when reaching 0. If ``false``, it will restart. Default value: ``false``. +---- + .. _class_Timer_property_paused: - :ref:`bool` **paused** @@ -114,6 +118,8 @@ If ``true``, the timer will stop when reaching 0. If ``false``, it will restart. If ``true``, the timer is paused and will not process until it is unpaused again, even if :ref:`start` is called. +---- + .. _class_Timer_property_process_mode: - :ref:`TimerProcessMode` **process_mode** @@ -126,6 +132,8 @@ If ``true``, the timer is paused and will not process until it is unpaused again Processing mode. See :ref:`TimerProcessMode`. +---- + .. _class_Timer_property_time_left: - :ref:`float` **time_left** @@ -138,6 +146,8 @@ The timer's remaining time in seconds. Returns 0 if the timer is inactive. Note: You cannot set this value. To change the timer's remaining time, use :ref:`wait_time`. +---- + .. _class_Timer_property_wait_time: - :ref:`float` **wait_time** @@ -159,6 +169,8 @@ Method Descriptions Returns ``true`` if the timer is stopped. +---- + .. _class_Timer_method_start: - void **start** **(** :ref:`float` time_sec=-1 **)** @@ -167,6 +179,8 @@ Starts the timer. Sets ``wait_time`` to ``time_sec`` if ``time_sec > 0``. This a Note: this method will not resume a paused timer. See :ref:`paused`. +---- + .. _class_Timer_method_stop: - void **stop** **(** **)** diff --git a/classes/class_touchscreenbutton.rst b/classes/class_touchscreenbutton.rst index d21f07eec..760228d4f 100644 --- a/classes/class_touchscreenbutton.rst +++ b/classes/class_touchscreenbutton.rst @@ -57,6 +57,8 @@ Signals Emitted when the button is pressed (down). +---- + .. _class_TouchScreenButton_signal_released: - **released** **(** **)** @@ -98,6 +100,8 @@ Property Descriptions The button's action. Actions can be handled with :ref:`InputEventAction`. +---- + .. _class_TouchScreenButton_property_bitmask: - :ref:`BitMap` **bitmask** @@ -110,6 +114,8 @@ The button's action. Actions can be handled with :ref:`InputEventAction` **normal** @@ -122,6 +128,8 @@ The button's bitmask. The button's texture for the normal state. +---- + .. _class_TouchScreenButton_property_passby_press: - :ref:`bool` **passby_press** @@ -134,6 +142,8 @@ The button's texture for the normal state. If ``true``, passby presses are enabled. +---- + .. _class_TouchScreenButton_property_pressed: - :ref:`Texture` **pressed** @@ -146,6 +156,8 @@ If ``true``, passby presses are enabled. The button's texture for the pressed state. +---- + .. _class_TouchScreenButton_property_shape: - :ref:`Shape2D` **shape** @@ -158,6 +170,8 @@ The button's texture for the pressed state. The button's shape. +---- + .. _class_TouchScreenButton_property_shape_centered: - :ref:`bool` **shape_centered** @@ -170,6 +184,8 @@ The button's shape. If ``true``, the button's shape is centered. +---- + .. _class_TouchScreenButton_property_shape_visible: - :ref:`bool` **shape_visible** @@ -182,6 +198,8 @@ If ``true``, the button's shape is centered. If ``true``, the button's shape is visible. +---- + .. _class_TouchScreenButton_property_visibility_mode: - :ref:`VisibilityMode` **visibility_mode** diff --git a/classes/class_transform.rst b/classes/class_transform.rst index 0cf867bcb..7a6ed13dd 100644 --- a/classes/class_transform.rst +++ b/classes/class_transform.rst @@ -100,6 +100,8 @@ Property Descriptions The basis is a matrix containing 3 :ref:`Vector3` as its columns: X axis, Y axis, and Z axis. These vectors can be interpreted as the basis vectors of local coordinate system traveling with the object. +---- + .. _class_Transform_property_origin: - :ref:`Vector3` **origin** @@ -115,40 +117,56 @@ Method Descriptions Constructs the Transform from four :ref:`Vector3`. Each axis corresponds to local basis vectors (some of which may be scaled). +---- + - :ref:`Transform` **Transform** **(** :ref:`Basis` basis, :ref:`Vector3` origin **)** Constructs the Transform from a :ref:`Basis` and :ref:`Vector3`. +---- + - :ref:`Transform` **Transform** **(** :ref:`Transform2D` from **)** Constructs the Transform from a :ref:`Transform2D`. +---- + - :ref:`Transform` **Transform** **(** :ref:`Quat` from **)** Constructs the Transform from a :ref:`Quat`. The origin will be Vector3(0, 0, 0). +---- + - :ref:`Transform` **Transform** **(** :ref:`Basis` from **)** Constructs the Transform from a :ref:`Basis`. The origin will be Vector3(0, 0, 0). +---- + .. _class_Transform_method_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_method_interpolate_with: - :ref:`Transform` **interpolate_with** **(** :ref:`Transform` transform, :ref:`float` weight **)** Interpolates the transform to other Transform by weight amount (0-1). +---- + .. _class_Transform_method_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_method_looking_at: - :ref:`Transform` **looking_at** **(** :ref:`Vector3` target, :ref:`Vector3` up **)** @@ -159,36 +177,48 @@ The transform will first be rotated around the given ``up`` vector, and then ful Operations take place in global space. +---- + .. _class_Transform_method_orthonormalized: - :ref:`Transform` **orthonormalized** **(** **)** Returns the transform with the basis orthogonal (90 degrees), and normalized axis vectors. +---- + .. _class_Transform_method_rotated: - :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_method_scaled: - :ref:`Transform` **scaled** **(** :ref:`Vector3` scale **)** Scales the transform by the specified 3D scaling factors. +---- + .. _class_Transform_method_translated: - :ref:`Transform` **translated** **(** :ref:`Vector3` ofs **)** Translates the transform by the specified offset. +---- + .. _class_Transform_method_xform: - :ref:`Variant` **xform** **(** :ref:`Variant` v **)** Transforms the given :ref:`Vector3`, :ref:`Plane`, or :ref:`AABB` by this transform. +---- + .. _class_Transform_method_xform_inv: - :ref:`Variant` **xform_inv** **(** :ref:`Variant` v **)** diff --git a/classes/class_transform2d.rst b/classes/class_transform2d.rst index 18754db84..8f3952ad9 100644 --- a/classes/class_transform2d.rst +++ b/classes/class_transform2d.rst @@ -95,12 +95,16 @@ Property Descriptions The transform's translation offset. +---- + .. _class_Transform2D_property_x: - :ref:`Vector2` **x** The X axis of 2x2 basis matrix containing 2 :ref:`Vector2`\ s as its columns: X axis and Y axis. These vectors can be interpreted as the basis vectors of local coordinate system traveling with the object. +---- + .. _class_Transform2D_property_y: - :ref:`Vector2` **y** @@ -116,92 +120,124 @@ Method Descriptions Constructs the transform from a 3D :ref:`Transform`. +---- + - :ref:`Transform2D` **Transform2D** **(** :ref:`Vector2` x_axis, :ref:`Vector2` y_axis, :ref:`Vector2` origin **)** Constructs the transform from 3 :ref:`Vector2`\ s representing x, y, and origin. +---- + - :ref:`Transform2D` **Transform2D** **(** :ref:`float` rotation, :ref:`Vector2` position **)** Constructs the transform from a given angle (in radians) and position. +---- + .. _class_Transform2D_method_affine_inverse: - :ref:`Transform2D` **affine_inverse** **(** **)** Returns the inverse of the matrix. +---- + .. _class_Transform2D_method_basis_xform: - :ref:`Vector2` **basis_xform** **(** :ref:`Vector2` v **)** Transforms the given vector by this transform's basis (no translation). +---- + .. _class_Transform2D_method_basis_xform_inv: - :ref:`Vector2` **basis_xform_inv** **(** :ref:`Vector2` v **)** Inverse-transforms the given vector by this transform's basis (no translation). +---- + .. _class_Transform2D_method_get_origin: - :ref:`Vector2` **get_origin** **(** **)** Returns the transform's origin (translation). +---- + .. _class_Transform2D_method_get_rotation: - :ref:`float` **get_rotation** **(** **)** Returns the transform's rotation (in radians). +---- + .. _class_Transform2D_method_get_scale: - :ref:`Vector2` **get_scale** **(** **)** Returns the scale. +---- + .. _class_Transform2D_method_interpolate_with: - :ref:`Transform2D` **interpolate_with** **(** :ref:`Transform2D` transform, :ref:`float` weight **)** Returns a transform interpolated between this transform and another by a given weight (0-1). +---- + .. _class_Transform2D_method_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_method_orthonormalized: - :ref:`Transform2D` **orthonormalized** **(** **)** Returns the transform with the basis orthogonal (90 degrees), and normalized axis vectors. +---- + .. _class_Transform2D_method_rotated: - :ref:`Transform2D` **rotated** **(** :ref:`float` phi **)** Rotates the transform by the given angle (in radians). +---- + .. _class_Transform2D_method_scaled: - :ref:`Transform2D` **scaled** **(** :ref:`Vector2` scale **)** Scales the transform by the given factor. +---- + .. _class_Transform2D_method_translated: - :ref:`Transform2D` **translated** **(** :ref:`Vector2` offset **)** Translates the transform by the given offset. +---- + .. _class_Transform2D_method_xform: - :ref:`Variant` **xform** **(** :ref:`Variant` v **)** Transforms the given :ref:`Vector2` or :ref:`Rect2` by this transform. +---- + .. _class_Transform2D_method_xform_inv: - :ref:`Variant` **xform_inv** **(** :ref:`Variant` v **)** diff --git a/classes/class_translation.rst b/classes/class_translation.rst index ba107d362..f368620cc 100644 --- a/classes/class_translation.rst +++ b/classes/class_translation.rst @@ -78,24 +78,32 @@ Method Descriptions Adds a message if nonexistent, followed by its translation. +---- + .. _class_Translation_method_erase_message: - void **erase_message** **(** :ref:`String` src_message **)** Erases a message. +---- + .. _class_Translation_method_get_message: - :ref:`String` **get_message** **(** :ref:`String` src_message **)** const Returns a message's translation. +---- + .. _class_Translation_method_get_message_count: - :ref:`int` **get_message_count** **(** **)** const Returns the number of existing messages. +---- + .. _class_Translation_method_get_message_list: - :ref:`PoolStringArray` **get_message_list** **(** **)** const diff --git a/classes/class_translationserver.rst b/classes/class_translationserver.rst index 5f20f150f..8e1be0ee7 100644 --- a/classes/class_translationserver.rst +++ b/classes/class_translationserver.rst @@ -26,6 +26,8 @@ Methods +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_loaded_locales` **(** **)** const | ++-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_locale` **(** **)** const | +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_locale_name` **(** :ref:`String` locale **)** const | @@ -58,36 +60,54 @@ Method Descriptions Adds a :ref:`Translation` resource. +---- + .. _class_TranslationServer_method_clear: - void **clear** **(** **)** Clears the server from all translations. +---- + +.. _class_TranslationServer_method_get_loaded_locales: + +- :ref:`Array` **get_loaded_locales** **(** **)** const + +---- + .. _class_TranslationServer_method_get_locale: - :ref:`String` **get_locale** **(** **)** const Returns the current locale of the game. +---- + .. _class_TranslationServer_method_get_locale_name: - :ref:`String` **get_locale_name** **(** :ref:`String` locale **)** const Returns a locale's language and its variant (e.g. "en_US" would return "English (United States)"). +---- + .. _class_TranslationServer_method_remove_translation: - void **remove_translation** **(** :ref:`Translation` translation **)** Removes the given translation from the server. +---- + .. _class_TranslationServer_method_set_locale: - void **set_locale** **(** :ref:`String` locale **)** Sets the locale of the game. +---- + .. _class_TranslationServer_method_translate: - :ref:`String` **translate** **(** :ref:`String` message **)** const diff --git a/classes/class_tree.rst b/classes/class_tree.rst index d16095f9f..d1620bec6 100644 --- a/classes/class_tree.rst +++ b/classes/class_tree.rst @@ -180,82 +180,110 @@ Signals Emitted when a button on the tree was pressed (see :ref:`TreeItem.add_button`). +---- + .. _class_Tree_signal_cell_selected: - **cell_selected** **(** **)** Emitted when a cell is selected. +---- + .. _class_Tree_signal_column_title_pressed: - **column_title_pressed** **(** :ref:`int` column **)** Emitted when a column's title is pressed. +---- + .. _class_Tree_signal_custom_popup_edited: - **custom_popup_edited** **(** :ref:`bool` arrow_clicked **)** Emitted when a cell with the :ref:`TreeItem.CELL_MODE_CUSTOM` is clicked to be edited. +---- + .. _class_Tree_signal_empty_tree_rmb_selected: - **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_signal_item_activated: - **item_activated** **(** **)** Emitted when an item's label is double-clicked. +---- + .. _class_Tree_signal_item_collapsed: - **item_collapsed** **(** :ref:`TreeItem` item **)** Emitted when an item is collapsed by a click on the folding arrow. +---- + .. _class_Tree_signal_item_custom_button_pressed: - **item_custom_button_pressed** **(** **)** +---- + .. _class_Tree_signal_item_double_clicked: - **item_double_clicked** **(** **)** Emitted when an item's icon is double-clicked. +---- + .. _class_Tree_signal_item_edited: - **item_edited** **(** **)** Emitted when an item is edited. +---- + .. _class_Tree_signal_item_rmb_edited: - **item_rmb_edited** **(** **)** Emitted when an item is edited using the right mouse button. +---- + .. _class_Tree_signal_item_rmb_selected: - **item_rmb_selected** **(** :ref:`Vector2` position **)** Emitted when an item is selected with the right mouse button. +---- + .. _class_Tree_signal_item_selected: - **item_selected** **(** **)** Emitted when an item is selected. +---- + .. _class_Tree_signal_multi_selected: - **multi_selected** **(** :ref:`TreeItem` item, :ref:`int` column, :ref:`bool` selected **)** Emitted instead of ``item_selected`` when ``select_mode`` is :ref:`SELECT_MULTI`. +---- + .. _class_Tree_signal_nothing_selected: - **nothing_selected** **(** **)** @@ -279,6 +307,8 @@ enum **SelectMode**: - **SELECT_MULTI** = **2** --- Allow selection of multiple items at the same time. +---- + .. _enum_Tree_DropModeFlags: .. _class_Tree_constant_DROP_MODE_DISABLED: @@ -328,6 +358,8 @@ Property Descriptions If ``true``, the currently selected cell may be selected again. +---- + .. _class_Tree_property_allow_rmb_select: - :ref:`bool` **allow_rmb_select** @@ -340,6 +372,8 @@ If ``true``, the currently selected cell may be selected again. If ``true``, a right mouse button click can select items. +---- + .. _class_Tree_property_columns: - :ref:`int` **columns** @@ -352,6 +386,8 @@ If ``true``, a right mouse button click can select items. The amount of columns. +---- + .. _class_Tree_property_drop_mode_flags: - :ref:`int` **drop_mode_flags** @@ -364,6 +400,8 @@ The amount of columns. The drop mode as an OR combination of flags. See ``DROP_MODE_*`` constants. Once dropping is done, reverts to :ref:`DROP_MODE_DISABLED`. Setting this during :ref:`Control.can_drop_data` is recommended. +---- + .. _class_Tree_property_hide_folding: - :ref:`bool` **hide_folding** @@ -376,6 +414,8 @@ The drop mode as an OR combination of flags. See ``DROP_MODE_*`` constants. Once If ``true``, the folding arrow is hidden. +---- + .. _class_Tree_property_hide_root: - :ref:`bool` **hide_root** @@ -388,6 +428,8 @@ If ``true``, the folding arrow is hidden. If ``true``, the tree's root is hidden. +---- + .. _class_Tree_property_select_mode: - :ref:`SelectMode` **select_mode** @@ -409,48 +451,64 @@ Method Descriptions Returns ``true`` if the column titles are being shown. +---- + .. _class_Tree_method_clear: - void **clear** **(** **)** Clears the tree. This removes all items. +---- + .. _class_Tree_method_create_item: - :ref:`TreeItem` **create_item** **(** :ref:`Object` parent=null, :ref:`int` idx=-1 **)** 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_method_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_method_get_column_at_position: - :ref:`int` **get_column_at_position** **(** :ref:`Vector2` position **)** const Returns the column index under the given point. +---- + .. _class_Tree_method_get_column_title: - :ref:`String` **get_column_title** **(** :ref:`int` column **)** const Returns the column's title. +---- + .. _class_Tree_method_get_column_width: - :ref:`int` **get_column_width** **(** :ref:`int` column **)** const Returns the column's width in pixels. +---- + .. _class_Tree_method_get_custom_popup_rect: - :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_method_get_drop_section_at_position: - :ref:`int` **get_drop_section_at_position** **(** :ref:`Vector2` position **)** const @@ -459,84 +517,112 @@ If :ref:`drop_mode_flags` includes :ref:`DR Otherwise, returns 0. If there are no tree item at ``position``, returns -100. +---- + .. _class_Tree_method_get_edited: - :ref:`TreeItem` **get_edited** **(** **)** const Returns the currently edited item. This is only available for custom cell mode. +---- + .. _class_Tree_method_get_edited_column: - :ref:`int` **get_edited_column** **(** **)** const Returns the column for the currently edited item. This is only available for custom cell mode. +---- + .. _class_Tree_method_get_item_area_rect: - :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_method_get_item_at_position: - :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_method_get_next_selected: - :ref:`TreeItem` **get_next_selected** **(** :ref:`Object` from **)** Returns the next selected item after the given one. +---- + .. _class_Tree_method_get_pressed_button: - :ref:`int` **get_pressed_button** **(** **)** const Returns the last pressed button's index. +---- + .. _class_Tree_method_get_root: - :ref:`TreeItem` **get_root** **(** **)** Returns the tree's root item. +---- + .. _class_Tree_method_get_scroll: - :ref:`Vector2` **get_scroll** **(** **)** const Returns the current scrolling position. +---- + .. _class_Tree_method_get_selected: - :ref:`TreeItem` **get_selected** **(** **)** const Returns the currently selected item. +---- + .. _class_Tree_method_get_selected_column: - :ref:`int` **get_selected_column** **(** **)** const Returns the current selection's column. +---- + .. _class_Tree_method_set_column_expand: - void **set_column_expand** **(** :ref:`int` column, :ref:`bool` expand **)** If ``true``, the column will have the "Expand" flag of :ref:`Control`. Columns that have the "Expand" flag will use their "min_width" in a similar fashion to :ref:`Control.size_flags_stretch_ratio`. +---- + .. _class_Tree_method_set_column_min_width: - void **set_column_min_width** **(** :ref:`int` column, :ref:`int` min_width **)** Sets the minimum width of a column. Columns that have the "Expand" flag will use their "min_width" in a similar fashion to :ref:`Control.size_flags_stretch_ratio`. +---- + .. _class_Tree_method_set_column_title: - void **set_column_title** **(** :ref:`int` column, :ref:`String` title **)** Set the title of a column. +---- + .. _class_Tree_method_set_column_titles_visible: - void **set_column_titles_visible** **(** :ref:`bool` visible **)** diff --git a/classes/class_treeitem.rst b/classes/class_treeitem.rst index e83b170e8..1ac768ed6 100644 --- a/classes/class_treeitem.rst +++ b/classes/class_treeitem.rst @@ -169,6 +169,8 @@ enum **TreeCellMode**: - **CELL_MODE_CUSTOM** = **4** +---- + .. _enum_TreeItem_TextAlign: .. _class_TreeItem_constant_ALIGN_LEFT: @@ -205,6 +207,8 @@ Property Descriptions If ``true``, the TreeItem is collapsed. +---- + .. _class_TreeItem_property_custom_minimum_height: - :ref:`int` **custom_minimum_height** @@ -217,6 +221,8 @@ If ``true``, the TreeItem is collapsed. The custom minimum height. +---- + .. _class_TreeItem_property_disable_folding: - :ref:`bool` **disable_folding** @@ -238,236 +244,318 @@ Method Descriptions 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 :ref:`get_button_count` immediately after this method. Optionally, the button can be ``disabled`` and have a ``tooltip``. +---- + .. _class_TreeItem_method_clear_custom_bg_color: - void **clear_custom_bg_color** **(** :ref:`int` column **)** Resets the background color for the given column to default. +---- + .. _class_TreeItem_method_clear_custom_color: - void **clear_custom_color** **(** :ref:`int` column **)** Resets the color for the given column to default. +---- + .. _class_TreeItem_method_deselect: - void **deselect** **(** :ref:`int` column **)** Deselects the given column. +---- + .. _class_TreeItem_method_erase_button: - void **erase_button** **(** :ref:`int` column, :ref:`int` button_idx **)** Removes the button at index ``button_idx`` in column ``column``. +---- + .. _class_TreeItem_method_get_button: - :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_method_get_button_count: - :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_method_get_cell_mode: - :ref:`TreeCellMode` **get_cell_mode** **(** :ref:`int` column **)** const Returns the column's cell mode. See ``CELL_MODE_*`` constants. +---- + .. _class_TreeItem_method_get_children: - :ref:`TreeItem` **get_children** **(** **)** Returns the TreeItem's child items. +---- + .. _class_TreeItem_method_get_custom_bg_color: - :ref:`Color` **get_custom_bg_color** **(** :ref:`int` column **)** const Returns the custom background color of column ``column``. +---- + .. _class_TreeItem_method_get_expand_right: - :ref:`bool` **get_expand_right** **(** :ref:`int` column **)** const Returns ``true`` if ``expand_right`` is set. +---- + .. _class_TreeItem_method_get_icon: - :ref:`Texture` **get_icon** **(** :ref:`int` column **)** const Returns the given column's icon :ref:`Texture`. Error if no icon is set. +---- + .. _class_TreeItem_method_get_icon_max_width: - :ref:`int` **get_icon_max_width** **(** :ref:`int` column **)** const Returns the column's icon's maximum width. +---- + .. _class_TreeItem_method_get_icon_region: - :ref:`Rect2` **get_icon_region** **(** :ref:`int` column **)** const Returns the icon :ref:`Texture` region as :ref:`Rect2`. +---- + .. _class_TreeItem_method_get_metadata: - :ref:`Variant` **get_metadata** **(** :ref:`int` column **)** const +---- + .. _class_TreeItem_method_get_next: - :ref:`TreeItem` **get_next** **(** **)** Returns the next TreeItem in the tree. +---- + .. _class_TreeItem_method_get_next_visible: - :ref:`TreeItem` **get_next_visible** **(** **)** Returns the next visible TreeItem in the tree. +---- + .. _class_TreeItem_method_get_parent: - :ref:`TreeItem` **get_parent** **(** **)** Returns the parent TreeItem. +---- + .. _class_TreeItem_method_get_prev: - :ref:`TreeItem` **get_prev** **(** **)** Returns the previous TreeItem in the tree. +---- + .. _class_TreeItem_method_get_prev_visible: - :ref:`TreeItem` **get_prev_visible** **(** **)** Returns the previous visible TreeItem in the tree. +---- + .. _class_TreeItem_method_get_range: - :ref:`float` **get_range** **(** :ref:`int` column **)** const +---- + .. _class_TreeItem_method_get_range_config: - :ref:`Dictionary` **get_range_config** **(** :ref:`int` column **)** +---- + .. _class_TreeItem_method_get_text: - :ref:`String` **get_text** **(** :ref:`int` column **)** const Returns the given column's text. +---- + .. _class_TreeItem_method_get_text_align: - :ref:`TextAlign` **get_text_align** **(** :ref:`int` column **)** const Returns the given column's text alignment. +---- + .. _class_TreeItem_method_get_tooltip: - :ref:`String` **get_tooltip** **(** :ref:`int` column **)** const Returns the given column's tooltip. +---- + .. _class_TreeItem_method_is_button_disabled: - :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_method_is_checked: - :ref:`bool` **is_checked** **(** :ref:`int` column **)** const Returns ``true`` if the given column is checked. +---- + .. _class_TreeItem_method_is_custom_set_as_button: - :ref:`bool` **is_custom_set_as_button** **(** :ref:`int` column **)** const +---- + .. _class_TreeItem_method_is_editable: - :ref:`bool` **is_editable** **(** :ref:`int` column **)** Returns ``true`` if column ``column`` is editable. +---- + .. _class_TreeItem_method_is_selectable: - :ref:`bool` **is_selectable** **(** :ref:`int` column **)** const Returns ``true`` if column ``column`` is selectable. +---- + .. _class_TreeItem_method_is_selected: - :ref:`bool` **is_selected** **(** :ref:`int` column **)** Returns ``true`` if column ``column`` is selected. +---- + .. _class_TreeItem_method_move_to_bottom: - void **move_to_bottom** **(** **)** Moves this TreeItem to the bottom in the :ref:`Tree` hierarchy. +---- + .. _class_TreeItem_method_move_to_top: - void **move_to_top** **(** **)** Moves this TreeItem to the top in the :ref:`Tree` hierarchy. +---- + .. _class_TreeItem_method_remove_child: - void **remove_child** **(** :ref:`Object` child **)** Removes the given child TreeItem. +---- + .. _class_TreeItem_method_select: - void **select** **(** :ref:`int` column **)** Selects the column ``column``. +---- + .. _class_TreeItem_method_set_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_method_set_cell_mode: - void **set_cell_mode** **(** :ref:`int` column, :ref:`TreeCellMode` mode **)** Sets the given column's cell mode to ``mode``. See ``CELL_MODE_*`` constants. +---- + .. _class_TreeItem_method_set_checked: - void **set_checked** **(** :ref:`int` column, :ref:`bool` checked **)** If ``true``, the column ``column`` is checked. +---- + .. _class_TreeItem_method_set_custom_as_button: - void **set_custom_as_button** **(** :ref:`int` column, :ref:`bool` enable **)** +---- + .. _class_TreeItem_method_set_custom_bg_color: - 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_method_set_custom_color: - void **set_custom_color** **(** :ref:`int` column, :ref:`Color` color **)** Sets the given column's custom color. +---- + .. _class_TreeItem_method_set_custom_draw: - void **set_custom_draw** **(** :ref:`int` column, :ref:`Object` object, :ref:`String` callback **)** @@ -476,64 +564,88 @@ Sets the given column's custom draw callback to ``callback`` method on ``object` The ``callback`` should accept two arguments: the :ref:`TreeItem` that is drawn and its position and size as a :ref:`Rect2`. +---- + .. _class_TreeItem_method_set_editable: - void **set_editable** **(** :ref:`int` column, :ref:`bool` enabled **)** If ``true``, column ``column`` is editable. +---- + .. _class_TreeItem_method_set_expand_right: - void **set_expand_right** **(** :ref:`int` column, :ref:`bool` enable **)** If ``true``, column ``column`` is expanded to the right. +---- + .. _class_TreeItem_method_set_icon: - void **set_icon** **(** :ref:`int` column, :ref:`Texture` texture **)** Sets the given column's icon :ref:`Texture`. +---- + .. _class_TreeItem_method_set_icon_max_width: - void **set_icon_max_width** **(** :ref:`int` column, :ref:`int` width **)** Sets the given column's icon's maximum width. +---- + .. _class_TreeItem_method_set_icon_region: - void **set_icon_region** **(** :ref:`int` column, :ref:`Rect2` region **)** Sets the given column's icon's texture region. +---- + .. _class_TreeItem_method_set_metadata: - void **set_metadata** **(** :ref:`int` column, :ref:`Variant` meta **)** +---- + .. _class_TreeItem_method_set_range: - void **set_range** **(** :ref:`int` column, :ref:`float` value **)** +---- + .. _class_TreeItem_method_set_range_config: - void **set_range_config** **(** :ref:`int` column, :ref:`float` min, :ref:`float` max, :ref:`float` step, :ref:`bool` expr=false **)** +---- + .. _class_TreeItem_method_set_selectable: - void **set_selectable** **(** :ref:`int` column, :ref:`bool` selectable **)** If ``true``, the given column is selectable. +---- + .. _class_TreeItem_method_set_text: - void **set_text** **(** :ref:`int` column, :ref:`String` text **)** +---- + .. _class_TreeItem_method_set_text_align: - void **set_text_align** **(** :ref:`int` column, :ref:`TextAlign` text_align **)** Sets the given column's text alignment. See ``ALIGN_*`` constants. +---- + .. _class_TreeItem_method_set_tooltip: - void **set_tooltip** **(** :ref:`int` column, :ref:`String` tooltip **)** diff --git a/classes/class_tween.rst b/classes/class_tween.rst index 5ff39d7ff..dcff1c126 100644 --- a/classes/class_tween.rst +++ b/classes/class_tween.rst @@ -87,18 +87,24 @@ Signals Emitted when all processes in a tween end. +---- + .. _class_Tween_signal_tween_completed: - **tween_completed** **(** :ref:`Object` object, :ref:`NodePath` key **)** Emitted when a tween ends. +---- + .. _class_Tween_signal_tween_started: - **tween_started** **(** :ref:`Object` object, :ref:`NodePath` key **)** Emitted when a tween starts. +---- + .. _class_Tween_signal_tween_step: - **tween_step** **(** :ref:`Object` object, :ref:`NodePath` key, :ref:`float` elapsed, :ref:`Object` value **)** @@ -120,6 +126,8 @@ enum **TweenProcessMode**: - **TWEEN_PROCESS_IDLE** = **1** --- The tween updates with the ``_process`` callback. +---- + .. _enum_Tween_TransitionType: .. _class_Tween_constant_TRANS_LINEAR: @@ -168,6 +176,8 @@ enum **TransitionType**: - **TRANS_BACK** = **10** --- The animation is interpolated backing out at ends. +---- + .. _enum_Tween_EaseType: .. _class_Tween_constant_EASE_IN: @@ -222,6 +232,8 @@ Property Descriptions The tween's animation process thread. See :ref:`TweenProcessMode`. Default value: :ref:`TWEEN_PROCESS_IDLE`. +---- + .. _class_Tween_property_playback_speed: - :ref:`float` **playback_speed** @@ -234,6 +246,8 @@ The tween's animation process thread. See :ref:`TweenProcessMode` or :ref:`stop_all` for this. +---- + .. _class_Tween_property_repeat: - :ref:`bool` **repeat** @@ -257,6 +271,8 @@ Follows ``method`` of ``object`` and applies the returned value on ``target_meth Use :ref:`TransitionType` for ``trans_type`` and :ref:`EaseType` for ``ease_type`` parameters. These values control the timing and direction of the interpolation. See the class description for more information +---- + .. _class_Tween_method_follow_property: - :ref:`bool` **follow_property** **(** :ref:`Object` object, :ref:`NodePath` property, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`NodePath` target_property, :ref:`float` duration, :ref:`TransitionType` trans_type, :ref:`EaseType` ease_type, :ref:`float` delay=0 **)** @@ -265,24 +281,32 @@ Follows ``property`` of ``object`` and applies it on ``target_property`` of ``ta Use :ref:`TransitionType` for ``trans_type`` and :ref:`EaseType` for ``ease_type`` parameters. These values control the timing and direction of the interpolation. See the class description for more information +---- + .. _class_Tween_method_get_runtime: - :ref:`float` **get_runtime** **(** **)** const Returns the total time needed for all tweens to end. If you have two tweens, one lasting 10 seconds and the other 20 seconds, it would return 20 seconds, as by that time all tweens would have finished. +---- + .. _class_Tween_method_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 **)** Calls ``callback`` of ``object`` after ``duration``. ``arg1``-``arg5`` are arguments to be passed to the callback. +---- + .. _class_Tween_method_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 **)** Calls ``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_method_interpolate_method: - :ref:`bool` **interpolate_method** **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`TransitionType` trans_type, :ref:`EaseType` ease_type, :ref:`float` delay=0 **)** @@ -291,6 +315,8 @@ Animates ``method`` of ``object`` from ``initial_val`` to ``final_val`` for ``du Use :ref:`TransitionType` for ``trans_type`` and :ref:`EaseType` for ``ease_type`` parameters. These values control the timing and direction of the interpolation. See the class description for more information +---- + .. _class_Tween_method_interpolate_property: - :ref:`bool` **interpolate_property** **(** :ref:`Object` object, :ref:`NodePath` property, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`TransitionType` trans_type, :ref:`EaseType` ease_type, :ref:`float` delay=0 **)** @@ -299,78 +325,104 @@ Animates ``property`` of ``object`` from ``initial_val`` to ``final_val`` for `` Use :ref:`TransitionType` for ``trans_type`` and :ref:`EaseType` for ``ease_type`` parameters. These values control the timing and direction of the interpolation. See the class description for more information +---- + .. _class_Tween_method_is_active: - :ref:`bool` **is_active** **(** **)** const Returns ``true`` if any tweens are currently running. Note that this method doesn't consider tweens that have ended. +---- + .. _class_Tween_method_remove: - :ref:`bool` **remove** **(** :ref:`Object` object, :ref:`String` key="" **)** Stops animation and removes a tween, given its object and property/method pair. By default, all tweens are removed, unless ``key`` is specified. +---- + .. _class_Tween_method_remove_all: - :ref:`bool` **remove_all** **(** **)** Stops animation and removes all tweens. +---- + .. _class_Tween_method_reset: - :ref:`bool` **reset** **(** :ref:`Object` object, :ref:`String` key="" **)** Resets a tween to its initial value (the one given, not the one before the tween), given its object and property/method pair. By default, all tweens are removed, unless ``key`` is specified. +---- + .. _class_Tween_method_reset_all: - :ref:`bool` **reset_all** **(** **)** Resets all tweens to their initial values (the ones given, not those before the tween). +---- + .. _class_Tween_method_resume: - :ref:`bool` **resume** **(** :ref:`Object` object, :ref:`String` key="" **)** Continues animating a stopped tween, given its object and property/method pair. By default, all tweens are resumed, unless ``key`` is specified. +---- + .. _class_Tween_method_resume_all: - :ref:`bool` **resume_all** **(** **)** Continues animating all stopped tweens. +---- + .. _class_Tween_method_seek: - :ref:`bool` **seek** **(** :ref:`float` time **)** Sets the interpolation to the given ``time`` in seconds. +---- + .. _class_Tween_method_set_active: - void **set_active** **(** :ref:`bool` active **)** Activates/deactivates the tween. See also :ref:`stop_all` and :ref:`resume_all`. +---- + .. _class_Tween_method_start: - :ref:`bool` **start** **(** **)** Starts the tween. You can define animations both before and after this. +---- + .. _class_Tween_method_stop: - :ref:`bool` **stop** **(** :ref:`Object` object, :ref:`String` key="" **)** Stops a tween, given its object and property/method pair. By default, all tweens are stopped, unless ``key`` is specified. +---- + .. _class_Tween_method_stop_all: - :ref:`bool` **stop_all** **(** **)** Stops animating all tweens. +---- + .. _class_Tween_method_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:`TransitionType` trans_type, :ref:`EaseType` ease_type, :ref:`float` delay=0 **)** @@ -379,6 +431,8 @@ Animates ``method`` of ``object`` from the value returned by ``initial_method`` Use :ref:`TransitionType` for ``trans_type`` and :ref:`EaseType` for ``ease_type`` parameters. These values control the timing and direction of the interpolation. See the class description for more information +---- + .. _class_Tween_method_targeting_property: - :ref:`bool` **targeting_property** **(** :ref:`Object` object, :ref:`NodePath` property, :ref:`Object` initial, :ref:`NodePath` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`TransitionType` trans_type, :ref:`EaseType` ease_type, :ref:`float` delay=0 **)** @@ -387,6 +441,8 @@ Animates ``property`` of ``object`` from the current value of the ``initial_val` Use :ref:`TransitionType` for ``trans_type`` and :ref:`EaseType` for ``ease_type`` parameters. These values control the timing and direction of the interpolation. See the class description for more information +---- + .. _class_Tween_method_tell: - :ref:`float` **tell** **(** **)** const diff --git a/classes/class_undoredo.rst b/classes/class_undoredo.rst index 94c946b74..9046ea48e 100644 --- a/classes/class_undoredo.rst +++ b/classes/class_undoredo.rst @@ -111,36 +111,48 @@ Method Descriptions Register a method that will be called when the action is committed. +---- + .. _class_UndoRedo_method_add_do_property: - void **add_do_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** Register a property value change for 'do'. +---- + .. _class_UndoRedo_method_add_do_reference: - void **add_do_reference** **(** :ref:`Object` object **)** Register a reference for 'do' 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_method_add_undo_method: - :ref:`Variant` **add_undo_method** **(** :ref:`Object` object, :ref:`String` method, ... **)** vararg Register a method that will be called when the action is undone. +---- + .. _class_UndoRedo_method_add_undo_property: - void **add_undo_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** Register a property value change for 'undo'. +---- + .. _class_UndoRedo_method_add_undo_reference: - void **add_undo_reference** **(** :ref:`Object` object **)** Register a reference for 'undo' 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_method_clear_history: - void **clear_history** **(** :ref:`bool` increase_version=true **)** @@ -149,12 +161,16 @@ Clear the undo/redo history and associated references. Passing ``false`` to ``increase_version`` will prevent the version number to be increased from this. +---- + .. _class_UndoRedo_method_commit_action: - void **commit_action** **(** **)** Commit the action. All 'do' methods/properties are called/set when this function is called. +---- + .. _class_UndoRedo_method_create_action: - void **create_action** **(** :ref:`String` name, :ref:`MergeMode` merge_mode=0 **)** @@ -163,12 +179,16 @@ Create a new action. After this is called, do all your calls to :ref:`add_do_met The way actions are merged is dictated by the ``merge_mode`` argument. See :ref:`MergeMode` for details. +---- + .. _class_UndoRedo_method_get_current_action_name: - :ref:`String` **get_current_action_name** **(** **)** const Get the name of the current action. +---- + .. _class_UndoRedo_method_get_version: - :ref:`int` **get_version** **(** **)** const @@ -177,18 +197,24 @@ Get the version, each time a new action is committed, the version number of the This is useful mostly to check if something changed from a saved version. +---- + .. _class_UndoRedo_method_is_commiting_action: - :ref:`bool` **is_commiting_action** **(** **)** const Returns ``true`` if the :ref:`UndoRedo` is currently committing the action, i.e. running its 'do' method or property change (see :ref:`commit_action`). +---- + .. _class_UndoRedo_method_redo: - :ref:`bool` **redo** **(** **)** Redo the last action. +---- + .. _class_UndoRedo_method_undo: - :ref:`bool` **undo** **(** **)** diff --git a/classes/class_upnp.rst b/classes/class_upnp.rst index 637252127..f1e769987 100644 --- a/classes/class_upnp.rst +++ b/classes/class_upnp.rst @@ -214,6 +214,8 @@ Property Descriptions If ``true``, IPv6 is used for :ref:`UPNPDevice` discovery. +---- + .. _class_UPNP_property_discover_local_port: - :ref:`int` **discover_local_port** @@ -226,6 +228,8 @@ If ``true``, IPv6 is used for :ref:`UPNPDevice` discovery. If ``0``, the local port to use for discovery is chosen automatically by the system. If ``1``, discovery will be done from the source port 1900 (same as destination port). Otherwise, the value will be used as the port. +---- + .. _class_UPNP_property_discover_multicast_if: - :ref:`String` **discover_multicast_if** @@ -247,6 +251,8 @@ Method Descriptions Adds the given :ref:`UPNPDevice` to the list of discovered devices. +---- + .. _class_UPNP_method_add_port_mapping: - :ref:`int` **add_port_mapping** **(** :ref:`int` port, :ref:`int` port_internal=0, :ref:`String` desc="", :ref:`String` proto="UDP", :ref:`int` duration=0 **)** const @@ -259,18 +265,24 @@ The description (``desc``) is shown in some router UIs and can be used to point See :ref:`UPNPResult` for possible return values. +---- + .. _class_UPNP_method_clear_devices: - void **clear_devices** **(** **)** Clears the list of discovered devices. +---- + .. _class_UPNP_method_delete_port_mapping: - :ref:`int` **delete_port_mapping** **(** :ref:`int` port, :ref:`String` proto="UDP" **)** const Deletes the port mapping for the given port and protocol combination on the default gateway (see :ref:`get_gateway`) if one exists. ``port`` must be a valid port between 1 and 65535, ``proto`` can be either ``TCP`` or ``UDP``. See :ref:`UPNPResult` for possible return values. +---- + .. _class_UPNP_method_discover: - :ref:`int` **discover** **(** :ref:`int` timeout=2000, :ref:`int` ttl=2, :ref:`String` device_filter="InternetGatewayDevice" **)** @@ -281,36 +293,48 @@ Filters for IGD (InternetGatewayDevice) type devices by default, as those manage See :ref:`UPNPResult` for possible return values. +---- + .. _class_UPNP_method_get_device: - :ref:`UPNPDevice` **get_device** **(** :ref:`int` index **)** const Returns the :ref:`UPNPDevice` at the given ``index``. +---- + .. _class_UPNP_method_get_device_count: - :ref:`int` **get_device_count** **(** **)** const Returns the number of discovered :ref:`UPNPDevice`\ s. +---- + .. _class_UPNP_method_get_gateway: - :ref:`UPNPDevice` **get_gateway** **(** **)** const Returns the default gateway. That is the first discovered :ref:`UPNPDevice` that is also a valid IGD (InternetGatewayDevice). +---- + .. _class_UPNP_method_query_external_address: - :ref:`String` **query_external_address** **(** **)** const Returns the external :ref:`IP` address of the default gateway (see :ref:`get_gateway`) as string. Returns an empty string on error. +---- + .. _class_UPNP_method_remove_device: - void **remove_device** **(** :ref:`int` index **)** Removes the device at ``index`` from the list of discovered devices. +---- + .. _class_UPNP_method_set_device: - void **set_device** **(** :ref:`int` index, :ref:`UPNPDevice` device **)** diff --git a/classes/class_upnpdevice.rst b/classes/class_upnpdevice.rst index c11456a33..74c1fb379 100644 --- a/classes/class_upnpdevice.rst +++ b/classes/class_upnpdevice.rst @@ -115,6 +115,8 @@ Property Descriptions URL to the device description. +---- + .. _class_UPNPDevice_property_igd_control_url: - :ref:`String` **igd_control_url** @@ -127,6 +129,8 @@ URL to the device description. IDG control URL. +---- + .. _class_UPNPDevice_property_igd_our_addr: - :ref:`String` **igd_our_addr** @@ -139,6 +143,8 @@ IDG control URL. Address of the local machine in the network connecting it to this :ref:`UPNPDevice`. +---- + .. _class_UPNPDevice_property_igd_service_type: - :ref:`String` **igd_service_type** @@ -151,6 +157,8 @@ Address of the local machine in the network connecting it to this :ref:`UPNPDevi IGD service type. +---- + .. _class_UPNPDevice_property_igd_status: - :ref:`IGDStatus` **igd_status** @@ -163,6 +171,8 @@ IGD service type. IGD status. See :ref:`IGDStatus`. +---- + .. _class_UPNPDevice_property_service_type: - :ref:`String` **service_type** @@ -184,18 +194,24 @@ Method Descriptions Adds a port mapping to forward the given external port on this :ref:`UPNPDevice` for the given protocol to the local machine. See :ref:`UPNP.add_port_mapping`. +---- + .. _class_UPNPDevice_method_delete_port_mapping: - :ref:`int` **delete_port_mapping** **(** :ref:`int` port, :ref:`String` proto="UDP" **)** const Deletes the port mapping identified by the given port and protocol combination on this device. See :ref:`UPNP.delete_port_mapping`. +---- + .. _class_UPNPDevice_method_is_valid_gateway: - :ref:`bool` **is_valid_gateway** **(** **)** const Returns ``true`` if this is a valid IGD (InternetGatewayDevice) which potentially supports port forwarding. +---- + .. _class_UPNPDevice_method_query_external_address: - :ref:`String` **query_external_address** **(** **)** const diff --git a/classes/class_vector2.rst b/classes/class_vector2.rst index 72d613020..61b72c982 100644 --- a/classes/class_vector2.rst +++ b/classes/class_vector2.rst @@ -122,7 +122,7 @@ Constants Description ----------- -2-element structure that can be used to represent positions in 2d space or any other pair of numeric values. +2-element structure that can be used to represent positions in 2D space or any other pair of numeric values. Tutorials --------- @@ -138,6 +138,8 @@ Property Descriptions The vector's x component. Also accessible by using the index position ``[0]``. +---- + .. _class_Vector2_property_y: - :ref:`float` **y** @@ -153,12 +155,16 @@ Method Descriptions Constructs a new Vector2 from the given x and y. +---- + .. _class_Vector2_method_abs: - :ref:`Vector2` **abs** **(** **)** Returns a new vector with all components in absolute values (i.e. positive). +---- + .. _class_Vector2_method_angle: - :ref:`float` **angle** **(** **)** @@ -167,138 +173,184 @@ Returns the vector's angle in radians with respect to the x-axis, or ``(1, 0)`` Equivalent to the result of atan2 when called with the vector's x and y as parameters: ``atan2(x, y)``. +---- + .. _class_Vector2_method_angle_to: - :ref:`float` **angle_to** **(** :ref:`Vector2` to **)** Returns the angle in radians between the two vectors. +---- + .. _class_Vector2_method_angle_to_point: - :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_method_aspect: - :ref:`float` **aspect** **(** **)** Returns the ratio of x to y. +---- + .. _class_Vector2_method_bounce: - :ref:`Vector2` **bounce** **(** :ref:`Vector2` n **)** Returns the vector "bounced off" from a plane defined by the given normal. +---- + .. _class_Vector2_method_ceil: - :ref:`Vector2` **ceil** **(** **)** Returns the vector with all components rounded up. +---- + .. _class_Vector2_method_clamped: - :ref:`Vector2` **clamped** **(** :ref:`float` length **)** Returns the vector with a maximum length. +---- + .. _class_Vector2_method_cross: - :ref:`float` **cross** **(** :ref:`Vector2` with **)** Returns the 2 dimensional analog of the cross product with the given vector. +---- + .. _class_Vector2_method_cubic_interpolate: - :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 returns the result at position ``t``. ``t`` is in the range of ``0.0 - 1.0``, representing the amount of interpolation. +---- + .. _class_Vector2_method_direction_to: - :ref:`Vector2` **direction_to** **(** :ref:`Vector2` b **)** Returns the normalized vector pointing from this vector to ``b``. +---- + .. _class_Vector2_method_distance_squared_to: - :ref:`float` **distance_squared_to** **(** :ref:`Vector2` to **)** Returns the squared distance to vector ``b``. Prefer this function over :ref:`distance_to` if you need to sort vectors or need the squared distance for some formula. +---- + .. _class_Vector2_method_distance_to: - :ref:`float` **distance_to** **(** :ref:`Vector2` to **)** Returns the distance to vector ``b``. +---- + .. _class_Vector2_method_dot: - :ref:`float` **dot** **(** :ref:`Vector2` with **)** Returns the dot product with vector ``b``. +---- + .. _class_Vector2_method_floor: - :ref:`Vector2` **floor** **(** **)** Returns the vector with all components rounded down. +---- + .. _class_Vector2_method_is_normalized: - :ref:`bool` **is_normalized** **(** **)** Returns ``true`` if the vector is normalized. +---- + .. _class_Vector2_method_length: - :ref:`float` **length** **(** **)** Returns the vector's length. +---- + .. _class_Vector2_method_length_squared: - :ref:`float` **length_squared** **(** **)** Returns the vector's length squared. Prefer this method over :ref:`length` if you need to sort vectors or need the squared length for some formula. +---- + .. _class_Vector2_method_linear_interpolate: - :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``. ``t`` is in the range of ``0.0 - 1.0``, representing the amount of interpolation. +---- + .. _class_Vector2_method_normalized: - :ref:`Vector2` **normalized** **(** **)** Returns the vector scaled to unit length. Equivalent to ``v / v.length()``. +---- + .. _class_Vector2_method_project: - :ref:`Vector2` **project** **(** :ref:`Vector2` b **)** Returns the vector projected onto the vector ``b``. +---- + .. _class_Vector2_method_reflect: - :ref:`Vector2` **reflect** **(** :ref:`Vector2` n **)** Returns the vector reflected from a plane defined by the given normal. +---- + .. _class_Vector2_method_rotated: - :ref:`Vector2` **rotated** **(** :ref:`float` phi **)** Returns the vector rotated by ``phi`` radians. See also :ref:`@GDScript.deg2rad`. +---- + .. _class_Vector2_method_round: - :ref:`Vector2` **round** **(** **)** Returns the vector with all components rounded to the nearest integer, with halfway cases rounded away from zero. +---- + .. _class_Vector2_method_slerp: - :ref:`Vector2` **slerp** **(** :ref:`Vector2` b, :ref:`float` t **)** @@ -307,18 +359,24 @@ Returns the result of SLERP between this vector and ``b``, by amount ``t``. ``t` Both vectors need to be normalized. +---- + .. _class_Vector2_method_slide: - :ref:`Vector2` **slide** **(** :ref:`Vector2` n **)** Returns the component of the vector along a plane defined by the given normal. +---- + .. _class_Vector2_method_snapped: - :ref:`Vector2` **snapped** **(** :ref:`Vector2` by **)** Returns the vector snapped to a grid with the given size. +---- + .. _class_Vector2_method_tangent: - :ref:`Vector2` **tangent** **(** **)** diff --git a/classes/class_vector3.rst b/classes/class_vector3.rst index e9093b53a..677143c7b 100644 --- a/classes/class_vector3.rst +++ b/classes/class_vector3.rst @@ -160,12 +160,16 @@ Property Descriptions The vector's x component. Also accessible by using the index position ``[0]``. +---- + .. _class_Vector3_property_y: - :ref:`float` **y** The vector's y component. Also accessible by using the index position ``[1]``. +---- + .. _class_Vector3_property_z: - :ref:`float` **z** @@ -181,150 +185,200 @@ Method Descriptions Returns a Vector3 with the given components. +---- + .. _class_Vector3_method_abs: - :ref:`Vector3` **abs** **(** **)** Returns a new vector with all components in absolute values (i.e. positive). +---- + .. _class_Vector3_method_angle_to: - :ref:`float` **angle_to** **(** :ref:`Vector3` to **)** Returns the minimum angle to the given vector. +---- + .. _class_Vector3_method_bounce: - :ref:`Vector3` **bounce** **(** :ref:`Vector3` n **)** Returns the vector "bounced off" from a plane defined by the given normal. +---- + .. _class_Vector3_method_ceil: - :ref:`Vector3` **ceil** **(** **)** Returns a new vector with all components rounded up. +---- + .. _class_Vector3_method_cross: - :ref:`Vector3` **cross** **(** :ref:`Vector3` b **)** Returns the cross product with ``b``. +---- + .. _class_Vector3_method_cubic_interpolate: - :ref:`Vector3` **cubic_interpolate** **(** :ref:`Vector3` b, :ref:`Vector3` pre_a, :ref:`Vector3` post_b, :ref:`float` t **)** Performs a cubic interpolation between vectors ``pre_a``, ``a``, ``b``, ``post_b`` (``a`` is current), by the given amount ``t``. ``t`` is in the range of ``0.0 - 1.0``, representing the amount of interpolation. +---- + .. _class_Vector3_method_direction_to: - :ref:`Vector3` **direction_to** **(** :ref:`Vector3` b **)** Returns the normalized vector pointing from this vector to ``b``. +---- + .. _class_Vector3_method_distance_squared_to: - :ref:`float` **distance_squared_to** **(** :ref:`Vector3` b **)** Returns the squared distance to ``b``. Prefer this function over :ref:`distance_to` if you need to sort vectors or need the squared distance for some formula. +---- + .. _class_Vector3_method_distance_to: - :ref:`float` **distance_to** **(** :ref:`Vector3` b **)** Returns the distance to ``b``. +---- + .. _class_Vector3_method_dot: - :ref:`float` **dot** **(** :ref:`Vector3` b **)** Returns the dot product with ``b``. +---- + .. _class_Vector3_method_floor: - :ref:`Vector3` **floor** **(** **)** Returns a new vector with all components rounded down. +---- + .. _class_Vector3_method_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_method_is_normalized: - :ref:`bool` **is_normalized** **(** **)** Returns ``true`` if the vector is normalized. +---- + .. _class_Vector3_method_length: - :ref:`float` **length** **(** **)** Returns the vector's length. +---- + .. _class_Vector3_method_length_squared: - :ref:`float` **length_squared** **(** **)** Returns the vector's length squared. Prefer this function over :ref:`length` if you need to sort vectors or need the squared length for some formula. +---- + .. _class_Vector3_method_linear_interpolate: - :ref:`Vector3` **linear_interpolate** **(** :ref:`Vector3` b, :ref:`float` t **)** Returns the result of the linear interpolation between this vector and ``b`` by amount ``t``. ``t`` is in the range of ``0.0 - 1.0``, representing the amount of interpolation.. +---- + .. _class_Vector3_method_max_axis: - :ref:`int` **max_axis** **(** **)** Returns the axis of the vector's largest value. See ``AXIS_*`` constants. +---- + .. _class_Vector3_method_min_axis: - :ref:`int` **min_axis** **(** **)** Returns the axis of the vector's smallest value. See ``AXIS_*`` constants. +---- + .. _class_Vector3_method_normalized: - :ref:`Vector3` **normalized** **(** **)** Returns the vector scaled to unit length. Equivalent to ``v / v.length()``. +---- + .. _class_Vector3_method_outer: - :ref:`Basis` **outer** **(** :ref:`Vector3` b **)** Returns the outer product with ``b``. +---- + .. _class_Vector3_method_project: - :ref:`Vector3` **project** **(** :ref:`Vector3` b **)** Returns the vector projected onto the vector ``b``. +---- + .. _class_Vector3_method_reflect: - :ref:`Vector3` **reflect** **(** :ref:`Vector3` n **)** Returns the vector reflected from a plane defined by the given normal. +---- + .. _class_Vector3_method_rotated: - :ref:`Vector3` **rotated** **(** :ref:`Vector3` axis, :ref:`float` phi **)** Rotates the vector around a given axis by ``phi`` radians. The axis must be a normalized vector. +---- + .. _class_Vector3_method_round: - :ref:`Vector3` **round** **(** **)** Returns the vector with all components rounded to the nearest integer, with halfway cases rounded away from zero. +---- + .. _class_Vector3_method_slerp: - :ref:`Vector3` **slerp** **(** :ref:`Vector3` b, :ref:`float` t **)** @@ -333,18 +387,24 @@ Returns the result of SLERP between this vector and ``b``, by amount ``t``. ``t` Both vectors need to be normalized. +---- + .. _class_Vector3_method_slide: - :ref:`Vector3` **slide** **(** :ref:`Vector3` n **)** Returns the component of the vector along a plane defined by the given normal. +---- + .. _class_Vector3_method_snapped: - :ref:`Vector3` **snapped** **(** :ref:`Vector3` by **)** Returns a copy of the vector, snapped to the lowest neared multiple. +---- + .. _class_Vector3_method_to_diagonal_matrix: - :ref:`Basis` **to_diagonal_matrix** **(** **)** diff --git a/classes/class_vehiclebody.rst b/classes/class_vehiclebody.rst index fe2af3c59..1d597b869 100644 --- a/classes/class_vehiclebody.rst +++ b/classes/class_vehiclebody.rst @@ -51,6 +51,8 @@ Property Descriptions Slows down the vehicle by applying a braking force. The vehicle is only slowed down if the wheels are in contact with a surface. The force you need to apply to adequately slow down your vehicle depends on the :ref:`RigidBody.mass` of the vehicle. For a vehicle with a mass set to 1000, try a value in the 25 - 30 range for hard braking. +---- + .. _class_VehicleBody_property_engine_force: - :ref:`float` **engine_force** @@ -65,6 +67,8 @@ Accelerates the vehicle by applying an engine force. The vehicle is only speed u A negative value will result in the vehicle reversing. +---- + .. _class_VehicleBody_property_steering: - :ref:`float` **steering** diff --git a/classes/class_vehiclewheel.rst b/classes/class_vehiclewheel.rst index f1bb48186..155f86a91 100644 --- a/classes/class_vehiclewheel.rst +++ b/classes/class_vehiclewheel.rst @@ -74,6 +74,8 @@ Property Descriptions The damping applied to the spring when the spring is being compressed. This value should be between 0.0 (no damping) and 1.0. A value of 0.0 means the car will keep bouncing as the spring keeps its energy. A good value for this is around 0.3 for a normal car, 0.5 for a race car. +---- + .. _class_VehicleWheel_property_damping_relaxation: - :ref:`float` **damping_relaxation** @@ -86,6 +88,8 @@ The damping applied to the spring when the spring is being compressed. This valu The damping applied to the spring when relaxing. This value should be between 0.0 (no damping) and 1.0. This value should always be slightly higher than the :ref:`damping_compression` property. For a :ref:`damping_compression` value of 0.3, try a relaxation value of 0.5 +---- + .. _class_VehicleWheel_property_suspension_max_force: - :ref:`float` **suspension_max_force** @@ -98,6 +102,8 @@ The damping applied to the spring when relaxing. This value should be between 0. The maximum force the spring can resist. This value should be higher than a quarter of the :ref:`RigidBody.mass` of the :ref:`VehicleBody` or the spring will not carry the weight of the vehicle. Good results are often obtained by a value that is about 3x to 4x this number. +---- + .. _class_VehicleWheel_property_suspension_stiffness: - :ref:`float` **suspension_stiffness** @@ -110,6 +116,8 @@ The maximum force the spring can resist. This value should be higher than a quar This value defines the stiffness of the suspension. Use a value lower than 50 for an off-road car, a value between 50 and 100 for a race car and try something around 200 for something like a Formula 1 car. +---- + .. _class_VehicleWheel_property_suspension_travel: - :ref:`float` **suspension_travel** @@ -122,6 +130,8 @@ This value defines the stiffness of the suspension. Use a value lower than 50 fo This is the distance the suspension can travel. As Godot measures are in meters keep this setting relatively low. Try a value between 0.1 and 0.3 depending on the type of car . +---- + .. _class_VehicleWheel_property_use_as_steering: - :ref:`bool` **use_as_steering** @@ -134,6 +144,8 @@ This is the distance the suspension can travel. As Godot measures are in meters If ``true`` this wheel will be turned when the car steers. +---- + .. _class_VehicleWheel_property_use_as_traction: - :ref:`bool` **use_as_traction** @@ -146,6 +158,8 @@ If ``true`` this wheel will be turned when the car steers. If ``true`` this wheel transfers engine force to the ground to propel the vehicle forward. +---- + .. _class_VehicleWheel_property_wheel_friction_slip: - :ref:`float` **wheel_friction_slip** @@ -160,6 +174,8 @@ This determines how much grip this wheel has. It is combined with the friction s It's best to set this to 1.0 when starting out. +---- + .. _class_VehicleWheel_property_wheel_radius: - :ref:`float` **wheel_radius** @@ -172,6 +188,8 @@ It's best to set this to 1.0 when starting out. The radius of the wheel in meters. +---- + .. _class_VehicleWheel_property_wheel_rest_length: - :ref:`float` **wheel_rest_length** @@ -184,6 +202,8 @@ The radius of the wheel in meters. This is the distance in meters the wheel is lowered from its origin point. Don't set this to 0.0 and move the wheel into position, instead move the origin point of your wheel (the gizmo in Godot) to the position the wheel will take when bottoming out, then use the rest length to move the wheel down to the position it should be in when the car is in rest. +---- + .. _class_VehicleWheel_property_wheel_roll_influence: - :ref:`float` **wheel_roll_influence** @@ -205,6 +225,8 @@ Method Descriptions Returns a value between 0.0 and 1.0 that indicates whether this wheel is skidding. 0.0 is skidding (the wheel has lost grip, e.g. icy terrain), 1.0 means not skidding (the wheel has full grip, e.g. dry asphalt road). +---- + .. _class_VehicleWheel_method_is_in_contact: - :ref:`bool` **is_in_contact** **(** **)** const diff --git a/classes/class_videoplayer.rst b/classes/class_videoplayer.rst index 8d7f29cb5..822f443b1 100644 --- a/classes/class_videoplayer.rst +++ b/classes/class_videoplayer.rst @@ -87,6 +87,8 @@ Property Descriptions The embedded audio track to play. +---- + .. _class_VideoPlayer_property_autoplay: - :ref:`bool` **autoplay** @@ -99,6 +101,8 @@ The embedded audio track to play. If ``true``, playback starts when the scene loads. Default value: ``false``. +---- + .. _class_VideoPlayer_property_buffering_msec: - :ref:`int` **buffering_msec** @@ -111,6 +115,8 @@ If ``true``, playback starts when the scene loads. Default value: ``false``. Amount of time in milliseconds to store in buffer while playing. +---- + .. _class_VideoPlayer_property_bus: - :ref:`String` **bus** @@ -123,6 +129,8 @@ Amount of time in milliseconds to store in buffer while playing. Audio bus to use for sound playback. +---- + .. _class_VideoPlayer_property_expand: - :ref:`bool` **expand** @@ -135,6 +143,8 @@ Audio bus to use for sound playback. If ``true``, the video scales to the control size. Default value: ``true``. +---- + .. _class_VideoPlayer_property_paused: - :ref:`bool` **paused** @@ -147,6 +157,8 @@ If ``true``, the video scales to the control size. Default value: ``true``. If ``true``, the video is paused. +---- + .. _class_VideoPlayer_property_stream: - :ref:`VideoStream` **stream** @@ -157,6 +169,8 @@ If ``true``, the video is paused. | *Getter* | get_stream() | +----------+-------------------+ +---- + .. _class_VideoPlayer_property_stream_position: - :ref:`float` **stream_position** @@ -169,6 +183,8 @@ If ``true``, the video is paused. The current position of the stream, in seconds. +---- + .. _class_VideoPlayer_property_volume: - :ref:`float` **volume** @@ -181,6 +197,8 @@ The current position of the stream, in seconds. Audio volume as a linear value. +---- + .. _class_VideoPlayer_property_volume_db: - :ref:`float` **volume_db** @@ -202,24 +220,32 @@ Method Descriptions Returns the video stream's name. +---- + .. _class_VideoPlayer_method_get_video_texture: - :ref:`Texture` **get_video_texture** **(** **)** Returns the current frame as a :ref:`Texture`. +---- + .. _class_VideoPlayer_method_is_playing: - :ref:`bool` **is_playing** **(** **)** const Returns ``true`` if the video is playing. +---- + .. _class_VideoPlayer_method_play: - void **play** **(** **)** Starts the video playback. +---- + .. _class_VideoPlayer_method_stop: - void **stop** **(** **)** diff --git a/classes/class_videostreamgdnative.rst b/classes/class_videostreamgdnative.rst index 0036bfbd4..73eb43c2d 100644 --- a/classes/class_videostreamgdnative.rst +++ b/classes/class_videostreamgdnative.rst @@ -34,6 +34,8 @@ Method Descriptions - :ref:`String` **get_file** **(** **)** +---- + .. _class_VideoStreamGDNative_method_set_file: - void **set_file** **(** :ref:`String` file **)** diff --git a/classes/class_videostreamtheora.rst b/classes/class_videostreamtheora.rst index 34400e2f6..847504e41 100644 --- a/classes/class_videostreamtheora.rst +++ b/classes/class_videostreamtheora.rst @@ -34,6 +34,8 @@ Method Descriptions - :ref:`String` **get_file** **(** **)** +---- + .. _class_VideoStreamTheora_method_set_file: - void **set_file** **(** :ref:`String` file **)** diff --git a/classes/class_videostreamwebm.rst b/classes/class_videostreamwebm.rst index 6641d523a..9ddd1e733 100644 --- a/classes/class_videostreamwebm.rst +++ b/classes/class_videostreamwebm.rst @@ -34,6 +34,8 @@ Method Descriptions - :ref:`String` **get_file** **(** **)** +---- + .. _class_VideoStreamWebm_method_set_file: - void **set_file** **(** :ref:`String` file **)** diff --git a/classes/class_viewport.rst b/classes/class_viewport.rst index 189255856..df09959b7 100644 --- a/classes/class_viewport.rst +++ b/classes/class_viewport.rst @@ -166,6 +166,8 @@ enum **UpdateMode**: - **UPDATE_ALWAYS** = **3** --- Always update the render target. +---- + .. _enum_Viewport_ShadowAtlasQuadrantSubdiv: .. _class_Viewport_constant_SHADOW_ATLAS_QUADRANT_SUBDIV_DISABLED: @@ -202,6 +204,8 @@ enum **ShadowAtlasQuadrantSubdiv**: - **SHADOW_ATLAS_QUADRANT_SUBDIV_MAX** = **7** --- Represents the size of the :ref:`ShadowAtlasQuadrantSubdiv` enum. +---- + .. _enum_Viewport_RenderInfo: .. _class_Viewport_constant_RENDER_INFO_OBJECTS_IN_FRAME: @@ -234,6 +238,8 @@ enum **RenderInfo**: - **RENDER_INFO_MAX** = **6** --- Represents the size of the :ref:`RenderInfo` enum. +---- + .. _enum_Viewport_DebugDraw: .. _class_Viewport_constant_DEBUG_DRAW_DISABLED: @@ -254,6 +260,8 @@ enum **DebugDraw**: - **DEBUG_DRAW_WIREFRAME** = **3** --- Objects are displayed in wireframe style. +---- + .. _enum_Viewport_MSAA: .. _class_Viewport_constant_MSAA_DISABLED: @@ -278,6 +286,8 @@ enum **MSAA**: - **MSAA_16X** = **4** +---- + .. _enum_Viewport_Usage: .. _class_Viewport_constant_USAGE_2D: @@ -298,6 +308,8 @@ enum **Usage**: - **USAGE_3D_NO_EFFECTS** = **3** +---- + .. _enum_Viewport_ClearMode: .. _class_Viewport_constant_CLEAR_MODE_ALWAYS: @@ -351,6 +363,8 @@ Property Descriptions If ``true``, the viewport will be used in AR/VR process. Default value: ``false``. +---- + .. _class_Viewport_property_audio_listener_enable_2d: - :ref:`bool` **audio_listener_enable_2d** @@ -363,6 +377,8 @@ If ``true``, the viewport will be used in AR/VR process. Default value: ``false` If ``true``, the viewport will process 2D audio streams. Default value: ``false``. +---- + .. _class_Viewport_property_audio_listener_enable_3d: - :ref:`bool` **audio_listener_enable_3d** @@ -375,6 +391,8 @@ If ``true``, the viewport will process 2D audio streams. Default value: ``false` If ``true``, the viewport will process 3D audio streams. Default value: ``false``. +---- + .. _class_Viewport_property_canvas_transform: - :ref:`Transform2D` **canvas_transform** @@ -387,6 +405,8 @@ If ``true``, the viewport will process 3D audio streams. Default value: ``false` 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_property_debug_draw: - :ref:`DebugDraw` **debug_draw** @@ -399,6 +419,8 @@ The canvas transform of the viewport, useful for changing the on-screen position The overlay mode for test rendered geometry in debug purposes. Default value: :ref:`DEBUG_DRAW_DISABLED`. +---- + .. _class_Viewport_property_disable_3d: - :ref:`bool` **disable_3d** @@ -411,6 +433,8 @@ The overlay mode for test rendered geometry in debug purposes. Default value: :r If ``true``, the viewport will disable 3D rendering. For actual disabling use ``usage``. Default value: ``false``. +---- + .. _class_Viewport_property_global_canvas_transform: - :ref:`Transform2D` **global_canvas_transform** @@ -423,6 +447,8 @@ If ``true``, the viewport will disable 3D rendering. For actual disabling use `` The global canvas transform of the viewport. The canvas transform is relative to this. +---- + .. _class_Viewport_property_gui_disable_input: - :ref:`bool` **gui_disable_input** @@ -435,6 +461,8 @@ The global canvas transform of the viewport. The canvas transform is relative to If ``true``, the viewport will not receive input event. Default value: ``false``. +---- + .. _class_Viewport_property_gui_snap_controls_to_pixels: - :ref:`bool` **gui_snap_controls_to_pixels** @@ -447,6 +475,8 @@ If ``true``, the viewport will not receive input event. Default value: ``false`` If ``true``, the GUI controls on the viewport will lay pixel perfectly. Default value: ``true``. +---- + .. _class_Viewport_property_handle_input_locally: - :ref:`bool` **handle_input_locally** @@ -457,6 +487,8 @@ If ``true``, the GUI controls on the viewport will lay pixel perfectly. Default | *Getter* | is_handling_input_locally() | +----------+---------------------------------+ +---- + .. _class_Viewport_property_hdr: - :ref:`bool` **hdr** @@ -469,6 +501,8 @@ If ``true``, the GUI controls on the viewport will lay pixel perfectly. Default If ``true``, the viewport rendering will receive benefits from High Dynamic Range algorithm. Default value: ``true``. +---- + .. _class_Viewport_property_keep_3d_linear: - :ref:`bool` **keep_3d_linear** @@ -481,6 +515,8 @@ If ``true``, the viewport rendering will receive benefits from High Dynamic Rang If ``true``, the result after 3D rendering will not have a linear to sRGB color conversion applied. This is important when the viewport is used as a render target where the result is used as a texture on a 3D object rendered in another viewport. It is also important if the viewport is used to create data that is not color based (noise, heightmaps, pickmaps, etc.). Do not enable this when the viewport is used as a texture on a 2D object or if the viewport is your final output. +---- + .. _class_Viewport_property_msaa: - :ref:`MSAA` **msaa** @@ -493,6 +529,8 @@ If ``true``, the result after 3D rendering will not have a linear to sRGB color The multisample anti-aliasing mode. Default value: :ref:`MSAA_DISABLED`. +---- + .. _class_Viewport_property_own_world: - :ref:`bool` **own_world** @@ -505,6 +543,8 @@ The multisample anti-aliasing mode. Default value: :ref:`MSAA_DISABLED` defined in ``world`` property. Default value: ``false``. +---- + .. _class_Viewport_property_physics_object_picking: - :ref:`bool` **physics_object_picking** @@ -517,6 +557,8 @@ If ``true``, the viewport will use :ref:`World` defined in ``world` If ``true``, the objects rendered by viewport become subjects of mouse picking process. Default value: ``false``. +---- + .. _class_Viewport_property_render_target_clear_mode: - :ref:`ClearMode` **render_target_clear_mode** @@ -529,6 +571,8 @@ If ``true``, the objects rendered by viewport become subjects of mouse picking p The clear mode when viewport used as a render target. Default value: :ref:`CLEAR_MODE_ALWAYS`. +---- + .. _class_Viewport_property_render_target_update_mode: - :ref:`UpdateMode` **render_target_update_mode** @@ -541,6 +585,8 @@ The clear mode when viewport used as a render target. Default value: :ref:`CLEAR The update mode when viewport used as a render target. Default value: :ref:`UPDATE_WHEN_VISIBLE`. +---- + .. _class_Viewport_property_render_target_v_flip: - :ref:`bool` **render_target_v_flip** @@ -553,6 +599,8 @@ The update mode when viewport used as a render target. Default value: :ref:`UPDA If ``true``, the result of rendering will be flipped vertically. Default value: ``false``. +---- + .. _class_Viewport_property_shadow_atlas_quad_0: - :ref:`ShadowAtlasQuadrantSubdiv` **shadow_atlas_quad_0** @@ -565,6 +613,8 @@ If ``true``, the result of rendering will be flipped vertically. Default value: The subdivision amount of first quadrant on shadow atlas. Default value: ``SHADOW_ATLAS_QUADRANT_SUBDIV_4``. +---- + .. _class_Viewport_property_shadow_atlas_quad_1: - :ref:`ShadowAtlasQuadrantSubdiv` **shadow_atlas_quad_1** @@ -577,6 +627,8 @@ The subdivision amount of first quadrant on shadow atlas. Default value: ``SHADO The subdivision amount of second quadrant on shadow atlas. Default value: ``SHADOW_ATLAS_QUADRANT_SUBDIV_4``. +---- + .. _class_Viewport_property_shadow_atlas_quad_2: - :ref:`ShadowAtlasQuadrantSubdiv` **shadow_atlas_quad_2** @@ -589,6 +641,8 @@ The subdivision amount of second quadrant on shadow atlas. Default value: ``SHAD The subdivision amount of third quadrant on shadow atlas. Default value: ``SHADOW_ATLAS_QUADRANT_SUBDIV_16``. +---- + .. _class_Viewport_property_shadow_atlas_quad_3: - :ref:`ShadowAtlasQuadrantSubdiv` **shadow_atlas_quad_3** @@ -601,6 +655,8 @@ The subdivision amount of third quadrant on shadow atlas. Default value: ``SHADO The subdivision amount of fourth quadrant on shadow atlas. Default value: ``SHADOW_ATLAS_QUADRANT_SUBDIV_64``. +---- + .. _class_Viewport_property_shadow_atlas_size: - :ref:`int` **shadow_atlas_size** @@ -613,6 +669,8 @@ The subdivision amount of fourth quadrant on shadow atlas. Default value: ``SHAD The resolution of shadow atlas. Both width and height is equal to one value. +---- + .. _class_Viewport_property_size: - :ref:`Vector2` **size** @@ -625,6 +683,8 @@ The resolution of shadow atlas. Both width and height is equal to one value. The width and height of viewport. +---- + .. _class_Viewport_property_transparent_bg: - :ref:`bool` **transparent_bg** @@ -637,6 +697,8 @@ The width and height of viewport. If ``true``, the viewport should render its background as transparent. Default value: ``false``. +---- + .. _class_Viewport_property_usage: - :ref:`Usage` **usage** @@ -649,6 +711,8 @@ If ``true``, the viewport should render its background as transparent. Default v The rendering mode of viewport. Default value: ``USAGE_3D``. +---- + .. _class_Viewport_property_world: - :ref:`World` **world** @@ -661,6 +725,8 @@ The rendering mode of viewport. Default value: ``USAGE_3D``. The custom :ref:`World` which can be used as 3D environment source. +---- + .. _class_Viewport_property_world_2d: - :ref:`World2D` **world_2d** @@ -682,48 +748,64 @@ Method Descriptions Returns the 3D world of the viewport, or if none the world of the parent viewport. +---- + .. _class_Viewport_method_find_world_2d: - :ref:`World2D` **find_world_2d** **(** **)** const Returns the 2D world of the viewport. +---- + .. _class_Viewport_method_get_camera: - :ref:`Camera` **get_camera** **(** **)** const Returns the active 3D camera. +---- + .. _class_Viewport_method_get_final_transform: - :ref:`Transform2D` **get_final_transform** **(** **)** const Returns the total transform of the viewport. +---- + .. _class_Viewport_method_get_modal_stack_top: - :ref:`Control` **get_modal_stack_top** **(** **)** const Returns the topmost modal in the stack. +---- + .. _class_Viewport_method_get_mouse_position: - :ref:`Vector2` **get_mouse_position** **(** **)** const Returns the mouse position relative to the viewport. +---- + .. _class_Viewport_method_get_render_info: - :ref:`int` **get_render_info** **(** :ref:`RenderInfo` info **)** Returns information about the viewport from the rendering pipeline. +---- + .. _class_Viewport_method_get_size_override: - :ref:`Vector2` **get_size_override** **(** **)** const Returns the size override set with :ref:`set_size_override`. +---- + .. _class_Viewport_method_get_texture: - :ref:`ViewportTexture` **get_texture** **(** **)** const @@ -735,80 +817,112 @@ Returns the viewport's texture. Note that due to the way OpenGL works, the resul var img = get_viewport().get_texture().get_data() img.flip_y() +---- + .. _class_Viewport_method_get_viewport_rid: - :ref:`RID` **get_viewport_rid** **(** **)** const Returns the viewport's RID from the :ref:`VisualServer`. +---- + .. _class_Viewport_method_get_visible_rect: - :ref:`Rect2` **get_visible_rect** **(** **)** const Returns the visible rectangle in global screen coordinates. +---- + .. _class_Viewport_method_gui_get_drag_data: - :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_method_gui_has_modal_stack: - :ref:`bool` **gui_has_modal_stack** **(** **)** const Returns ``true`` if there are visible modals on-screen. +---- + .. _class_Viewport_method_gui_is_dragging: - :ref:`bool` **gui_is_dragging** **(** **)** const +---- + .. _class_Viewport_method_input: - void **input** **(** :ref:`InputEvent` local_event **)** +---- + .. _class_Viewport_method_is_input_handled: - :ref:`bool` **is_input_handled** **(** **)** const +---- + .. _class_Viewport_method_is_size_override_enabled: - :ref:`bool` **is_size_override_enabled** **(** **)** const Returns ``true`` if the size override is enabled. See :ref:`set_size_override`. +---- + .. _class_Viewport_method_is_size_override_stretch_enabled: - :ref:`bool` **is_size_override_stretch_enabled** **(** **)** const +---- + .. _class_Viewport_method_set_attach_to_screen_rect: - void **set_attach_to_screen_rect** **(** :ref:`Rect2` rect **)** +---- + .. _class_Viewport_method_set_input_as_handled: - void **set_input_as_handled** **(** **)** +---- + .. _class_Viewport_method_set_size_override: - void **set_size_override** **(** :ref:`bool` enable, :ref:`Vector2` size=Vector2( -1, -1 ), :ref:`Vector2` margin=Vector2( 0, 0 ) **)** Sets the size override of the viewport. If the ``enable`` parameter is ``true`` the override is used, otherwise it uses the default size. If the size parameter is ``(-1, -1)``, it won't update the size. +---- + .. _class_Viewport_method_set_size_override_stretch: - void **set_size_override_stretch** **(** :ref:`bool` enabled **)** +---- + .. _class_Viewport_method_unhandled_input: - void **unhandled_input** **(** :ref:`InputEvent` local_event **)** +---- + .. _class_Viewport_method_update_worlds: - void **update_worlds** **(** **)** Forces update of the 2D and 3D worlds. +---- + .. _class_Viewport_method_warp_mouse: - void **warp_mouse** **(** :ref:`Vector2` to_position **)** diff --git a/classes/class_viewportcontainer.rst b/classes/class_viewportcontainer.rst index 9883c1f49..7ae36b811 100644 --- a/classes/class_viewportcontainer.rst +++ b/classes/class_viewportcontainer.rst @@ -47,6 +47,8 @@ Property Descriptions If ``true``, the viewport will be scaled to the control's size. Default value:``false``. +---- + .. _class_ViewportContainer_property_stretch_shrink: - :ref:`int` **stretch_shrink** diff --git a/classes/class_visibilityenabler.rst b/classes/class_visibilityenabler.rst index 85d5f9d56..19778a6bf 100644 --- a/classes/class_visibilityenabler.rst +++ b/classes/class_visibilityenabler.rst @@ -66,6 +66,8 @@ Property Descriptions If ``true``, :ref:`RigidBody` nodes will be paused. +---- + .. _class_VisibilityEnabler_property_pause_animations: - :ref:`bool` **pause_animations** diff --git a/classes/class_visibilityenabler2d.rst b/classes/class_visibilityenabler2d.rst index 30d4ca429..bfa482b58 100644 --- a/classes/class_visibilityenabler2d.rst +++ b/classes/class_visibilityenabler2d.rst @@ -90,6 +90,8 @@ Property Descriptions If ``true``, :ref:`RigidBody2D` nodes will be paused. +---- + .. _class_VisibilityEnabler2D_property_pause_animated_sprites: - :ref:`bool` **pause_animated_sprites** @@ -102,6 +104,8 @@ If ``true``, :ref:`RigidBody2D` nodes will be paused. If ``true``, :ref:`AnimatedSprite` nodes will be paused. +---- + .. _class_VisibilityEnabler2D_property_pause_animations: - :ref:`bool` **pause_animations** @@ -114,6 +118,8 @@ If ``true``, :ref:`AnimatedSprite` nodes will be paused. If ``true``, :ref:`AnimationPlayer` nodes will be paused. +---- + .. _class_VisibilityEnabler2D_property_pause_particles: - :ref:`bool` **pause_particles** @@ -126,6 +132,8 @@ If ``true``, :ref:`AnimationPlayer` nodes will be paused. If ``true``, :ref:`Particles2D` nodes will be paused. +---- + .. _class_VisibilityEnabler2D_property_physics_process_parent: - :ref:`bool` **physics_process_parent** @@ -138,6 +146,8 @@ If ``true``, :ref:`Particles2D` nodes will be paused. If ``true``, the parent's :ref:`Node._physics_process` will be stopped. +---- + .. _class_VisibilityEnabler2D_property_process_parent: - :ref:`bool` **process_parent** diff --git a/classes/class_visibilitynotifier.rst b/classes/class_visibilitynotifier.rst index 43d0aabde..b9e8d190d 100644 --- a/classes/class_visibilitynotifier.rst +++ b/classes/class_visibilitynotifier.rst @@ -43,18 +43,24 @@ Signals Emitted when the VisibilityNotifier enters a :ref:`Camera`'s view. +---- + .. _class_VisibilityNotifier_signal_camera_exited: - **camera_exited** **(** :ref:`Camera` camera **)** Emitted when the VisibilityNotifier exits a :ref:`Camera`'s view. +---- + .. _class_VisibilityNotifier_signal_screen_entered: - **screen_entered** **(** **)** Emitted when the VisibilityNotifier enters the screen. +---- + .. _class_VisibilityNotifier_signal_screen_exited: - **screen_exited** **(** **)** diff --git a/classes/class_visibilitynotifier2d.rst b/classes/class_visibilitynotifier2d.rst index 626a6b483..fb3044789 100644 --- a/classes/class_visibilitynotifier2d.rst +++ b/classes/class_visibilitynotifier2d.rst @@ -43,18 +43,24 @@ Signals Emitted when the VisibilityNotifier2D enters the screen. +---- + .. _class_VisibilityNotifier2D_signal_screen_exited: - **screen_exited** **(** **)** Emitted when the VisibilityNotifier2D exits the screen. +---- + .. _class_VisibilityNotifier2D_signal_viewport_entered: - **viewport_entered** **(** :ref:`Viewport` viewport **)** Emitted when the VisibilityNotifier2D enters a :ref:`Viewport`'s view. +---- + .. _class_VisibilityNotifier2D_signal_viewport_exited: - **viewport_exited** **(** :ref:`Viewport` viewport **)** diff --git a/classes/class_visualinstance.rst b/classes/class_visualinstance.rst index af838aa34..65d05ee72 100644 --- a/classes/class_visualinstance.rst +++ b/classes/class_visualinstance.rst @@ -72,18 +72,26 @@ Method Descriptions Returns the :ref:`AABB` (also known as the bounding box) for this VisualInstance. +---- + .. _class_VisualInstance_method_get_base: - :ref:`RID` **get_base** **(** **)** const +---- + .. _class_VisualInstance_method_get_instance: - :ref:`RID` **get_instance** **(** **)** const +---- + .. _class_VisualInstance_method_get_layer_mask_bit: - :ref:`bool` **get_layer_mask_bit** **(** :ref:`int` layer **)** const +---- + .. _class_VisualInstance_method_get_transformed_aabb: - :ref:`AABB` **get_transformed_aabb** **(** **)** const @@ -92,6 +100,8 @@ Returns the transformed :ref:`AABB` (also known as the bounding box) Transformed in this case means the :ref:`AABB` plus the position, rotation, and scale of the :ref:`Spatial`\ s :ref:`Transform` +---- + .. _class_VisualInstance_method_set_base: - void **set_base** **(** :ref:`RID` base **)** @@ -100,6 +110,8 @@ Sets the base of the VisualInstance, which changes how the engine handles the Vi It is recommended to only use set_base if you know what you're doing. +---- + .. _class_VisualInstance_method_set_layer_mask_bit: - void **set_layer_mask_bit** **(** :ref:`int` layer, :ref:`bool` enabled **)** diff --git a/classes/class_visualscript.rst b/classes/class_visualscript.rst index 9521a9435..c512a0a99 100644 --- a/classes/class_visualscript.rst +++ b/classes/class_visualscript.rst @@ -139,204 +139,272 @@ Method Descriptions Add a custom signal with the specified name to the VisualScript. +---- + .. _class_VisualScript_method_add_function: - void **add_function** **(** :ref:`String` name **)** Add a function with the specified name to the VisualScript. +---- + .. _class_VisualScript_method_add_node: - 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_method_add_variable: - 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_method_custom_signal_add_argument: - void **custom_signal_add_argument** **(** :ref:`String` name, :ref:`Variant.Type` type, :ref:`String` argname, :ref:`int` index=-1 **)** Add an argument to a custom signal added with :ref:`add_custom_signal`. +---- + .. _class_VisualScript_method_custom_signal_get_argument_count: - :ref:`int` **custom_signal_get_argument_count** **(** :ref:`String` name **)** const Get the count of a custom signal's arguments. +---- + .. _class_VisualScript_method_custom_signal_get_argument_name: - :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_method_custom_signal_get_argument_type: - :ref:`Variant.Type` **custom_signal_get_argument_type** **(** :ref:`String` name, :ref:`int` argidx **)** const Get the type of a custom signal's argument. +---- + .. _class_VisualScript_method_custom_signal_remove_argument: - void **custom_signal_remove_argument** **(** :ref:`String` name, :ref:`int` argidx **)** Remove a specific custom signal's argument. +---- + .. _class_VisualScript_method_custom_signal_set_argument_name: - void **custom_signal_set_argument_name** **(** :ref:`String` name, :ref:`int` argidx, :ref:`String` argname **)** Rename a custom signal's argument. +---- + .. _class_VisualScript_method_custom_signal_set_argument_type: - void **custom_signal_set_argument_type** **(** :ref:`String` name, :ref:`int` argidx, :ref:`Variant.Type` type **)** Change the type of a custom signal's argument. +---- + .. _class_VisualScript_method_custom_signal_swap_argument: - 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_method_data_connect: - 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_method_data_disconnect: - 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_method_get_function_node_id: - :ref:`int` **get_function_node_id** **(** :ref:`String` name **)** const Returns the id of a function's entry point node. +---- + .. _class_VisualScript_method_get_function_scroll: - :ref:`Vector2` **get_function_scroll** **(** :ref:`String` name **)** const Returns the position of the center of the screen for a given function. +---- + .. _class_VisualScript_method_get_node: - :ref:`VisualScriptNode` **get_node** **(** :ref:`String` func, :ref:`int` id **)** const Returns a node given its id and its function. +---- + .. _class_VisualScript_method_get_node_position: - :ref:`Vector2` **get_node_position** **(** :ref:`String` func, :ref:`int` id **)** const Returns a node's position in pixels. +---- + .. _class_VisualScript_method_get_variable_default_value: - :ref:`Variant` **get_variable_default_value** **(** :ref:`String` name **)** const Returns the default (initial) value of a variable. +---- + .. _class_VisualScript_method_get_variable_export: - :ref:`bool` **get_variable_export** **(** :ref:`String` name **)** const Returns whether a variable is exported. +---- + .. _class_VisualScript_method_get_variable_info: - :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_method_has_custom_signal: - :ref:`bool` **has_custom_signal** **(** :ref:`String` name **)** const Returns whether a signal exists with the specified name. +---- + .. _class_VisualScript_method_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 Returns whether the specified data ports are connected. +---- + .. _class_VisualScript_method_has_function: - :ref:`bool` **has_function** **(** :ref:`String` name **)** const Returns whether a function exists with the specified name. +---- + .. _class_VisualScript_method_has_node: - :ref:`bool` **has_node** **(** :ref:`String` func, :ref:`int` id **)** const Returns whether a node exists with the given id. +---- + .. _class_VisualScript_method_has_sequence_connection: - :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_method_has_variable: - :ref:`bool` **has_variable** **(** :ref:`String` name **)** const Returns whether a variable exists with the specified name. +---- + .. _class_VisualScript_method_remove_custom_signal: - void **remove_custom_signal** **(** :ref:`String` name **)** Remove a custom signal with the given name. +---- + .. _class_VisualScript_method_remove_function: - void **remove_function** **(** :ref:`String` name **)** Remove a specific function and its nodes from the script. +---- + .. _class_VisualScript_method_remove_node: - void **remove_node** **(** :ref:`String` func, :ref:`int` id **)** Remove a specific node. +---- + .. _class_VisualScript_method_remove_variable: - void **remove_variable** **(** :ref:`String` name **)** Remove a variable with the given name. +---- + .. _class_VisualScript_method_rename_custom_signal: - void **rename_custom_signal** **(** :ref:`String` name, :ref:`String` new_name **)** Change the name of a custom signal. +---- + .. _class_VisualScript_method_rename_function: - void **rename_function** **(** :ref:`String` name, :ref:`String` new_name **)** Change the name of a function. +---- + .. _class_VisualScript_method_rename_variable: - void **rename_variable** **(** :ref:`String` name, :ref:`String` new_name **)** Change the name of a variable. +---- + .. _class_VisualScript_method_sequence_connect: - void **sequence_connect** **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** @@ -345,42 +413,56 @@ Connect two sequence ports. The execution will flow from of ``from_node``'s ``fr Unlike :ref:`data_connect`, there isn't a ``to_port``, since the target node can have only one sequence port. +---- + .. _class_VisualScript_method_sequence_disconnect: - 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_method_set_function_scroll: - void **set_function_scroll** **(** :ref:`String` name, :ref:`Vector2` ofs **)** Position the center of the screen for a function. +---- + .. _class_VisualScript_method_set_instance_base_type: - void **set_instance_base_type** **(** :ref:`String` type **)** Set the base type of the script. +---- + .. _class_VisualScript_method_set_node_position: - void **set_node_position** **(** :ref:`String` func, :ref:`int` id, :ref:`Vector2` position **)** Position a node on the screen. +---- + .. _class_VisualScript_method_set_variable_default_value: - void **set_variable_default_value** **(** :ref:`String` name, :ref:`Variant` value **)** Change the default (initial) value of a variable. +---- + .. _class_VisualScript_method_set_variable_export: - void **set_variable_export** **(** :ref:`String` name, :ref:`bool` enable **)** Change whether a variable is exported. +---- + .. _class_VisualScript_method_set_variable_info: - void **set_variable_info** **(** :ref:`String` name, :ref:`Dictionary` value **)** diff --git a/classes/class_visualscriptbasictypeconstant.rst b/classes/class_visualscriptbasictypeconstant.rst index 069cce8d9..20bdde0a0 100644 --- a/classes/class_visualscriptbasictypeconstant.rst +++ b/classes/class_visualscriptbasictypeconstant.rst @@ -47,6 +47,8 @@ Property Descriptions The type to get the constant from. +---- + .. _class_VisualScriptBasicTypeConstant_property_constant: - :ref:`String` **constant** diff --git a/classes/class_visualscriptclassconstant.rst b/classes/class_visualscriptclassconstant.rst index 6e90e5499..3fbacb446 100644 --- a/classes/class_visualscriptclassconstant.rst +++ b/classes/class_visualscriptclassconstant.rst @@ -55,6 +55,8 @@ Property Descriptions The constant's parent class. +---- + .. _class_VisualScriptClassConstant_property_constant: - :ref:`String` **constant** diff --git a/classes/class_visualscriptcomment.rst b/classes/class_visualscriptcomment.rst index 1ea0c33b6..030b906af 100644 --- a/classes/class_visualscriptcomment.rst +++ b/classes/class_visualscriptcomment.rst @@ -51,6 +51,8 @@ Property Descriptions The text inside the comment node. +---- + .. _class_VisualScriptComment_property_size: - :ref:`Vector2` **size** @@ -63,6 +65,8 @@ The text inside the comment node. The comment node's size (in pixels). +---- + .. _class_VisualScriptComment_property_title: - :ref:`String` **title** diff --git a/classes/class_visualscriptconstant.rst b/classes/class_visualscriptconstant.rst index 20fcf3d9a..6ed9c6b17 100644 --- a/classes/class_visualscriptconstant.rst +++ b/classes/class_visualscriptconstant.rst @@ -55,6 +55,8 @@ Property Descriptions The constant's type. +---- + .. _class_VisualScriptConstant_property_value: - :ref:`Variant` **value** diff --git a/classes/class_visualscriptconstructor.rst b/classes/class_visualscriptconstructor.rst index b0999519a..125613441 100644 --- a/classes/class_visualscriptconstructor.rst +++ b/classes/class_visualscriptconstructor.rst @@ -43,14 +43,20 @@ Method Descriptions - :ref:`Dictionary` **get_constructor** **(** **)** const +---- + .. _class_VisualScriptConstructor_method_get_constructor_type: - :ref:`Variant.Type` **get_constructor_type** **(** **)** const +---- + .. _class_VisualScriptConstructor_method_set_constructor: - void **set_constructor** **(** :ref:`Dictionary` constructor **)** +---- + .. _class_VisualScriptConstructor_method_set_constructor_type: - void **set_constructor_type** **(** :ref:`Variant.Type` type **)** diff --git a/classes/class_visualscriptcustomnode.rst b/classes/class_visualscriptcustomnode.rst index b6f5512d8..ba84de4ae 100644 --- a/classes/class_visualscriptcustomnode.rst +++ b/classes/class_visualscriptcustomnode.rst @@ -111,78 +111,104 @@ Method Descriptions Return the node's title. +---- + .. _class_VisualScriptCustomNode_method__get_category: - :ref:`String` **_get_category** **(** **)** virtual Return the node's category. +---- + .. _class_VisualScriptCustomNode_method__get_input_value_port_count: - :ref:`int` **_get_input_value_port_count** **(** **)** virtual Return the count of input value ports. +---- + .. _class_VisualScriptCustomNode_method__get_input_value_port_name: - :ref:`String` **_get_input_value_port_name** **(** :ref:`int` idx **)** virtual Return the specified input port's name. +---- + .. _class_VisualScriptCustomNode_method__get_input_value_port_type: - :ref:`int` **_get_input_value_port_type** **(** :ref:`int` idx **)** virtual Return the specified input port's type. See the TYPE\_\* enum in :ref:`@GlobalScope`. +---- + .. _class_VisualScriptCustomNode_method__get_output_sequence_port_count: - :ref:`int` **_get_output_sequence_port_count** **(** **)** virtual Return the amount of output **sequence** ports. +---- + .. _class_VisualScriptCustomNode_method__get_output_sequence_port_text: - :ref:`String` **_get_output_sequence_port_text** **(** :ref:`int` idx **)** virtual Return the specified **sequence** output's name. +---- + .. _class_VisualScriptCustomNode_method__get_output_value_port_count: - :ref:`int` **_get_output_value_port_count** **(** **)** virtual Return the amount of output value ports. +---- + .. _class_VisualScriptCustomNode_method__get_output_value_port_name: - :ref:`String` **_get_output_value_port_name** **(** :ref:`int` idx **)** virtual Return the specified output's name. +---- + .. _class_VisualScriptCustomNode_method__get_output_value_port_type: - :ref:`int` **_get_output_value_port_type** **(** :ref:`int` idx **)** virtual Return the specified output's type. See the TYPE\_\* enum in :ref:`@GlobalScope`. +---- + .. _class_VisualScriptCustomNode_method__get_text: - :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_method__get_working_memory_size: - :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_method__has_input_sequence_port: - :ref:`bool` **_has_input_sequence_port** **(** **)** virtual Return whether the custom node has an input **sequence** port. +---- + .. _class_VisualScriptCustomNode_method__step: - :ref:`Variant` **_step** **(** :ref:`Array` inputs, :ref:`Array` outputs, :ref:`int` start_mode, :ref:`Array` working_mem **)** virtual diff --git a/classes/class_visualscripteditor.rst b/classes/class_visualscripteditor.rst index 686281499..012fa7fad 100644 --- a/classes/class_visualscripteditor.rst +++ b/classes/class_visualscripteditor.rst @@ -45,6 +45,8 @@ Method Descriptions Add a custom Visual Script node to the editor. It'll be placed under "Custom Nodes" with the ``category`` as the parameter. +---- + .. _class_VisualScriptEditor_method_remove_custom_node: - void **remove_custom_node** **(** :ref:`String` name, :ref:`String` category **)** diff --git a/classes/class_visualscriptfunctioncall.rst b/classes/class_visualscriptfunctioncall.rst index 0cbae3000..ef30cf2ec 100644 --- a/classes/class_visualscriptfunctioncall.rst +++ b/classes/class_visualscriptfunctioncall.rst @@ -70,6 +70,8 @@ enum **CallMode**: - **CALL_MODE_SINGLETON** = **4** +---- + .. _enum_VisualScriptFunctionCall_RPCCallMode: .. _class_VisualScriptFunctionCall_constant_RPC_DISABLED: @@ -107,6 +109,8 @@ Property Descriptions | *Getter* | get_base_script() | +----------+------------------------+ +---- + .. _class_VisualScriptFunctionCall_property_base_type: - :ref:`String` **base_type** @@ -117,6 +121,8 @@ Property Descriptions | *Getter* | get_base_type() | +----------+----------------------+ +---- + .. _class_VisualScriptFunctionCall_property_basic_type: - :ref:`Variant.Type` **basic_type** @@ -127,6 +133,8 @@ Property Descriptions | *Getter* | get_basic_type() | +----------+-----------------------+ +---- + .. _class_VisualScriptFunctionCall_property_call_mode: - :ref:`CallMode` **call_mode** @@ -137,6 +145,8 @@ Property Descriptions | *Getter* | get_call_mode() | +----------+----------------------+ +---- + .. _class_VisualScriptFunctionCall_property_function: - :ref:`String` **function** @@ -147,6 +157,8 @@ Property Descriptions | *Getter* | get_function() | +----------+---------------------+ +---- + .. _class_VisualScriptFunctionCall_property_node_path: - :ref:`NodePath` **node_path** @@ -157,6 +169,8 @@ Property Descriptions | *Getter* | get_base_path() | +----------+----------------------+ +---- + .. _class_VisualScriptFunctionCall_property_rpc_call_mode: - :ref:`RPCCallMode` **rpc_call_mode** @@ -167,6 +181,8 @@ Property Descriptions | *Getter* | get_rpc_call_mode() | +----------+--------------------------+ +---- + .. _class_VisualScriptFunctionCall_property_singleton: - :ref:`String` **singleton** @@ -177,6 +193,8 @@ Property Descriptions | *Getter* | get_singleton() | +----------+----------------------+ +---- + .. _class_VisualScriptFunctionCall_property_use_default_args: - :ref:`int` **use_default_args** @@ -187,6 +205,8 @@ Property Descriptions | *Getter* | get_use_default_args() | +----------+-----------------------------+ +---- + .. _class_VisualScriptFunctionCall_property_validate: - :ref:`bool` **validate** diff --git a/classes/class_visualscriptfunctionstate.rst b/classes/class_visualscriptfunctionstate.rst index e3cfff5fd..6ae7f5851 100644 --- a/classes/class_visualscriptfunctionstate.rst +++ b/classes/class_visualscriptfunctionstate.rst @@ -36,10 +36,14 @@ Method Descriptions - void **connect_to_signal** **(** :ref:`Object` obj, :ref:`String` signals, :ref:`Array` args **)** +---- + .. _class_VisualScriptFunctionState_method_is_valid: - :ref:`bool` **is_valid** **(** **)** const +---- + .. _class_VisualScriptFunctionState_method_resume: - :ref:`Variant` **resume** **(** :ref:`Array` args=null **)** diff --git a/classes/class_visualscriptinputaction.rst b/classes/class_visualscriptinputaction.rst index 4031be9db..9769aa5ad 100644 --- a/classes/class_visualscriptinputaction.rst +++ b/classes/class_visualscriptinputaction.rst @@ -63,6 +63,8 @@ Property Descriptions | *Getter* | get_action_name() | +----------+------------------------+ +---- + .. _class_VisualScriptInputAction_property_mode: - :ref:`Mode` **mode** diff --git a/classes/class_visualscriptlocalvar.rst b/classes/class_visualscriptlocalvar.rst index 1ab908a26..2e133f752 100644 --- a/classes/class_visualscriptlocalvar.rst +++ b/classes/class_visualscriptlocalvar.rst @@ -55,6 +55,8 @@ Property Descriptions The local variable's type. +---- + .. _class_VisualScriptLocalVar_property_var_name: - :ref:`String` **var_name** diff --git a/classes/class_visualscriptlocalvarset.rst b/classes/class_visualscriptlocalvarset.rst index 73e5932ff..59702c07f 100644 --- a/classes/class_visualscriptlocalvarset.rst +++ b/classes/class_visualscriptlocalvarset.rst @@ -59,6 +59,8 @@ Property Descriptions The local variable's type. +---- + .. _class_VisualScriptLocalVarSet_property_var_name: - :ref:`String` **var_name** diff --git a/classes/class_visualscriptnode.rst b/classes/class_visualscriptnode.rst index ef439701a..bec7a954a 100644 --- a/classes/class_visualscriptnode.rst +++ b/classes/class_visualscriptnode.rst @@ -56,18 +56,24 @@ Method Descriptions Returns the default value of a given port. The default value is used when nothing is connected to the port. +---- + .. _class_VisualScriptNode_method_get_visual_script: - :ref:`VisualScript` **get_visual_script** **(** **)** const Returns the :ref:`VisualScript` instance the node is bound to. +---- + .. _class_VisualScriptNode_method_ports_changed_notify: - void **ports_changed_notify** **(** **)** Notify that the node's ports have changed. Usually used in conjunction with :ref:`VisualScriptCustomNode` . +---- + .. _class_VisualScriptNode_method_set_default_input_value: - void **set_default_input_value** **(** :ref:`int` port_idx, :ref:`Variant` value **)** diff --git a/classes/class_visualscriptoperator.rst b/classes/class_visualscriptoperator.rst index 898f6a946..3163f628e 100644 --- a/classes/class_visualscriptoperator.rst +++ b/classes/class_visualscriptoperator.rst @@ -53,6 +53,8 @@ Property Descriptions | *Getter* | get_operator() | +----------+---------------------+ +---- + .. _class_VisualScriptOperator_property_type: - :ref:`Variant.Type` **type** diff --git a/classes/class_visualscriptpropertyget.rst b/classes/class_visualscriptpropertyget.rst index db8e003cc..e0907ad8b 100644 --- a/classes/class_visualscriptpropertyget.rst +++ b/classes/class_visualscriptpropertyget.rst @@ -69,6 +69,8 @@ Property Descriptions | *Getter* | get_base_script() | +----------+------------------------+ +---- + .. _class_VisualScriptPropertyGet_property_base_type: - :ref:`String` **base_type** @@ -79,6 +81,8 @@ Property Descriptions | *Getter* | get_base_type() | +----------+----------------------+ +---- + .. _class_VisualScriptPropertyGet_property_basic_type: - :ref:`Variant.Type` **basic_type** @@ -89,6 +93,8 @@ Property Descriptions | *Getter* | get_basic_type() | +----------+-----------------------+ +---- + .. _class_VisualScriptPropertyGet_property_index: - :ref:`String` **index** @@ -99,6 +105,8 @@ Property Descriptions | *Getter* | get_index() | +----------+------------------+ +---- + .. _class_VisualScriptPropertyGet_property_node_path: - :ref:`NodePath` **node_path** @@ -109,6 +117,8 @@ Property Descriptions | *Getter* | get_base_path() | +----------+----------------------+ +---- + .. _class_VisualScriptPropertyGet_property_property: - :ref:`String` **property** @@ -119,6 +129,8 @@ Property Descriptions | *Getter* | get_property() | +----------+---------------------+ +---- + .. _class_VisualScriptPropertyGet_property_set_mode: - :ref:`CallMode` **set_mode** diff --git a/classes/class_visualscriptpropertyset.rst b/classes/class_visualscriptpropertyset.rst index ad48355e2..c8cc163e4 100644 --- a/classes/class_visualscriptpropertyset.rst +++ b/classes/class_visualscriptpropertyset.rst @@ -62,6 +62,8 @@ enum **CallMode**: - **CALL_MODE_BASIC_TYPE** = **3** +---- + .. _enum_VisualScriptPropertySet_AssignOp: .. _class_VisualScriptPropertySet_constant_ASSIGN_OP_NONE: @@ -123,6 +125,8 @@ Property Descriptions | *Getter* | get_assign_op() | +----------+----------------------+ +---- + .. _class_VisualScriptPropertySet_property_base_script: - :ref:`String` **base_script** @@ -133,6 +137,8 @@ Property Descriptions | *Getter* | get_base_script() | +----------+------------------------+ +---- + .. _class_VisualScriptPropertySet_property_base_type: - :ref:`String` **base_type** @@ -143,6 +149,8 @@ Property Descriptions | *Getter* | get_base_type() | +----------+----------------------+ +---- + .. _class_VisualScriptPropertySet_property_basic_type: - :ref:`Variant.Type` **basic_type** @@ -153,6 +161,8 @@ Property Descriptions | *Getter* | get_basic_type() | +----------+-----------------------+ +---- + .. _class_VisualScriptPropertySet_property_index: - :ref:`String` **index** @@ -163,6 +173,8 @@ Property Descriptions | *Getter* | get_index() | +----------+------------------+ +---- + .. _class_VisualScriptPropertySet_property_node_path: - :ref:`NodePath` **node_path** @@ -173,6 +185,8 @@ Property Descriptions | *Getter* | get_base_path() | +----------+----------------------+ +---- + .. _class_VisualScriptPropertySet_property_property: - :ref:`String` **property** @@ -183,6 +197,8 @@ Property Descriptions | *Getter* | get_property() | +----------+---------------------+ +---- + .. _class_VisualScriptPropertySet_property_set_mode: - :ref:`CallMode` **set_mode** diff --git a/classes/class_visualscriptreturn.rst b/classes/class_visualscriptreturn.rst index ad49c316a..c5bf5e787 100644 --- a/classes/class_visualscriptreturn.rst +++ b/classes/class_visualscriptreturn.rst @@ -57,6 +57,8 @@ Property Descriptions If ``true``, the ``return`` input port is available. +---- + .. _class_VisualScriptReturn_property_return_type: - :ref:`Variant.Type` **return_type** diff --git a/classes/class_visualscripttypecast.rst b/classes/class_visualscripttypecast.rst index 7ee1099df..0fc424cb3 100644 --- a/classes/class_visualscripttypecast.rst +++ b/classes/class_visualscripttypecast.rst @@ -40,6 +40,8 @@ Property Descriptions | *Getter* | get_base_script() | +----------+------------------------+ +---- + .. _class_VisualScriptTypeCast_property_base_type: - :ref:`String` **base_type** diff --git a/classes/class_visualscriptyield.rst b/classes/class_visualscriptyield.rst index 6ac3ff804..736cad8d0 100644 --- a/classes/class_visualscriptyield.rst +++ b/classes/class_visualscriptyield.rst @@ -59,6 +59,8 @@ Property Descriptions | *Getter* | get_yield_mode() | +----------+-----------------------+ +---- + .. _class_VisualScriptYield_property_wait_time: - :ref:`float` **wait_time** diff --git a/classes/class_visualscriptyieldsignal.rst b/classes/class_visualscriptyieldsignal.rst index 1c8357cf6..b7410461f 100644 --- a/classes/class_visualscriptyieldsignal.rst +++ b/classes/class_visualscriptyieldsignal.rst @@ -63,6 +63,8 @@ Property Descriptions | *Getter* | get_base_type() | +----------+----------------------+ +---- + .. _class_VisualScriptYieldSignal_property_call_mode: - :ref:`CallMode` **call_mode** @@ -73,6 +75,8 @@ Property Descriptions | *Getter* | get_call_mode() | +----------+----------------------+ +---- + .. _class_VisualScriptYieldSignal_property_node_path: - :ref:`NodePath` **node_path** @@ -83,6 +87,8 @@ Property Descriptions | *Getter* | get_base_path() | +----------+----------------------+ +---- + .. _class_VisualScriptYieldSignal_property_signal: - :ref:`String` **signal** diff --git a/classes/class_visualserver.rst b/classes/class_visualserver.rst index a20d496b0..796593ba9 100644 --- a/classes/class_visualserver.rst +++ b/classes/class_visualserver.rst @@ -742,6 +742,8 @@ Signals - **frame_post_draw** **(** **)** +---- + .. _class_VisualServer_signal_frame_pre_draw: - **frame_pre_draw** **(** **)** @@ -777,6 +779,8 @@ enum **CubeMapSide**: - **CUBEMAP_BACK** = **5** --- Marks the back side of a cubemap. +---- + .. _enum_VisualServer_TextureType: .. _class_VisualServer_constant_TEXTURE_TYPE_2D: @@ -797,6 +801,8 @@ enum **TextureType**: - **TEXTURE_TYPE_3D** = **3** +---- + .. _enum_VisualServer_TextureFlags: .. _class_VisualServer_constant_TEXTURE_FLAG_MIPMAPS: @@ -835,6 +841,8 @@ More effective on planes often shown going to the horrizon as those textures (Wa - **TEXTURE_FLAGS_DEFAULT** = **7** --- Default flags. Generate mipmaps, repeat, and filter are enabled. +---- + .. _enum_VisualServer_ShaderMode: .. _class_VisualServer_constant_SHADER_SPATIAL: @@ -855,6 +863,8 @@ enum **ShaderMode**: - **SHADER_MAX** = **3** --- Represents the size of the :ref:`ShaderMode` enum. +---- + .. _enum_VisualServer_ArrayType: .. _class_VisualServer_constant_ARRAY_VERTEX: @@ -899,6 +909,8 @@ enum **ArrayType**: - **ARRAY_MAX** = **9** --- Represents the size of the :ref:`ArrayType` enum. +---- + .. _enum_VisualServer_ArrayFormat: .. _class_VisualServer_constant_ARRAY_FORMAT_VERTEX: @@ -987,6 +999,8 @@ enum **ArrayFormat**: - **ARRAY_COMPRESS_DEFAULT** = **97280** --- Used to set flags ARRAY_COMPRESS_VERTEX, ARRAY_COMPRESS_NORMAL, ARRAY_COMPRESS_TANGENT, ARRAY_COMPRESS_COLOR, ARRAY_COMPRESS_TEX_UV, ARRAY_COMPRESS_TEX_UV2 and ARRAY_COMPRESS_WEIGHTS quickly. +---- + .. _enum_VisualServer_PrimitiveType: .. _class_VisualServer_constant_PRIMITIVE_POINTS: @@ -1023,6 +1037,8 @@ enum **PrimitiveType**: - **PRIMITIVE_MAX** = **7** --- Represents the size of the :ref:`PrimitiveType` enum. +---- + .. _enum_VisualServer_BlendShapeMode: .. _class_VisualServer_constant_BLEND_SHAPE_MODE_NORMALIZED: @@ -1035,6 +1051,8 @@ enum **BlendShapeMode**: - **BLEND_SHAPE_MODE_RELATIVE** = **1** +---- + .. _enum_VisualServer_LightType: .. _class_VisualServer_constant_LIGHT_DIRECTIONAL: @@ -1051,6 +1069,8 @@ enum **LightType**: - **LIGHT_SPOT** = **2** --- is an spot light. +---- + .. _enum_VisualServer_LightParam: .. _class_VisualServer_constant_LIGHT_PARAM_ENERGY: @@ -1115,6 +1135,8 @@ enum **LightParam**: - **LIGHT_PARAM_MAX** = **15** --- Represents the size of the :ref:`LightParam` enum. +---- + .. _enum_VisualServer_LightOmniShadowMode: .. _class_VisualServer_constant_LIGHT_OMNI_SHADOW_DUAL_PARABOLOID: @@ -1127,6 +1149,8 @@ enum **LightOmniShadowMode**: - **LIGHT_OMNI_SHADOW_CUBE** = **1** +---- + .. _enum_VisualServer_LightOmniShadowDetail: .. _class_VisualServer_constant_LIGHT_OMNI_SHADOW_DETAIL_VERTICAL: @@ -1139,6 +1163,8 @@ enum **LightOmniShadowDetail**: - **LIGHT_OMNI_SHADOW_DETAIL_HORIZONTAL** = **1** +---- + .. _enum_VisualServer_LightDirectionalShadowMode: .. _class_VisualServer_constant_LIGHT_DIRECTIONAL_SHADOW_ORTHOGONAL: @@ -1155,6 +1181,8 @@ enum **LightDirectionalShadowMode**: - **LIGHT_DIRECTIONAL_SHADOW_PARALLEL_4_SPLITS** = **2** +---- + .. _enum_VisualServer_LightDirectionalShadowDepthRangeMode: .. _class_VisualServer_constant_LIGHT_DIRECTIONAL_SHADOW_DEPTH_RANGE_STABLE: @@ -1167,6 +1195,8 @@ enum **LightDirectionalShadowDepthRangeMode**: - **LIGHT_DIRECTIONAL_SHADOW_DEPTH_RANGE_OPTIMIZED** = **1** +---- + .. _enum_VisualServer_ViewportUpdateMode: .. _class_VisualServer_constant_VIEWPORT_UPDATE_DISABLED: @@ -1187,6 +1217,8 @@ enum **ViewportUpdateMode**: - **VIEWPORT_UPDATE_ALWAYS** = **3** +---- + .. _enum_VisualServer_ViewportClearMode: .. _class_VisualServer_constant_VIEWPORT_CLEAR_ALWAYS: @@ -1203,6 +1235,8 @@ enum **ViewportClearMode**: - **VIEWPORT_CLEAR_ONLY_NEXT_FRAME** = **2** --- The viewport is cleared once, then the clear mode is set to :ref:`VIEWPORT_CLEAR_NEVER`. +---- + .. _enum_VisualServer_ViewportMSAA: .. _class_VisualServer_constant_VIEWPORT_MSAA_DISABLED: @@ -1227,6 +1261,8 @@ enum **ViewportMSAA**: - **VIEWPORT_MSAA_16X** = **4** --- Multisample antialiasing is set to 16X. +---- + .. _enum_VisualServer_ViewportUsage: .. _class_VisualServer_constant_VIEWPORT_USAGE_2D: @@ -1247,6 +1283,8 @@ enum **ViewportUsage**: - **VIEWPORT_USAGE_3D_NO_EFFECTS** = **3** --- The Viewport renders 3D but without effects. +---- + .. _enum_VisualServer_ViewportRenderInfo: .. _class_VisualServer_constant_VIEWPORT_RENDER_INFO_OBJECTS_IN_FRAME: @@ -1279,6 +1317,8 @@ enum **ViewportRenderInfo**: - **VIEWPORT_RENDER_INFO_MAX** = **6** --- Represents the size of the :ref:`ViewportRenderInfo` enum. +---- + .. _enum_VisualServer_ViewportDebugDraw: .. _class_VisualServer_constant_VIEWPORT_DEBUG_DRAW_DISABLED: @@ -1299,6 +1339,8 @@ enum **ViewportDebugDraw**: - **VIEWPORT_DEBUG_DRAW_WIREFRAME** = **3** --- Debug draw draws objects in wireframe. +---- + .. _enum_VisualServer_ScenarioDebugMode: .. _class_VisualServer_constant_SCENARIO_DEBUG_DISABLED: @@ -1319,6 +1361,8 @@ enum **ScenarioDebugMode**: - **SCENARIO_DEBUG_SHADELESS** = **3** +---- + .. _enum_VisualServer_InstanceType: .. _class_VisualServer_constant_INSTANCE_NONE: @@ -1367,6 +1411,8 @@ enum **InstanceType**: - **INSTANCE_GEOMETRY_MASK** = **30** --- A combination of the flags of geometry instances (mesh, multimesh, immediate and particles). +---- + .. _enum_VisualServer_InstanceFlags: .. _class_VisualServer_constant_INSTANCE_FLAG_USE_BAKED_LIGHT: @@ -1383,6 +1429,8 @@ enum **InstanceFlags**: - **INSTANCE_FLAG_MAX** = **2** --- Represents the size of the :ref:`InstanceFlags` enum. +---- + .. _enum_VisualServer_ShadowCastingSetting: .. _class_VisualServer_constant_SHADOW_CASTING_SETTING_OFF: @@ -1403,6 +1451,8 @@ enum **ShadowCastingSetting**: - **SHADOW_CASTING_SETTING_SHADOWS_ONLY** = **3** +---- + .. _enum_VisualServer_NinePatchAxisMode: .. _class_VisualServer_constant_NINE_PATCH_STRETCH: @@ -1419,6 +1469,8 @@ enum **NinePatchAxisMode**: - **NINE_PATCH_TILE_FIT** = **2** --- The nine patch gets filled with tiles where needed and stretches them a bit if needed. +---- + .. _enum_VisualServer_CanvasLightMode: .. _class_VisualServer_constant_CANVAS_LIGHT_MODE_ADD: @@ -1439,6 +1491,8 @@ enum **CanvasLightMode**: - **CANVAS_LIGHT_MODE_MASK** = **3** --- The light adds color depending on mask. +---- + .. _enum_VisualServer_CanvasLightShadowFilter: .. _class_VisualServer_constant_CANVAS_LIGHT_FILTER_NONE: @@ -1467,6 +1521,8 @@ enum **CanvasLightShadowFilter**: - **CANVAS_LIGHT_FILTER_PCF13** = **5** +---- + .. _enum_VisualServer_CanvasOccluderPolygonCullMode: .. _class_VisualServer_constant_CANVAS_OCCLUDER_POLYGON_CULL_DISABLED: @@ -1483,6 +1539,8 @@ enum **CanvasOccluderPolygonCullMode**: - **CANVAS_OCCLUDER_POLYGON_CULL_COUNTER_CLOCKWISE** = **2** --- Culling of the canvas occluder is counterclockwise. +---- + .. _enum_VisualServer_RenderInfo: .. _class_VisualServer_constant_INFO_OBJECTS_IN_FRAME: @@ -1527,6 +1585,8 @@ enum **RenderInfo**: - **INFO_VERTEX_MEM_USED** = **9** --- The amount of vertex memory used. +---- + .. _enum_VisualServer_Features: .. _class_VisualServer_constant_FEATURE_SHADERS: @@ -1539,6 +1599,8 @@ enum **Features**: - **FEATURE_MULTITHREADED** = **1** +---- + .. _enum_VisualServer_MultimeshTransformFormat: .. _class_VisualServer_constant_MULTIMESH_TRANSFORM_2D: @@ -1551,6 +1613,8 @@ enum **MultimeshTransformFormat**: - **MULTIMESH_TRANSFORM_3D** = **1** +---- + .. _enum_VisualServer_MultimeshColorFormat: .. _class_VisualServer_constant_MULTIMESH_COLOR_NONE: @@ -1567,6 +1631,8 @@ enum **MultimeshColorFormat**: - **MULTIMESH_COLOR_FLOAT** = **2** +---- + .. _enum_VisualServer_MultimeshCustomDataFormat: .. _class_VisualServer_constant_MULTIMESH_CUSTOM_DATA_NONE: @@ -1583,6 +1649,8 @@ enum **MultimeshCustomDataFormat**: - **MULTIMESH_CUSTOM_DATA_FLOAT** = **2** +---- + .. _enum_VisualServer_ReflectionProbeUpdateMode: .. _class_VisualServer_constant_REFLECTION_PROBE_UPDATE_ONCE: @@ -1595,6 +1663,8 @@ enum **ReflectionProbeUpdateMode**: - **REFLECTION_PROBE_UPDATE_ALWAYS** = **1** +---- + .. _enum_VisualServer_ParticlesDrawOrder: .. _class_VisualServer_constant_PARTICLES_DRAW_ORDER_INDEX: @@ -1611,6 +1681,8 @@ enum **ParticlesDrawOrder**: - **PARTICLES_DRAW_ORDER_VIEW_DEPTH** = **2** +---- + .. _enum_VisualServer_EnvironmentBG: .. _class_VisualServer_constant_ENV_BG_CLEAR_COLOR: @@ -1643,6 +1715,8 @@ enum **EnvironmentBG**: - **ENV_BG_MAX** = **6** --- Represents the size of the :ref:`EnvironmentBG` enum. +---- + .. _enum_VisualServer_EnvironmentDOFBlurQuality: .. _class_VisualServer_constant_ENV_DOF_BLUR_QUALITY_LOW: @@ -1659,6 +1733,8 @@ enum **EnvironmentDOFBlurQuality**: - **ENV_DOF_BLUR_QUALITY_HIGH** = **2** +---- + .. _enum_VisualServer_EnvironmentGlowBlendMode: .. _class_VisualServer_constant_GLOW_BLEND_MODE_ADDITIVE: @@ -1679,6 +1755,8 @@ enum **EnvironmentGlowBlendMode**: - **GLOW_BLEND_MODE_REPLACE** = **3** +---- + .. _enum_VisualServer_EnvironmentToneMapper: .. _class_VisualServer_constant_ENV_TONE_MAPPER_LINEAR: @@ -1699,6 +1777,8 @@ enum **EnvironmentToneMapper**: - **ENV_TONE_MAPPER_ACES** = **3** +---- + .. _enum_VisualServer_EnvironmentSSAOQuality: .. _class_VisualServer_constant_ENV_SSAO_QUALITY_LOW: @@ -1715,6 +1795,8 @@ enum **EnvironmentSSAOQuality**: - **ENV_SSAO_QUALITY_HIGH** = **2** +---- + .. _enum_VisualServer_EnvironmentSSAOBlur: .. _class_VisualServer_constant_ENV_SSAO_BLUR_DISABLED: @@ -1786,76 +1868,106 @@ Method Descriptions Sets images to be rendered in the window margin. +---- + .. _class_VisualServer_method_black_bars_set_margins: - void **black_bars_set_margins** **(** :ref:`int` left, :ref:`int` top, :ref:`int` right, :ref:`int` bottom **)** Sets margin size, where black bars (or images, if :ref:`black_bars_set_images` was used) are rendered. +---- + .. _class_VisualServer_method_camera_create: - :ref:`RID` **camera_create** **(** **)** +---- + .. _class_VisualServer_method_camera_set_cull_mask: - void **camera_set_cull_mask** **(** :ref:`RID` camera, :ref:`int` layers **)** +---- + .. _class_VisualServer_method_camera_set_environment: - void **camera_set_environment** **(** :ref:`RID` camera, :ref:`RID` env **)** +---- + .. _class_VisualServer_method_camera_set_orthogonal: - void **camera_set_orthogonal** **(** :ref:`RID` camera, :ref:`float` size, :ref:`float` z_near, :ref:`float` z_far **)** +---- + .. _class_VisualServer_method_camera_set_perspective: - void **camera_set_perspective** **(** :ref:`RID` camera, :ref:`float` fovy_degrees, :ref:`float` z_near, :ref:`float` z_far **)** +---- + .. _class_VisualServer_method_camera_set_transform: - void **camera_set_transform** **(** :ref:`RID` camera, :ref:`Transform` transform **)** +---- + .. _class_VisualServer_method_camera_set_use_vertical_aspect: - void **camera_set_use_vertical_aspect** **(** :ref:`RID` camera, :ref:`bool` enable **)** +---- + .. _class_VisualServer_method_canvas_create: - :ref:`RID` **canvas_create** **(** **)** Creates a canvas and returns the assigned :ref:`RID`. +---- + .. _class_VisualServer_method_canvas_item_add_circle: - void **canvas_item_add_circle** **(** :ref:`RID` item, :ref:`Vector2` pos, :ref:`float` radius, :ref:`Color` color **)** Adds a circle command to the :ref:`CanvasItem`'s draw commands. +---- + .. _class_VisualServer_method_canvas_item_add_clip_ignore: - void **canvas_item_add_clip_ignore** **(** :ref:`RID` item, :ref:`bool` ignore **)** If ignore is ``true``, the VisualServer does not perform clipping. +---- + .. _class_VisualServer_method_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 **)** Adds a line command to the :ref:`CanvasItem`'s draw commands. +---- + .. _class_VisualServer_method_canvas_item_add_mesh: - void **canvas_item_add_mesh** **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`RID` texture, :ref:`RID` normal_map **)** Adds a :ref:`Mesh` to the :ref:`CanvasItem`'s draw commands. Only affects its aabb at the moment. +---- + .. _class_VisualServer_method_canvas_item_add_multimesh: - void **canvas_item_add_multimesh** **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`RID` texture, :ref:`RID` normal_map **)** Adds a :ref:`MultiMesh` to the :ref:`CanvasItem`'s draw commands. Only affects its aabb at the moment. +---- + .. _class_VisualServer_method_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:`NinePatchAxisMode` x_axis_mode=0, :ref:`NinePatchAxisMode` y_axis_mode=0, :ref:`bool` draw_center=true, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`RID` normal_map **)** @@ -1864,36 +1976,48 @@ Adds a nine patch image to the :ref:`CanvasItem`'s draw comman See :ref:`NinePatchRect` for more explanation. +---- + .. _class_VisualServer_method_canvas_item_add_particles: - void **canvas_item_add_particles** **(** :ref:`RID` item, :ref:`RID` particles, :ref:`RID` texture, :ref:`RID` normal_map **)** Adds a particles system to the :ref:`CanvasItem`'s draw commands. +---- + .. _class_VisualServer_method_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 **)** Adds a polygon to the :ref:`CanvasItem`'s draw commands. +---- + .. _class_VisualServer_method_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 **)** Adds a polyline, which is a line from multiple points with a width, to the :ref:`CanvasItem`'s draw commands. +---- + .. _class_VisualServer_method_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 **)** Adds a primitive to the :ref:`CanvasItem`'s draw commands. +---- + .. _class_VisualServer_method_canvas_item_add_rect: - void **canvas_item_add_rect** **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`Color` color **)** Adds a rectangle to the :ref:`CanvasItem`'s draw commands. +---- + .. _class_VisualServer_method_canvas_item_add_set_transform: - void **canvas_item_add_set_transform** **(** :ref:`RID` item, :ref:`Transform2D` transform **)** @@ -1902,708 +2026,1002 @@ Adds a :ref:`Transform2D` command to the :ref:`CanvasItem` 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 **)** Adds a textured rect to the :ref:`CanvasItem`'s draw commands. +---- + .. _class_VisualServer_method_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 **)** Adds a texture rect with region setting to the :ref:`CanvasItem`'s draw commands. +---- + .. _class_VisualServer_method_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:`PoolIntArray` bones=PoolIntArray( ), :ref:`PoolRealArray` weights=PoolRealArray( ), :ref:`RID` texture, :ref:`int` count=-1, :ref:`RID` normal_map **)** +---- + .. _class_VisualServer_method_canvas_item_clear: - void **canvas_item_clear** **(** :ref:`RID` item **)** Clears the :ref:`CanvasItem` and removes all commands in it. +---- + .. _class_VisualServer_method_canvas_item_create: - :ref:`RID` **canvas_item_create** **(** **)** Creates a new :ref:`CanvasItem` and returns its :ref:`RID`. +---- + .. _class_VisualServer_method_canvas_item_set_clip: - void **canvas_item_set_clip** **(** :ref:`RID` item, :ref:`bool` clip **)** Sets clipping for the :ref:`CanvasItem`. +---- + .. _class_VisualServer_method_canvas_item_set_copy_to_backbuffer: - void **canvas_item_set_copy_to_backbuffer** **(** :ref:`RID` item, :ref:`bool` enabled, :ref:`Rect2` rect **)** Sets the :ref:`CanvasItem` to copy a rect to the backbuffer. +---- + .. _class_VisualServer_method_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 ) **)** Defines a custom drawing rectangle for the :ref:`CanvasItem`. +---- + .. _class_VisualServer_method_canvas_item_set_distance_field_mode: - void **canvas_item_set_distance_field_mode** **(** :ref:`RID` item, :ref:`bool` enabled **)** +---- + .. _class_VisualServer_method_canvas_item_set_draw_behind_parent: - void **canvas_item_set_draw_behind_parent** **(** :ref:`RID` item, :ref:`bool` enabled **)** Sets :ref:`CanvasItem` to be drawn behind its parent. +---- + .. _class_VisualServer_method_canvas_item_set_draw_index: - void **canvas_item_set_draw_index** **(** :ref:`RID` item, :ref:`int` index **)** Sets the index for the :ref:`CanvasItem`. +---- + .. _class_VisualServer_method_canvas_item_set_light_mask: - void **canvas_item_set_light_mask** **(** :ref:`RID` item, :ref:`int` mask **)** The light mask. See :ref:`LightOccluder2D` for more information on light masks. +---- + .. _class_VisualServer_method_canvas_item_set_material: - void **canvas_item_set_material** **(** :ref:`RID` item, :ref:`RID` material **)** Sets a new material to the :ref:`CanvasItem`. +---- + .. _class_VisualServer_method_canvas_item_set_modulate: - void **canvas_item_set_modulate** **(** :ref:`RID` item, :ref:`Color` color **)** Sets the color that modulates the :ref:`CanvasItem` and its children. +---- + .. _class_VisualServer_method_canvas_item_set_parent: - void **canvas_item_set_parent** **(** :ref:`RID` item, :ref:`RID` parent **)** Sets the parent for the :ref:`CanvasItem`. +---- + .. _class_VisualServer_method_canvas_item_set_self_modulate: - void **canvas_item_set_self_modulate** **(** :ref:`RID` item, :ref:`Color` color **)** Sets the color that modulates the :ref:`CanvasItem` without children. +---- + .. _class_VisualServer_method_canvas_item_set_sort_children_by_y: - void **canvas_item_set_sort_children_by_y** **(** :ref:`RID` item, :ref:`bool` enabled **)** Sets if :ref:`CanvasItem`'s children should be sorted by y-position. +---- + .. _class_VisualServer_method_canvas_item_set_transform: - void **canvas_item_set_transform** **(** :ref:`RID` item, :ref:`Transform2D` transform **)** Sets the :ref:`CanvasItem`'s :ref:`Transform2D`. +---- + .. _class_VisualServer_method_canvas_item_set_use_parent_material: - void **canvas_item_set_use_parent_material** **(** :ref:`RID` item, :ref:`bool` enabled **)** Sets if the :ref:`CanvasItem` uses its parent's material. +---- + .. _class_VisualServer_method_canvas_item_set_visible: - void **canvas_item_set_visible** **(** :ref:`RID` item, :ref:`bool` visible **)** Sets if the canvas item (including its children) is visible. +---- + .. _class_VisualServer_method_canvas_item_set_z_as_relative_to_parent: - void **canvas_item_set_z_as_relative_to_parent** **(** :ref:`RID` item, :ref:`bool` enabled **)** If this is enabled, the z-index of the parent will be added to the children's z-index. +---- + .. _class_VisualServer_method_canvas_item_set_z_index: - void **canvas_item_set_z_index** **(** :ref:`RID` item, :ref:`int` z_index **)** Sets the :ref:`CanvasItem`'s z-index, i.e. its draw order (lower indexes are drawn first). +---- + .. _class_VisualServer_method_canvas_light_attach_to_canvas: - void **canvas_light_attach_to_canvas** **(** :ref:`RID` light, :ref:`RID` canvas **)** Attaches the canvas light to the canvas. Removes it from its previous canvas. +---- + .. _class_VisualServer_method_canvas_light_create: - :ref:`RID` **canvas_light_create** **(** **)** Creates a canvas light. +---- + .. _class_VisualServer_method_canvas_light_occluder_attach_to_canvas: - void **canvas_light_occluder_attach_to_canvas** **(** :ref:`RID` occluder, :ref:`RID` canvas **)** Attaches a light occluder to the canvas. Removes it from its previous canvas. +---- + .. _class_VisualServer_method_canvas_light_occluder_create: - :ref:`RID` **canvas_light_occluder_create** **(** **)** Creates a light occluder. +---- + .. _class_VisualServer_method_canvas_light_occluder_set_enabled: - void **canvas_light_occluder_set_enabled** **(** :ref:`RID` occluder, :ref:`bool` enabled **)** Enables or disables light occluder. +---- + .. _class_VisualServer_method_canvas_light_occluder_set_light_mask: - void **canvas_light_occluder_set_light_mask** **(** :ref:`RID` occluder, :ref:`int` mask **)** The light mask. See :ref:`LightOccluder2D` for more information on light masks +---- + .. _class_VisualServer_method_canvas_light_occluder_set_polygon: - void **canvas_light_occluder_set_polygon** **(** :ref:`RID` occluder, :ref:`RID` polygon **)** Sets a light occluder's polygon. +---- + .. _class_VisualServer_method_canvas_light_occluder_set_transform: - void **canvas_light_occluder_set_transform** **(** :ref:`RID` occluder, :ref:`Transform2D` transform **)** Sets a light occluder's :ref:`Transform2D`. +---- + .. _class_VisualServer_method_canvas_light_set_color: - void **canvas_light_set_color** **(** :ref:`RID` light, :ref:`Color` color **)** Sets the color for a light. +---- + .. _class_VisualServer_method_canvas_light_set_enabled: - void **canvas_light_set_enabled** **(** :ref:`RID` light, :ref:`bool` enabled **)** Enables or disables a canvas light. +---- + .. _class_VisualServer_method_canvas_light_set_energy: - void **canvas_light_set_energy** **(** :ref:`RID` light, :ref:`float` energy **)** Sets a canvas light's energy. +---- + .. _class_VisualServer_method_canvas_light_set_height: - void **canvas_light_set_height** **(** :ref:`RID` light, :ref:`float` height **)** Sets a canvas light's height. +---- + .. _class_VisualServer_method_canvas_light_set_item_cull_mask: - void **canvas_light_set_item_cull_mask** **(** :ref:`RID` light, :ref:`int` mask **)** The light mask. See :ref:`LightOccluder2D` for more information on light masks +---- + .. _class_VisualServer_method_canvas_light_set_item_shadow_cull_mask: - void **canvas_light_set_item_shadow_cull_mask** **(** :ref:`RID` light, :ref:`int` mask **)** The shadow mask. binary about which layers this canvas light affects which canvas item's shadows. See :ref:`LightOccluder2D` for more information on light masks. +---- + .. _class_VisualServer_method_canvas_light_set_layer_range: - void **canvas_light_set_layer_range** **(** :ref:`RID` light, :ref:`int` min_layer, :ref:`int` max_layer **)** The layer range that gets rendered with this light. +---- + .. _class_VisualServer_method_canvas_light_set_mode: - void **canvas_light_set_mode** **(** :ref:`RID` light, :ref:`CanvasLightMode` mode **)** The mode of the light, see CANVAS_LIGHT_MODE\_\* constants. +---- + .. _class_VisualServer_method_canvas_light_set_scale: - void **canvas_light_set_scale** **(** :ref:`RID` light, :ref:`float` scale **)** +---- + .. _class_VisualServer_method_canvas_light_set_shadow_buffer_size: - void **canvas_light_set_shadow_buffer_size** **(** :ref:`RID` light, :ref:`int` size **)** Sets the width of the shadow buffer, size gets scaled to the next power of two for this. +---- + .. _class_VisualServer_method_canvas_light_set_shadow_color: - void **canvas_light_set_shadow_color** **(** :ref:`RID` light, :ref:`Color` color **)** Sets the color of the canvas light's shadow. +---- + .. _class_VisualServer_method_canvas_light_set_shadow_enabled: - void **canvas_light_set_shadow_enabled** **(** :ref:`RID` light, :ref:`bool` enabled **)** Enables or disables the canvas light's shadow. +---- + .. _class_VisualServer_method_canvas_light_set_shadow_filter: - void **canvas_light_set_shadow_filter** **(** :ref:`RID` light, :ref:`CanvasLightShadowFilter` filter **)** Sets the canvas light's shadow's filter, see CANVAS_LIGHT_SHADOW_FILTER\_\* constants. +---- + .. _class_VisualServer_method_canvas_light_set_shadow_gradient_length: - void **canvas_light_set_shadow_gradient_length** **(** :ref:`RID` light, :ref:`float` length **)** Sets the length of the shadow's gradient. +---- + .. _class_VisualServer_method_canvas_light_set_shadow_smooth: - void **canvas_light_set_shadow_smooth** **(** :ref:`RID` light, :ref:`float` smooth **)** Smoothens the shadow. The lower, the more smooth. +---- + .. _class_VisualServer_method_canvas_light_set_texture: - void **canvas_light_set_texture** **(** :ref:`RID` light, :ref:`RID` texture **)** +---- + .. _class_VisualServer_method_canvas_light_set_texture_offset: - void **canvas_light_set_texture_offset** **(** :ref:`RID` light, :ref:`Vector2` offset **)** +---- + .. _class_VisualServer_method_canvas_light_set_transform: - void **canvas_light_set_transform** **(** :ref:`RID` light, :ref:`Transform2D` transform **)** Sets the canvas light's :ref:`Transform2D`. +---- + .. _class_VisualServer_method_canvas_light_set_z_range: - void **canvas_light_set_z_range** **(** :ref:`RID` light, :ref:`int` min_z, :ref:`int` max_z **)** +---- + .. _class_VisualServer_method_canvas_occluder_polygon_create: - :ref:`RID` **canvas_occluder_polygon_create** **(** **)** Creates a new light occluder polygon. +---- + .. _class_VisualServer_method_canvas_occluder_polygon_set_cull_mode: - void **canvas_occluder_polygon_set_cull_mode** **(** :ref:`RID` occluder_polygon, :ref:`CanvasOccluderPolygonCullMode` mode **)** Sets an occluder polygons cull mode. See CANVAS_OCCLUDER_POLYGON_CULL_MODE\_\* constants. +---- + .. _class_VisualServer_method_canvas_occluder_polygon_set_shape: - void **canvas_occluder_polygon_set_shape** **(** :ref:`RID` occluder_polygon, :ref:`PoolVector2Array` shape, :ref:`bool` closed **)** Sets the shape of the occluder polygon. +---- + .. _class_VisualServer_method_canvas_occluder_polygon_set_shape_as_lines: - void **canvas_occluder_polygon_set_shape_as_lines** **(** :ref:`RID` occluder_polygon, :ref:`PoolVector2Array` shape **)** Sets the shape of the occluder polygon as lines. +---- + .. _class_VisualServer_method_canvas_set_item_mirroring: - void **canvas_set_item_mirroring** **(** :ref:`RID` canvas, :ref:`RID` item, :ref:`Vector2` mirroring **)** A copy of the canvas item will be drawn with a local offset of the mirroring :ref:`Vector2`. +---- + .. _class_VisualServer_method_canvas_set_modulate: - void **canvas_set_modulate** **(** :ref:`RID` canvas, :ref:`Color` color **)** Modulates all colors in the given canvas. +---- + .. _class_VisualServer_method_directional_light_create: - :ref:`RID` **directional_light_create** **(** **)** +---- + .. _class_VisualServer_method_draw: - void **draw** **(** :ref:`bool` swap_buffers=true, :ref:`float` frame_step=0.0 **)** +---- + .. _class_VisualServer_method_environment_create: - :ref:`RID` **environment_create** **(** **)** +---- + .. _class_VisualServer_method_environment_set_adjustment: - void **environment_set_adjustment** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` brightness, :ref:`float` contrast, :ref:`float` saturation, :ref:`RID` ramp **)** +---- + .. _class_VisualServer_method_environment_set_ambient_light: - void **environment_set_ambient_light** **(** :ref:`RID` env, :ref:`Color` color, :ref:`float` energy=1.0, :ref:`float` sky_contibution=0.0 **)** +---- + .. _class_VisualServer_method_environment_set_background: - void **environment_set_background** **(** :ref:`RID` env, :ref:`EnvironmentBG` bg **)** +---- + .. _class_VisualServer_method_environment_set_bg_color: - void **environment_set_bg_color** **(** :ref:`RID` env, :ref:`Color` color **)** +---- + .. _class_VisualServer_method_environment_set_bg_energy: - void **environment_set_bg_energy** **(** :ref:`RID` env, :ref:`float` energy **)** +---- + .. _class_VisualServer_method_environment_set_canvas_max_layer: - void **environment_set_canvas_max_layer** **(** :ref:`RID` env, :ref:`int` max_layer **)** +---- + .. _class_VisualServer_method_environment_set_dof_blur_far: - void **environment_set_dof_blur_far** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` distance, :ref:`float` transition, :ref:`float` far_amount, :ref:`EnvironmentDOFBlurQuality` quality **)** +---- + .. _class_VisualServer_method_environment_set_dof_blur_near: - void **environment_set_dof_blur_near** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` distance, :ref:`float` transition, :ref:`float` far_amount, :ref:`EnvironmentDOFBlurQuality` quality **)** +---- + .. _class_VisualServer_method_environment_set_fog: - void **environment_set_fog** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`Color` color, :ref:`Color` sun_color, :ref:`float` sun_amount **)** +---- + .. _class_VisualServer_method_environment_set_fog_depth: - void **environment_set_fog_depth** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` depth_begin, :ref:`float` depth_end, :ref:`float` depth_curve, :ref:`bool` transmit, :ref:`float` transmit_curve **)** +---- + .. _class_VisualServer_method_environment_set_fog_height: - void **environment_set_fog_height** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` min_height, :ref:`float` max_height, :ref:`float` height_curve **)** +---- + .. _class_VisualServer_method_environment_set_glow: - void **environment_set_glow** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`int` level_flags, :ref:`float` intensity, :ref:`float` strength, :ref:`float` bloom_threshold, :ref:`EnvironmentGlowBlendMode` blend_mode, :ref:`float` hdr_bleed_threshold, :ref:`float` hdr_bleed_scale, :ref:`float` hdr_luminance_cap, :ref:`bool` bicubic_upscale **)** +---- + .. _class_VisualServer_method_environment_set_sky: - void **environment_set_sky** **(** :ref:`RID` env, :ref:`RID` sky **)** +---- + .. _class_VisualServer_method_environment_set_sky_custom_fov: - void **environment_set_sky_custom_fov** **(** :ref:`RID` env, :ref:`float` scale **)** +---- + .. _class_VisualServer_method_environment_set_sky_orientation: - void **environment_set_sky_orientation** **(** :ref:`RID` env, :ref:`Basis` orientation **)** +---- + .. _class_VisualServer_method_environment_set_ssao: - void **environment_set_ssao** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` radius, :ref:`float` intensity, :ref:`float` radius2, :ref:`float` intensity2, :ref:`float` bias, :ref:`float` light_affect, :ref:`float` ao_channel_affect, :ref:`Color` color, :ref:`EnvironmentSSAOQuality` quality, :ref:`EnvironmentSSAOBlur` blur, :ref:`float` bilateral_sharpness **)** +---- + .. _class_VisualServer_method_environment_set_ssr: - void **environment_set_ssr** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`int` max_steps, :ref:`float` fade_in, :ref:`float` fade_out, :ref:`float` depth_tolerance, :ref:`bool` roughness **)** +---- + .. _class_VisualServer_method_environment_set_tonemap: - void **environment_set_tonemap** **(** :ref:`RID` env, :ref:`EnvironmentToneMapper` tone_mapper, :ref:`float` exposure, :ref:`float` white, :ref:`bool` auto_exposure, :ref:`float` min_luminance, :ref:`float` max_luminance, :ref:`float` auto_exp_speed, :ref:`float` auto_exp_grey **)** +---- + .. _class_VisualServer_method_finish: - void **finish** **(** **)** Removes buffers and clears testcubes. +---- + .. _class_VisualServer_method_force_draw: - void **force_draw** **(** :ref:`bool` swap_buffers=true, :ref:`float` frame_step=0.0 **)** +---- + .. _class_VisualServer_method_force_sync: - void **force_sync** **(** **)** Synchronizes threads. +---- + .. _class_VisualServer_method_free_rid: - void **free_rid** **(** :ref:`RID` rid **)** Tries to free an object in the VisualServer. +---- + .. _class_VisualServer_method_get_render_info: - :ref:`int` **get_render_info** **(** :ref:`RenderInfo` info **)** Returns a certain information, see RENDER_INFO\_\* for options. +---- + .. _class_VisualServer_method_get_test_cube: - :ref:`RID` **get_test_cube** **(** **)** Returns the id of the test cube. Creates one if none exists. +---- + .. _class_VisualServer_method_get_test_texture: - :ref:`RID` **get_test_texture** **(** **)** Returns the id of the test texture. Creates one if none exists. +---- + .. _class_VisualServer_method_get_white_texture: - :ref:`RID` **get_white_texture** **(** **)** Returns the id of a white texture. Creates one if none exists. +---- + .. _class_VisualServer_method_gi_probe_create: - :ref:`RID` **gi_probe_create** **(** **)** +---- + .. _class_VisualServer_method_gi_probe_get_bias: - :ref:`float` **gi_probe_get_bias** **(** :ref:`RID` probe **)** const +---- + .. _class_VisualServer_method_gi_probe_get_bounds: - :ref:`AABB` **gi_probe_get_bounds** **(** :ref:`RID` probe **)** const +---- + .. _class_VisualServer_method_gi_probe_get_cell_size: - :ref:`float` **gi_probe_get_cell_size** **(** :ref:`RID` probe **)** const +---- + .. _class_VisualServer_method_gi_probe_get_dynamic_data: - :ref:`PoolIntArray` **gi_probe_get_dynamic_data** **(** :ref:`RID` probe **)** const +---- + .. _class_VisualServer_method_gi_probe_get_dynamic_range: - :ref:`int` **gi_probe_get_dynamic_range** **(** :ref:`RID` probe **)** const +---- + .. _class_VisualServer_method_gi_probe_get_energy: - :ref:`float` **gi_probe_get_energy** **(** :ref:`RID` probe **)** const +---- + .. _class_VisualServer_method_gi_probe_get_normal_bias: - :ref:`float` **gi_probe_get_normal_bias** **(** :ref:`RID` probe **)** const +---- + .. _class_VisualServer_method_gi_probe_get_propagation: - :ref:`float` **gi_probe_get_propagation** **(** :ref:`RID` probe **)** const +---- + .. _class_VisualServer_method_gi_probe_get_to_cell_xform: - :ref:`Transform` **gi_probe_get_to_cell_xform** **(** :ref:`RID` probe **)** const +---- + .. _class_VisualServer_method_gi_probe_is_compressed: - :ref:`bool` **gi_probe_is_compressed** **(** :ref:`RID` probe **)** const +---- + .. _class_VisualServer_method_gi_probe_is_interior: - :ref:`bool` **gi_probe_is_interior** **(** :ref:`RID` probe **)** const +---- + .. _class_VisualServer_method_gi_probe_set_bias: - void **gi_probe_set_bias** **(** :ref:`RID` probe, :ref:`float` bias **)** +---- + .. _class_VisualServer_method_gi_probe_set_bounds: - void **gi_probe_set_bounds** **(** :ref:`RID` probe, :ref:`AABB` bounds **)** +---- + .. _class_VisualServer_method_gi_probe_set_cell_size: - void **gi_probe_set_cell_size** **(** :ref:`RID` probe, :ref:`float` range **)** +---- + .. _class_VisualServer_method_gi_probe_set_compress: - void **gi_probe_set_compress** **(** :ref:`RID` probe, :ref:`bool` enable **)** +---- + .. _class_VisualServer_method_gi_probe_set_dynamic_data: - void **gi_probe_set_dynamic_data** **(** :ref:`RID` probe, :ref:`PoolIntArray` data **)** +---- + .. _class_VisualServer_method_gi_probe_set_dynamic_range: - void **gi_probe_set_dynamic_range** **(** :ref:`RID` probe, :ref:`int` range **)** +---- + .. _class_VisualServer_method_gi_probe_set_energy: - void **gi_probe_set_energy** **(** :ref:`RID` probe, :ref:`float` energy **)** +---- + .. _class_VisualServer_method_gi_probe_set_interior: - void **gi_probe_set_interior** **(** :ref:`RID` probe, :ref:`bool` enable **)** +---- + .. _class_VisualServer_method_gi_probe_set_normal_bias: - void **gi_probe_set_normal_bias** **(** :ref:`RID` probe, :ref:`float` bias **)** +---- + .. _class_VisualServer_method_gi_probe_set_propagation: - void **gi_probe_set_propagation** **(** :ref:`RID` probe, :ref:`float` propagation **)** +---- + .. _class_VisualServer_method_gi_probe_set_to_cell_xform: - void **gi_probe_set_to_cell_xform** **(** :ref:`RID` probe, :ref:`Transform` xform **)** +---- + .. _class_VisualServer_method_has_changed: - :ref:`bool` **has_changed** **(** **)** const Returns ``true`` if changes have been made to the VisualServer's data. :ref:`draw` is usually called if this happens. +---- + .. _class_VisualServer_method_has_feature: - :ref:`bool` **has_feature** **(** :ref:`Features` feature **)** const +---- + .. _class_VisualServer_method_has_os_feature: - :ref:`bool` **has_os_feature** **(** :ref:`String` feature **)** const Returns ``true`` if the OS supports a certain feature. Features might be s3tc, etc, etc2 and pvrtc, +---- + .. _class_VisualServer_method_immediate_begin: - void **immediate_begin** **(** :ref:`RID` immediate, :ref:`PrimitiveType` primitive, :ref:`RID` texture **)** +---- + .. _class_VisualServer_method_immediate_clear: - void **immediate_clear** **(** :ref:`RID` immediate **)** +---- + .. _class_VisualServer_method_immediate_color: - void **immediate_color** **(** :ref:`RID` immediate, :ref:`Color` color **)** +---- + .. _class_VisualServer_method_immediate_create: - :ref:`RID` **immediate_create** **(** **)** +---- + .. _class_VisualServer_method_immediate_end: - void **immediate_end** **(** :ref:`RID` immediate **)** +---- + .. _class_VisualServer_method_immediate_get_material: - :ref:`RID` **immediate_get_material** **(** :ref:`RID` immediate **)** const +---- + .. _class_VisualServer_method_immediate_normal: - void **immediate_normal** **(** :ref:`RID` immediate, :ref:`Vector3` normal **)** +---- + .. _class_VisualServer_method_immediate_set_material: - void **immediate_set_material** **(** :ref:`RID` immediate, :ref:`RID` material **)** +---- + .. _class_VisualServer_method_immediate_tangent: - void **immediate_tangent** **(** :ref:`RID` immediate, :ref:`Plane` tangent **)** +---- + .. _class_VisualServer_method_immediate_uv: - void **immediate_uv** **(** :ref:`RID` immediate, :ref:`Vector2` tex_uv **)** +---- + .. _class_VisualServer_method_immediate_uv2: - void **immediate_uv2** **(** :ref:`RID` immediate, :ref:`Vector2` tex_uv **)** +---- + .. _class_VisualServer_method_immediate_vertex: - void **immediate_vertex** **(** :ref:`RID` immediate, :ref:`Vector3` vertex **)** +---- + .. _class_VisualServer_method_immediate_vertex_2d: - void **immediate_vertex_2d** **(** :ref:`RID` immediate, :ref:`Vector2` vertex **)** +---- + .. _class_VisualServer_method_init: - void **init** **(** **)** Initializes the visual server. +---- + .. _class_VisualServer_method_instance_attach_object_instance_id: - void **instance_attach_object_instance_id** **(** :ref:`RID` instance, :ref:`int` id **)** +---- + .. _class_VisualServer_method_instance_attach_skeleton: - void **instance_attach_skeleton** **(** :ref:`RID` instance, :ref:`RID` skeleton **)** +---- + .. _class_VisualServer_method_instance_create: - :ref:`RID` **instance_create** **(** **)** +---- + .. _class_VisualServer_method_instance_create2: - :ref:`RID` **instance_create2** **(** :ref:`RID` base, :ref:`RID` scenario **)** +---- + .. _class_VisualServer_method_instance_geometry_set_as_instance_lod: - void **instance_geometry_set_as_instance_lod** **(** :ref:`RID` instance, :ref:`RID` as_lod_of_instance **)** +---- + .. _class_VisualServer_method_instance_geometry_set_cast_shadows_setting: - void **instance_geometry_set_cast_shadows_setting** **(** :ref:`RID` instance, :ref:`ShadowCastingSetting` shadow_casting_setting **)** +---- + .. _class_VisualServer_method_instance_geometry_set_draw_range: - void **instance_geometry_set_draw_range** **(** :ref:`RID` instance, :ref:`float` min, :ref:`float` max, :ref:`float` min_margin, :ref:`float` max_margin **)** +---- + .. _class_VisualServer_method_instance_geometry_set_flag: - void **instance_geometry_set_flag** **(** :ref:`RID` instance, :ref:`InstanceFlags` flag, :ref:`bool` enabled **)** +---- + .. _class_VisualServer_method_instance_geometry_set_material_override: - void **instance_geometry_set_material_override** **(** :ref:`RID` instance, :ref:`RID` material **)** +---- + .. _class_VisualServer_method_instance_set_base: - void **instance_set_base** **(** :ref:`RID` instance, :ref:`RID` base **)** +---- + .. _class_VisualServer_method_instance_set_blend_shape_weight: - void **instance_set_blend_shape_weight** **(** :ref:`RID` instance, :ref:`int` shape, :ref:`float` weight **)** +---- + .. _class_VisualServer_method_instance_set_custom_aabb: - void **instance_set_custom_aabb** **(** :ref:`RID` instance, :ref:`AABB` aabb **)** +---- + .. _class_VisualServer_method_instance_set_exterior: - void **instance_set_exterior** **(** :ref:`RID` instance, :ref:`bool` enabled **)** +---- + .. _class_VisualServer_method_instance_set_extra_visibility_margin: - void **instance_set_extra_visibility_margin** **(** :ref:`RID` instance, :ref:`float` margin **)** +---- + .. _class_VisualServer_method_instance_set_layer_mask: - void **instance_set_layer_mask** **(** :ref:`RID` instance, :ref:`int` mask **)** +---- + .. _class_VisualServer_method_instance_set_scenario: - void **instance_set_scenario** **(** :ref:`RID` instance, :ref:`RID` scenario **)** +---- + .. _class_VisualServer_method_instance_set_surface_material: - void **instance_set_surface_material** **(** :ref:`RID` instance, :ref:`int` surface, :ref:`RID` material **)** +---- + .. _class_VisualServer_method_instance_set_transform: - void **instance_set_transform** **(** :ref:`RID` instance, :ref:`Transform` transform **)** +---- + .. _class_VisualServer_method_instance_set_use_lightmap: - void **instance_set_use_lightmap** **(** :ref:`RID` instance, :ref:`RID` lightmap_instance, :ref:`RID` lightmap **)** +---- + .. _class_VisualServer_method_instance_set_visible: - void **instance_set_visible** **(** :ref:`RID` instance, :ref:`bool` visible **)** +---- + .. _class_VisualServer_method_instances_cull_aabb: - :ref:`Array` **instances_cull_aabb** **(** :ref:`AABB` aabb, :ref:`RID` scenario **)** const +---- + .. _class_VisualServer_method_instances_cull_convex: - :ref:`Array` **instances_cull_convex** **(** :ref:`Array` convex, :ref:`RID` scenario **)** const +---- + .. _class_VisualServer_method_instances_cull_ray: - :ref:`Array` **instances_cull_ray** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`RID` scenario **)** const @@ -2612,514 +3030,738 @@ Returns an array of object IDs intersecting with the provided 3D ray. Only visua Warning: this function is primarily intended for editor usage. For in-game use cases, prefer physics collision. +---- + .. _class_VisualServer_method_light_directional_set_blend_splits: - void **light_directional_set_blend_splits** **(** :ref:`RID` light, :ref:`bool` enable **)** +---- + .. _class_VisualServer_method_light_directional_set_shadow_depth_range_mode: - void **light_directional_set_shadow_depth_range_mode** **(** :ref:`RID` light, :ref:`LightDirectionalShadowDepthRangeMode` range_mode **)** +---- + .. _class_VisualServer_method_light_directional_set_shadow_mode: - void **light_directional_set_shadow_mode** **(** :ref:`RID` light, :ref:`LightDirectionalShadowMode` mode **)** +---- + .. _class_VisualServer_method_light_omni_set_shadow_detail: - void **light_omni_set_shadow_detail** **(** :ref:`RID` light, :ref:`LightOmniShadowDetail` detail **)** +---- + .. _class_VisualServer_method_light_omni_set_shadow_mode: - void **light_omni_set_shadow_mode** **(** :ref:`RID` light, :ref:`LightOmniShadowMode` mode **)** +---- + .. _class_VisualServer_method_light_set_color: - void **light_set_color** **(** :ref:`RID` light, :ref:`Color` color **)** +---- + .. _class_VisualServer_method_light_set_cull_mask: - void **light_set_cull_mask** **(** :ref:`RID` light, :ref:`int` mask **)** +---- + .. _class_VisualServer_method_light_set_negative: - void **light_set_negative** **(** :ref:`RID` light, :ref:`bool` enable **)** +---- + .. _class_VisualServer_method_light_set_param: - void **light_set_param** **(** :ref:`RID` light, :ref:`LightParam` param, :ref:`float` value **)** +---- + .. _class_VisualServer_method_light_set_projector: - void **light_set_projector** **(** :ref:`RID` light, :ref:`RID` texture **)** +---- + .. _class_VisualServer_method_light_set_reverse_cull_face_mode: - void **light_set_reverse_cull_face_mode** **(** :ref:`RID` light, :ref:`bool` enabled **)** +---- + .. _class_VisualServer_method_light_set_shadow: - void **light_set_shadow** **(** :ref:`RID` light, :ref:`bool` enabled **)** +---- + .. _class_VisualServer_method_light_set_shadow_color: - void **light_set_shadow_color** **(** :ref:`RID` light, :ref:`Color` color **)** +---- + .. _class_VisualServer_method_lightmap_capture_create: - :ref:`RID` **lightmap_capture_create** **(** **)** +---- + .. _class_VisualServer_method_lightmap_capture_get_bounds: - :ref:`AABB` **lightmap_capture_get_bounds** **(** :ref:`RID` capture **)** const +---- + .. _class_VisualServer_method_lightmap_capture_get_energy: - :ref:`float` **lightmap_capture_get_energy** **(** :ref:`RID` capture **)** const +---- + .. _class_VisualServer_method_lightmap_capture_get_octree: - :ref:`PoolByteArray` **lightmap_capture_get_octree** **(** :ref:`RID` capture **)** const +---- + .. _class_VisualServer_method_lightmap_capture_get_octree_cell_subdiv: - :ref:`int` **lightmap_capture_get_octree_cell_subdiv** **(** :ref:`RID` capture **)** const +---- + .. _class_VisualServer_method_lightmap_capture_get_octree_cell_transform: - :ref:`Transform` **lightmap_capture_get_octree_cell_transform** **(** :ref:`RID` capture **)** const +---- + .. _class_VisualServer_method_lightmap_capture_set_bounds: - void **lightmap_capture_set_bounds** **(** :ref:`RID` capture, :ref:`AABB` bounds **)** +---- + .. _class_VisualServer_method_lightmap_capture_set_energy: - void **lightmap_capture_set_energy** **(** :ref:`RID` capture, :ref:`float` energy **)** +---- + .. _class_VisualServer_method_lightmap_capture_set_octree: - void **lightmap_capture_set_octree** **(** :ref:`RID` capture, :ref:`PoolByteArray` octree **)** +---- + .. _class_VisualServer_method_lightmap_capture_set_octree_cell_subdiv: - void **lightmap_capture_set_octree_cell_subdiv** **(** :ref:`RID` capture, :ref:`int` subdiv **)** +---- + .. _class_VisualServer_method_lightmap_capture_set_octree_cell_transform: - void **lightmap_capture_set_octree_cell_transform** **(** :ref:`RID` capture, :ref:`Transform` xform **)** +---- + .. _class_VisualServer_method_make_sphere_mesh: - :ref:`RID` **make_sphere_mesh** **(** :ref:`int` latitudes, :ref:`int` longitudes, :ref:`float` radius **)** Returns a mesh of a sphere with the given amount of horizontal and vertical subdivisions. +---- + .. _class_VisualServer_method_material_create: - :ref:`RID` **material_create** **(** **)** Returns an empty material. +---- + .. _class_VisualServer_method_material_get_param: - :ref:`Variant` **material_get_param** **(** :ref:`RID` material, :ref:`String` parameter **)** const Returns the value of a certain material's parameter. +---- + .. _class_VisualServer_method_material_get_param_default: - :ref:`Variant` **material_get_param_default** **(** :ref:`RID` material, :ref:`String` parameter **)** const +---- + .. _class_VisualServer_method_material_get_shader: - :ref:`RID` **material_get_shader** **(** :ref:`RID` shader_material **)** const Returns the shader of a certain material's shader. Returns an empty RID if the material doesn't have a shader. +---- + .. _class_VisualServer_method_material_set_line_width: - void **material_set_line_width** **(** :ref:`RID` material, :ref:`float` width **)** Sets a materials line width. +---- + .. _class_VisualServer_method_material_set_next_pass: - void **material_set_next_pass** **(** :ref:`RID` material, :ref:`RID` next_material **)** Sets an objects next material. +---- + .. _class_VisualServer_method_material_set_param: - void **material_set_param** **(** :ref:`RID` material, :ref:`String` parameter, :ref:`Variant` value **)** Sets a materials parameter. +---- + .. _class_VisualServer_method_material_set_render_priority: - void **material_set_render_priority** **(** :ref:`RID` material, :ref:`int` priority **)** Sets a material's render priority. +---- + .. _class_VisualServer_method_material_set_shader: - void **material_set_shader** **(** :ref:`RID` shader_material, :ref:`RID` shader **)** Sets a shader material's shader. +---- + .. _class_VisualServer_method_mesh_add_surface_from_arrays: - void **mesh_add_surface_from_arrays** **(** :ref:`RID` mesh, :ref:`PrimitiveType` primtive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[ ], :ref:`int` compress_format=97280 **)** Adds a surface generated from the Arrays to a mesh. See PRIMITIVE_TYPE\_\* constants for types. +---- + .. _class_VisualServer_method_mesh_clear: - void **mesh_clear** **(** :ref:`RID` mesh **)** Removes all surfaces from a mesh. +---- + .. _class_VisualServer_method_mesh_create: - :ref:`RID` **mesh_create** **(** **)** Creates a new mesh. +---- + .. _class_VisualServer_method_mesh_get_blend_shape_count: - :ref:`int` **mesh_get_blend_shape_count** **(** :ref:`RID` mesh **)** const Returns a mesh's blend shape count. +---- + .. _class_VisualServer_method_mesh_get_blend_shape_mode: - :ref:`BlendShapeMode` **mesh_get_blend_shape_mode** **(** :ref:`RID` mesh **)** const Returns a mesh's blend shape mode. +---- + .. _class_VisualServer_method_mesh_get_custom_aabb: - :ref:`AABB` **mesh_get_custom_aabb** **(** :ref:`RID` mesh **)** const Returns a mesh's custom aabb. +---- + .. _class_VisualServer_method_mesh_get_surface_count: - :ref:`int` **mesh_get_surface_count** **(** :ref:`RID` mesh **)** const Returns a mesh's number of surfaces. +---- + .. _class_VisualServer_method_mesh_remove_surface: - void **mesh_remove_surface** **(** :ref:`RID` mesh, :ref:`int` index **)** Removes a mesh's surface. +---- + .. _class_VisualServer_method_mesh_set_blend_shape_count: - void **mesh_set_blend_shape_count** **(** :ref:`RID` mesh, :ref:`int` amount **)** Sets a mesh's blend shape count. +---- + .. _class_VisualServer_method_mesh_set_blend_shape_mode: - void **mesh_set_blend_shape_mode** **(** :ref:`RID` mesh, :ref:`BlendShapeMode` mode **)** Sets a mesh's blend shape mode. +---- + .. _class_VisualServer_method_mesh_set_custom_aabb: - void **mesh_set_custom_aabb** **(** :ref:`RID` mesh, :ref:`AABB` aabb **)** Sets a mesh's custom aabb. +---- + .. _class_VisualServer_method_mesh_surface_get_aabb: - :ref:`AABB` **mesh_surface_get_aabb** **(** :ref:`RID` mesh, :ref:`int` surface **)** const Returns a mesh's surface's aabb. +---- + .. _class_VisualServer_method_mesh_surface_get_array: - :ref:`PoolByteArray` **mesh_surface_get_array** **(** :ref:`RID` mesh, :ref:`int` surface **)** const Returns a mesh's surface's vertex buffer. +---- + .. _class_VisualServer_method_mesh_surface_get_array_index_len: - :ref:`int` **mesh_surface_get_array_index_len** **(** :ref:`RID` mesh, :ref:`int` surface **)** const Returns a mesh's surface's amount of indices. +---- + .. _class_VisualServer_method_mesh_surface_get_array_len: - :ref:`int` **mesh_surface_get_array_len** **(** :ref:`RID` mesh, :ref:`int` surface **)** const Returns a mesh's surface's amount of vertices. +---- + .. _class_VisualServer_method_mesh_surface_get_arrays: - :ref:`Array` **mesh_surface_get_arrays** **(** :ref:`RID` mesh, :ref:`int` surface **)** const Returns a mesh's surface's buffer arrays. +---- + .. _class_VisualServer_method_mesh_surface_get_blend_shape_arrays: - :ref:`Array` **mesh_surface_get_blend_shape_arrays** **(** :ref:`RID` mesh, :ref:`int` surface **)** const Returns a mesh's surface's arrays for blend shapes +---- + .. _class_VisualServer_method_mesh_surface_get_format: - :ref:`int` **mesh_surface_get_format** **(** :ref:`RID` mesh, :ref:`int` surface **)** const Returns the format of a mesh's surface. +---- + .. _class_VisualServer_method_mesh_surface_get_format_offset: - :ref:`int` **mesh_surface_get_format_offset** **(** :ref:`int` format, :ref:`int` vertex_len, :ref:`int` index_len, :ref:`int` array_index **)** const +---- + .. _class_VisualServer_method_mesh_surface_get_format_stride: - :ref:`int` **mesh_surface_get_format_stride** **(** :ref:`int` format, :ref:`int` vertex_len, :ref:`int` index_len **)** const +---- + .. _class_VisualServer_method_mesh_surface_get_index_array: - :ref:`PoolByteArray` **mesh_surface_get_index_array** **(** :ref:`RID` mesh, :ref:`int` surface **)** const Returns a mesh's surface's index buffer. +---- + .. _class_VisualServer_method_mesh_surface_get_material: - :ref:`RID` **mesh_surface_get_material** **(** :ref:`RID` mesh, :ref:`int` surface **)** const Returns a mesh's surface's material. +---- + .. _class_VisualServer_method_mesh_surface_get_primitive_type: - :ref:`PrimitiveType` **mesh_surface_get_primitive_type** **(** :ref:`RID` mesh, :ref:`int` surface **)** const Returns the primitive type of a mesh's surface. +---- + .. _class_VisualServer_method_mesh_surface_get_skeleton_aabb: - :ref:`Array` **mesh_surface_get_skeleton_aabb** **(** :ref:`RID` mesh, :ref:`int` surface **)** const Returns the aabb of a mesh's surface's skeleton. +---- + .. _class_VisualServer_method_mesh_surface_set_material: - void **mesh_surface_set_material** **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`RID` material **)** Sets a mesh's surface's material. +---- + .. _class_VisualServer_method_mesh_surface_update_region: - void **mesh_surface_update_region** **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`int` offset, :ref:`PoolByteArray` data **)** +---- + .. _class_VisualServer_method_multimesh_allocate: - void **multimesh_allocate** **(** :ref:`RID` multimesh, :ref:`int` instances, :ref:`MultimeshTransformFormat` transform_format, :ref:`MultimeshColorFormat` color_format, :ref:`MultimeshCustomDataFormat` custom_data_format=0 **)** +---- + .. _class_VisualServer_method_multimesh_get_aabb: - :ref:`AABB` **multimesh_get_aabb** **(** :ref:`RID` multimesh **)** const +---- + .. _class_VisualServer_method_multimesh_get_instance_count: - :ref:`int` **multimesh_get_instance_count** **(** :ref:`RID` multimesh **)** const +---- + .. _class_VisualServer_method_multimesh_get_mesh: - :ref:`RID` **multimesh_get_mesh** **(** :ref:`RID` multimesh **)** const +---- + .. _class_VisualServer_method_multimesh_get_visible_instances: - :ref:`int` **multimesh_get_visible_instances** **(** :ref:`RID` multimesh **)** const +---- + .. _class_VisualServer_method_multimesh_instance_get_color: - :ref:`Color` **multimesh_instance_get_color** **(** :ref:`RID` multimesh, :ref:`int` index **)** const +---- + .. _class_VisualServer_method_multimesh_instance_get_custom_data: - :ref:`Color` **multimesh_instance_get_custom_data** **(** :ref:`RID` multimesh, :ref:`int` index **)** const +---- + .. _class_VisualServer_method_multimesh_instance_get_transform: - :ref:`Transform` **multimesh_instance_get_transform** **(** :ref:`RID` multimesh, :ref:`int` index **)** const +---- + .. _class_VisualServer_method_multimesh_instance_get_transform_2d: - :ref:`Transform2D` **multimesh_instance_get_transform_2d** **(** :ref:`RID` multimesh, :ref:`int` index **)** const +---- + .. _class_VisualServer_method_multimesh_instance_set_color: - void **multimesh_instance_set_color** **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Color` color **)** +---- + .. _class_VisualServer_method_multimesh_instance_set_custom_data: - void **multimesh_instance_set_custom_data** **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Color` custom_data **)** +---- + .. _class_VisualServer_method_multimesh_instance_set_transform: - void **multimesh_instance_set_transform** **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Transform` transform **)** +---- + .. _class_VisualServer_method_multimesh_instance_set_transform_2d: - void **multimesh_instance_set_transform_2d** **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Transform2D` transform **)** +---- + .. _class_VisualServer_method_multimesh_set_as_bulk_array: - void **multimesh_set_as_bulk_array** **(** :ref:`RID` multimesh, :ref:`PoolRealArray` array **)** +---- + .. _class_VisualServer_method_multimesh_set_mesh: - void **multimesh_set_mesh** **(** :ref:`RID` multimesh, :ref:`RID` mesh **)** +---- + .. _class_VisualServer_method_multimesh_set_visible_instances: - void **multimesh_set_visible_instances** **(** :ref:`RID` multimesh, :ref:`int` visible **)** +---- + .. _class_VisualServer_method_omni_light_create: - :ref:`RID` **omni_light_create** **(** **)** +---- + .. _class_VisualServer_method_particles_create: - :ref:`RID` **particles_create** **(** **)** +---- + .. _class_VisualServer_method_particles_get_current_aabb: - :ref:`AABB` **particles_get_current_aabb** **(** :ref:`RID` particles **)** +---- + .. _class_VisualServer_method_particles_get_emitting: - :ref:`bool` **particles_get_emitting** **(** :ref:`RID` particles **)** +---- + .. _class_VisualServer_method_particles_restart: - void **particles_restart** **(** :ref:`RID` particles **)** +---- + .. _class_VisualServer_method_particles_set_amount: - void **particles_set_amount** **(** :ref:`RID` particles, :ref:`int` amount **)** +---- + .. _class_VisualServer_method_particles_set_custom_aabb: - void **particles_set_custom_aabb** **(** :ref:`RID` particles, :ref:`AABB` aabb **)** +---- + .. _class_VisualServer_method_particles_set_draw_order: - void **particles_set_draw_order** **(** :ref:`RID` particles, :ref:`ParticlesDrawOrder` order **)** +---- + .. _class_VisualServer_method_particles_set_draw_pass_mesh: - void **particles_set_draw_pass_mesh** **(** :ref:`RID` particles, :ref:`int` pass, :ref:`RID` mesh **)** +---- + .. _class_VisualServer_method_particles_set_draw_passes: - void **particles_set_draw_passes** **(** :ref:`RID` particles, :ref:`int` count **)** +---- + .. _class_VisualServer_method_particles_set_emission_transform: - void **particles_set_emission_transform** **(** :ref:`RID` particles, :ref:`Transform` transform **)** +---- + .. _class_VisualServer_method_particles_set_emitting: - void **particles_set_emitting** **(** :ref:`RID` particles, :ref:`bool` emitting **)** +---- + .. _class_VisualServer_method_particles_set_explosiveness_ratio: - void **particles_set_explosiveness_ratio** **(** :ref:`RID` particles, :ref:`float` ratio **)** +---- + .. _class_VisualServer_method_particles_set_fixed_fps: - void **particles_set_fixed_fps** **(** :ref:`RID` particles, :ref:`int` fps **)** +---- + .. _class_VisualServer_method_particles_set_fractional_delta: - void **particles_set_fractional_delta** **(** :ref:`RID` particles, :ref:`bool` enable **)** +---- + .. _class_VisualServer_method_particles_set_lifetime: - void **particles_set_lifetime** **(** :ref:`RID` particles, :ref:`float` lifetime **)** +---- + .. _class_VisualServer_method_particles_set_one_shot: - void **particles_set_one_shot** **(** :ref:`RID` particles, :ref:`bool` one_shot **)** +---- + .. _class_VisualServer_method_particles_set_pre_process_time: - void **particles_set_pre_process_time** **(** :ref:`RID` particles, :ref:`float` time **)** +---- + .. _class_VisualServer_method_particles_set_process_material: - void **particles_set_process_material** **(** :ref:`RID` particles, :ref:`RID` material **)** +---- + .. _class_VisualServer_method_particles_set_randomness_ratio: - void **particles_set_randomness_ratio** **(** :ref:`RID` particles, :ref:`float` ratio **)** +---- + .. _class_VisualServer_method_particles_set_speed_scale: - void **particles_set_speed_scale** **(** :ref:`RID` particles, :ref:`float` scale **)** +---- + .. _class_VisualServer_method_particles_set_use_local_coordinates: - void **particles_set_use_local_coordinates** **(** :ref:`RID` particles, :ref:`bool` enable **)** +---- + .. _class_VisualServer_method_reflection_probe_create: - :ref:`RID` **reflection_probe_create** **(** **)** +---- + .. _class_VisualServer_method_reflection_probe_set_as_interior: - void **reflection_probe_set_as_interior** **(** :ref:`RID` probe, :ref:`bool` enable **)** +---- + .. _class_VisualServer_method_reflection_probe_set_cull_mask: - void **reflection_probe_set_cull_mask** **(** :ref:`RID` probe, :ref:`int` layers **)** +---- + .. _class_VisualServer_method_reflection_probe_set_enable_box_projection: - void **reflection_probe_set_enable_box_projection** **(** :ref:`RID` probe, :ref:`bool` enable **)** +---- + .. _class_VisualServer_method_reflection_probe_set_enable_shadows: - void **reflection_probe_set_enable_shadows** **(** :ref:`RID` probe, :ref:`bool` enable **)** +---- + .. _class_VisualServer_method_reflection_probe_set_extents: - void **reflection_probe_set_extents** **(** :ref:`RID` probe, :ref:`Vector3` extents **)** +---- + .. _class_VisualServer_method_reflection_probe_set_intensity: - void **reflection_probe_set_intensity** **(** :ref:`RID` probe, :ref:`float` intensity **)** +---- + .. _class_VisualServer_method_reflection_probe_set_interior_ambient: - void **reflection_probe_set_interior_ambient** **(** :ref:`RID` probe, :ref:`Color` color **)** +---- + .. _class_VisualServer_method_reflection_probe_set_interior_ambient_energy: - void **reflection_probe_set_interior_ambient_energy** **(** :ref:`RID` probe, :ref:`float` energy **)** +---- + .. _class_VisualServer_method_reflection_probe_set_interior_ambient_probe_contribution: - void **reflection_probe_set_interior_ambient_probe_contribution** **(** :ref:`RID` probe, :ref:`float` contrib **)** +---- + .. _class_VisualServer_method_reflection_probe_set_max_distance: - void **reflection_probe_set_max_distance** **(** :ref:`RID` probe, :ref:`float` distance **)** +---- + .. _class_VisualServer_method_reflection_probe_set_origin_offset: - void **reflection_probe_set_origin_offset** **(** :ref:`RID` probe, :ref:`Vector3` offset **)** +---- + .. _class_VisualServer_method_reflection_probe_set_update_mode: - void **reflection_probe_set_update_mode** **(** :ref:`RID` probe, :ref:`ReflectionProbeUpdateMode` mode **)** +---- + .. _class_VisualServer_method_request_frame_drawn_callback: - void **request_frame_drawn_callback** **(** :ref:`Object` where, :ref:`String` method, :ref:`Variant` userdata **)** @@ -3128,288 +3770,398 @@ Schedules a callback to the corresponding named 'method' on 'where' after a fram The callback method must use only 1 argument which will be called with 'userdata'. +---- + .. _class_VisualServer_method_scenario_create: - :ref:`RID` **scenario_create** **(** **)** +---- + .. _class_VisualServer_method_scenario_set_debug: - void **scenario_set_debug** **(** :ref:`RID` scenario, :ref:`ScenarioDebugMode` debug_mode **)** +---- + .. _class_VisualServer_method_scenario_set_environment: - void **scenario_set_environment** **(** :ref:`RID` scenario, :ref:`RID` environment **)** +---- + .. _class_VisualServer_method_scenario_set_fallback_environment: - void **scenario_set_fallback_environment** **(** :ref:`RID` scenario, :ref:`RID` environment **)** +---- + .. _class_VisualServer_method_scenario_set_reflection_atlas_size: - void **scenario_set_reflection_atlas_size** **(** :ref:`RID` scenario, :ref:`int` size, :ref:`int` subdiv **)** +---- + .. _class_VisualServer_method_set_boot_image: - void **set_boot_image** **(** :ref:`Image` image, :ref:`Color` color, :ref:`bool` scale **)** Sets a boot image. The color defines the background color and if scale is ``true`` the image will be scaled to fit the screen size. +---- + .. _class_VisualServer_method_set_debug_generate_wireframes: - void **set_debug_generate_wireframes** **(** :ref:`bool` generate **)** +---- + .. _class_VisualServer_method_set_default_clear_color: - void **set_default_clear_color** **(** :ref:`Color` color **)** +---- + .. _class_VisualServer_method_shader_create: - :ref:`RID` **shader_create** **(** **)** Creates an empty shader. +---- + .. _class_VisualServer_method_shader_get_code: - :ref:`String` **shader_get_code** **(** :ref:`RID` shader **)** const Returns a shader's code. +---- + .. _class_VisualServer_method_shader_get_default_texture_param: - :ref:`RID` **shader_get_default_texture_param** **(** :ref:`RID` shader, :ref:`String` name **)** const Returns a default texture from a shader searched by name. +---- + .. _class_VisualServer_method_shader_get_param_list: - :ref:`Array` **shader_get_param_list** **(** :ref:`RID` shader **)** const Returns the parameters of a shader. +---- + .. _class_VisualServer_method_shader_set_code: - void **shader_set_code** **(** :ref:`RID` shader, :ref:`String` code **)** Sets a shader's code. +---- + .. _class_VisualServer_method_shader_set_default_texture_param: - void **shader_set_default_texture_param** **(** :ref:`RID` shader, :ref:`String` name, :ref:`RID` texture **)** Sets a shader's default texture. Overwrites the texture given by name. +---- + .. _class_VisualServer_method_skeleton_allocate: - void **skeleton_allocate** **(** :ref:`RID` skeleton, :ref:`int` bones, :ref:`bool` is_2d_skeleton=false **)** +---- + .. _class_VisualServer_method_skeleton_bone_get_transform: - :ref:`Transform` **skeleton_bone_get_transform** **(** :ref:`RID` skeleton, :ref:`int` bone **)** const +---- + .. _class_VisualServer_method_skeleton_bone_get_transform_2d: - :ref:`Transform2D` **skeleton_bone_get_transform_2d** **(** :ref:`RID` skeleton, :ref:`int` bone **)** const +---- + .. _class_VisualServer_method_skeleton_bone_set_transform: - void **skeleton_bone_set_transform** **(** :ref:`RID` skeleton, :ref:`int` bone, :ref:`Transform` transform **)** +---- + .. _class_VisualServer_method_skeleton_bone_set_transform_2d: - void **skeleton_bone_set_transform_2d** **(** :ref:`RID` skeleton, :ref:`int` bone, :ref:`Transform2D` transform **)** +---- + .. _class_VisualServer_method_skeleton_create: - :ref:`RID` **skeleton_create** **(** **)** +---- + .. _class_VisualServer_method_skeleton_get_bone_count: - :ref:`int` **skeleton_get_bone_count** **(** :ref:`RID` skeleton **)** const +---- + .. _class_VisualServer_method_sky_create: - :ref:`RID` **sky_create** **(** **)** Creates an empty sky. +---- + .. _class_VisualServer_method_sky_set_texture: - void **sky_set_texture** **(** :ref:`RID` sky, :ref:`RID` cube_map, :ref:`int` radiance_size **)** Sets a sky's texture. +---- + .. _class_VisualServer_method_spot_light_create: - :ref:`RID` **spot_light_create** **(** **)** +---- + .. _class_VisualServer_method_sync: - void **sync** **(** **)** +---- + .. _class_VisualServer_method_texture_allocate: - void **texture_allocate** **(** :ref:`RID` texture, :ref:`int` width, :ref:`int` height, :ref:`int` depth_3d, :ref:`Format` format, :ref:`TextureType` type, :ref:`int` flags=7 **)** +---- + .. _class_VisualServer_method_texture_create: - :ref:`RID` **texture_create** **(** **)** Creates an empty texture. +---- + .. _class_VisualServer_method_texture_create_from_image: - :ref:`RID` **texture_create_from_image** **(** :ref:`Image` image, :ref:`int` flags=7 **)** Creates a texture, allocates the space for an image, and fills in the image. +---- + .. _class_VisualServer_method_texture_debug_usage: - :ref:`Array` **texture_debug_usage** **(** **)** Returns a list of all the textures and their information. +---- + .. _class_VisualServer_method_texture_get_data: - :ref:`Image` **texture_get_data** **(** :ref:`RID` texture, :ref:`int` cube_side=0 **)** const Returns a copy of a texture's image unless it's a CubeMap, in which case it returns the :ref:`RID` of the image at one of the cubes sides. +---- + .. _class_VisualServer_method_texture_get_depth: - :ref:`int` **texture_get_depth** **(** :ref:`RID` texture **)** const +---- + .. _class_VisualServer_method_texture_get_flags: - :ref:`int` **texture_get_flags** **(** :ref:`RID` texture **)** const Returns the flags of a texture. +---- + .. _class_VisualServer_method_texture_get_format: - :ref:`Format` **texture_get_format** **(** :ref:`RID` texture **)** const Returns the format of the texture's image. +---- + .. _class_VisualServer_method_texture_get_height: - :ref:`int` **texture_get_height** **(** :ref:`RID` texture **)** const Returns the texture's height. +---- + .. _class_VisualServer_method_texture_get_path: - :ref:`String` **texture_get_path** **(** :ref:`RID` texture **)** const Returns the texture's path. +---- + .. _class_VisualServer_method_texture_get_texid: - :ref:`int` **texture_get_texid** **(** :ref:`RID` texture **)** const Returns the opengl id of the texture's image. +---- + .. _class_VisualServer_method_texture_get_type: - :ref:`TextureType` **texture_get_type** **(** :ref:`RID` texture **)** const +---- + .. _class_VisualServer_method_texture_get_width: - :ref:`int` **texture_get_width** **(** :ref:`RID` texture **)** const Returns the texture's width. +---- + .. _class_VisualServer_method_texture_set_data: - void **texture_set_data** **(** :ref:`RID` texture, :ref:`Image` image, :ref:`int` layer=0 **)** Sets the texture's image data. If it's a CubeMap, it sets the image data at a cube side. +---- + .. _class_VisualServer_method_texture_set_data_partial: - void **texture_set_data_partial** **(** :ref:`RID` texture, :ref:`Image` image, :ref:`int` src_x, :ref:`int` src_y, :ref:`int` src_w, :ref:`int` src_h, :ref:`int` dst_x, :ref:`int` dst_y, :ref:`int` dst_mip, :ref:`int` layer=0 **)** +---- + .. _class_VisualServer_method_texture_set_flags: - void **texture_set_flags** **(** :ref:`RID` texture, :ref:`int` flags **)** Sets the texture's flags. See :ref:`TextureFlags` for options +---- + .. _class_VisualServer_method_texture_set_path: - void **texture_set_path** **(** :ref:`RID` texture, :ref:`String` path **)** Sets the texture's path. +---- + .. _class_VisualServer_method_texture_set_shrink_all_x2_on_set_data: - void **texture_set_shrink_all_x2_on_set_data** **(** :ref:`bool` shrink **)** If ``true``, sets internal processes to shrink all image data to half the size. +---- + .. _class_VisualServer_method_texture_set_size_override: - void **texture_set_size_override** **(** :ref:`RID` texture, :ref:`int` width, :ref:`int` height, :ref:`int` depth **)** +---- + .. _class_VisualServer_method_textures_keep_original: - void **textures_keep_original** **(** :ref:`bool` enable **)** If ``true``, the image will be stored in the texture's images array if overwritten. +---- + .. _class_VisualServer_method_viewport_attach_camera: - void **viewport_attach_camera** **(** :ref:`RID` viewport, :ref:`RID` camera **)** Sets a viewport's camera. +---- + .. _class_VisualServer_method_viewport_attach_canvas: - void **viewport_attach_canvas** **(** :ref:`RID` viewport, :ref:`RID` canvas **)** Sets a viewport's canvas. +---- + .. _class_VisualServer_method_viewport_attach_to_screen: - void **viewport_attach_to_screen** **(** :ref:`RID` viewport, :ref:`Rect2` rect=Rect2( 0, 0, 0, 0 ), :ref:`int` screen=0 **)** Attaches a viewport to a screen. +---- + .. _class_VisualServer_method_viewport_create: - :ref:`RID` **viewport_create** **(** **)** Creates an empty viewport. +---- + .. _class_VisualServer_method_viewport_detach: - void **viewport_detach** **(** :ref:`RID` viewport **)** Detaches the viewport from the screen. +---- + .. _class_VisualServer_method_viewport_get_render_info: - :ref:`int` **viewport_get_render_info** **(** :ref:`RID` viewport, :ref:`ViewportRenderInfo` info **)** Returns a viewport's render info. for options see VIEWPORT_RENDER_INFO\* constants. +---- + .. _class_VisualServer_method_viewport_get_texture: - :ref:`RID` **viewport_get_texture** **(** :ref:`RID` viewport **)** const Returns the viewport's last rendered frame. +---- + .. _class_VisualServer_method_viewport_remove_canvas: - void **viewport_remove_canvas** **(** :ref:`RID` viewport, :ref:`RID` canvas **)** Detaches a viewport from a canvas and vice versa. +---- + .. _class_VisualServer_method_viewport_set_active: - void **viewport_set_active** **(** :ref:`RID` viewport, :ref:`bool` active **)** If ``true``, sets the viewport active, else sets it inactive. +---- + .. _class_VisualServer_method_viewport_set_canvas_stacking: - void **viewport_set_canvas_stacking** **(** :ref:`RID` viewport, :ref:`RID` canvas, :ref:`int` layer, :ref:`int` sublayer **)** @@ -3418,70 +4170,94 @@ Sets the stacking order for a viewport's canvas. ``layer`` is the actual canvas layer, while ``sublayer`` specifies the stacking order of the canvas among those in the same layer. +---- + .. _class_VisualServer_method_viewport_set_canvas_transform: - void **viewport_set_canvas_transform** **(** :ref:`RID` viewport, :ref:`RID` canvas, :ref:`Transform2D` offset **)** Sets the transformation of a viewport's canvas. +---- + .. _class_VisualServer_method_viewport_set_clear_mode: - void **viewport_set_clear_mode** **(** :ref:`RID` viewport, :ref:`ViewportClearMode` clear_mode **)** Sets the clear mode of a viewport. See :ref:`ViewportClearMode` for options. +---- + .. _class_VisualServer_method_viewport_set_debug_draw: - void **viewport_set_debug_draw** **(** :ref:`RID` viewport, :ref:`ViewportDebugDraw` draw **)** Sets the debug draw mode of a viewport. See :ref:`ViewportDebugDraw` for options. +---- + .. _class_VisualServer_method_viewport_set_disable_3d: - void **viewport_set_disable_3d** **(** :ref:`RID` viewport, :ref:`bool` disabled **)** If ``true``, a viewport's 3D rendering is disabled. +---- + .. _class_VisualServer_method_viewport_set_disable_environment: - void **viewport_set_disable_environment** **(** :ref:`RID` viewport, :ref:`bool` disabled **)** If ``true``, rendering of a viewport's environment is disabled. +---- + .. _class_VisualServer_method_viewport_set_global_canvas_transform: - void **viewport_set_global_canvas_transform** **(** :ref:`RID` viewport, :ref:`Transform2D` transform **)** Sets the viewport's global transformation matrix. +---- + .. _class_VisualServer_method_viewport_set_hdr: - void **viewport_set_hdr** **(** :ref:`RID` viewport, :ref:`bool` enabled **)** If ``true``, the viewport renders to hdr. +---- + .. _class_VisualServer_method_viewport_set_hide_canvas: - void **viewport_set_hide_canvas** **(** :ref:`RID` viewport, :ref:`bool` hidden **)** If ``true``, the viewport's canvas is not rendered. +---- + .. _class_VisualServer_method_viewport_set_hide_scenario: - void **viewport_set_hide_scenario** **(** :ref:`RID` viewport, :ref:`bool` hidden **)** +---- + .. _class_VisualServer_method_viewport_set_msaa: - void **viewport_set_msaa** **(** :ref:`RID` viewport, :ref:`ViewportMSAA` msaa **)** Sets the anti-aliasing mode. see :ref:`ViewportMSAA` for options. +---- + .. _class_VisualServer_method_viewport_set_parent_viewport: - void **viewport_set_parent_viewport** **(** :ref:`RID` viewport, :ref:`RID` parent_viewport **)** Sets the viewport's parent to another viewport. +---- + .. _class_VisualServer_method_viewport_set_scenario: - void **viewport_set_scenario** **(** :ref:`RID` viewport, :ref:`RID` scenario **)** @@ -3490,48 +4266,64 @@ Sets a viewport's scenario. The scenario contains information about the :ref:`ScenarioDebugMode`, environment information, reflection atlas etc. +---- + .. _class_VisualServer_method_viewport_set_shadow_atlas_quadrant_subdivision: - void **viewport_set_shadow_atlas_quadrant_subdivision** **(** :ref:`RID` viewport, :ref:`int` quadrant, :ref:`int` subdivision **)** Sets the shadow atlas quadrant's subdivision. +---- + .. _class_VisualServer_method_viewport_set_shadow_atlas_size: - void **viewport_set_shadow_atlas_size** **(** :ref:`RID` viewport, :ref:`int` size **)** Sets the size of the shadow atlas's images. +---- + .. _class_VisualServer_method_viewport_set_size: - void **viewport_set_size** **(** :ref:`RID` viewport, :ref:`int` width, :ref:`int` height **)** Sets the viewport's width and height. +---- + .. _class_VisualServer_method_viewport_set_transparent_background: - void **viewport_set_transparent_background** **(** :ref:`RID` viewport, :ref:`bool` enabled **)** If ``true``, the viewport renders its background as transparent. +---- + .. _class_VisualServer_method_viewport_set_update_mode: - void **viewport_set_update_mode** **(** :ref:`RID` viewport, :ref:`ViewportUpdateMode` update_mode **)** Sets when the viewport should be updated. See :ref:`ViewportUpdateMode` constants for options. +---- + .. _class_VisualServer_method_viewport_set_usage: - void **viewport_set_usage** **(** :ref:`RID` viewport, :ref:`ViewportUsage` usage **)** Sets the viewport's 2D/3D mode. See :ref:`ViewportUsage` constants for options. +---- + .. _class_VisualServer_method_viewport_set_use_arvr: - void **viewport_set_use_arvr** **(** :ref:`RID` viewport, :ref:`bool` use_arvr **)** If ``true``, the viewport uses augmented or virtual reality technologies. See :ref:`ARVRInterface`. +---- + .. _class_VisualServer_method_viewport_set_vflip: - void **viewport_set_vflip** **(** :ref:`RID` viewport, :ref:`bool` enabled **)** diff --git a/classes/class_visualshader.rst b/classes/class_visualshader.rst index 56ab78cd7..c61eada28 100644 --- a/classes/class_visualshader.rst +++ b/classes/class_visualshader.rst @@ -110,50 +110,74 @@ Method Descriptions - void **add_node** **(** :ref:`Type` type, :ref:`VisualShaderNode` node, :ref:`Vector2` position, :ref:`int` id **)** +---- + .. _class_VisualShader_method_can_connect_nodes: - :ref:`bool` **can_connect_nodes** **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** const +---- + .. _class_VisualShader_method_connect_nodes: - :ref:`Error` **connect_nodes** **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** +---- + .. _class_VisualShader_method_disconnect_nodes: - void **disconnect_nodes** **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** +---- + .. _class_VisualShader_method_get_node: - :ref:`VisualShaderNode` **get_node** **(** :ref:`Type` type, :ref:`int` id **)** const +---- + .. _class_VisualShader_method_get_node_connections: - :ref:`Array` **get_node_connections** **(** :ref:`Type` type **)** const +---- + .. _class_VisualShader_method_get_node_list: - :ref:`PoolIntArray` **get_node_list** **(** :ref:`Type` type **)** const +---- + .. _class_VisualShader_method_get_node_position: - :ref:`Vector2` **get_node_position** **(** :ref:`Type` type, :ref:`int` id **)** const +---- + .. _class_VisualShader_method_get_valid_node_id: - :ref:`int` **get_valid_node_id** **(** :ref:`Type` type **)** const +---- + .. _class_VisualShader_method_is_node_connection: - :ref:`bool` **is_node_connection** **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** const +---- + .. _class_VisualShader_method_remove_node: - void **remove_node** **(** :ref:`Type` type, :ref:`int` id **)** +---- + .. _class_VisualShader_method_set_mode: - void **set_mode** **(** :ref:`Mode` mode **)** +---- + .. _class_VisualShader_method_set_node_position: - void **set_node_position** **(** :ref:`Type` type, :ref:`int` id, :ref:`Vector2` position **)** diff --git a/classes/class_visualshadernode.rst b/classes/class_visualshadernode.rst index 5cd59fe93..947dc7af1 100644 --- a/classes/class_visualshadernode.rst +++ b/classes/class_visualshadernode.rst @@ -52,6 +52,8 @@ Property Descriptions - :ref:`Array` **default_input_values** +---- + .. _class_VisualShaderNode_property_output_port_for_preview: - :ref:`int` **output_port_for_preview** @@ -69,6 +71,8 @@ Method Descriptions - :ref:`Variant` **get_input_port_default_value** **(** :ref:`int` port **)** const +---- + .. _class_VisualShaderNode_method_set_input_port_default_value: - void **set_input_port_default_value** **(** :ref:`int` port, :ref:`Variant` value **)** diff --git a/classes/class_visualshadernodecubemap.rst b/classes/class_visualshadernodecubemap.rst index 82d1b5924..28690219c 100644 --- a/classes/class_visualshadernodecubemap.rst +++ b/classes/class_visualshadernodecubemap.rst @@ -59,6 +59,8 @@ Property Descriptions | *Getter* | get_cube_map() | +----------+---------------------+ +---- + .. _class_VisualShaderNodeCubeMap_property_texture_type: - :ref:`TextureType` **texture_type** diff --git a/classes/class_visualshadernodetexture.rst b/classes/class_visualshadernodetexture.rst index 5a0c7fce0..fed0468e7 100644 --- a/classes/class_visualshadernodetexture.rst +++ b/classes/class_visualshadernodetexture.rst @@ -52,6 +52,8 @@ enum **Source**: - **SOURCE_2D_NORMAL** = **3** +---- + .. _enum_VisualShaderNodeTexture_TextureType: .. _class_VisualShaderNodeTexture_constant_TYPE_DATA: @@ -81,6 +83,8 @@ Property Descriptions | *Getter* | get_source() | +----------+-------------------+ +---- + .. _class_VisualShaderNodeTexture_property_texture: - :ref:`Texture` **texture** @@ -91,6 +95,8 @@ Property Descriptions | *Getter* | get_texture() | +----------+--------------------+ +---- + .. _class_VisualShaderNodeTexture_property_texture_type: - :ref:`TextureType` **texture_type** diff --git a/classes/class_visualshadernodetextureuniform.rst b/classes/class_visualshadernodetextureuniform.rst index 8cbd13bbf..b19a0afea 100644 --- a/classes/class_visualshadernodetextureuniform.rst +++ b/classes/class_visualshadernodetextureuniform.rst @@ -50,6 +50,8 @@ enum **TextureType**: - **TYPE_ANISO** = **3** +---- + .. _enum_VisualShaderNodeTextureUniform_ColorDefault: .. _class_VisualShaderNodeTextureUniform_constant_COLOR_DEFAULT_WHITE: @@ -75,6 +77,8 @@ Property Descriptions | *Getter* | get_color_default() | +----------+--------------------------+ +---- + .. _class_VisualShaderNodeTextureUniform_property_texture_type: - :ref:`TextureType` **texture_type** diff --git a/classes/class_websocketclient.rst b/classes/class_websocketclient.rst index bce5051f7..896a77060 100644 --- a/classes/class_websocketclient.rst +++ b/classes/class_websocketclient.rst @@ -43,24 +43,32 @@ Signals Emitted when the connection to the server is closed. ``was_clean_close`` will be ``true`` if the connection was shutdown cleanly. +---- + .. _class_WebSocketClient_signal_connection_error: - **connection_error** **(** **)** Emitted when the connection to the server fails. +---- + .. _class_WebSocketClient_signal_connection_established: - **connection_established** **(** :ref:`String` protocol **)** Emitted when a connection with the server is established, ``protocol`` will contain the sub-protocol agreed with the server. +---- + .. _class_WebSocketClient_signal_data_received: - **data_received** **(** **)** Emitted when a WebSocket message is received. Note: This signal is NOT emitted when used as high level multiplayer peer. +---- + .. _class_WebSocketClient_signal_server_close_request: - **server_close_request** **(** :ref:`int` code, :ref:`String` reason **)** @@ -106,6 +114,8 @@ If ``true`` is passed as ``gd_mp_api``, the client will behave like a network pe If ``false`` is passed instead (default), you must call :ref:`PacketPeer` functions (``put_packet``, ``get_packet``, etc.) on the :ref:`WebSocketPeer` returned via ``get_peer(1)`` and not on this object directly (e.g. ``get_peer(1).put_packet(data)``). +---- + .. _class_WebSocketClient_method_disconnect_from_host: - void **disconnect_from_host** **(** :ref:`int` code=1000, :ref:`String` reason="" **)** diff --git a/classes/class_websocketpeer.rst b/classes/class_websocketpeer.rst index e486e9279..e11af9724 100644 --- a/classes/class_websocketpeer.rst +++ b/classes/class_websocketpeer.rst @@ -72,36 +72,48 @@ Note: To achieve a clean close, you will need to keep polling until either :ref: Note: HTML5 export might not support all status codes. Please refer to browsers-specific documentation for more details. +---- + .. _class_WebSocketPeer_method_get_connected_host: - :ref:`String` **get_connected_host** **(** **)** const Returns the IP Address of the connected peer. (Not available in HTML5 export) +---- + .. _class_WebSocketPeer_method_get_connected_port: - :ref:`int` **get_connected_port** **(** **)** const Returns the remote port of the connected peer. (Not available in HTML5 export) +---- + .. _class_WebSocketPeer_method_get_write_mode: - :ref:`WriteMode` **get_write_mode** **(** **)** const Get the current selected write mode. See :ref:`WriteMode`. +---- + .. _class_WebSocketPeer_method_is_connected_to_host: - :ref:`bool` **is_connected_to_host** **(** **)** const Returns ``true`` if this peer is currently connected. +---- + .. _class_WebSocketPeer_method_set_write_mode: - void **set_write_mode** **(** :ref:`WriteMode` mode **)** Sets the socket to use the given :ref:`WriteMode`. +---- + .. _class_WebSocketPeer_method_was_string_packet: - :ref:`bool` **was_string_packet** **(** **)** const diff --git a/classes/class_websocketserver.rst b/classes/class_websocketserver.rst index dc7893cac..1cd1cf070 100644 --- a/classes/class_websocketserver.rst +++ b/classes/class_websocketserver.rst @@ -46,18 +46,24 @@ Signals Emitted when a client requests a clean close. You should keep polling until you get a :ref:`client_disconnected` signal with the same ``id`` to achieve the clean close. See :ref:`WebSocketPeer.close` for more details. +---- + .. _class_WebSocketServer_signal_client_connected: - **client_connected** **(** :ref:`int` id, :ref:`String` protocol **)** Emitted when a new client connects. "protocol" will be the sub-protocol agreed with the client. +---- + .. _class_WebSocketServer_signal_client_disconnected: - **client_disconnected** **(** :ref:`int` id, :ref:`bool` was_clean_close **)** Emitted when a client disconnects. ``was_clean_close`` will be ``true`` if the connection was shutdown cleanly. +---- + .. _class_WebSocketServer_signal_data_received: - **data_received** **(** :ref:`int` id **)** @@ -82,30 +88,40 @@ Method Descriptions Disconnects the peer identified by ``id`` from the server. See :ref:`WebSocketPeer.close` for more info. +---- + .. _class_WebSocketServer_method_get_peer_address: - :ref:`String` **get_peer_address** **(** :ref:`int` id **)** const Returns the IP address of the given peer. +---- + .. _class_WebSocketServer_method_get_peer_port: - :ref:`int` **get_peer_port** **(** :ref:`int` id **)** const Returns the remote port of the given peer. +---- + .. _class_WebSocketServer_method_has_peer: - :ref:`bool` **has_peer** **(** :ref:`int` id **)** const Returns ``true`` if a peer with the given ID is connected. +---- + .. _class_WebSocketServer_method_is_listening: - :ref:`bool` **is_listening** **(** **)** const Returns ``true`` if the server is actively listening on a port. +---- + .. _class_WebSocketServer_method_listen: - :ref:`Error` **listen** **(** :ref:`int` port, :ref:`PoolStringArray` protocols=PoolStringArray( ), :ref:`bool` gd_mp_api=false **)** @@ -118,6 +134,8 @@ If ``true`` is passed as ``gd_mp_api``, the server will behave like a network pe If ``false`` is passed instead (default), you must call :ref:`PacketPeer` functions (``put_packet``, ``get_packet``, etc.), on the :ref:`WebSocketPeer` returned via ``get_peer(id)`` to communicate with the peer with given ``id`` (e.g. ``get_peer(id).get_available_packet_count``). +---- + .. _class_WebSocketServer_method_stop: - void **stop** **(** **)** diff --git a/classes/class_windowdialog.rst b/classes/class_windowdialog.rst index be6a1ecf6..b9e6de564 100644 --- a/classes/class_windowdialog.rst +++ b/classes/class_windowdialog.rst @@ -79,6 +79,8 @@ Property Descriptions If ``true``, the user can resize the window. Default value: ``false``. +---- + .. _class_WindowDialog_property_window_title: - :ref:`String` **window_title** diff --git a/classes/class_world.rst b/classes/class_world.rst index d5fd3bd36..cf9fc4a5c 100644 --- a/classes/class_world.rst +++ b/classes/class_world.rst @@ -56,6 +56,8 @@ Property Descriptions The World's physics direct space state, used for making various queries. Might be used only during ``_physics_process``. +---- + .. _class_World_property_environment: - :ref:`Environment` **environment** @@ -68,6 +70,8 @@ The World's physics direct space state, used for making various queries. Might b The World's :ref:`Environment`. +---- + .. _class_World_property_fallback_environment: - :ref:`Environment` **fallback_environment** @@ -80,6 +84,8 @@ The World's :ref:`Environment`. The World's fallback_environment will be used if the World's :ref:`Environment` fails or is missing. +---- + .. _class_World_property_scenario: - :ref:`RID` **scenario** @@ -90,6 +96,8 @@ The World's fallback_environment will be used if the World's :ref:`Environment` **space** diff --git a/classes/class_world2d.rst b/classes/class_world2d.rst index 042fbf2d4..c5c3f266d 100644 --- a/classes/class_world2d.rst +++ b/classes/class_world2d.rst @@ -52,6 +52,8 @@ Property Descriptions The :ref:`RID` of this world's canvas resource. Used by the :ref:`VisualServer` for 2D drawing. +---- + .. _class_World2D_property_direct_space_state: - :ref:`Physics2DDirectSpaceState` **direct_space_state** @@ -62,6 +64,8 @@ The :ref:`RID` of this world's canvas resource. Used by the :ref:`Vis The state of this world's physics space. This allows arbitrary querying for collision. +---- + .. _class_World2D_property_space: - :ref:`RID` **space** diff --git a/classes/class_xmlparser.rst b/classes/class_xmlparser.rst index 6e9c939ac..99d1efa8e 100644 --- a/classes/class_xmlparser.rst +++ b/classes/class_xmlparser.rst @@ -106,96 +106,128 @@ Method Descriptions Get the amount of attributes in the current element. +---- + .. _class_XMLParser_method_get_attribute_name: - :ref:`String` **get_attribute_name** **(** :ref:`int` idx **)** const Get the name of the attribute specified by the index in ``idx`` argument. +---- + .. _class_XMLParser_method_get_attribute_value: - :ref:`String` **get_attribute_value** **(** :ref:`int` idx **)** const Get the value of the attribute specified by the index in ``idx`` argument. +---- + .. _class_XMLParser_method_get_current_line: - :ref:`int` **get_current_line** **(** **)** const Get the current line in the parsed file (currently not implemented). +---- + .. _class_XMLParser_method_get_named_attribute_value: - :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_method_get_named_attribute_value_safe: - :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_method_get_node_data: - :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_method_get_node_name: - :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 :ref:`NODE_ELEMENT` nor :ref:`NODE_ELEMENT_END` +---- + .. _class_XMLParser_method_get_node_offset: - :ref:`int` **get_node_offset** **(** **)** const Get the byte offset of the current node since the beginning of the file or buffer. +---- + .. _class_XMLParser_method_get_node_type: - :ref:`NodeType` **get_node_type** **(** **)** Get the type of the current node. Compare with ``NODE_*`` constants. +---- + .. _class_XMLParser_method_has_attribute: - :ref:`bool` **has_attribute** **(** :ref:`String` name **)** const Check whether or not the current element has a certain attribute. +---- + .. _class_XMLParser_method_is_empty: - :ref:`bool` **is_empty** **(** **)** const Check whether the current element is empty (this only works for completely empty tags, e.g. ). +---- + .. _class_XMLParser_method_open: - :ref:`Error` **open** **(** :ref:`String` file **)** Open a XML file for parsing. This returns an error code. +---- + .. _class_XMLParser_method_open_buffer: - :ref:`Error` **open_buffer** **(** :ref:`PoolByteArray` buffer **)** Open a XML raw buffer for parsing. This returns an error code. +---- + .. _class_XMLParser_method_read: - :ref:`Error` **read** **(** **)** Read the next node of the file. This returns an error code. +---- + .. _class_XMLParser_method_seek: - :ref:`Error` **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_method_skip_section: - void **skip_section** **(** **)**