From 9060c28080e96d5ea0faffc9d73c0dd0269e536f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Fri, 19 Nov 2021 10:05:42 +0100 Subject: [PATCH] classref: Sync with current 3.4 branch --- classes/class_@gdscript.rst | 46 +- classes/class_@globalscope.rst | 6 +- classes/class_aabb.rst | 13 +- classes/class_acceptdialog.rst | 6 +- classes/class_aescontext.rst | 6 +- classes/class_animatedsprite.rst | 4 +- classes/class_animatedsprite3d.rst | 2 +- classes/class_animatedtexture.rst | 2 +- classes/class_animation.rst | 2 +- classes/class_animationnode.rst | 2 +- classes/class_animationnodeadd2.rst | 2 +- classes/class_animationnodeadd3.rst | 4 +- classes/class_animationnodeanimation.rst | 6 +- classes/class_animationnodeblend2.rst | 6 +- classes/class_animationnodeblend3.rst | 2 +- classes/class_animationnodeblendspace1d.rst | 2 +- classes/class_animationnodeblendspace2d.rst | 4 +- classes/class_animationnodeblendtree.rst | 2 +- classes/class_animationnodeoneshot.rst | 4 +- classes/class_animationnodeoutput.rst | 6 +- classes/class_animationnodestatemachine.rst | 2 +- ...lass_animationnodestatemachineplayback.rst | 2 +- ...ss_animationnodestatemachinetransition.rst | 4 +- classes/class_animationnodetimescale.rst | 4 +- classes/class_animationnodetimeseek.rst | 2 +- classes/class_animationnodetransition.rst | 6 +- classes/class_animationplayer.rst | 6 +- classes/class_animationrootnode.rst | 2 +- classes/class_animationtrackeditplugin.rst | 2 +- classes/class_animationtree.rst | 8 +- classes/class_animationtreeplayer.rst | 2 +- classes/class_area.rst | 46 +- classes/class_area2d.rst | 48 +- classes/class_array.rst | 16 +- classes/class_arraymesh.rst | 4 +- classes/class_arvranchor.rst | 2 +- classes/class_arvrcamera.rst | 2 +- classes/class_arvrcontroller.rst | 2 +- classes/class_arvrinterface.rst | 2 +- classes/class_arvrinterfacegdnative.rst | 2 +- classes/class_arvrorigin.rst | 2 +- classes/class_arvrpositionaltracker.rst | 2 +- classes/class_arvrserver.rst | 2 +- classes/class_aspectratiocontainer.rst | 2 +- classes/class_astar.rst | 2 +- classes/class_astar2d.rst | 2 +- classes/class_atlastexture.rst | 2 +- classes/class_audiobuslayout.rst | 2 +- classes/class_audioeffect.rst | 4 +- classes/class_audioeffectamplify.rst | 2 +- classes/class_audioeffectbandlimitfilter.rst | 2 +- classes/class_audioeffectbandpassfilter.rst | 2 +- classes/class_audioeffectcapture.rst | 2 +- classes/class_audioeffectchorus.rst | 2 +- classes/class_audioeffectcompressor.rst | 2 +- classes/class_audioeffectdelay.rst | 2 +- classes/class_audioeffectdistortion.rst | 2 +- classes/class_audioeffecteq.rst | 2 +- classes/class_audioeffecteq10.rst | 2 +- classes/class_audioeffecteq21.rst | 2 +- classes/class_audioeffecteq6.rst | 2 +- classes/class_audioeffectfilter.rst | 2 +- classes/class_audioeffecthighpassfilter.rst | 2 +- classes/class_audioeffecthighshelffilter.rst | 2 +- classes/class_audioeffectinstance.rst | 2 +- classes/class_audioeffectlimiter.rst | 2 +- classes/class_audioeffectlowpassfilter.rst | 2 +- classes/class_audioeffectlowshelffilter.rst | 2 +- classes/class_audioeffectnotchfilter.rst | 2 +- classes/class_audioeffectpanner.rst | 2 +- classes/class_audioeffectphaser.rst | 2 +- classes/class_audioeffectpitchshift.rst | 4 +- classes/class_audioeffectrecord.rst | 4 +- classes/class_audioeffectreverb.rst | 4 +- classes/class_audioeffectspectrumanalyzer.rst | 8 +- ...ss_audioeffectspectrumanalyzerinstance.rst | 2 +- classes/class_audioeffectstereoenhance.rst | 2 +- classes/class_audioserver.rst | 8 +- classes/class_audiostream.rst | 8 +- classes/class_audiostreamgenerator.rst | 8 +- .../class_audiostreamgeneratorplayback.rst | 6 +- classes/class_audiostreammicrophone.rst | 2 +- classes/class_audiostreammp3.rst | 2 +- classes/class_audiostreamoggvorbis.rst | 2 +- classes/class_audiostreamplayback.rst | 4 +- .../class_audiostreamplaybackresampled.rst | 2 +- classes/class_audiostreamplayer.rst | 12 +- classes/class_audiostreamplayer2d.rst | 2 +- classes/class_audiostreamplayer3d.rst | 12 +- classes/class_audiostreamrandompitch.rst | 2 +- classes/class_audiostreamsample.rst | 4 +- classes/class_backbuffercopy.rst | 2 +- classes/class_bakedlightmap.rst | 12 +- classes/class_bakedlightmapdata.rst | 2 +- classes/class_basebutton.rst | 4 +- classes/class_basis.rst | 10 +- classes/class_bitmap.rst | 4 +- classes/class_bitmapfont.rst | 4 +- classes/class_bone2d.rst | 2 +- classes/class_boneattachment.rst | 2 +- classes/class_bool.rst | 2 +- classes/class_boxcontainer.rst | 2 +- classes/class_boxshape.rst | 8 +- classes/class_bulletphysicsserver.rst | 18 - classes/class_button.rst | 175 +++++- classes/class_buttongroup.rst | 2 +- classes/class_camera.rst | 18 +- classes/class_camera2d.rst | 8 +- classes/class_camerafeed.rst | 2 +- classes/class_cameraserver.rst | 2 +- classes/class_cameratexture.rst | 2 +- classes/class_canvasitem.rst | 4 +- classes/class_canvasitemmaterial.rst | 2 +- classes/class_canvaslayer.rst | 4 +- classes/class_canvasmodulate.rst | 2 +- classes/class_capsulemesh.rst | 2 +- classes/class_capsuleshape.rst | 4 +- classes/class_capsuleshape2d.rst | 2 +- classes/class_centercontainer.rst | 2 +- classes/class_charfxtransform.rst | 6 +- classes/class_checkbox.rst | 307 ++++++++-- classes/class_checkbutton.rst | 263 ++++++-- classes/class_circleshape2d.rst | 2 +- classes/class_classdb.rst | 124 ++-- classes/class_clippedcamera.rst | 4 +- classes/class_collisionobject.rst | 6 +- classes/class_collisionobject2d.rst | 6 +- classes/class_collisionpolygon.rst | 2 +- classes/class_collisionpolygon2d.rst | 2 +- classes/class_collisionshape.rst | 8 +- classes/class_collisionshape2d.rst | 8 +- classes/class_color.rst | 12 +- classes/class_colorpicker.rst | 159 ++++- classes/class_colorpickerbutton.rst | 193 +++++- classes/class_colorrect.rst | 4 +- classes/class_concavepolygonshape.rst | 6 +- classes/class_concavepolygonshape2d.rst | 2 +- classes/class_conetwistjoint.rst | 2 +- classes/class_configfile.rst | 50 +- classes/class_confirmationdialog.rst | 4 +- classes/class_container.rst | 2 +- classes/class_control.rst | 162 +++-- classes/class_convexpolygonshape.rst | 4 +- classes/class_convexpolygonshape2d.rst | 2 +- classes/class_cpuparticles.rst | 2 +- classes/class_cpuparticles2d.rst | 4 +- classes/class_crypto.rst | 10 +- classes/class_cryptokey.rst | 6 +- classes/class_csgbox.rst | 2 +- classes/class_csgcombiner.rst | 2 +- classes/class_csgcylinder.rst | 2 +- classes/class_csgmesh.rst | 2 +- classes/class_csgpolygon.rst | 162 +++-- classes/class_csgprimitive.rst | 2 +- classes/class_csgshape.rst | 6 +- classes/class_csgsphere.rst | 2 +- classes/class_csgtorus.rst | 2 +- classes/class_csharpscript.rst | 2 +- classes/class_cubemap.rst | 2 +- classes/class_cubemesh.rst | 2 +- classes/class_cullinstance.rst | 2 +- classes/class_curve.rst | 2 +- classes/class_curve2d.rst | 2 +- classes/class_curve3d.rst | 2 +- classes/class_curvetexture.rst | 2 +- classes/class_cylindermesh.rst | 2 +- classes/class_cylindershape.rst | 8 +- classes/class_dampedspringjoint2d.rst | 2 +- classes/class_dictionary.rst | 14 +- classes/class_directionallight.rst | 2 +- classes/class_directory.rst | 4 +- classes/class_dtlsserver.rst | 4 +- classes/class_dynamicfont.rst | 10 +- classes/class_dynamicfontdata.rst | 4 +- classes/class_editorexportplugin.rst | 2 +- classes/class_editorfeatureprofile.rst | 2 +- classes/class_editorfiledialog.rst | 4 +- classes/class_editorfilesystem.rst | 4 +- classes/class_editorfilesystemdirectory.rst | 4 +- classes/class_editorimportplugin.rst | 6 +- classes/class_editorinspector.rst | 2 +- classes/class_editorinspectorplugin.rst | 13 +- classes/class_editorinterface.rst | 12 +- .../class_editornavigationmeshgenerator.rst | 2 +- classes/class_editorplugin.rst | 4 +- classes/class_editorproperty.rst | 8 +- .../class_editorresourceconversionplugin.rst | 2 +- classes/class_editorresourcepicker.rst | 6 +- classes/class_editorresourcepreview.rst | 6 +- .../class_editorresourcepreviewgenerator.rst | 2 +- classes/class_editorsceneimporter.rst | 34 +- classes/class_editorsceneimporterfbx.rst | 2 +- classes/class_editorsceneimportergltf.rst | 2 +- classes/class_editorscenepostimport.rst | 2 +- classes/class_editorscript.rst | 2 +- classes/class_editorscriptpicker.rst | 2 +- classes/class_editorselection.rst | 2 +- classes/class_editorsettings.rst | 2 +- classes/class_editorspatialgizmo.rst | 2 +- classes/class_editorspatialgizmoplugin.rst | 8 +- classes/class_editorspinslider.rst | 2 +- classes/class_editorvcsinterface.rst | 2 +- classes/class_encodedobjectasid.rst | 2 +- classes/class_engine.rst | 26 +- classes/class_environment.rst | 36 +- classes/class_expression.rst | 2 +- classes/class_externaltexture.rst | 14 +- classes/class_file.rst | 41 +- classes/class_filedialog.rst | 119 +++- classes/class_filesystemdock.rst | 28 +- classes/class_float.rst | 15 +- classes/class_font.rst | 8 +- classes/class_funcref.rst | 2 +- classes/class_gdnative.rst | 2 +- classes/class_gdnativelibrary.rst | 2 +- classes/class_gdscript.rst | 2 +- classes/class_gdscriptfunctionstate.rst | 2 +- classes/class_generic6dofjoint.rst | 2 +- classes/class_geometry.rst | 2 +- classes/class_geometryinstance.rst | 2 +- classes/class_giprobe.rst | 14 +- classes/class_giprobedata.rst | 4 +- classes/class_gltfaccessor.rst | 2 +- classes/class_gltfanimation.rst | 2 +- classes/class_gltfbufferview.rst | 2 +- classes/class_gltfcamera.rst | 2 +- classes/class_gltfdocument.rst | 2 +- classes/class_gltflight.rst | 34 +- classes/class_gltfmesh.rst | 28 +- classes/class_gltfnode.rst | 2 +- classes/class_gltfskeleton.rst | 2 +- classes/class_gltfskin.rst | 2 +- classes/class_gltfspecgloss.rst | 2 +- classes/class_gltfstate.rst | 2 +- classes/class_gltftexture.rst | 2 +- classes/class_godotsharp.rst | 2 +- classes/class_gradient.rst | 2 +- classes/class_gradienttexture.rst | 2 +- classes/class_graphedit.rst | 217 +++++-- classes/class_graphnode.rst | 257 ++++++-- classes/class_gridcontainer.rst | 39 +- classes/class_gridmap.rst | 8 +- classes/class_groovejoint2d.rst | 2 +- classes/class_hashingcontext.rst | 2 +- classes/class_hboxcontainer.rst | 21 +- classes/class_heightmapshape.rst | 2 +- classes/class_hingejoint.rst | 2 +- classes/class_hmaccontext.rst | 2 +- classes/class_hscrollbar.rst | 133 +++- classes/class_hseparator.rst | 33 +- classes/class_hslider.rst | 87 ++- classes/class_hsplitcontainer.rst | 59 +- classes/class_httpclient.rst | 6 +- classes/class_httprequest.rst | 58 +- classes/class_image.rst | 48 +- classes/class_imagetexture.rst | 4 +- classes/class_immediategeometry.rst | 4 +- classes/class_input.rst | 66 +- classes/class_inputevent.rst | 14 +- classes/class_inputeventaction.rst | 6 +- classes/class_inputeventgesture.rst | 2 +- classes/class_inputeventjoypadbutton.rst | 2 +- classes/class_inputeventjoypadmotion.rst | 2 +- classes/class_inputeventkey.rst | 2 +- classes/class_inputeventmagnifygesture.rst | 2 +- classes/class_inputeventmidi.rst | 2 +- classes/class_inputeventmouse.rst | 2 +- classes/class_inputeventmousebutton.rst | 2 +- classes/class_inputeventmousemotion.rst | 6 +- classes/class_inputeventpangesture.rst | 2 +- classes/class_inputeventscreendrag.rst | 4 +- classes/class_inputeventscreentouch.rst | 2 +- classes/class_inputeventwithmodifiers.rst | 2 +- classes/class_inputmap.rst | 2 +- classes/class_instanceplaceholder.rst | 2 +- classes/class_int.rst | 2 +- classes/class_interpolatedcamera.rst | 2 +- classes/class_ip.rst | 2 +- classes/class_itemlist.rst | 203 ++++++- classes/class_javaclass.rst | 2 +- classes/class_javaclasswrapper.rst | 2 +- classes/class_javascript.rst | 6 +- classes/class_javascriptobject.rst | 4 +- classes/class_jnisingleton.rst | 12 +- classes/class_joint.rst | 4 +- classes/class_joint2d.rst | 2 +- classes/class_json.rst | 2 +- classes/class_jsonparseresult.rst | 2 +- classes/class_jsonrpc.rst | 43 +- classes/class_kinematicbody.rst | 98 ++- classes/class_kinematicbody2d.rst | 34 +- classes/class_kinematiccollision.rst | 18 +- classes/class_kinematiccollision2d.rst | 18 +- classes/class_label.rst | 145 ++++- classes/class_largetexture.rst | 2 +- classes/class_light.rst | 4 +- classes/class_light2d.rst | 2 +- classes/class_lightoccluder2d.rst | 2 +- classes/class_line2d.rst | 8 +- classes/class_lineedit.rst | 195 +++++- classes/class_lineshape2d.rst | 2 +- classes/class_linkbutton.rst | 107 +++- classes/class_listener.rst | 4 +- classes/class_listener2d.rst | 63 ++ classes/class_mainloop.rst | 2 +- classes/class_margincontainer.rst | 69 ++- classes/class_marshalls.rst | 2 +- classes/class_material.rst | 10 +- classes/class_menubutton.rst | 173 +++++- classes/class_mesh.rst | 10 +- classes/class_meshdatatool.rst | 4 +- classes/class_meshinstance.rst | 10 +- classes/class_meshinstance2d.rst | 4 +- classes/class_meshlibrary.rst | 100 +-- classes/class_meshtexture.rst | 2 +- classes/class_mobilevrinterface.rst | 2 +- classes/class_multimesh.rst | 2 +- classes/class_multimeshinstance.rst | 2 +- classes/class_multimeshinstance2d.rst | 4 +- classes/class_multiplayerapi.rst | 2 +- classes/class_multiplayerpeergdnative.rst | 2 +- classes/class_mutex.rst | 8 +- classes/class_nativescript.rst | 4 +- classes/class_navigation.rst | 4 +- classes/class_navigation2d.rst | 4 +- classes/class_navigationmesh.rst | 235 ++++++-- classes/class_navigationmeshinstance.rst | 11 +- classes/class_navigationpolygon.rst | 6 +- classes/class_navigationpolygoninstance.rst | 2 +- classes/class_networkedmultiplayerenet.rst | 46 +- classes/class_networkedmultiplayerpeer.rst | 4 +- classes/class_ninepatchrect.rst | 2 +- classes/class_node.rst | 14 +- classes/class_node2d.rst | 8 +- classes/class_nodepath.rst | 4 +- classes/class_noisetexture.rst | 2 +- classes/class_object.rst | 10 +- classes/class_occluder.rst | 65 ++ classes/class_occluderpolygon2d.rst | 2 +- classes/class_occludershape.rst | 25 + classes/class_occludershapesphere.rst | 75 +++ classes/class_omnilight.rst | 2 +- classes/class_opensimplexnoise.rst | 2 +- classes/class_optionbutton.rst | 201 ++++++- classes/class_os.rst | 76 ++- classes/class_packeddatacontainer.rst | 2 +- classes/class_packeddatacontainerref.rst | 2 +- classes/class_packedscene.rst | 4 +- classes/class_packedscenegltf.rst | 20 +- classes/class_packetpeer.rst | 2 +- classes/class_packetpeerdtls.rst | 4 +- classes/class_packetpeergdnative.rst | 2 +- classes/class_packetpeerstream.rst | 2 +- classes/class_packetpeerudp.rst | 8 +- classes/class_panel.rst | 23 +- classes/class_panelcontainer.rst | 19 +- classes/class_panoramasky.rst | 4 +- classes/class_parallaxbackground.rst | 2 +- classes/class_parallaxlayer.rst | 2 +- classes/class_particles.rst | 4 +- classes/class_particles2d.rst | 6 +- classes/class_particlesmaterial.rst | 2 +- classes/class_path.rst | 2 +- classes/class_path2d.rst | 2 +- classes/class_pathfollow.rst | 2 +- classes/class_pathfollow2d.rst | 2 +- classes/class_pckpacker.rst | 2 +- classes/class_performance.rst | 2 +- classes/class_phashtranslation.rst | 2 +- classes/class_physicalbone.rst | 2 +- classes/class_physics2ddirectbodystate.rst | 14 +- classes/class_physics2ddirectspacestate.rst | 28 +- classes/class_physics2dserver.rst | 8 +- .../class_physics2dshapequeryparameters.rst | 4 +- classes/class_physics2dtestmotionresult.rst | 2 +- classes/class_physicsbody.rst | 2 +- classes/class_physicsbody2d.rst | 2 +- classes/class_physicsdirectbodystate.rst | 19 +- classes/class_physicsdirectspacestate.rst | 48 +- classes/class_physicsmaterial.rst | 2 +- classes/class_physicsserver.rst | 474 ++++++++------- classes/class_physicsshapequeryparameters.rst | 4 +- classes/class_physicstestmotionresult.rst | 2 +- classes/class_pinjoint.rst | 2 +- classes/class_pinjoint2d.rst | 2 +- classes/class_plane.rst | 2 +- classes/class_planemesh.rst | 2 +- classes/class_planeshape.rst | 2 +- classes/class_pluginscript.rst | 2 +- classes/class_pointmesh.rst | 2 +- classes/class_polygon2d.rst | 2 +- classes/class_polygonpathfinder.rst | 2 +- classes/class_poolbytearray.rst | 4 +- classes/class_poolcolorarray.rst | 2 +- classes/class_poolintarray.rst | 4 +- classes/class_poolrealarray.rst | 4 +- classes/class_poolstringarray.rst | 4 +- classes/class_poolvector2array.rst | 4 +- classes/class_poolvector3array.rst | 2 +- classes/class_popup.rst | 2 +- classes/class_popupdialog.rst | 17 +- classes/class_popupmenu.rst | 261 ++++++-- classes/class_popuppanel.rst | 17 +- classes/class_portal.rst | 24 +- classes/class_position2d.rst | 2 +- classes/class_position3d.rst | 2 +- classes/class_primitivemesh.rst | 2 +- classes/class_prismmesh.rst | 2 +- classes/class_proceduralsky.rst | 2 +- classes/class_progressbar.rst | 73 ++- classes/class_projectsettings.rst | 302 ++++++++-- classes/class_proximitygroup.rst | 2 +- classes/class_proxytexture.rst | 2 +- classes/class_quadmesh.rst | 6 +- classes/class_quat.rst | 4 +- classes/class_randomnumbergenerator.rst | 6 +- classes/class_range.rst | 2 +- classes/class_raycast.rst | 6 +- classes/class_raycast2d.rst | 6 +- classes/class_rayshape.rst | 2 +- classes/class_rayshape2d.rst | 2 +- classes/class_rect2.rst | 17 +- classes/class_rectangleshape2d.rst | 6 +- classes/class_reference.rst | 2 +- classes/class_referencerect.rst | 2 +- classes/class_reflectionprobe.rst | 6 +- classes/class_regex.rst | 6 +- classes/class_regexmatch.rst | 2 +- classes/class_remotetransform.rst | 2 +- classes/class_remotetransform2d.rst | 2 +- classes/class_resource.rst | 8 +- classes/class_resourceformatloader.rst | 2 +- classes/class_resourceformatsaver.rst | 2 +- classes/class_resourceimporter.rst | 2 +- classes/class_resourceinteractiveloader.rst | 2 +- classes/class_resourceloader.rst | 4 +- classes/class_resourcepreloader.rst | 2 +- classes/class_resourcesaver.rst | 2 +- classes/class_richtexteffect.rst | 4 +- classes/class_richtextlabel.rst | 259 ++++++-- classes/class_rid.rst | 2 +- classes/class_rigidbody.rst | 22 +- classes/class_rigidbody2d.rst | 22 +- classes/class_room.rst | 18 +- classes/class_roomgroup.rst | 2 +- classes/class_roommanager.rst | 96 +-- classes/class_rootmotionview.rst | 2 +- classes/class_scenestate.rst | 2 +- classes/class_scenetree.rst | 125 ++-- classes/class_scenetreetimer.rst | 2 +- classes/class_script.rst | 2 +- classes/class_scriptcreatedialog.rst | 2 +- classes/class_scripteditor.rst | 2 +- classes/class_scrollbar.rst | 2 +- classes/class_scrollcontainer.rst | 21 +- classes/class_segmentshape2d.rst | 2 +- classes/class_semaphore.rst | 2 +- classes/class_separator.rst | 2 +- classes/class_shader.rst | 2 +- classes/class_shadermaterial.rst | 6 +- classes/class_shape.rst | 2 +- classes/class_shape2d.rst | 2 +- classes/class_shortcut.rst | 2 +- classes/class_skeleton.rst | 6 +- classes/class_skeleton2d.rst | 2 +- classes/class_skeletonik.rst | 4 +- classes/class_skin.rst | 2 +- classes/class_skinreference.rst | 2 +- classes/class_sky.rst | 2 +- classes/class_slider.rst | 2 +- classes/class_sliderjoint.rst | 2 +- classes/class_softbody.rst | 66 +- classes/class_spatial.rst | 6 +- classes/class_spatialgizmo.rst | 2 +- classes/class_spatialmaterial.rst | 22 +- classes/class_spatialvelocitytracker.rst | 2 +- classes/class_spheremesh.rst | 2 +- classes/class_sphereshape.rst | 4 +- classes/class_spinbox.rst | 19 +- classes/class_splitcontainer.rst | 2 +- classes/class_spotlight.rst | 4 +- classes/class_springarm.rst | 4 +- classes/class_sprite.rst | 6 +- classes/class_sprite3d.rst | 2 +- classes/class_spritebase3d.rst | 2 +- classes/class_spriteframes.rst | 2 +- classes/class_staticbody.rst | 8 +- classes/class_staticbody2d.rst | 2 +- classes/class_streampeer.rst | 6 +- classes/class_streampeerbuffer.rst | 2 +- classes/class_streampeergdnative.rst | 2 +- classes/class_streampeerssl.rst | 2 +- classes/class_streampeertcp.rst | 4 +- classes/class_streamtexture.rst | 2 +- classes/class_string.rst | 33 +- classes/class_stylebox.rst | 2 +- classes/class_styleboxempty.rst | 2 +- classes/class_styleboxflat.rst | 10 +- classes/class_styleboxline.rst | 2 +- classes/class_styleboxtexture.rst | 4 +- classes/class_surfacetool.rst | 12 +- classes/class_tabcontainer.rst | 301 ++++++++-- classes/class_tabs.rst | 251 ++++++-- classes/class_tcp_server.rst | 2 +- classes/class_textedit.rst | 567 +++++++++++++++--- classes/class_textfile.rst | 2 +- classes/class_texture.rst | 2 +- classes/class_texture3d.rst | 26 +- classes/class_texturearray.rst | 18 +- classes/class_texturebutton.rst | 4 +- classes/class_texturelayered.rst | 34 +- classes/class_textureprogress.rst | 86 +-- classes/class_texturerect.rst | 4 +- classes/class_theme.rst | 28 +- classes/class_thread.rst | 26 +- classes/class_tilemap.rst | 18 +- classes/class_tileset.rst | 16 +- classes/class_timer.rst | 10 +- classes/class_toolbutton.rst | 171 +++++- classes/class_touchscreenbutton.rst | 4 +- classes/class_transform.rst | 8 +- classes/class_transform2d.rst | 6 +- classes/class_translation.rst | 12 +- classes/class_translationserver.rst | 12 +- classes/class_tree.rst | 497 ++++++++++++--- classes/class_treeitem.rst | 2 +- classes/class_trianglemesh.rst | 2 +- classes/class_tween.rst | 6 +- classes/class_udpserver.rst | 2 +- classes/class_undoredo.rst | 10 +- classes/class_upnp.rst | 36 +- classes/class_upnpdevice.rst | 2 +- classes/class_variant.rst | 2 +- classes/class_vboxcontainer.rst | 23 +- classes/class_vector2.rst | 14 +- classes/class_vector3.rst | 8 +- classes/class_vehiclebody.rst | 4 +- classes/class_vehiclewheel.rst | 4 +- classes/class_videoplayer.rst | 4 +- classes/class_videostream.rst | 2 +- classes/class_videostreamgdnative.rst | 4 +- classes/class_videostreamtheora.rst | 4 +- classes/class_videostreamwebm.rst | 4 +- classes/class_viewport.rst | 38 +- classes/class_viewportcontainer.rst | 2 +- classes/class_viewporttexture.rst | 10 +- classes/class_visibilityenabler.rst | 2 +- classes/class_visibilityenabler2d.rst | 2 +- classes/class_visibilitynotifier.rst | 2 +- classes/class_visibilitynotifier2d.rst | 4 +- classes/class_visualinstance.rst | 2 +- classes/class_visualscript.rst | 2 +- .../class_visualscriptbasictypeconstant.rst | 2 +- classes/class_visualscriptbuiltinfunc.rst | 2 +- classes/class_visualscriptclassconstant.rst | 2 +- classes/class_visualscriptcomment.rst | 2 +- classes/class_visualscriptcomposearray.rst | 2 +- classes/class_visualscriptcondition.rst | 2 +- classes/class_visualscriptconstant.rst | 2 +- classes/class_visualscriptconstructor.rst | 2 +- classes/class_visualscriptcustomnode.rst | 4 +- classes/class_visualscriptdeconstruct.rst | 2 +- classes/class_visualscripteditor.rst | 2 +- classes/class_visualscriptemitsignal.rst | 2 +- classes/class_visualscriptenginesingleton.rst | 2 +- classes/class_visualscriptexpression.rst | 2 +- classes/class_visualscriptfunction.rst | 2 +- classes/class_visualscriptfunctioncall.rst | 2 +- classes/class_visualscriptfunctionstate.rst | 2 +- classes/class_visualscriptglobalconstant.rst | 2 +- classes/class_visualscriptindexget.rst | 2 +- classes/class_visualscriptindexset.rst | 2 +- classes/class_visualscriptinputaction.rst | 2 +- classes/class_visualscriptiterator.rst | 2 +- classes/class_visualscriptlists.rst | 2 +- classes/class_visualscriptlocalvar.rst | 2 +- classes/class_visualscriptlocalvarset.rst | 2 +- classes/class_visualscriptmathconstant.rst | 2 +- classes/class_visualscriptnode.rst | 2 +- classes/class_visualscriptoperator.rst | 2 +- classes/class_visualscriptpreload.rst | 2 +- classes/class_visualscriptpropertyget.rst | 2 +- classes/class_visualscriptpropertyset.rst | 2 +- classes/class_visualscriptresourcepath.rst | 2 +- classes/class_visualscriptreturn.rst | 2 +- classes/class_visualscriptscenenode.rst | 2 +- classes/class_visualscriptscenetree.rst | 2 +- classes/class_visualscriptselect.rst | 2 +- classes/class_visualscriptself.rst | 2 +- classes/class_visualscriptsequence.rst | 2 +- classes/class_visualscriptsubcall.rst | 2 +- classes/class_visualscriptswitch.rst | 2 +- classes/class_visualscripttypecast.rst | 2 +- classes/class_visualscriptvariableget.rst | 2 +- classes/class_visualscriptvariableset.rst | 2 +- classes/class_visualscriptwhile.rst | 2 +- classes/class_visualscriptyield.rst | 2 +- classes/class_visualscriptyieldsignal.rst | 2 +- classes/class_visualserver.rst | 42 +- classes/class_visualshader.rst | 2 +- classes/class_visualshadernode.rst | 2 +- .../class_visualshadernodebooleanconstant.rst | 2 +- .../class_visualshadernodebooleanuniform.rst | 2 +- .../class_visualshadernodecolorconstant.rst | 2 +- classes/class_visualshadernodecolorfunc.rst | 2 +- classes/class_visualshadernodecolorop.rst | 2 +- .../class_visualshadernodecoloruniform.rst | 2 +- classes/class_visualshadernodecompare.rst | 2 +- classes/class_visualshadernodecubemap.rst | 2 +- .../class_visualshadernodecubemapuniform.rst | 2 +- classes/class_visualshadernodecustom.rst | 2 +- classes/class_visualshadernodedeterminant.rst | 2 +- classes/class_visualshadernodedotproduct.rst | 2 +- classes/class_visualshadernodeexpression.rst | 2 +- classes/class_visualshadernodefaceforward.rst | 2 +- classes/class_visualshadernodefresnel.rst | 2 +- ...class_visualshadernodeglobalexpression.rst | 2 +- classes/class_visualshadernodegroupbase.rst | 2 +- classes/class_visualshadernodeif.rst | 2 +- classes/class_visualshadernodeinput.rst | 2 +- classes/class_visualshadernodeis.rst | 2 +- .../class_visualshadernodeouterproduct.rst | 2 +- classes/class_visualshadernodeoutput.rst | 2 +- classes/class_visualshadernodescalarclamp.rst | 2 +- .../class_visualshadernodescalarconstant.rst | 2 +- ...s_visualshadernodescalarderivativefunc.rst | 2 +- classes/class_visualshadernodescalarfunc.rst | 2 +- .../class_visualshadernodescalarinterp.rst | 2 +- classes/class_visualshadernodescalarop.rst | 2 +- ...class_visualshadernodescalarsmoothstep.rst | 2 +- .../class_visualshadernodescalarswitch.rst | 2 +- .../class_visualshadernodescalaruniform.rst | 2 +- classes/class_visualshadernodeswitch.rst | 2 +- classes/class_visualshadernodetexture.rst | 2 +- .../class_visualshadernodetextureuniform.rst | 2 +- ...isualshadernodetextureuniformtriplanar.rst | 2 +- ...class_visualshadernodetransformcompose.rst | 2 +- ...lass_visualshadernodetransformconstant.rst | 2 +- ...ass_visualshadernodetransformdecompose.rst | 2 +- .../class_visualshadernodetransformfunc.rst | 2 +- .../class_visualshadernodetransformmult.rst | 2 +- ...class_visualshadernodetransformuniform.rst | 2 +- ...class_visualshadernodetransformvecmult.rst | 2 +- classes/class_visualshadernodeuniform.rst | 2 +- classes/class_visualshadernodeuniformref.rst | 2 +- .../class_visualshadernodevec3constant.rst | 2 +- classes/class_visualshadernodevec3uniform.rst | 2 +- classes/class_visualshadernodevectorclamp.rst | 2 +- .../class_visualshadernodevectorcompose.rst | 2 +- .../class_visualshadernodevectordecompose.rst | 2 +- ...s_visualshadernodevectorderivativefunc.rst | 2 +- .../class_visualshadernodevectordistance.rst | 2 +- classes/class_visualshadernodevectorfunc.rst | 2 +- .../class_visualshadernodevectorinterp.rst | 2 +- classes/class_visualshadernodevectorlen.rst | 2 +- classes/class_visualshadernodevectorop.rst | 2 +- .../class_visualshadernodevectorrefract.rst | 2 +- .../class_visualshadernodevectorscalarmix.rst | 2 +- ...visualshadernodevectorscalarsmoothstep.rst | 2 +- ...class_visualshadernodevectorscalarstep.rst | 2 +- ...class_visualshadernodevectorsmoothstep.rst | 2 +- classes/class_vscrollbar.rst | 133 +++- classes/class_vseparator.rst | 33 +- classes/class_vslider.rst | 87 ++- classes/class_vsplitcontainer.rst | 59 +- classes/class_weakref.rst | 2 +- classes/class_webrtcdatachannel.rst | 2 +- classes/class_webrtcdatachannelgdnative.rst | 2 +- classes/class_webrtcmultiplayer.rst | 2 +- classes/class_webrtcpeerconnection.rst | 6 +- .../class_webrtcpeerconnectiongdnative.rst | 2 +- classes/class_websocketclient.rst | 2 +- classes/class_websocketmultiplayerpeer.rst | 2 +- classes/class_websocketpeer.rst | 4 +- classes/class_websocketserver.rst | 2 +- classes/class_webxrinterface.rst | 24 +- classes/class_windowdialog.rst | 135 ++++- classes/class_world.rst | 2 +- classes/class_world2d.rst | 2 +- classes/class_worldenvironment.rst | 8 +- classes/class_x509certificate.rst | 2 +- classes/class_xmlparser.rst | 4 +- classes/class_ysort.rst | 2 +- 683 files changed, 8789 insertions(+), 2973 deletions(-) delete mode 100644 classes/class_bulletphysicsserver.rst create mode 100644 classes/class_listener2d.rst create mode 100644 classes/class_occluder.rst create mode 100644 classes/class_occludershape.rst create mode 100644 classes/class_occludershapesphere.rst diff --git a/classes/class_@gdscript.rst b/classes/class_@gdscript.rst index 732cf5785..71cf2eafd 100644 --- a/classes/class_@gdscript.rst +++ b/classes/class_@gdscript.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the @GDScript.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -479,6 +479,8 @@ Deprecated alias for :ref:`step_decimals`. - :ref:`float` **dectime** **(** :ref:`float` value, :ref:`float` amount, :ref:`float` step **)** +**Note:** ``dectime`` has been deprecated and will be removed in Godot 4.0, please use :ref:`move_toward` instead. + Returns the result of ``value`` decreased by ``step`` \* ``amount``. :: @@ -511,7 +513,21 @@ Converts a dictionary (previously created with :ref:`inst2dict` **ease** **(** :ref:`float` s, :ref:`float` curve **)** -Easing function, based on exponent. The curve values are: 0 is constant, 1 is linear, 0 to 1 is ease-in, 1+ is ease out. Negative values are in-out/out in. +Returns an "eased" value of ``x`` based on an easing function defined with ``curve``. This easing function is based on an exponent. The ``curve`` can be any floating-point number, with specific values leading to the following behaviors: + +:: + + - Lower than -1.0 (exclusive): Ease in-out + - 1.0: Linear + - Between -1.0 and 0.0 (exclusive): Ease out-in + - 0.0: Constant + - Between 0.0 to 1.0 (exclusive): Ease in + - 1.0: Linear + - Greater than 1.0 (exclusive): Ease out + +`ease() curve values cheatsheet `__ + +See also :ref:`smoothstep`. If you need to perform more advanced transitions, use :ref:`Tween` or :ref:`AnimationPlayer`. ---- @@ -1197,7 +1213,9 @@ Randomizes the seed (or the internal state) of the random number generator. Curr - :ref:`Array` **range** **(** ... **)** |vararg| -Returns an array with the given range. Range can be 1 argument N (0 to N-1), two arguments (initial, final-1) or three arguments (initial, final-1, increment). +Returns an array with the given range. Range can be 1 argument ``N`` (0 to ``N`` - 1), two arguments (``initial``, ``final - 1``) or three arguments (``initial``, ``final - 1``, ``increment``). Returns an empty array if the range isn't valid (e.g. ``range(2, 5, -1)`` or ``range(5, 5, 1)``). + +Returns an array with the given range. ``range()`` can have 1 argument N (``0`` to ``N - 1``), two arguments (``initial``, ``final - 1``) or three arguments (``initial``, ``final - 1``, ``increment``). ``increment`` can be negative. If ``increment`` is negative, ``final - 1`` will become ``final + 1``. Also, the initial value must be greater than the final value for the loop to run. :: @@ -1213,6 +1231,24 @@ Output: [2, 3, 4] [0, 2, 4] +To iterate over an :ref:`Array` backwards, use: + +:: + + var array = [3, 6, 9] + var i := array.size() - 1 + while i >= 0: + print(array[i]) + i -= 1 + +Output: + +:: + + 9 + 6 + 3 + ---- .. _class_@GDScript_method_range_lerp: @@ -1312,6 +1348,10 @@ This S-shaped curve is the cubic Hermite interpolator, given by ``f(y) = 3*y^2 - smoothstep(0, 2, 1.0) # Returns 0.5 smoothstep(0, 2, 2.0) # Returns 1.0 +Compared to :ref:`ease` with a curve value of ``-1.6521``, :ref:`smoothstep` returns the smoothest possible curve with no sudden changes in the derivative. If you need to perform more advanced transitions, use :ref:`Tween` or :ref:`AnimationPlayer`. + +`Comparison between smoothstep() and ease(x, -1.6521) return values `__ + ---- .. _class_@GDScript_method_sqrt: diff --git a/classes/class_@globalscope.rst b/classes/class_@globalscope.rst index 06854482e..52fb53984 100644 --- a/classes/class_@globalscope.rst +++ b/classes/class_@globalscope.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the @GlobalScope.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -1176,7 +1176,7 @@ enum **KeyModifierMask**: - **KEY_MASK_CTRL** = **268435456** --- Ctrl key mask. -- **KEY_MASK_CMD** = **268435456** --- Command key mask. On macOS, this is equivalent to :ref:`KEY_MASK_META`. On other platforms, this is equivalent to :ref:`KEY_MASK_CTRL`. This mask should be preferred to :ref:`KEY_MASK_META` or :ref:`KEY_MASK_CTRL` for system shortcuts as it handles all platforms correctly. +- **KEY_MASK_CMD** = **platform-dependent** --- Command key mask. On macOS, this is equivalent to :ref:`KEY_MASK_META`. On other platforms, this is equivalent to :ref:`KEY_MASK_CTRL`. This mask should be preferred to :ref:`KEY_MASK_META` or :ref:`KEY_MASK_CTRL` for system shortcuts as it handles all platforms correctly. - **KEY_MASK_KPAD** = **536870912** --- Keypad key mask. @@ -1887,7 +1887,7 @@ enum **PropertyHint**: - **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 ``"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_EXP_RANGE** = **2** --- Hints that a 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"``. diff --git a/classes/class_aabb.rst b/classes/class_aabb.rst index 4ffa98413..13eea1f3b 100644 --- a/classes/class_aabb.rst +++ b/classes/class_aabb.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AABB.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -161,7 +161,16 @@ Returns ``true`` if this ``AABB`` completely encloses another one. - :ref:`AABB` **expand** **(** :ref:`Vector3` to_point **)** -Returns this ``AABB`` expanded to include a given point. +Returns a copy of this ``AABB`` expanded to include a given point. + +**Example:** + +:: + + # position (-3, 2, 0), size (1, 1, 1) + var box = AABB(Vector3(-3, 2, 0), Vector3(1, 1, 1)) + # position (-3, -1, 0), size (3, 4, 2), so we fit both the original AABB and Vector3(0, -1, 2) + var box2 = box.expand(Vector3(0, -1, 2)) ---- diff --git a/classes/class_acceptdialog.rst b/classes/class_acceptdialog.rst index 7fbeb7fa3..37a7aeda4 100644 --- a/classes/class_acceptdialog.rst +++ b/classes/class_acceptdialog.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AcceptDialog.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -149,6 +149,8 @@ You can use :ref:`remove_button` method Returns the label used for built-in text. +**Warning:** This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their :ref:`CanvasItem.visible` property. + ---- .. _class_AcceptDialog_method_get_ok: @@ -157,6 +159,8 @@ Returns the label used for built-in text. Returns the OK :ref:`Button` instance. +**Warning:** This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their :ref:`CanvasItem.visible` property. + ---- .. _class_AcceptDialog_method_register_text_enter: diff --git a/classes/class_aescontext.rst b/classes/class_aescontext.rst index 84cf39a06..68cfc6729 100644 --- a/classes/class_aescontext.rst +++ b/classes/class_aescontext.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AESContext.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -107,7 +107,7 @@ Close this AES context so it can be started again. See :ref:`start`). You normally don't need this function. -Note: This function only makes sense when the context is started with :ref:`MODE_CBC_ENCRYPT` or :ref:`MODE_CBC_DECRYPT`. +**Note:** This function only makes sense when the context is started with :ref:`MODE_CBC_ENCRYPT` or :ref:`MODE_CBC_DECRYPT`. ---- @@ -125,7 +125,7 @@ Start the AES context in the given ``mode``. A ``key`` of either 16 or 32 bytes Run the desired operation for this AES context. Will return a :ref:`PoolByteArray` containing the result of encrypting (or decrypting) the given ``src``. See :ref:`start` for mode of operation. -Note: The size of ``src`` must be a multiple of 16. Apply some padding if needed. +**Note:** The size of ``src`` must be a multiple of 16. Apply some padding if needed. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_animatedsprite.rst b/classes/class_animatedsprite.rst index 5451b0bd5..332860e80 100644 --- a/classes/class_animatedsprite.rst +++ b/classes/class_animatedsprite.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AnimatedSprite.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -25,7 +25,7 @@ Tutorials - :doc:`../tutorials/2d/2d_sprite_animation` -- `2D Dodge The Creeps Demo `_ +- `2D Dodge The Creeps Demo `__ Properties ---------- diff --git a/classes/class_animatedsprite3d.rst b/classes/class_animatedsprite3d.rst index 20f7f87ab..66829a770 100644 --- a/classes/class_animatedsprite3d.rst +++ b/classes/class_animatedsprite3d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AnimatedSprite3D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_animatedtexture.rst b/classes/class_animatedtexture.rst index f55d96c3f..3ebb8468e 100644 --- a/classes/class_animatedtexture.rst +++ b/classes/class_animatedtexture.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AnimatedTexture.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_animation.rst b/classes/class_animation.rst index 42b03f2a7..47b6e2dd8 100644 --- a/classes/class_animation.rst +++ b/classes/class_animation.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Animation.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_animationnode.rst b/classes/class_animationnode.rst index 9cff141ac..b2396f6a6 100644 --- a/classes/class_animationnode.rst +++ b/classes/class_animationnode.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AnimationNode.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_animationnodeadd2.rst b/classes/class_animationnodeadd2.rst index cbc30a0b1..26fa7f567 100644 --- a/classes/class_animationnodeadd2.rst +++ b/classes/class_animationnodeadd2.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AnimationNodeAdd2.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_animationnodeadd3.rst b/classes/class_animationnodeadd3.rst index e0a67c854..414f57906 100644 --- a/classes/class_animationnodeadd3.rst +++ b/classes/class_animationnodeadd3.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AnimationNodeAdd3.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -31,7 +31,7 @@ Tutorials - :doc:`../tutorials/animation/animation_tree` -- `Third Person Shooter Demo `_ +- `Third Person Shooter Demo `__ Properties ---------- diff --git a/classes/class_animationnodeanimation.rst b/classes/class_animationnodeanimation.rst index af295ed83..02ac68880 100644 --- a/classes/class_animationnodeanimation.rst +++ b/classes/class_animationnodeanimation.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AnimationNodeAnimation.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -23,9 +23,9 @@ Tutorials - :doc:`../tutorials/animation/animation_tree` -- `3D Platformer Demo `_ +- `3D Platformer Demo `__ -- `Third Person Shooter Demo `_ +- `Third Person Shooter Demo `__ Properties ---------- diff --git a/classes/class_animationnodeblend2.rst b/classes/class_animationnodeblend2.rst index 1d3b61a24..45962153f 100644 --- a/classes/class_animationnodeblend2.rst +++ b/classes/class_animationnodeblend2.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AnimationNodeBlend2.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -23,9 +23,9 @@ Tutorials - :doc:`../tutorials/animation/animation_tree` -- `3D Platformer Demo `_ +- `3D Platformer Demo `__ -- `Third Person Shooter Demo `_ +- `Third Person Shooter Demo `__ Properties ---------- diff --git a/classes/class_animationnodeblend3.rst b/classes/class_animationnodeblend3.rst index 5baa201a6..80115ad25 100644 --- a/classes/class_animationnodeblend3.rst +++ b/classes/class_animationnodeblend3.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AnimationNodeBlend3.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_animationnodeblendspace1d.rst b/classes/class_animationnodeblendspace1d.rst index cc85dd858..e6471f011 100644 --- a/classes/class_animationnodeblendspace1d.rst +++ b/classes/class_animationnodeblendspace1d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AnimationNodeBlendSpace1D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_animationnodeblendspace2d.rst b/classes/class_animationnodeblendspace2d.rst index 4d040dd0a..3c7cfa6a4 100644 --- a/classes/class_animationnodeblendspace2d.rst +++ b/classes/class_animationnodeblendspace2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AnimationNodeBlendSpace2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -27,7 +27,7 @@ Tutorials - :doc:`../tutorials/animation/animation_tree` -- `Third Person Shooter Demo `_ +- `Third Person Shooter Demo `__ Properties ---------- diff --git a/classes/class_animationnodeblendtree.rst b/classes/class_animationnodeblendtree.rst index 8edb6fd97..557d9c77d 100644 --- a/classes/class_animationnodeblendtree.rst +++ b/classes/class_animationnodeblendtree.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AnimationNodeBlendTree.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_animationnodeoneshot.rst b/classes/class_animationnodeoneshot.rst index 42c9dd0d8..172613d36 100644 --- a/classes/class_animationnodeoneshot.rst +++ b/classes/class_animationnodeoneshot.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AnimationNodeOneShot.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -23,7 +23,7 @@ Tutorials - :doc:`../tutorials/animation/animation_tree` -- `Third Person Shooter Demo `_ +- `Third Person Shooter Demo `__ Properties ---------- diff --git a/classes/class_animationnodeoutput.rst b/classes/class_animationnodeoutput.rst index 96647bb1b..31eedc3af 100644 --- a/classes/class_animationnodeoutput.rst +++ b/classes/class_animationnodeoutput.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AnimationNodeOutput.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -18,9 +18,9 @@ Tutorials - :doc:`../tutorials/animation/animation_tree` -- `3D Platformer Demo `_ +- `3D Platformer Demo `__ -- `Third Person Shooter Demo `_ +- `Third Person Shooter Demo `__ .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_animationnodestatemachine.rst b/classes/class_animationnodestatemachine.rst index dca1983d4..54ce3cd4b 100644 --- a/classes/class_animationnodestatemachine.rst +++ b/classes/class_animationnodestatemachine.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AnimationNodeStateMachine.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_animationnodestatemachineplayback.rst b/classes/class_animationnodestatemachineplayback.rst index 3f7e4f4ed..10bf93eab 100644 --- a/classes/class_animationnodestatemachineplayback.rst +++ b/classes/class_animationnodestatemachineplayback.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AnimationNodeStateMachinePlayback.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_animationnodestatemachinetransition.rst b/classes/class_animationnodestatemachinetransition.rst index 4c50111ac..c1498de4a 100644 --- a/classes/class_animationnodestatemachinetransition.rst +++ b/classes/class_animationnodestatemachinetransition.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AnimationNodeStateMachineTransition.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -78,7 +78,7 @@ Property Descriptions | *Getter* | get_advance_condition() | +-----------+------------------------------+ -Turn on auto advance when this condition is set. The provided name will become a boolean parameter on the :ref:`AnimationTree` that can be controlled from code (see `https://docs.godotengine.org/en/3.3/tutorials/animation/animation_tree.html#controlling-from-code `_). For example, if :ref:`AnimationTree.tree_root` is an :ref:`AnimationNodeStateMachine` and :ref:`advance_condition` is set to ``"idle"``: +Turn on auto advance when this condition is set. The provided name will become a boolean parameter on the :ref:`AnimationTree` that can be controlled from code (see `https://docs.godotengine.org/en/3.4/tutorials/animation/animation_tree.html#controlling-from-code `__). For example, if :ref:`AnimationTree.tree_root` is an :ref:`AnimationNodeStateMachine` and :ref:`advance_condition` is set to ``"idle"``: :: diff --git a/classes/class_animationnodetimescale.rst b/classes/class_animationnodetimescale.rst index 68421428d..86027192f 100644 --- a/classes/class_animationnodetimescale.rst +++ b/classes/class_animationnodetimescale.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AnimationNodeTimeScale.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -23,7 +23,7 @@ Tutorials - :doc:`../tutorials/animation/animation_tree` -- `3D Platformer Demo `_ +- `3D Platformer Demo `__ .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_animationnodetimeseek.rst b/classes/class_animationnodetimeseek.rst index 349884d24..6f02acdde 100644 --- a/classes/class_animationnodetimeseek.rst +++ b/classes/class_animationnodetimeseek.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AnimationNodeTimeSeek.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_animationnodetransition.rst b/classes/class_animationnodetransition.rst index 8ccb188dd..2744b1392 100644 --- a/classes/class_animationnodetransition.rst +++ b/classes/class_animationnodetransition.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AnimationNodeTransition.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -23,9 +23,9 @@ Tutorials - :doc:`../tutorials/animation/animation_tree` -- `3D Platformer Demo `_ +- `3D Platformer Demo `__ -- `Third Person Shooter Demo `_ +- `Third Person Shooter Demo `__ Properties ---------- diff --git a/classes/class_animationplayer.rst b/classes/class_animationplayer.rst index a2b6554a0..55e050556 100644 --- a/classes/class_animationplayer.rst +++ b/classes/class_animationplayer.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AnimationPlayer.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -29,7 +29,7 @@ Tutorials - :doc:`../tutorials/2d/2d_sprite_animation` -- `Third Person Shooter Demo `_ +- `Third Person Shooter Demo `__ Properties ---------- @@ -224,7 +224,7 @@ The name of the animation to play when the scene loads. The name of the currently playing animation. If no animation is playing, the property's value is an empty string. Changing this value does not restart the animation. See :ref:`play` for more information on playing animations. -**Note**: while this property appears in the inspector, it's not meant to be edited, and it's not saved in the scene. This property is mainly used to get the currently playing animation, and internally for animation playback tracks. For more information, see :ref:`Animation`. +**Note:** While this property appears in the inspector, it's not meant to be edited, and it's not saved in the scene. This property is mainly used to get the currently playing animation, and internally for animation playback tracks. For more information, see :ref:`Animation`. ---- diff --git a/classes/class_animationrootnode.rst b/classes/class_animationrootnode.rst index bdb39eb20..0c09ee7c7 100644 --- a/classes/class_animationrootnode.rst +++ b/classes/class_animationrootnode.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AnimationRootNode.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_animationtrackeditplugin.rst b/classes/class_animationtrackeditplugin.rst index 3c87d6138..cbeb17caa 100644 --- a/classes/class_animationtrackeditplugin.rst +++ b/classes/class_animationtrackeditplugin.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AnimationTrackEditPlugin.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_animationtree.rst b/classes/class_animationtree.rst index 9b69ea2a5..437a5cca4 100644 --- a/classes/class_animationtree.rst +++ b/classes/class_animationtree.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AnimationTree.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -16,14 +16,16 @@ A node to be used for advanced animation transitions in an :ref:`AnimationPlayer Description ----------- -Note: When linked with an :ref:`AnimationPlayer`, several properties and methods of the corresponding :ref:`AnimationPlayer` will not function as expected. Playback and transitions should be handled using only the ``AnimationTree`` and its constituent :ref:`AnimationNode`\ (s). The :ref:`AnimationPlayer` node should be used solely for adding, deleting, and editing animations. +A node to be used for advanced animation transitions in an :ref:`AnimationPlayer`. + +**Note:** When linked with an :ref:`AnimationPlayer`, several properties and methods of the corresponding :ref:`AnimationPlayer` will not function as expected. Playback and transitions should be handled using only the ``AnimationTree`` and its constituent :ref:`AnimationNode`\ (s). The :ref:`AnimationPlayer` node should be used solely for adding, deleting, and editing animations. Tutorials --------- - :doc:`../tutorials/animation/animation_tree` -- `Third Person Shooter Demo `_ +- `Third Person Shooter Demo `__ Properties ---------- diff --git a/classes/class_animationtreeplayer.rst b/classes/class_animationtreeplayer.rst index de354497c..6d1327498 100644 --- a/classes/class_animationtreeplayer.rst +++ b/classes/class_animationtreeplayer.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AnimationTreePlayer.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_area.rst b/classes/class_area.rst index f1b1818cc..e530b8a41 100644 --- a/classes/class_area.rst +++ b/classes/class_area.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Area.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -21,9 +21,9 @@ Description Tutorials --------- -- `3D Platformer Demo `_ +- `3D Platformer Demo `__ -- `GUI in 3D Demo `_ +- `GUI in 3D Demo `__ Properties ---------- @@ -100,33 +100,33 @@ Emitted when another Area exits this Area. Requires :ref:`monitoring` area_rid, :ref:`Area` area, :ref:`int` area_shape, :ref:`int` local_shape **)** +- **area_shape_entered** **(** :ref:`RID` area_rid, :ref:`Area` area, :ref:`int` area_shape_index, :ref:`int` local_shape_index **)** Emitted when one of another Area's :ref:`Shape`\ s enters one of this Area's :ref:`Shape`\ s. Requires :ref:`monitoring` to be set to ``true``. -``area_id`` the :ref:`RID` of the other Area's :ref:`CollisionObject` used by the :ref:`PhysicsServer`. +``area_rid`` the :ref:`RID` of the other Area's :ref:`CollisionObject` used by the :ref:`PhysicsServer`. ``area`` the other Area. -``area_shape`` the index of the :ref:`Shape` of the other Area used by the :ref:`PhysicsServer`. +``area_shape_index`` the index of the :ref:`Shape` of the other Area used by the :ref:`PhysicsServer`. Get the :ref:`CollisionShape` node with ``area.shape_owner_get_owner(area_shape_index)``. -``local_shape`` the index of the :ref:`Shape` of this Area used by the :ref:`PhysicsServer`. +``local_shape_index`` the index of the :ref:`Shape` of this Area used by the :ref:`PhysicsServer`. Get the :ref:`CollisionShape` node with ``self.shape_owner_get_owner(local_shape_index)``. ---- .. _class_Area_signal_area_shape_exited: -- **area_shape_exited** **(** :ref:`RID` area_rid, :ref:`Area` area, :ref:`int` area_shape, :ref:`int` local_shape **)** +- **area_shape_exited** **(** :ref:`RID` area_rid, :ref:`Area` area, :ref:`int` area_shape_index, :ref:`int` local_shape_index **)** Emitted when one of another Area's :ref:`Shape`\ s enters one of this Area's :ref:`Shape`\ s. Requires :ref:`monitoring` to be set to ``true``. -``area_id`` the :ref:`RID` of the other Area's :ref:`CollisionObject` used by the :ref:`PhysicsServer`. +``area_rid`` the :ref:`RID` of the other Area's :ref:`CollisionObject` used by the :ref:`PhysicsServer`. ``area`` the other Area. -``area_shape`` the index of the :ref:`Shape` of the other Area used by the :ref:`PhysicsServer`. +``area_shape_index`` the index of the :ref:`Shape` of the other Area used by the :ref:`PhysicsServer`. Get the :ref:`CollisionShape` node with ``area.shape_owner_get_owner(area_shape_index)``. -``local_shape`` the index of the :ref:`Shape` of this Area used by the :ref:`PhysicsServer`. +``local_shape_index`` the index of the :ref:`Shape` of this Area used by the :ref:`PhysicsServer`. Get the :ref:`CollisionShape` node with ``self.shape_owner_get_owner(local_shape_index)``. ---- @@ -152,33 +152,33 @@ Emitted when a :ref:`PhysicsBody` or :ref:`GridMap` body_rid, :ref:`Node` body, :ref:`int` body_shape, :ref:`int` local_shape **)** +- **body_shape_entered** **(** :ref:`RID` body_rid, :ref:`Node` body, :ref:`int` body_shape_index, :ref:`int` local_shape_index **)** Emitted when one of a :ref:`PhysicsBody` or :ref:`GridMap`'s :ref:`Shape`\ s enters one of this Area's :ref:`Shape`\ s. Requires :ref:`monitoring` to be set to ``true``. :ref:`GridMap`\ s are detected if the :ref:`MeshLibrary` has Collision :ref:`Shape`\ s. -``body_id`` the :ref:`RID` of the :ref:`PhysicsBody` or :ref:`MeshLibrary`'s :ref:`CollisionObject` used by the :ref:`PhysicsServer`. +``body_rid`` the :ref:`RID` of the :ref:`PhysicsBody` or :ref:`MeshLibrary`'s :ref:`CollisionObject` used by the :ref:`PhysicsServer`. ``body`` the :ref:`Node`, if it exists in the tree, of the :ref:`PhysicsBody` or :ref:`GridMap`. -``body_shape`` the index of the :ref:`Shape` of the :ref:`PhysicsBody` or :ref:`GridMap` used by the :ref:`PhysicsServer`. +``body_shape_index`` the index of the :ref:`Shape` of the :ref:`PhysicsBody` or :ref:`GridMap` used by the :ref:`PhysicsServer`. Get the :ref:`CollisionShape` node with ``body.shape_owner_get_owner(body_shape_index)``. -``local_shape`` the index of the :ref:`Shape` of this Area used by the :ref:`PhysicsServer`. +``local_shape_index`` the index of the :ref:`Shape` of this Area used by the :ref:`PhysicsServer`. Get the :ref:`CollisionShape` node with ``self.shape_owner_get_owner(local_shape_index)``. ---- .. _class_Area_signal_body_shape_exited: -- **body_shape_exited** **(** :ref:`RID` body_rid, :ref:`Node` body, :ref:`int` body_shape, :ref:`int` local_shape **)** +- **body_shape_exited** **(** :ref:`RID` body_rid, :ref:`Node` body, :ref:`int` body_shape_index, :ref:`int` local_shape_index **)** Emitted when one of a :ref:`PhysicsBody` or :ref:`GridMap`'s :ref:`Shape`\ s enters one of this Area's :ref:`Shape`\ s. Requires :ref:`monitoring` to be set to ``true``. :ref:`GridMap`\ s are detected if the :ref:`MeshLibrary` has Collision :ref:`Shape`\ s. -``body_id`` the :ref:`RID` of the :ref:`PhysicsBody` or :ref:`MeshLibrary`'s :ref:`CollisionObject` used by the :ref:`PhysicsServer`. +``body_rid`` the :ref:`RID` of the :ref:`PhysicsBody` or :ref:`MeshLibrary`'s :ref:`CollisionObject` used by the :ref:`PhysicsServer`. ``body`` the :ref:`Node`, if it exists in the tree, of the :ref:`PhysicsBody` or :ref:`GridMap`. -``body_shape`` the index of the :ref:`Shape` of the :ref:`PhysicsBody` or :ref:`GridMap` used by the :ref:`PhysicsServer`. +``body_shape_index`` the index of the :ref:`Shape` of the :ref:`PhysicsBody` or :ref:`GridMap` used by the :ref:`PhysicsServer`. Get the :ref:`CollisionShape` node with ``body.shape_owner_get_owner(body_shape_index)``. -``local_shape`` the index of the :ref:`Shape` of this Area used by the :ref:`PhysicsServer`. +``local_shape_index`` the index of the :ref:`Shape` of this Area used by the :ref:`PhysicsServer`. Get the :ref:`CollisionShape` node with ``self.shape_owner_get_owner(local_shape_index)``. Enumerations ------------ @@ -475,7 +475,9 @@ Method Descriptions - :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. +Returns a list of intersecting ``Area``\ s. The overlapping area's :ref:`CollisionObject.collision_layer` must be part of this area's :ref:`CollisionObject.collision_mask` in order to be detected. + +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. ---- @@ -483,7 +485,9 @@ Returns a list of intersecting ``Area``\ s. For performance reasons (collisions - :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. +Returns a list of intersecting :ref:`PhysicsBody`\ s. The overlapping body's :ref:`CollisionObject.collision_layer` must be part of this area's :ref:`CollisionObject.collision_mask` in order to be detected. + +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. ---- diff --git a/classes/class_area2d.rst b/classes/class_area2d.rst index 2be0e18ae..b9d9bbbd5 100644 --- a/classes/class_area2d.rst +++ b/classes/class_area2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Area2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -23,11 +23,11 @@ Tutorials - :doc:`../tutorials/physics/using_area_2d` -- `2D Dodge The Creeps Demo `_ +- `2D Dodge The Creeps Demo `__ -- `2D Pong Demo `_ +- `2D Pong Demo `__ -- `2D Platformer Demo `_ +- `2D Platformer Demo `__ Properties ---------- @@ -96,33 +96,33 @@ Emitted when another Area2D exits this Area2D. Requires :ref:`monitoring` area_rid, :ref:`Area2D` area, :ref:`int` area_shape, :ref:`int` local_shape **)** +- **area_shape_entered** **(** :ref:`RID` area_rid, :ref:`Area2D` area, :ref:`int` area_shape_index, :ref:`int` local_shape_index **)** Emitted when one of another Area2D's :ref:`Shape2D`\ s enters one of this Area2D's :ref:`Shape2D`\ s. Requires :ref:`monitoring` to be set to ``true``. -``area_id`` the :ref:`RID` of the other Area2D's :ref:`CollisionObject2D` used by the :ref:`Physics2DServer`. +``area_rid`` the :ref:`RID` of the other Area2D's :ref:`CollisionObject2D` used by the :ref:`Physics2DServer`. ``area`` the other Area2D. -``area_shape`` the index of the :ref:`Shape2D` of the other Area2D used by the :ref:`Physics2DServer`. +``area_shape_index`` the index of the :ref:`Shape2D` of the other Area2D used by the :ref:`Physics2DServer`. Get the :ref:`CollisionShape2D` node with ``area.shape_owner_get_owner(area_shape_index)``. -``local_shape`` the index of the :ref:`Shape2D` of this Area2D used by the :ref:`Physics2DServer`. +``local_shape_index`` the index of the :ref:`Shape2D` of this Area2D used by the :ref:`Physics2DServer`. Get the :ref:`CollisionShape2D` node with ``self.shape_owner_get_owner(local_shape_index)``. ---- .. _class_Area2D_signal_area_shape_exited: -- **area_shape_exited** **(** :ref:`RID` area_rid, :ref:`Area2D` area, :ref:`int` area_shape, :ref:`int` local_shape **)** +- **area_shape_exited** **(** :ref:`RID` area_rid, :ref:`Area2D` area, :ref:`int` area_shape_index, :ref:`int` local_shape_index **)** Emitted when one of another Area2D's :ref:`Shape2D`\ s exits one of this Area2D's :ref:`Shape2D`\ s. Requires :ref:`monitoring` to be set to ``true``. -``area_id`` the :ref:`RID` of the other Area2D's :ref:`CollisionObject2D` used by the :ref:`Physics2DServer`. +``area_rid`` the :ref:`RID` of the other Area2D's :ref:`CollisionObject2D` used by the :ref:`Physics2DServer`. ``area`` the other Area2D. -``area_shape`` the index of the :ref:`Shape2D` of the other Area2D used by the :ref:`Physics2DServer`. +``area_shape_index`` the index of the :ref:`Shape2D` of the other Area2D used by the :ref:`Physics2DServer`. Get the :ref:`CollisionShape2D` node with ``area.shape_owner_get_owner(area_shape_index)``. -``local_shape`` the index of the :ref:`Shape2D` of this Area2D used by the :ref:`Physics2DServer`. +``local_shape_index`` the index of the :ref:`Shape2D` of this Area2D used by the :ref:`Physics2DServer`. Get the :ref:`CollisionShape2D` node with ``self.shape_owner_get_owner(local_shape_index)``. ---- @@ -148,33 +148,33 @@ Emitted when a :ref:`PhysicsBody2D` or :ref:`TileMap` body_rid, :ref:`Node` body, :ref:`int` body_shape, :ref:`int` local_shape **)** +- **body_shape_entered** **(** :ref:`RID` body_rid, :ref:`Node` body, :ref:`int` body_shape_index, :ref:`int` local_shape_index **)** Emitted when one of a :ref:`PhysicsBody2D` or :ref:`TileMap`'s :ref:`Shape2D`\ s enters one of this Area2D's :ref:`Shape2D`\ s. Requires :ref:`monitoring` to be set to ``true``. :ref:`TileMap`\ s are detected if the :ref:`TileSet` has Collision :ref:`Shape2D`\ s. -``body_id`` the :ref:`RID` of the :ref:`PhysicsBody2D` or :ref:`TileSet`'s :ref:`CollisionObject2D` used by the :ref:`Physics2DServer`. +``body_rid`` the :ref:`RID` of the :ref:`PhysicsBody2D` or :ref:`TileSet`'s :ref:`CollisionObject2D` used by the :ref:`Physics2DServer`. ``body`` the :ref:`Node`, if it exists in the tree, of the :ref:`PhysicsBody2D` or :ref:`TileMap`. -``body_shape`` the index of the :ref:`Shape2D` of the :ref:`PhysicsBody2D` or :ref:`TileMap` used by the :ref:`Physics2DServer`. +``body_shape_index`` the index of the :ref:`Shape2D` of the :ref:`PhysicsBody2D` or :ref:`TileMap` used by the :ref:`Physics2DServer`. Get the :ref:`CollisionShape2D` node with ``body.shape_owner_get_owner(body_shape_index)``. -``local_shape`` the index of the :ref:`Shape2D` of this Area2D used by the :ref:`Physics2DServer`. +``local_shape_index`` the index of the :ref:`Shape2D` of this Area2D used by the :ref:`Physics2DServer`. Get the :ref:`CollisionShape2D` node with ``self.shape_owner_get_owner(local_shape_index)``. ---- .. _class_Area2D_signal_body_shape_exited: -- **body_shape_exited** **(** :ref:`RID` body_rid, :ref:`Node` body, :ref:`int` body_shape, :ref:`int` local_shape **)** +- **body_shape_exited** **(** :ref:`RID` body_rid, :ref:`Node` body, :ref:`int` body_shape_index, :ref:`int` local_shape_index **)** Emitted when one of a :ref:`PhysicsBody2D` or :ref:`TileMap`'s :ref:`Shape2D`\ s exits one of this Area2D's :ref:`Shape2D`\ s. Requires :ref:`monitoring` to be set to ``true``. :ref:`TileMap`\ s are detected if the :ref:`TileSet` has Collision :ref:`Shape2D`\ s. -``body_id`` the :ref:`RID` of the :ref:`PhysicsBody2D` or :ref:`TileSet`'s :ref:`CollisionObject2D` used by the :ref:`Physics2DServer`. +``body_rid`` the :ref:`RID` of the :ref:`PhysicsBody2D` or :ref:`TileSet`'s :ref:`CollisionObject2D` used by the :ref:`Physics2DServer`. ``body`` the :ref:`Node`, if it exists in the tree, of the :ref:`PhysicsBody2D` or :ref:`TileMap`. -``body_shape`` the index of the :ref:`Shape2D` of the :ref:`PhysicsBody2D` or :ref:`TileMap` used by the :ref:`Physics2DServer`. +``body_shape_index`` the index of the :ref:`Shape2D` of the :ref:`PhysicsBody2D` or :ref:`TileMap` used by the :ref:`Physics2DServer`. Get the :ref:`CollisionShape2D` node with ``body.shape_owner_get_owner(body_shape_index)``. -``local_shape`` the index of the :ref:`Shape2D` of this Area2D used by the :ref:`Physics2DServer`. +``local_shape_index`` the index of the :ref:`Shape2D` of this Area2D used by the :ref:`Physics2DServer`. Get the :ref:`CollisionShape2D` node with ``self.shape_owner_get_owner(local_shape_index)``. Enumerations ------------ @@ -407,7 +407,9 @@ Method Descriptions - :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. +Returns a list of intersecting ``Area2D``\ s. The overlapping area's :ref:`CollisionObject2D.collision_layer` must be part of this area's :ref:`CollisionObject2D.collision_mask` in order to be detected. + +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. ---- @@ -415,7 +417,9 @@ Returns a list of intersecting ``Area2D``\ s. For performance reasons (collision - :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. +Returns a list of intersecting :ref:`PhysicsBody2D`\ s. The overlapping body's :ref:`CollisionObject2D.collision_layer` must be part of this area's :ref:`CollisionObject2D.collision_mask` in order to be detected. + +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. ---- diff --git a/classes/class_array.rst b/classes/class_array.rst index 517d1476e..13d093994 100644 --- a/classes/class_array.rst +++ b/classes/class_array.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Array.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -97,6 +97,8 @@ Methods +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`min` **(** **)** | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`pop_at` **(** :ref:`int` position **)** | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`pop_back` **(** **)** | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`pop_front` **(** **)** | @@ -386,6 +388,16 @@ Returns the minimum value contained in the array if all elements are of comparab ---- +.. _class_Array_method_pop_at: + +- :ref:`Variant` **pop_at** **(** :ref:`int` position **)** + +Removes and returns the element of the array at index ``position``. If negative, ``position`` is considered relative to the end of the array. Leaves the array untouched and returns ``null`` if the array is empty or if it's accessed out of bounds. An error message is printed when the array is accessed out of bounds, but not when the array is empty. + +**Note:** On large arrays, this method can be slower than :ref:`pop_back` as it will reindex the array's elements that are located after the removed element. The larger the array and the lower the index of the removed element, the slower :ref:`pop_at` will be. + +---- + .. _class_Array_method_pop_back: - :ref:`Variant` **pop_back** **(** **)** @@ -498,7 +510,7 @@ Sorts the array using a custom method. The arguments are an object that holds th For two elements ``a`` and ``b``, if the given method returns ``true``, element ``b`` will be after element ``a`` in the array. -**Note:** you cannot randomize the return value as the heapsort algorithm expects a deterministic result. Doing so will result in unexpected behavior. +**Note:** You cannot randomize the return value as the heapsort algorithm expects a deterministic result. Doing so will result in unexpected behavior. :: diff --git a/classes/class_arraymesh.rst b/classes/class_arraymesh.rst index 132b57c39..429908806 100644 --- a/classes/class_arraymesh.rst +++ b/classes/class_arraymesh.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ArrayMesh.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -40,7 +40,7 @@ The :ref:`MeshInstance` is ready to be added to the :ref:`Sc See also :ref:`ImmediateGeometry`, :ref:`MeshDataTool` and :ref:`SurfaceTool` for procedural geometry generation. -**Note:** Godot uses clockwise `winding order `_ for front faces of triangle primitive modes. +**Note:** Godot uses clockwise `winding order `__ for front faces of triangle primitive modes. Tutorials --------- diff --git a/classes/class_arvranchor.rst b/classes/class_arvranchor.rst index ac2ab51f5..e575afcc4 100644 --- a/classes/class_arvranchor.rst +++ b/classes/class_arvranchor.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ARVRAnchor.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_arvrcamera.rst b/classes/class_arvrcamera.rst index ab49969dd..24d070ebe 100644 --- a/classes/class_arvrcamera.rst +++ b/classes/class_arvrcamera.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ARVRCamera.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_arvrcontroller.rst b/classes/class_arvrcontroller.rst index 08cee547f..6f8bb32e4 100644 --- a/classes/class_arvrcontroller.rst +++ b/classes/class_arvrcontroller.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ARVRController.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_arvrinterface.rst b/classes/class_arvrinterface.rst index 354121545..1daacb667 100644 --- a/classes/class_arvrinterface.rst +++ b/classes/class_arvrinterface.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ARVRInterface.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_arvrinterfacegdnative.rst b/classes/class_arvrinterfacegdnative.rst index 55ec47d92..244ec185b 100644 --- a/classes/class_arvrinterfacegdnative.rst +++ b/classes/class_arvrinterfacegdnative.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ARVRInterfaceGDNative.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_arvrorigin.rst b/classes/class_arvrorigin.rst index 87211e7ac..0d61ed05a 100644 --- a/classes/class_arvrorigin.rst +++ b/classes/class_arvrorigin.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ARVROrigin.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_arvrpositionaltracker.rst b/classes/class_arvrpositionaltracker.rst index b47b5dccc..dc1443b84 100644 --- a/classes/class_arvrpositionaltracker.rst +++ b/classes/class_arvrpositionaltracker.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ARVRPositionalTracker.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_arvrserver.rst b/classes/class_arvrserver.rst index 37c9e9e80..9d5b8572e 100644 --- a/classes/class_arvrserver.rst +++ b/classes/class_arvrserver.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the ARVRServer.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_aspectratiocontainer.rst b/classes/class_aspectratiocontainer.rst index a8c25a7dc..9a676d63f 100644 --- a/classes/class_aspectratiocontainer.rst +++ b/classes/class_aspectratiocontainer.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AspectRatioContainer.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_astar.rst b/classes/class_astar.rst index f315dc957..ec8acbdbf 100644 --- a/classes/class_astar.rst +++ b/classes/class_astar.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AStar.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_astar2d.rst b/classes/class_astar2d.rst index c9de8e5c0..0fce626a4 100644 --- a/classes/class_astar2d.rst +++ b/classes/class_astar2d.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AStar2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_atlastexture.rst b/classes/class_atlastexture.rst index 785a0059f..9061f5d11 100644 --- a/classes/class_atlastexture.rst +++ b/classes/class_atlastexture.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AtlasTexture.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audiobuslayout.rst b/classes/class_audiobuslayout.rst index dd47a0dde..30d21521e 100644 --- a/classes/class_audiobuslayout.rst +++ b/classes/class_audiobuslayout.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioBusLayout.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audioeffect.rst b/classes/class_audioeffect.rst index 9aaf2dddf..3f16d860e 100644 --- a/classes/class_audioeffect.rst +++ b/classes/class_audioeffect.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffect.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -23,7 +23,7 @@ Base resource for audio bus. Applies an audio effect on the bus that the resourc Tutorials --------- -- `Audio Mic Record Demo `_ +- `Audio Mic Record Demo `__ .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_audioeffectamplify.rst b/classes/class_audioeffectamplify.rst index 6c448fbd3..24730d7fd 100644 --- a/classes/class_audioeffectamplify.rst +++ b/classes/class_audioeffectamplify.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectAmplify.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audioeffectbandlimitfilter.rst b/classes/class_audioeffectbandlimitfilter.rst index ccbc39f97..4002e1ed5 100644 --- a/classes/class_audioeffectbandlimitfilter.rst +++ b/classes/class_audioeffectbandlimitfilter.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectBandLimitFilter.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audioeffectbandpassfilter.rst b/classes/class_audioeffectbandpassfilter.rst index e36754932..8ddf80b42 100644 --- a/classes/class_audioeffectbandpassfilter.rst +++ b/classes/class_audioeffectbandpassfilter.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectBandPassFilter.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audioeffectcapture.rst b/classes/class_audioeffectcapture.rst index 5680857a9..0385fd0eb 100644 --- a/classes/class_audioeffectcapture.rst +++ b/classes/class_audioeffectcapture.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectCapture.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audioeffectchorus.rst b/classes/class_audioeffectchorus.rst index 90abc59b3..4bbc9260e 100644 --- a/classes/class_audioeffectchorus.rst +++ b/classes/class_audioeffectchorus.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectChorus.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audioeffectcompressor.rst b/classes/class_audioeffectcompressor.rst index c9d678b6d..86617bb91 100644 --- a/classes/class_audioeffectcompressor.rst +++ b/classes/class_audioeffectcompressor.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectCompressor.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audioeffectdelay.rst b/classes/class_audioeffectdelay.rst index 92aeb3060..2f8fa3b9e 100644 --- a/classes/class_audioeffectdelay.rst +++ b/classes/class_audioeffectdelay.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectDelay.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audioeffectdistortion.rst b/classes/class_audioeffectdistortion.rst index f8bfb7110..27be5b911 100644 --- a/classes/class_audioeffectdistortion.rst +++ b/classes/class_audioeffectdistortion.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectDistortion.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audioeffecteq.rst b/classes/class_audioeffecteq.rst index b93a8c1b4..c748e93b2 100644 --- a/classes/class_audioeffecteq.rst +++ b/classes/class_audioeffecteq.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectEQ.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audioeffecteq10.rst b/classes/class_audioeffecteq10.rst index 4cb9fdaa2..34783e871 100644 --- a/classes/class_audioeffecteq10.rst +++ b/classes/class_audioeffecteq10.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectEQ10.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audioeffecteq21.rst b/classes/class_audioeffecteq21.rst index 6171d6895..3798a2b19 100644 --- a/classes/class_audioeffecteq21.rst +++ b/classes/class_audioeffecteq21.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectEQ21.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audioeffecteq6.rst b/classes/class_audioeffecteq6.rst index 60925c381..19dcf0804 100644 --- a/classes/class_audioeffecteq6.rst +++ b/classes/class_audioeffecteq6.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectEQ6.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audioeffectfilter.rst b/classes/class_audioeffectfilter.rst index 95b2303e5..f3bbe2558 100644 --- a/classes/class_audioeffectfilter.rst +++ b/classes/class_audioeffectfilter.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectFilter.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audioeffecthighpassfilter.rst b/classes/class_audioeffecthighpassfilter.rst index 2b853d0ec..189801573 100644 --- a/classes/class_audioeffecthighpassfilter.rst +++ b/classes/class_audioeffecthighpassfilter.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectHighPassFilter.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audioeffecthighshelffilter.rst b/classes/class_audioeffecthighshelffilter.rst index 90158451f..7f4f61b0f 100644 --- a/classes/class_audioeffecthighshelffilter.rst +++ b/classes/class_audioeffecthighshelffilter.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectHighShelfFilter.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audioeffectinstance.rst b/classes/class_audioeffectinstance.rst index a89edde59..e5e401882 100644 --- a/classes/class_audioeffectinstance.rst +++ b/classes/class_audioeffectinstance.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectInstance.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audioeffectlimiter.rst b/classes/class_audioeffectlimiter.rst index 063c03d8c..408c5466d 100644 --- a/classes/class_audioeffectlimiter.rst +++ b/classes/class_audioeffectlimiter.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectLimiter.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audioeffectlowpassfilter.rst b/classes/class_audioeffectlowpassfilter.rst index 53604e3b3..24a7cb830 100644 --- a/classes/class_audioeffectlowpassfilter.rst +++ b/classes/class_audioeffectlowpassfilter.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectLowPassFilter.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audioeffectlowshelffilter.rst b/classes/class_audioeffectlowshelffilter.rst index 6bb5f49db..f2af5d523 100644 --- a/classes/class_audioeffectlowshelffilter.rst +++ b/classes/class_audioeffectlowshelffilter.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectLowShelfFilter.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audioeffectnotchfilter.rst b/classes/class_audioeffectnotchfilter.rst index 351241246..2c2af2b45 100644 --- a/classes/class_audioeffectnotchfilter.rst +++ b/classes/class_audioeffectnotchfilter.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectNotchFilter.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audioeffectpanner.rst b/classes/class_audioeffectpanner.rst index c8fb92a9f..a9f1fb97b 100644 --- a/classes/class_audioeffectpanner.rst +++ b/classes/class_audioeffectpanner.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectPanner.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audioeffectphaser.rst b/classes/class_audioeffectphaser.rst index 763c2544b..081aaf107 100644 --- a/classes/class_audioeffectphaser.rst +++ b/classes/class_audioeffectphaser.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectPhaser.xml source instead. .. The source is found in doc/classes or modules//doc_classes. diff --git a/classes/class_audioeffectpitchshift.rst b/classes/class_audioeffectpitchshift.rst index a127f0e75..67cb02de5 100644 --- a/classes/class_audioeffectpitchshift.rst +++ b/classes/class_audioeffectpitchshift.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectPitchShift.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -77,7 +77,7 @@ Property Descriptions | *Getter* | get_fft_size() | +-----------+---------------------+ -The size of the `Fast Fourier transform `_ buffer. Higher values smooth out the effect over time, but have greater latency. The effects of this higher latency are especially noticeable on sounds that have sudden amplitude changes. +The size of the `Fast Fourier transform `__ buffer. Higher values smooth out the effect over time, but have greater latency. The effects of this higher latency are especially noticeable on sounds that have sudden amplitude changes. ---- diff --git a/classes/class_audioeffectrecord.rst b/classes/class_audioeffectrecord.rst index e5a39cec1..af39ccdc7 100644 --- a/classes/class_audioeffectrecord.rst +++ b/classes/class_audioeffectrecord.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectRecord.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -23,7 +23,7 @@ Tutorials - :doc:`../tutorials/audio/recording_with_microphone` -- `Audio Mic Record Demo `_ +- `Audio Mic Record Demo `__ Properties ---------- diff --git a/classes/class_audioeffectreverb.rst b/classes/class_audioeffectreverb.rst index a6ad0141b..17e27cc52 100644 --- a/classes/class_audioeffectreverb.rst +++ b/classes/class_audioeffectreverb.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectReverb.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -23,7 +23,7 @@ Simulates rooms of different sizes. Its parameters can be adjusted to simulate t Tutorials --------- -- `Third Person Shooter Demo `_ +- `Third Person Shooter Demo `__ Properties ---------- diff --git a/classes/class_audioeffectspectrumanalyzer.rst b/classes/class_audioeffectspectrumanalyzer.rst index 3778fc4cb..634009cda 100644 --- a/classes/class_audioeffectspectrumanalyzer.rst +++ b/classes/class_audioeffectspectrumanalyzer.rst @@ -1,6 +1,6 @@ :github_url: hide -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. Generated automatically by doc/tools/make_rst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectSpectrumAnalyzer.xml source instead. .. The source is found in doc/classes or modules//doc_classes. @@ -23,9 +23,9 @@ See also :ref:`AudioStreamGenerator` for procedurall Tutorials --------- -- `https://godotengine.org/asset-library/asset/528