From 77af6c9b616a266ca21ffd64a6e23cdeb2dd6466 Mon Sep 17 00:00:00 2001 From: Godot Organization Date: Tue, 7 May 2024 11:26:31 +0000 Subject: [PATCH] classref: Sync with current 4.2 branch (f9d101d) --- classes/class_@gdscript.rst | 16 +- classes/class_@globalscope.rst | 72 +- classes/class_aabb.rst | 262 +- classes/class_acceptdialog.rst | 4 +- classes/class_aescontext.rst | 4 +- classes/class_animatablebody2d.rst | 4 +- classes/class_animatablebody3d.rst | 4 +- classes/class_animatedsprite2d.rst | 4 +- classes/class_animatedsprite3d.rst | 4 +- classes/class_animatedtexture.rst | 4 +- classes/class_animation.rst | 14 +- classes/class_animationlibrary.rst | 4 +- classes/class_animationmixer.rst | 4 +- classes/class_animationnode.rst | 8 +- classes/class_animationnodeadd2.rst | 4 +- classes/class_animationnodeadd3.rst | 4 +- classes/class_animationnodeanimation.rst | 4 +- classes/class_animationnodeblend2.rst | 4 +- classes/class_animationnodeblend3.rst | 4 +- classes/class_animationnodeblendspace1d.rst | 4 +- classes/class_animationnodeblendspace2d.rst | 4 +- classes/class_animationnodeblendtree.rst | 4 +- classes/class_animationnodeoneshot.rst | 4 +- classes/class_animationnodeoutput.rst | 4 +- classes/class_animationnodestatemachine.rst | 6 +- ...lass_animationnodestatemachineplayback.rst | 4 +- ...ss_animationnodestatemachinetransition.rst | 4 +- classes/class_animationnodesub2.rst | 4 +- classes/class_animationnodesync.rst | 4 +- classes/class_animationnodetimescale.rst | 6 +- classes/class_animationnodetimeseek.rst | 4 +- classes/class_animationnodetransition.rst | 4 +- classes/class_animationplayer.rst | 4 +- classes/class_animationrootnode.rst | 4 +- classes/class_animationtree.rst | 4 +- classes/class_area2d.rst | 4 +- classes/class_area3d.rst | 4 +- classes/class_array.rst | 54 +- classes/class_arraymesh.rst | 4 +- classes/class_arrayoccluder3d.rst | 4 +- classes/class_aspectratiocontainer.rst | 4 +- classes/class_astar2d.rst | 4 +- classes/class_astar3d.rst | 4 +- classes/class_astargrid2d.rst | 6 +- classes/class_atlastexture.rst | 4 +- classes/class_audiobuslayout.rst | 4 +- classes/class_audioeffect.rst | 4 +- classes/class_audioeffectamplify.rst | 4 +- classes/class_audioeffectbandlimitfilter.rst | 4 +- classes/class_audioeffectbandpassfilter.rst | 4 +- classes/class_audioeffectcapture.rst | 4 +- classes/class_audioeffectchorus.rst | 4 +- classes/class_audioeffectcompressor.rst | 4 +- classes/class_audioeffectdelay.rst | 4 +- classes/class_audioeffectdistortion.rst | 4 +- classes/class_audioeffecteq.rst | 4 +- classes/class_audioeffecteq10.rst | 4 +- classes/class_audioeffecteq21.rst | 4 +- classes/class_audioeffecteq6.rst | 4 +- classes/class_audioeffectfilter.rst | 4 +- classes/class_audioeffecthighpassfilter.rst | 4 +- classes/class_audioeffecthighshelffilter.rst | 4 +- classes/class_audioeffectinstance.rst | 4 +- classes/class_audioeffectlimiter.rst | 4 +- classes/class_audioeffectlowpassfilter.rst | 4 +- classes/class_audioeffectlowshelffilter.rst | 4 +- classes/class_audioeffectnotchfilter.rst | 4 +- classes/class_audioeffectpanner.rst | 4 +- classes/class_audioeffectphaser.rst | 4 +- classes/class_audioeffectpitchshift.rst | 6 +- classes/class_audioeffectrecord.rst | 4 +- classes/class_audioeffectreverb.rst | 4 +- classes/class_audioeffectspectrumanalyzer.rst | 4 +- ...ss_audioeffectspectrumanalyzerinstance.rst | 4 +- classes/class_audioeffectstereoenhance.rst | 4 +- classes/class_audiolistener2d.rst | 4 +- classes/class_audiolistener3d.rst | 4 +- classes/class_audioserver.rst | 8 +- classes/class_audiostream.rst | 32 +- classes/class_audiostreamgenerator.rst | 4 +- .../class_audiostreamgeneratorplayback.rst | 4 +- classes/class_audiostreammicrophone.rst | 4 +- classes/class_audiostreammp3.rst | 4 +- classes/class_audiostreamoggvorbis.rst | 4 +- classes/class_audiostreamplayback.rst | 36 +- .../class_audiostreamplaybackoggvorbis.rst | 4 +- .../class_audiostreamplaybackpolyphonic.rst | 4 +- .../class_audiostreamplaybackresampled.rst | 4 +- classes/class_audiostreamplayer.rst | 4 +- classes/class_audiostreamplayer2d.rst | 4 +- classes/class_audiostreamplayer3d.rst | 4 +- classes/class_audiostreampolyphonic.rst | 4 +- classes/class_audiostreamrandomizer.rst | 4 +- classes/class_audiostreamwav.rst | 4 +- classes/class_backbuffercopy.rst | 4 +- classes/class_basebutton.rst | 4 +- classes/class_basematerial3d.rst | 18 +- classes/class_basis.rst | 381 ++- classes/class_bitmap.rst | 4 +- classes/class_bone2d.rst | 6 +- classes/class_boneattachment3d.rst | 4 +- classes/class_bonemap.rst | 4 +- classes/class_bool.rst | 4 +- classes/class_boxcontainer.rst | 4 +- classes/class_boxmesh.rst | 4 +- classes/class_boxoccluder3d.rst | 4 +- classes/class_boxshape3d.rst | 4 +- classes/class_button.rst | 4 +- classes/class_buttongroup.rst | 4 +- classes/class_callable.rst | 6 +- classes/class_callbacktweener.rst | 4 +- classes/class_camera2d.rst | 4 +- classes/class_camera3d.rst | 4 +- classes/class_cameraattributes.rst | 4 +- classes/class_cameraattributesphysical.rst | 6 +- classes/class_cameraattributespractical.rst | 6 +- classes/class_camerafeed.rst | 4 +- classes/class_cameraserver.rst | 4 +- classes/class_cameratexture.rst | 4 +- classes/class_canvasgroup.rst | 4 +- classes/class_canvasitem.rst | 30 +- classes/class_canvasitemmaterial.rst | 4 +- classes/class_canvaslayer.rst | 4 +- classes/class_canvasmodulate.rst | 4 +- classes/class_canvastexture.rst | 6 +- classes/class_capsulemesh.rst | 4 +- classes/class_capsuleshape2d.rst | 4 +- classes/class_capsuleshape3d.rst | 4 +- classes/class_centercontainer.rst | 4 +- classes/class_characterbody2d.rst | 4 +- classes/class_characterbody3d.rst | 4 +- classes/class_charfxtransform.rst | 4 +- classes/class_checkbox.rst | 4 +- classes/class_checkbutton.rst | 4 +- classes/class_circleshape2d.rst | 4 +- classes/class_classdb.rst | 4 +- classes/class_codeedit.rst | 4 +- classes/class_codehighlighter.rst | 4 +- classes/class_collisionobject2d.rst | 4 +- classes/class_collisionobject3d.rst | 4 +- classes/class_collisionpolygon2d.rst | 6 +- classes/class_collisionpolygon3d.rst | 4 +- classes/class_collisionshape2d.rst | 4 +- classes/class_collisionshape3d.rst | 4 +- classes/class_color.rst | 6 +- classes/class_colorpicker.rst | 4 +- classes/class_colorpickerbutton.rst | 4 +- classes/class_colorrect.rst | 4 +- classes/class_compressedcubemap.rst | 6 +- classes/class_compressedcubemaparray.rst | 6 +- classes/class_compressedtexture2d.rst | 4 +- classes/class_compressedtexture2darray.rst | 6 +- classes/class_compressedtexture3d.rst | 4 +- classes/class_compressedtexturelayered.rst | 4 +- classes/class_concavepolygonshape2d.rst | 4 +- classes/class_concavepolygonshape3d.rst | 4 +- classes/class_conetwistjoint3d.rst | 4 +- classes/class_configfile.rst | 4 +- classes/class_confirmationdialog.rst | 4 +- classes/class_container.rst | 4 +- classes/class_control.rst | 4 +- classes/class_convexpolygonshape2d.rst | 4 +- classes/class_convexpolygonshape3d.rst | 4 +- classes/class_cpuparticles2d.rst | 4 +- classes/class_cpuparticles3d.rst | 4 +- classes/class_crypto.rst | 4 +- classes/class_cryptokey.rst | 4 +- classes/class_csgbox3d.rst | 4 +- classes/class_csgcombiner3d.rst | 4 +- classes/class_csgcylinder3d.rst | 4 +- classes/class_csgmesh3d.rst | 4 +- classes/class_csgpolygon3d.rst | 4 +- classes/class_csgprimitive3d.rst | 4 +- classes/class_csgshape3d.rst | 4 +- classes/class_csgsphere3d.rst | 4 +- classes/class_csgtorus3d.rst | 4 +- classes/class_csharpscript.rst | 4 +- classes/class_cubemap.rst | 4 +- classes/class_cubemaparray.rst | 4 +- classes/class_curve.rst | 4 +- classes/class_curve2d.rst | 4 +- classes/class_curve3d.rst | 4 +- classes/class_curvetexture.rst | 4 +- classes/class_curvexyztexture.rst | 4 +- classes/class_cylindermesh.rst | 4 +- classes/class_cylindershape3d.rst | 4 +- classes/class_dampedspringjoint2d.rst | 4 +- classes/class_decal.rst | 4 +- classes/class_dictionary.rst | 4 +- classes/class_diraccess.rst | 4 +- classes/class_directionallight2d.rst | 4 +- classes/class_directionallight3d.rst | 4 +- classes/class_displayserver.rst | 16 +- classes/class_dtlsserver.rst | 10 +- classes/class_editorcommandpalette.rst | 4 +- classes/class_editordebuggerplugin.rst | 4 +- classes/class_editordebuggersession.rst | 4 +- classes/class_editorexportplatform.rst | 6 +- classes/class_editorexportplatformandroid.rst | 26 +- classes/class_editorexportplatformios.rst | 2292 ++++++++++++++++- .../class_editorexportplatformlinuxbsd.rst | 4 +- classes/class_editorexportplatformmacos.rst | 4 +- classes/class_editorexportplatformpc.rst | 4 +- classes/class_editorexportplatformweb.rst | 99 +- classes/class_editorexportplatformwindows.rst | 4 +- classes/class_editorexportplugin.rst | 4 +- classes/class_editorfeatureprofile.rst | 4 +- classes/class_editorfiledialog.rst | 4 +- classes/class_editorfilesystem.rst | 4 +- classes/class_editorfilesystemdirectory.rst | 4 +- ...itorfilesystemimportformatsupportquery.rst | 4 +- classes/class_editorimportplugin.rst | 4 +- classes/class_editorinspector.rst | 4 +- classes/class_editorinspectorplugin.rst | 4 +- classes/class_editorinterface.rst | 4 +- classes/class_editornode3dgizmo.rst | 20 +- classes/class_editornode3dgizmoplugin.rst | 20 +- classes/class_editorpaths.rst | 4 +- classes/class_editorplugin.rst | 6 +- classes/class_editorproperty.rst | 4 +- .../class_editorresourceconversionplugin.rst | 4 +- classes/class_editorresourcepicker.rst | 4 +- classes/class_editorresourcepreview.rst | 4 +- .../class_editorresourcepreviewgenerator.rst | 4 +- classes/class_editorresourcetooltipplugin.rst | 4 +- classes/class_editorsceneformatimporter.rst | 4 +- .../class_editorsceneformatimporterblend.rst | 4 +- .../class_editorsceneformatimporterfbx.rst | 4 +- .../class_editorsceneformatimportergltf.rst | 4 +- classes/class_editorscenepostimport.rst | 4 +- classes/class_editorscenepostimportplugin.rst | 4 +- classes/class_editorscript.rst | 4 +- classes/class_editorscriptpicker.rst | 4 +- classes/class_editorselection.rst | 4 +- classes/class_editorsettings.rst | 8 +- classes/class_editorspinslider.rst | 4 +- classes/class_editorsyntaxhighlighter.rst | 4 +- .../class_editortranslationparserplugin.rst | 4 +- classes/class_editorundoredomanager.rst | 4 +- classes/class_editorvcsinterface.rst | 4 +- classes/class_encodedobjectasid.rst | 4 +- classes/class_enetconnection.rst | 4 +- classes/class_enetmultiplayerpeer.rst | 4 +- classes/class_enetpacketpeer.rst | 4 +- classes/class_engine.rst | 6 +- classes/class_enginedebugger.rst | 4 +- classes/class_engineprofiler.rst | 4 +- classes/class_environment.rst | 4 +- classes/class_expression.rst | 4 +- classes/class_fastnoiselite.rst | 4 +- classes/class_fileaccess.rst | 8 +- classes/class_filedialog.rst | 4 +- classes/class_filesystemdock.rst | 4 +- classes/class_float.rst | 4 +- classes/class_flowcontainer.rst | 8 +- classes/class_fogmaterial.rst | 4 +- classes/class_fogvolume.rst | 4 +- classes/class_font.rst | 6 +- classes/class_fontfile.rst | 4 +- classes/class_fontvariation.rst | 4 +- classes/class_gdextension.rst | 4 +- classes/class_gdextensionmanager.rst | 4 +- classes/class_gdscript.rst | 4 +- classes/class_generic6dofjoint3d.rst | 4 +- classes/class_geometry2d.rst | 4 +- classes/class_geometry3d.rst | 4 +- classes/class_geometryinstance3d.rst | 10 +- classes/class_gltfaccessor.rst | 4 +- classes/class_gltfanimation.rst | 4 +- classes/class_gltfbufferview.rst | 4 +- classes/class_gltfcamera.rst | 4 +- classes/class_gltfdocument.rst | 4 +- classes/class_gltfdocumentextension.rst | 4 +- ...tfdocumentextensionconvertimportermesh.rst | 4 +- classes/class_gltflight.rst | 4 +- classes/class_gltfmesh.rst | 4 +- classes/class_gltfnode.rst | 6 +- classes/class_gltfphysicsbody.rst | 4 +- classes/class_gltfphysicsshape.rst | 4 +- classes/class_gltfskeleton.rst | 4 +- classes/class_gltfskin.rst | 4 +- classes/class_gltfspecgloss.rst | 4 +- classes/class_gltfstate.rst | 4 +- classes/class_gltftexture.rst | 4 +- classes/class_gltftexturesampler.rst | 4 +- classes/class_godotsharp.rst | 4 +- classes/class_gpuparticles2d.rst | 4 +- classes/class_gpuparticles3d.rst | 4 +- classes/class_gpuparticlesattractor3d.rst | 4 +- classes/class_gpuparticlesattractorbox3d.rst | 4 +- .../class_gpuparticlesattractorsphere3d.rst | 4 +- ...ass_gpuparticlesattractorvectorfield3d.rst | 4 +- classes/class_gpuparticlescollision3d.rst | 4 +- classes/class_gpuparticlescollisionbox3d.rst | 4 +- ...ass_gpuparticlescollisionheightfield3d.rst | 4 +- classes/class_gpuparticlescollisionsdf3d.rst | 4 +- .../class_gpuparticlescollisionsphere3d.rst | 4 +- classes/class_gradient.rst | 4 +- classes/class_gradienttexture1d.rst | 4 +- classes/class_gradienttexture2d.rst | 4 +- classes/class_graphedit.rst | 26 +- classes/class_graphelement.rst | 4 +- classes/class_graphnode.rst | 4 +- classes/class_gridcontainer.rst | 8 +- classes/class_gridmap.rst | 4 +- classes/class_groovejoint2d.rst | 4 +- classes/class_hashingcontext.rst | 4 +- classes/class_hboxcontainer.rst | 4 +- classes/class_heightmapshape3d.rst | 4 +- classes/class_hflowcontainer.rst | 4 +- classes/class_hingejoint3d.rst | 4 +- classes/class_hmaccontext.rst | 4 +- classes/class_hscrollbar.rst | 4 +- classes/class_hseparator.rst | 4 +- classes/class_hslider.rst | 4 +- classes/class_hsplitcontainer.rst | 4 +- classes/class_httpclient.rst | 8 +- classes/class_httprequest.rst | 12 +- classes/class_image.rst | 32 +- classes/class_imageformatloader.rst | 4 +- classes/class_imageformatloaderextension.rst | 4 +- classes/class_imagetexture.rst | 4 +- classes/class_imagetexture3d.rst | 4 +- classes/class_imagetexturelayered.rst | 4 +- classes/class_immediatemesh.rst | 4 +- classes/class_importermesh.rst | 4 +- classes/class_importermeshinstance3d.rst | 4 +- classes/class_input.rst | 6 +- classes/class_inputevent.rst | 4 +- classes/class_inputeventaction.rst | 4 +- classes/class_inputeventfromwindow.rst | 4 +- classes/class_inputeventgesture.rst | 4 +- classes/class_inputeventjoypadbutton.rst | 8 +- classes/class_inputeventjoypadmotion.rst | 4 +- classes/class_inputeventkey.rst | 4 +- classes/class_inputeventmagnifygesture.rst | 4 +- classes/class_inputeventmidi.rst | 77 +- classes/class_inputeventmouse.rst | 4 +- classes/class_inputeventmousebutton.rst | 4 +- classes/class_inputeventmousemotion.rst | 4 +- classes/class_inputeventpangesture.rst | 4 +- classes/class_inputeventscreendrag.rst | 6 +- classes/class_inputeventscreentouch.rst | 6 +- classes/class_inputeventshortcut.rst | 4 +- classes/class_inputeventwithmodifiers.rst | 4 +- classes/class_inputmap.rst | 4 +- classes/class_instanceplaceholder.rst | 4 +- classes/class_int.rst | 4 +- classes/class_intervaltweener.rst | 4 +- classes/class_ip.rst | 4 +- classes/class_itemlist.rst | 4 +- classes/class_javaclass.rst | 4 +- classes/class_javaclasswrapper.rst | 4 +- classes/class_javascriptbridge.rst | 4 +- classes/class_javascriptobject.rst | 4 +- classes/class_jnisingleton.rst | 4 +- classes/class_joint2d.rst | 4 +- classes/class_joint3d.rst | 4 +- classes/class_json.rst | 4 +- classes/class_jsonrpc.rst | 4 +- classes/class_kinematiccollision2d.rst | 4 +- classes/class_kinematiccollision3d.rst | 4 +- classes/class_label.rst | 6 +- classes/class_label3d.rst | 4 +- classes/class_labelsettings.rst | 4 +- classes/class_light2d.rst | 4 +- classes/class_light3d.rst | 4 +- classes/class_lightmapgi.rst | 6 +- classes/class_lightmapgidata.rst | 4 +- classes/class_lightmapper.rst | 4 +- classes/class_lightmapperrd.rst | 4 +- classes/class_lightmapprobe.rst | 4 +- classes/class_lightoccluder2d.rst | 4 +- classes/class_line2d.rst | 4 +- classes/class_lineedit.rst | 4 +- classes/class_linkbutton.rst | 4 +- classes/class_mainloop.rst | 7 +- classes/class_margincontainer.rst | 4 +- classes/class_marker2d.rst | 4 +- classes/class_marker3d.rst | 4 +- classes/class_marshalls.rst | 4 +- classes/class_material.rst | 4 +- classes/class_menubar.rst | 4 +- classes/class_menubutton.rst | 4 +- classes/class_mesh.rst | 12 +- .../class_meshconvexdecompositionsettings.rst | 4 +- classes/class_meshdatatool.rst | 4 +- classes/class_meshinstance2d.rst | 4 +- classes/class_meshinstance3d.rst | 4 +- classes/class_meshlibrary.rst | 4 +- classes/class_meshtexture.rst | 4 +- classes/class_methodtweener.rst | 4 +- classes/class_missingnode.rst | 4 +- classes/class_missingresource.rst | 4 +- classes/class_mobilevrinterface.rst | 4 +- classes/class_moviewriter.rst | 4 +- classes/class_multimesh.rst | 4 +- classes/class_multimeshinstance2d.rst | 4 +- classes/class_multimeshinstance3d.rst | 4 +- classes/class_multiplayerapi.rst | 4 +- classes/class_multiplayerapiextension.rst | 4 +- classes/class_multiplayerpeer.rst | 4 +- classes/class_multiplayerpeerextension.rst | 4 +- classes/class_multiplayerspawner.rst | 4 +- classes/class_multiplayersynchronizer.rst | 4 +- classes/class_mutex.rst | 4 +- classes/class_navigationagent2d.rst | 4 +- classes/class_navigationagent3d.rst | 4 +- classes/class_navigationlink2d.rst | 18 +- classes/class_navigationlink3d.rst | 18 +- classes/class_navigationmesh.rst | 4 +- classes/class_navigationmeshgenerator.rst | 4 +- ...ass_navigationmeshsourcegeometrydata2d.rst | 4 +- ...ass_navigationmeshsourcegeometrydata3d.rst | 4 +- classes/class_navigationobstacle2d.rst | 4 +- classes/class_navigationobstacle3d.rst | 4 +- .../class_navigationpathqueryparameters2d.rst | 4 +- .../class_navigationpathqueryparameters3d.rst | 4 +- classes/class_navigationpathqueryresult2d.rst | 4 +- classes/class_navigationpathqueryresult3d.rst | 4 +- classes/class_navigationpolygon.rst | 4 +- classes/class_navigationregion2d.rst | 20 +- classes/class_navigationregion3d.rst | 20 +- classes/class_navigationserver2d.rst | 6 +- classes/class_navigationserver3d.rst | 8 +- classes/class_ninepatchrect.rst | 4 +- classes/class_node.rst | 473 ++-- classes/class_node2d.rst | 4 +- classes/class_node3d.rst | 8 +- classes/class_node3dgizmo.rst | 4 +- classes/class_nodepath.rst | 4 +- classes/class_noise.rst | 4 +- classes/class_noisetexture2d.rst | 4 +- classes/class_noisetexture3d.rst | 4 +- classes/class_object.rst | 36 +- classes/class_occluder3d.rst | 4 +- classes/class_occluderinstance3d.rst | 4 +- classes/class_occluderpolygon2d.rst | 4 +- classes/class_offlinemultiplayerpeer.rst | 4 +- classes/class_oggpacketsequence.rst | 4 +- classes/class_oggpacketsequenceplayback.rst | 4 +- classes/class_omnilight3d.rst | 4 +- classes/class_openxraction.rst | 4 +- classes/class_openxractionmap.rst | 4 +- classes/class_openxractionset.rst | 4 +- classes/class_openxrapiextension.rst | 4 +- .../class_openxrextensionwrapperextension.rst | 4 +- classes/class_openxrhand.rst | 4 +- classes/class_openxrinteractionprofile.rst | 4 +- ...class_openxrinteractionprofilemetadata.rst | 4 +- classes/class_openxrinterface.rst | 4 +- classes/class_openxripbinding.rst | 4 +- classes/class_optimizedtranslation.rst | 4 +- classes/class_optionbutton.rst | 4 +- classes/class_ormmaterial3d.rst | 4 +- classes/class_os.rst | 14 +- classes/class_packedbytearray.rst | 10 +- classes/class_packedcolorarray.rst | 6 +- classes/class_packeddatacontainer.rst | 4 +- classes/class_packeddatacontainerref.rst | 4 +- classes/class_packedfloat32array.rst | 6 +- classes/class_packedfloat64array.rst | 6 +- classes/class_packedint32array.rst | 6 +- classes/class_packedint64array.rst | 6 +- classes/class_packedscene.rst | 6 +- classes/class_packedstringarray.rst | 6 +- classes/class_packedvector2array.rst | 6 +- classes/class_packedvector3array.rst | 6 +- classes/class_packetpeer.rst | 4 +- classes/class_packetpeerdtls.rst | 4 +- classes/class_packetpeerextension.rst | 4 +- classes/class_packetpeerstream.rst | 4 +- classes/class_packetpeerudp.rst | 6 +- classes/class_panel.rst | 4 +- classes/class_panelcontainer.rst | 4 +- classes/class_panoramaskymaterial.rst | 4 +- classes/class_parallaxbackground.rst | 4 +- classes/class_parallaxlayer.rst | 12 +- classes/class_particleprocessmaterial.rst | 4 +- classes/class_path2d.rst | 4 +- classes/class_path3d.rst | 4 +- classes/class_pathfollow2d.rst | 4 +- classes/class_pathfollow3d.rst | 4 +- classes/class_pckpacker.rst | 6 +- classes/class_performance.rst | 4 +- classes/class_physicalbone2d.rst | 4 +- classes/class_physicalbone3d.rst | 6 +- classes/class_physicalskymaterial.rst | 4 +- classes/class_physicsbody2d.rst | 4 +- classes/class_physicsbody3d.rst | 4 +- classes/class_physicsdirectbodystate2d.rst | 4 +- ...lass_physicsdirectbodystate2dextension.rst | 180 +- classes/class_physicsdirectbodystate3d.rst | 4 +- ...lass_physicsdirectbodystate3dextension.rst | 4 +- classes/class_physicsdirectspacestate2d.rst | 4 +- ...ass_physicsdirectspacestate2dextension.rst | 4 +- classes/class_physicsdirectspacestate3d.rst | 4 +- ...ass_physicsdirectspacestate3dextension.rst | 4 +- classes/class_physicsmaterial.rst | 6 +- .../class_physicspointqueryparameters2d.rst | 4 +- .../class_physicspointqueryparameters3d.rst | 4 +- classes/class_physicsrayqueryparameters2d.rst | 4 +- classes/class_physicsrayqueryparameters3d.rst | 4 +- classes/class_physicsserver2d.rst | 4 +- classes/class_physicsserver2dextension.rst | 564 ++-- classes/class_physicsserver2dmanager.rst | 4 +- classes/class_physicsserver3d.rst | 4 +- classes/class_physicsserver3dextension.rst | 4 +- classes/class_physicsserver3dmanager.rst | 4 +- ..._physicsserver3drenderingserverhandler.rst | 4 +- .../class_physicsshapequeryparameters2d.rst | 4 +- .../class_physicsshapequeryparameters3d.rst | 4 +- .../class_physicstestmotionparameters2d.rst | 4 +- .../class_physicstestmotionparameters3d.rst | 4 +- classes/class_physicstestmotionresult2d.rst | 4 +- classes/class_physicstestmotionresult3d.rst | 4 +- classes/class_pinjoint2d.rst | 4 +- classes/class_pinjoint3d.rst | 4 +- classes/class_placeholdercubemap.rst | 4 +- classes/class_placeholdercubemaparray.rst | 4 +- classes/class_placeholdermaterial.rst | 4 +- classes/class_placeholdermesh.rst | 4 +- classes/class_placeholdertexture2d.rst | 4 +- classes/class_placeholdertexture2darray.rst | 4 +- classes/class_placeholdertexture3d.rst | 4 +- classes/class_placeholdertexturelayered.rst | 4 +- classes/class_plane.rst | 4 +- classes/class_planemesh.rst | 4 +- classes/class_pointlight2d.rst | 4 +- classes/class_pointmesh.rst | 4 +- classes/class_polygon2d.rst | 4 +- classes/class_polygonoccluder3d.rst | 4 +- classes/class_polygonpathfinder.rst | 4 +- classes/class_popup.rst | 4 +- classes/class_popupmenu.rst | 4 +- classes/class_popuppanel.rst | 4 +- classes/class_portablecompressedtexture2d.rst | 4 +- classes/class_primitivemesh.rst | 8 +- classes/class_prismmesh.rst | 4 +- classes/class_proceduralskymaterial.rst | 6 +- classes/class_progressbar.rst | 4 +- classes/class_projection.rst | 4 +- classes/class_projectsettings.rst | 46 +- classes/class_propertytweener.rst | 4 +- classes/class_quadmesh.rst | 4 +- classes/class_quadoccluder3d.rst | 4 +- classes/class_quaternion.rst | 136 +- classes/class_randomnumbergenerator.rst | 6 +- classes/class_range.rst | 4 +- classes/class_raycast2d.rst | 27 +- classes/class_raycast3d.rst | 27 +- classes/class_rdattachmentformat.rst | 4 +- classes/class_rdframebufferpass.rst | 4 +- classes/class_rdpipelinecolorblendstate.rst | 4 +- ...ss_rdpipelinecolorblendstateattachment.rst | 4 +- classes/class_rdpipelinedepthstencilstate.rst | 84 +- classes/class_rdpipelinemultisamplestate.rst | 4 +- .../class_rdpipelinerasterizationstate.rst | 4 +- ...class_rdpipelinespecializationconstant.rst | 4 +- classes/class_rdsamplerstate.rst | 4 +- classes/class_rdshaderfile.rst | 4 +- classes/class_rdshadersource.rst | 4 +- classes/class_rdshaderspirv.rst | 4 +- classes/class_rdtextureformat.rst | 4 +- classes/class_rdtextureview.rst | 4 +- classes/class_rduniform.rst | 4 +- classes/class_rdvertexattribute.rst | 4 +- classes/class_rect2.rst | 4 +- classes/class_rect2i.rst | 4 +- classes/class_rectangleshape2d.rst | 4 +- classes/class_refcounted.rst | 4 +- classes/class_referencerect.rst | 4 +- classes/class_reflectionprobe.rst | 4 +- classes/class_regex.rst | 4 +- classes/class_regexmatch.rst | 4 +- classes/class_remotetransform2d.rst | 4 +- classes/class_remotetransform3d.rst | 4 +- classes/class_renderingdevice.rst | 6 +- classes/class_renderingserver.rst | 44 +- classes/class_renderscenebuffers.rst | 4 +- .../class_renderscenebuffersconfiguration.rst | 4 +- classes/class_renderscenebuffersextension.rst | 4 +- classes/class_renderscenebuffersrd.rst | 4 +- classes/class_resource.rst | 4 +- classes/class_resourceformatloader.rst | 4 +- classes/class_resourceformatsaver.rst | 4 +- classes/class_resourceimporter.rst | 4 +- classes/class_resourceimporterbitmap.rst | 4 +- classes/class_resourceimporterbmfont.rst | 4 +- .../class_resourceimportercsvtranslation.rst | 4 +- classes/class_resourceimporterdynamicfont.rst | 4 +- classes/class_resourceimporterimage.rst | 4 +- classes/class_resourceimporterimagefont.rst | 4 +- .../class_resourceimporterlayeredtexture.rst | 4 +- classes/class_resourceimportermp3.rst | 4 +- classes/class_resourceimporterobj.rst | 6 +- classes/class_resourceimporteroggvorbis.rst | 4 +- classes/class_resourceimporterscene.rst | 6 +- classes/class_resourceimportershaderfile.rst | 4 +- classes/class_resourceimportertexture.rst | 4 +- .../class_resourceimportertextureatlas.rst | 4 +- classes/class_resourceimporterwav.rst | 4 +- classes/class_resourceloader.rst | 6 +- classes/class_resourcepreloader.rst | 4 +- classes/class_resourcesaver.rst | 4 +- classes/class_resourceuid.rst | 4 +- classes/class_ribbontrailmesh.rst | 4 +- classes/class_richtexteffect.rst | 6 +- classes/class_richtextlabel.rst | 56 +- classes/class_rid.rst | 4 +- classes/class_rigidbody2d.rst | 4 +- classes/class_rigidbody3d.rst | 4 +- classes/class_rootmotionview.rst | 4 +- classes/class_scenemultiplayer.rst | 4 +- classes/class_scenereplicationconfig.rst | 4 +- classes/class_scenestate.rst | 4 +- classes/class_scenetree.rst | 4 +- classes/class_scenetreetimer.rst | 4 +- classes/class_script.rst | 4 +- classes/class_scriptcreatedialog.rst | 4 +- classes/class_scripteditor.rst | 4 +- classes/class_scripteditorbase.rst | 4 +- classes/class_scriptextension.rst | 4 +- classes/class_scriptlanguage.rst | 4 +- classes/class_scriptlanguageextension.rst | 4 +- classes/class_scrollbar.rst | 4 +- classes/class_scrollcontainer.rst | 4 +- classes/class_segmentshape2d.rst | 4 +- classes/class_semaphore.rst | 4 +- classes/class_separationrayshape2d.rst | 4 +- classes/class_separationrayshape3d.rst | 4 +- classes/class_separator.rst | 4 +- classes/class_shader.rst | 4 +- classes/class_shaderglobalsoverride.rst | 4 +- classes/class_shaderinclude.rst | 4 +- classes/class_shadermaterial.rst | 4 +- classes/class_shape2d.rst | 4 +- classes/class_shape3d.rst | 4 +- classes/class_shapecast2d.rst | 4 +- classes/class_shapecast3d.rst | 4 +- classes/class_shortcut.rst | 4 +- classes/class_signal.rst | 4 +- classes/class_skeleton2d.rst | 4 +- classes/class_skeleton3d.rst | 26 +- classes/class_skeletonik3d.rst | 4 +- classes/class_skeletonmodification2d.rst | 4 +- classes/class_skeletonmodification2dccdik.rst | 4 +- .../class_skeletonmodification2dfabrik.rst | 4 +- .../class_skeletonmodification2djiggle.rst | 4 +- .../class_skeletonmodification2dlookat.rst | 4 +- ...ss_skeletonmodification2dphysicalbones.rst | 4 +- ...lass_skeletonmodification2dstackholder.rst | 4 +- .../class_skeletonmodification2dtwoboneik.rst | 4 +- classes/class_skeletonmodificationstack2d.rst | 4 +- classes/class_skeletonprofile.rst | 4 +- classes/class_skeletonprofilehumanoid.rst | 4 +- classes/class_skin.rst | 4 +- classes/class_skinreference.rst | 4 +- classes/class_sky.rst | 4 +- classes/class_slider.rst | 4 +- classes/class_sliderjoint3d.rst | 4 +- classes/class_softbody3d.rst | 20 +- classes/class_spheremesh.rst | 4 +- classes/class_sphereoccluder3d.rst | 4 +- classes/class_sphereshape3d.rst | 4 +- classes/class_spinbox.rst | 4 +- classes/class_splitcontainer.rst | 4 +- classes/class_spotlight3d.rst | 4 +- classes/class_springarm3d.rst | 4 +- classes/class_sprite2d.rst | 10 +- classes/class_sprite3d.rst | 10 +- classes/class_spritebase3d.rst | 10 +- classes/class_spriteframes.rst | 4 +- classes/class_standardmaterial3d.rst | 4 +- classes/class_staticbody2d.rst | 4 +- classes/class_staticbody3d.rst | 4 +- classes/class_streampeer.rst | 4 +- classes/class_streampeerbuffer.rst | 4 +- classes/class_streampeerextension.rst | 4 +- classes/class_streampeergzip.rst | 4 +- classes/class_streampeertcp.rst | 4 +- classes/class_streampeertls.rst | 4 +- classes/class_string.rst | 46 +- classes/class_stringname.rst | 39 +- classes/class_stylebox.rst | 4 +- classes/class_styleboxempty.rst | 4 +- classes/class_styleboxflat.rst | 4 +- classes/class_styleboxline.rst | 4 +- classes/class_styleboxtexture.rst | 4 +- classes/class_subviewport.rst | 4 +- classes/class_subviewportcontainer.rst | 4 +- classes/class_surfacetool.rst | 6 +- classes/class_syntaxhighlighter.rst | 4 +- classes/class_systemfont.rst | 6 +- classes/class_tabbar.rst | 4 +- classes/class_tabcontainer.rst | 6 +- classes/class_tcpserver.rst | 4 +- classes/class_textedit.rst | 6 +- classes/class_textline.rst | 4 +- classes/class_textmesh.rst | 4 +- classes/class_textparagraph.rst | 4 +- classes/class_textserver.rst | 10 +- classes/class_textserveradvanced.rst | 4 +- classes/class_textserverdummy.rst | 4 +- classes/class_textserverextension.rst | 4 +- classes/class_textserverfallback.rst | 4 +- classes/class_textservermanager.rst | 4 +- classes/class_texture.rst | 4 +- classes/class_texture2d.rst | 6 +- classes/class_texture2darray.rst | 4 +- classes/class_texture2darrayrd.rst | 4 +- classes/class_texture2drd.rst | 4 +- classes/class_texture3d.rst | 6 +- classes/class_texture3drd.rst | 4 +- classes/class_texturebutton.rst | 4 +- classes/class_texturecubemaparrayrd.rst | 4 +- classes/class_texturecubemaprd.rst | 4 +- classes/class_texturelayered.rst | 4 +- classes/class_texturelayeredrd.rst | 4 +- classes/class_textureprogressbar.rst | 4 +- classes/class_texturerect.rst | 4 +- classes/class_theme.rst | 4 +- classes/class_themedb.rst | 4 +- classes/class_thread.rst | 4 +- classes/class_tiledata.rst | 4 +- classes/class_tilemap.rst | 6 +- classes/class_tilemappattern.rst | 4 +- classes/class_tileset.rst | 4 +- classes/class_tilesetatlassource.rst | 4 +- .../class_tilesetscenescollectionsource.rst | 4 +- classes/class_tilesetsource.rst | 4 +- classes/class_time.rst | 8 +- classes/class_timer.rst | 4 +- classes/class_tlsoptions.rst | 4 +- classes/class_torusmesh.rst | 4 +- classes/class_touchscreenbutton.rst | 4 +- classes/class_transform2d.rst | 6 +- classes/class_transform3d.rst | 92 +- classes/class_translation.rst | 4 +- classes/class_translationserver.rst | 4 +- classes/class_tree.rst | 4 +- classes/class_treeitem.rst | 4 +- classes/class_trianglemesh.rst | 4 +- classes/class_tubetrailmesh.rst | 4 +- classes/class_tween.rst | 14 +- classes/class_tweener.rst | 4 +- classes/class_udpserver.rst | 4 +- classes/class_undoredo.rst | 4 +- classes/class_upnp.rst | 4 +- classes/class_upnpdevice.rst | 4 +- classes/class_variant.rst | 8 +- classes/class_vboxcontainer.rst | 4 +- classes/class_vector2.rst | 6 +- classes/class_vector2i.rst | 4 +- classes/class_vector3.rst | 6 +- classes/class_vector3i.rst | 4 +- classes/class_vector4.rst | 4 +- classes/class_vector4i.rst | 4 +- classes/class_vehiclebody3d.rst | 4 +- classes/class_vehiclewheel3d.rst | 6 +- classes/class_vflowcontainer.rst | 4 +- classes/class_videostream.rst | 4 +- classes/class_videostreamplayback.rst | 4 +- classes/class_videostreamplayer.rst | 6 +- classes/class_videostreamtheora.rst | 4 +- classes/class_viewport.rst | 18 +- classes/class_viewporttexture.rst | 4 +- classes/class_visibleonscreenenabler2d.rst | 4 +- classes/class_visibleonscreenenabler3d.rst | 4 +- classes/class_visibleonscreennotifier2d.rst | 4 +- classes/class_visibleonscreennotifier3d.rst | 4 +- classes/class_visualinstance3d.rst | 4 +- classes/class_visualshader.rst | 4 +- classes/class_visualshadernode.rst | 4 +- classes/class_visualshadernodebillboard.rst | 4 +- .../class_visualshadernodebooleanconstant.rst | 4 +- ...class_visualshadernodebooleanparameter.rst | 4 +- classes/class_visualshadernodeclamp.rst | 4 +- .../class_visualshadernodecolorconstant.rst | 4 +- classes/class_visualshadernodecolorfunc.rst | 4 +- classes/class_visualshadernodecolorop.rst | 4 +- .../class_visualshadernodecolorparameter.rst | 4 +- classes/class_visualshadernodecomment.rst | 4 +- classes/class_visualshadernodecompare.rst | 4 +- classes/class_visualshadernodeconstant.rst | 4 +- classes/class_visualshadernodecubemap.rst | 6 +- ...class_visualshadernodecubemapparameter.rst | 4 +- .../class_visualshadernodecurvetexture.rst | 4 +- .../class_visualshadernodecurvexyztexture.rst | 4 +- classes/class_visualshadernodecustom.rst | 4 +- .../class_visualshadernodederivativefunc.rst | 4 +- classes/class_visualshadernodedeterminant.rst | 4 +- .../class_visualshadernodedistancefade.rst | 4 +- classes/class_visualshadernodedotproduct.rst | 4 +- classes/class_visualshadernodeexpression.rst | 4 +- classes/class_visualshadernodefaceforward.rst | 4 +- .../class_visualshadernodefloatconstant.rst | 4 +- classes/class_visualshadernodefloatfunc.rst | 4 +- classes/class_visualshadernodefloatop.rst | 4 +- .../class_visualshadernodefloatparameter.rst | 4 +- classes/class_visualshadernodefresnel.rst | 4 +- ...class_visualshadernodeglobalexpression.rst | 4 +- classes/class_visualshadernodegroupbase.rst | 4 +- classes/class_visualshadernodeif.rst | 4 +- classes/class_visualshadernodeinput.rst | 4 +- classes/class_visualshadernodeintconstant.rst | 4 +- classes/class_visualshadernodeintfunc.rst | 4 +- classes/class_visualshadernodeintop.rst | 4 +- .../class_visualshadernodeintparameter.rst | 4 +- classes/class_visualshadernodeis.rst | 4 +- ...class_visualshadernodelinearscenedepth.rst | 4 +- classes/class_visualshadernodemix.rst | 4 +- classes/class_visualshadernodemultiplyadd.rst | 4 +- .../class_visualshadernodeouterproduct.rst | 4 +- classes/class_visualshadernodeoutput.rst | 4 +- classes/class_visualshadernodeparameter.rst | 4 +- .../class_visualshadernodeparameterref.rst | 4 +- ...ss_visualshadernodeparticleaccelerator.rst | 4 +- ...ass_visualshadernodeparticleboxemitter.rst | 4 +- ...s_visualshadernodeparticleconevelocity.rst | 4 +- .../class_visualshadernodeparticleemit.rst | 4 +- .../class_visualshadernodeparticleemitter.rst | 4 +- ...ss_visualshadernodeparticlemeshemitter.rst | 4 +- ...lshadernodeparticlemultiplybyaxisangle.rst | 4 +- .../class_visualshadernodeparticleoutput.rst | 4 +- ...ass_visualshadernodeparticlerandomness.rst | 4 +- ...ss_visualshadernodeparticleringemitter.rst | 4 +- ..._visualshadernodeparticlesphereemitter.rst | 4 +- .../class_visualshadernodeproximityfade.rst | 4 +- classes/class_visualshadernoderandomrange.rst | 4 +- classes/class_visualshadernoderemap.rst | 4 +- .../class_visualshadernoderesizablebase.rst | 4 +- .../class_visualshadernoderotationbyaxis.rst | 4 +- classes/class_visualshadernodesample3d.rst | 4 +- ...visualshadernodescreennormalworldspace.rst | 4 +- .../class_visualshadernodescreenuvtosdf.rst | 4 +- classes/class_visualshadernodesdfraymarch.rst | 4 +- .../class_visualshadernodesdftoscreenuv.rst | 4 +- classes/class_visualshadernodesmoothstep.rst | 4 +- classes/class_visualshadernodestep.rst | 4 +- classes/class_visualshadernodeswitch.rst | 4 +- classes/class_visualshadernodetexture.rst | 6 +- .../class_visualshadernodetexture2darray.rst | 4 +- ...isualshadernodetexture2darrayparameter.rst | 4 +- ...ass_visualshadernodetexture2dparameter.rst | 4 +- classes/class_visualshadernodetexture3d.rst | 4 +- ...ass_visualshadernodetexture3dparameter.rst | 4 +- ...class_visualshadernodetextureparameter.rst | 24 +- ...ualshadernodetextureparametertriplanar.rst | 4 +- classes/class_visualshadernodetexturesdf.rst | 4 +- ...class_visualshadernodetexturesdfnormal.rst | 4 +- ...class_visualshadernodetransformcompose.rst | 4 +- ...lass_visualshadernodetransformconstant.rst | 4 +- ...ass_visualshadernodetransformdecompose.rst | 4 +- .../class_visualshadernodetransformfunc.rst | 4 +- classes/class_visualshadernodetransformop.rst | 4 +- ...ass_visualshadernodetransformparameter.rst | 4 +- ...class_visualshadernodetransformvecmult.rst | 4 +- .../class_visualshadernodeuintconstant.rst | 4 +- classes/class_visualshadernodeuintfunc.rst | 4 +- classes/class_visualshadernodeuintop.rst | 4 +- .../class_visualshadernodeuintparameter.rst | 4 +- classes/class_visualshadernodeuvfunc.rst | 4 +- .../class_visualshadernodeuvpolarcoord.rst | 4 +- classes/class_visualshadernodevarying.rst | 4 +- .../class_visualshadernodevaryinggetter.rst | 4 +- .../class_visualshadernodevaryingsetter.rst | 4 +- .../class_visualshadernodevec2constant.rst | 4 +- .../class_visualshadernodevec2parameter.rst | 4 +- .../class_visualshadernodevec3constant.rst | 4 +- .../class_visualshadernodevec3parameter.rst | 4 +- .../class_visualshadernodevec4constant.rst | 4 +- .../class_visualshadernodevec4parameter.rst | 4 +- classes/class_visualshadernodevectorbase.rst | 4 +- .../class_visualshadernodevectorcompose.rst | 4 +- .../class_visualshadernodevectordecompose.rst | 4 +- .../class_visualshadernodevectordistance.rst | 4 +- classes/class_visualshadernodevectorfunc.rst | 4 +- classes/class_visualshadernodevectorlen.rst | 4 +- classes/class_visualshadernodevectorop.rst | 4 +- .../class_visualshadernodevectorrefract.rst | 4 +- ...visualshadernodeworldpositionfromdepth.rst | 4 +- classes/class_voxelgi.rst | 4 +- classes/class_voxelgidata.rst | 4 +- classes/class_vscrollbar.rst | 4 +- classes/class_vseparator.rst | 4 +- classes/class_vslider.rst | 4 +- classes/class_vsplitcontainer.rst | 4 +- classes/class_weakref.rst | 4 +- classes/class_webrtcdatachannel.rst | 4 +- classes/class_webrtcdatachannelextension.rst | 4 +- classes/class_webrtcmultiplayerpeer.rst | 4 +- classes/class_webrtcpeerconnection.rst | 4 +- .../class_webrtcpeerconnectionextension.rst | 4 +- classes/class_websocketmultiplayerpeer.rst | 4 +- classes/class_websocketpeer.rst | 4 +- classes/class_webxrinterface.rst | 4 +- classes/class_window.rst | 6 +- classes/class_workerthreadpool.rst | 4 +- classes/class_world2d.rst | 4 +- classes/class_world3d.rst | 4 +- classes/class_worldboundaryshape2d.rst | 4 +- classes/class_worldboundaryshape3d.rst | 4 +- classes/class_worldenvironment.rst | 4 +- classes/class_x509certificate.rst | 4 +- classes/class_xmlparser.rst | 4 +- classes/class_xranchor3d.rst | 4 +- classes/class_xrcamera3d.rst | 4 +- classes/class_xrcontroller3d.rst | 4 +- classes/class_xrinterface.rst | 4 +- classes/class_xrinterfaceextension.rst | 4 +- classes/class_xrnode3d.rst | 4 +- classes/class_xrorigin3d.rst | 14 +- classes/class_xrpose.rst | 4 +- classes/class_xrpositionaltracker.rst | 4 +- classes/class_xrserver.rst | 6 +- classes/class_zippacker.rst | 4 +- classes/class_zipreader.rst | 4 +- classes/index.rst | 2 +- 919 files changed, 5970 insertions(+), 3350 deletions(-) diff --git a/classes/class_@gdscript.rst b/classes/class_@gdscript.rst index 1bbf88cc1..c0de90177 100644 --- a/classes/class_@gdscript.rst +++ b/classes/class_@gdscript.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/gdscript/doc_classes/@GDScript.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/gdscript/doc_classes/@GDScript.xml. .. _class_@GDScript: @@ -725,6 +725,10 @@ The order of ``mode``, ``sync`` and ``transfer_mode`` does not matter, but value Make a script with static variables to not persist after all references are lost. If the script is loaded again the static variables will revert to their default values. +\ **Note:** As annotations describe their subject, the :ref:`@static_unload` annotation must be placed before the class definition and inheritance. + +\ **Warning:** Currently, due to a bug, scripts are never freed, even if :ref:`@static_unload` annotation is used. + .. rst-class:: classref-item-separator ---- @@ -814,6 +818,8 @@ An optional ``message`` can be shown in addition to the generic "Assertion faile assert(speed >= 0 and speed < 20) # You can also combine the two conditional statements in one check. assert(speed < 20, "the speed limit is 20") # Show a message. +\ **Note:** :ref:`assert` is a keyword, not a function. So you cannot access it as a :ref:`Callable` or use it inside expressions. + .. rst-class:: classref-item-separator ---- @@ -947,7 +953,7 @@ Returns ``true`` if ``value`` is an instance of ``type``. The ``type`` value mus - A :ref:`Script` (you can use any class, including inner one). -Unlike the right operand of the ``is`` operator, ``type`` can be a non-constant value. The ``is`` operator supports more features (such as typed arrays) and is more performant. Use the operator instead of this method if you do not need dynamic type checking. +Unlike the right operand of the ``is`` operator, ``type`` can be a non-constant value. The ``is`` operator supports more features (such as typed arrays). Use the operator instead of this method if you do not need dynamic type checking. Examples: @@ -1001,7 +1007,7 @@ Returns a :ref:`Resource` from the filesystem located at the abs # Load a scene called "main" located in the root of the project directory and cache it in a variable. var main = load("res://main.tscn") # main will contain a PackedScene resource. -\ **Important:** The path must be absolute. A relative path will always return ``null``. +\ **Important:** Relative paths are *not* relative to the script calling this method, instead it is prefixed with ``"res://"``. Loading from relative paths might not work as expected. This function is a simplified version of :ref:`ResourceLoader.load`, which can be used for more advanced scenarios. @@ -1028,6 +1034,8 @@ Returns a :ref:`Resource` from the filesystem located at ``path` # Create instance of a scene. var diamond = preload("res://diamond.tscn").instantiate() +\ **Note:** :ref:`preload` is a keyword, not a function. So you cannot access it as a :ref:`Callable`. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_@globalscope.rst b/classes/class_@globalscope.rst index 28ab0c65f..e3d1c7e7c 100644 --- a/classes/class_@globalscope.rst +++ b/classes/class_@globalscope.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/@GlobalScope.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/@GlobalScope.xml. .. _class_@GlobalScope: @@ -2835,7 +2835,7 @@ enum **MIDIMessage**: :ref:`MIDIMessage` **MIDI_MESSAGE_NONE** = ``0`` -Enum value which doesn't correspond to any MIDI message. This is used to initialize :ref:`MIDIMessage` properties with a generic state. +Does not correspond to any MIDI message. This is the default value of :ref:`InputEventMIDI.message`. .. _class_@GlobalScope_constant_MIDI_MESSAGE_NOTE_OFF: @@ -2843,7 +2843,9 @@ Enum value which doesn't correspond to any MIDI message. This is used to initial :ref:`MIDIMessage` **MIDI_MESSAGE_NOTE_OFF** = ``8`` -MIDI note OFF message. Not all MIDI devices send this event; some send :ref:`MIDI_MESSAGE_NOTE_ON` with zero velocity instead. See the documentation of :ref:`InputEventMIDI` for information of how to use MIDI inputs. +MIDI message sent when a note is released. + +\ **Note:** Not all MIDI devices send this message; some may send :ref:`MIDI_MESSAGE_NOTE_ON` with :ref:`InputEventMIDI.velocity` set to ``0``. .. _class_@GlobalScope_constant_MIDI_MESSAGE_NOTE_ON: @@ -2851,7 +2853,7 @@ MIDI note OFF message. Not all MIDI devices send this event; some send :ref:`MID :ref:`MIDIMessage` **MIDI_MESSAGE_NOTE_ON** = ``9`` -MIDI note ON message. Some MIDI devices send this event with velocity zero instead of :ref:`MIDI_MESSAGE_NOTE_OFF`, but implementations vary. See the documentation of :ref:`InputEventMIDI` for information of how to use MIDI inputs. +MIDI message sent when a note is pressed. .. _class_@GlobalScope_constant_MIDI_MESSAGE_AFTERTOUCH: @@ -2859,7 +2861,7 @@ MIDI note ON message. Some MIDI devices send this event with velocity zero inste :ref:`MIDIMessage` **MIDI_MESSAGE_AFTERTOUCH** = ``10`` -MIDI aftertouch message. This message is most often sent by pressing down on the key after it "bottoms out". +MIDI message sent to indicate a change in pressure while a note is being pressed down, also called aftertouch. .. _class_@GlobalScope_constant_MIDI_MESSAGE_CONTROL_CHANGE: @@ -2867,7 +2869,7 @@ MIDI aftertouch message. This message is most often sent by pressing down on the :ref:`MIDIMessage` **MIDI_MESSAGE_CONTROL_CHANGE** = ``11`` -MIDI control change message. This message is sent when a controller value changes. Controllers include devices such as pedals and levers. +MIDI message sent when a controller value changes. In a MIDI device, a controller is any input that doesn't play notes. These may include sliders for volume, balance, and panning, as well as switches and pedals. See the `General MIDI specification `__ for a small list. .. _class_@GlobalScope_constant_MIDI_MESSAGE_PROGRAM_CHANGE: @@ -2875,7 +2877,7 @@ MIDI control change message. This message is sent when a controller value change :ref:`MIDIMessage` **MIDI_MESSAGE_PROGRAM_CHANGE** = ``12`` -MIDI program change message. This message sent when the program patch number changes. +MIDI message sent when the MIDI device changes its current instrument (also called *program* or *preset*). .. _class_@GlobalScope_constant_MIDI_MESSAGE_CHANNEL_PRESSURE: @@ -2883,7 +2885,7 @@ MIDI program change message. This message sent when the program patch number cha :ref:`MIDIMessage` **MIDI_MESSAGE_CHANNEL_PRESSURE** = ``13`` -MIDI channel pressure message. This message is most often sent by pressing down on the key after it "bottoms out". This message is different from polyphonic after-touch as it indicates the highest pressure across all keys. +MIDI message sent to indicate a change in pressure for the whole channel. Some MIDI devices may send this instead of :ref:`MIDI_MESSAGE_AFTERTOUCH`. .. _class_@GlobalScope_constant_MIDI_MESSAGE_PITCH_BEND: @@ -2891,7 +2893,7 @@ MIDI channel pressure message. This message is most often sent by pressing down :ref:`MIDIMessage` **MIDI_MESSAGE_PITCH_BEND** = ``14`` -MIDI pitch bend message. This message is sent to indicate a change in the pitch bender (wheel or lever, typically). +MIDI message sent when the value of the pitch bender changes, usually a wheel on the MIDI device. .. _class_@GlobalScope_constant_MIDI_MESSAGE_SYSTEM_EXCLUSIVE: @@ -2899,7 +2901,9 @@ MIDI pitch bend message. This message is sent to indicate a change in the pitch :ref:`MIDIMessage` **MIDI_MESSAGE_SYSTEM_EXCLUSIVE** = ``240`` -MIDI system exclusive message. This has behavior exclusive to the device you're receiving input from. Getting this data is not implemented in Godot. +MIDI system exclusive (SysEx) message. This type of message is not standardized and it's highly dependent on the MIDI device sending it. + +\ **Note:** Getting this message's data from :ref:`InputEventMIDI` is not implemented. .. _class_@GlobalScope_constant_MIDI_MESSAGE_QUARTER_FRAME: @@ -2907,7 +2911,9 @@ MIDI system exclusive message. This has behavior exclusive to the device you're :ref:`MIDIMessage` **MIDI_MESSAGE_QUARTER_FRAME** = ``241`` -MIDI quarter frame message. Contains timing information that is used to synchronize MIDI devices. Getting this data is not implemented in Godot. +MIDI message sent every quarter frame to keep connected MIDI devices synchronized. Related to :ref:`MIDI_MESSAGE_TIMING_CLOCK`. + +\ **Note:** Getting this message's data from :ref:`InputEventMIDI` is not implemented. .. _class_@GlobalScope_constant_MIDI_MESSAGE_SONG_POSITION_POINTER: @@ -2915,7 +2921,9 @@ MIDI quarter frame message. Contains timing information that is used to synchron :ref:`MIDIMessage` **MIDI_MESSAGE_SONG_POSITION_POINTER** = ``242`` -MIDI song position pointer message. Gives the number of 16th notes since the start of the song. Getting this data is not implemented in Godot. +MIDI message sent to jump onto a new position in the current sequence or song. + +\ **Note:** Getting this message's data from :ref:`InputEventMIDI` is not implemented. .. _class_@GlobalScope_constant_MIDI_MESSAGE_SONG_SELECT: @@ -2923,7 +2931,9 @@ MIDI song position pointer message. Gives the number of 16th notes since the sta :ref:`MIDIMessage` **MIDI_MESSAGE_SONG_SELECT** = ``243`` -MIDI song select message. Specifies which sequence or song is to be played. Getting this data is not implemented in Godot. +MIDI message sent to select a sequence or song to play. + +\ **Note:** Getting this message's data from :ref:`InputEventMIDI` is not implemented. .. _class_@GlobalScope_constant_MIDI_MESSAGE_TUNE_REQUEST: @@ -2931,7 +2941,7 @@ MIDI song select message. Specifies which sequence or song is to be played. Gett :ref:`MIDIMessage` **MIDI_MESSAGE_TUNE_REQUEST** = ``246`` -MIDI tune request message. Upon receiving a tune request, all analog synthesizers should tune their oscillators. +MIDI message sent to request a tuning calibration. Used on analog synthesizers. Most modern MIDI devices do not need this message. .. _class_@GlobalScope_constant_MIDI_MESSAGE_TIMING_CLOCK: @@ -2939,7 +2949,7 @@ MIDI tune request message. Upon receiving a tune request, all analog synthesizer :ref:`MIDIMessage` **MIDI_MESSAGE_TIMING_CLOCK** = ``248`` -MIDI timing clock message. Sent 24 times per quarter note when synchronization is required. +MIDI message sent 24 times after :ref:`MIDI_MESSAGE_QUARTER_FRAME`, to keep connected MIDI devices synchronized. .. _class_@GlobalScope_constant_MIDI_MESSAGE_START: @@ -2947,7 +2957,7 @@ MIDI timing clock message. Sent 24 times per quarter note when synchronization i :ref:`MIDIMessage` **MIDI_MESSAGE_START** = ``250`` -MIDI start message. Start the current sequence playing. This message will be followed with Timing Clocks. +MIDI message sent to start the current sequence or song from the beginning. .. _class_@GlobalScope_constant_MIDI_MESSAGE_CONTINUE: @@ -2955,7 +2965,7 @@ MIDI start message. Start the current sequence playing. This message will be fol :ref:`MIDIMessage` **MIDI_MESSAGE_CONTINUE** = ``251`` -MIDI continue message. Continue at the point the sequence was stopped. +MIDI message sent to resume from the point the current sequence or song was paused. .. _class_@GlobalScope_constant_MIDI_MESSAGE_STOP: @@ -2963,7 +2973,7 @@ MIDI continue message. Continue at the point the sequence was stopped. :ref:`MIDIMessage` **MIDI_MESSAGE_STOP** = ``252`` -MIDI stop message. Stop the current sequence. +MIDI message sent to pause the current sequence or song. .. _class_@GlobalScope_constant_MIDI_MESSAGE_ACTIVE_SENSING: @@ -2971,7 +2981,7 @@ MIDI stop message. Stop the current sequence. :ref:`MIDIMessage` **MIDI_MESSAGE_ACTIVE_SENSING** = ``254`` -MIDI active sensing message. This message is intended to be sent repeatedly to tell the receiver that a connection is alive. +MIDI message sent repeatedly while the MIDI device is idle, to tell the receiver that the connection is alive. Most MIDI devices do not send this message. .. _class_@GlobalScope_constant_MIDI_MESSAGE_SYSTEM_RESET: @@ -2979,7 +2989,7 @@ MIDI active sensing message. This message is intended to be sent repeatedly to t :ref:`MIDIMessage` **MIDI_MESSAGE_SYSTEM_RESET** = ``255`` -MIDI system reset message. Reset all receivers in the system to power-up status. It should not be sent on power-up itself. +MIDI message sent to reset a MIDI device to its default state, as if it was just turned on. It should not be sent when the MIDI device is being turned on. .. rst-class:: classref-item-separator @@ -5480,20 +5490,10 @@ Clamps the ``value``, returning a :ref:`Variant` not less than `` var b = clamp(8.1, 0.9, 5.5) # b is 5.5 - - var c = clamp(Vector2(-3.5, -4), Vector2(-3.2, -2), Vector2(2, 6.5)) - # c is (-3.2, -2) - - var d = clamp(Vector2i(7, 8), Vector2i(-3, -2), Vector2i(2, 6)) - # d is (2, 6) - - var e = clamp(Vector3(-7, 8.5, -3.8), Vector3(-3, -2, 5.4), Vector3(-2, 6, -4.1)) - # e is (-3, -2, 5.4) - - var f = clamp(Vector3i(-7, -8, -9), Vector3i(-1, 2, 3), Vector3i(-4, -5, -6)) - # f is (-4, -5, -6) -\ **Note:** For better type safety, use :ref:`clampf`, :ref:`clampi`, :ref:`Vector2.clamp`, :ref:`Vector2i.clamp`, :ref:`Vector3.clamp`, :ref:`Vector3i.clamp`, :ref:`Vector4.clamp`, :ref:`Vector4i.clamp`, or :ref:`Color.clamp`. +\ **Note:** For better type safety, use :ref:`clampf`, :ref:`clampi`, :ref:`Vector2.clamp`, :ref:`Vector2i.clamp`, :ref:`Vector3.clamp`, :ref:`Vector3i.clamp`, :ref:`Vector4.clamp`, :ref:`Vector4i.clamp`, or :ref:`Color.clamp` (not currently supported by this method). + +\ **Note:** When using this on vectors it will *not* perform component-wise clamping, and will pick ``min`` if ``value < min`` or ``max`` if ``value > max``. To perform component-wise clamping use the methods listed above. .. rst-class:: classref-item-separator @@ -7293,6 +7293,8 @@ Encodes a :ref:`Variant` value to a byte array, without encoding \ **Note:** If you need object serialization, see :ref:`var_to_bytes_with_objects`. +\ **Note:** Encoding :ref:`Callable` is not supported and will result in an empty value, regardless of the data. + .. rst-class:: classref-item-separator ---- @@ -7305,6 +7307,8 @@ Encodes a :ref:`Variant` value to a byte array, without encoding Encodes a :ref:`Variant` value to a byte array. Encoding objects is allowed (and can potentially include executable code). Deserialization can be done with :ref:`bytes_to_var_with_objects`. +\ **Note:** Encoding :ref:`Callable` is not supported and will result in an empty value, regardless of the data. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_aabb.rst b/classes/class_aabb.rst index 113d74bdf..20100cc54 100644 --- a/classes/class_aabb.rst +++ b/classes/class_aabb.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AABB.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AABB.xml. .. _class_AABB: @@ -17,13 +17,13 @@ A 3D axis-aligned bounding box. Description ----------- -**AABB** consists of a position, a size, and several utility functions. It is typically used for fast overlap tests. +The **AABB** built-in :ref:`Variant` type represents an axis-aligned bounding box in a 3D space. It is defined by its :ref:`position` and :ref:`size`, which are :ref:`Vector3`. It is frequently used for fast overlap tests (see :ref:`intersects`). Although **AABB** itself is axis-aligned, it can be combined with :ref:`Transform3D` to represent a rotated or skewed bounding box. -It uses floating-point coordinates. The 2D counterpart to **AABB** is :ref:`Rect2`. +It uses floating-point coordinates. The 2D counterpart to **AABB** is :ref:`Rect2`. There is no version of **AABB** that uses integer coordinates. -Negative values for :ref:`size` are not supported and will not work for most methods. Use :ref:`abs` to get an AABB with a positive size. +\ **Note:** Negative values for :ref:`size` are not supported. With negative size, most **AABB** methods do not work correctly. Use :ref:`abs` to get an equivalent **AABB** with a non-negative size. -\ **Note:** Unlike :ref:`Rect2`, **AABB** does not have a variant that uses integer coordinates. +\ **Note:** In a boolean context, a **AABB** evaluates to ``false`` if both :ref:`position` and :ref:`size` are zero (equal to :ref:`Vector3.ZERO`). Otherwise, it always evaluates to ``true``. .. note:: @@ -163,7 +163,7 @@ Property Descriptions :ref:`Vector3` **end** = ``Vector3(0, 0, 0)`` -Ending corner. This is calculated as ``position + size``. Setting this value will change the size. +The ending point. This is usually the corner on the top-right and forward of the bounding box, and is equivalent to ``position + size``. Setting this point affects the :ref:`size`. .. rst-class:: classref-item-separator @@ -175,7 +175,7 @@ Ending corner. This is calculated as ``position + size``. Setting this value wil :ref:`Vector3` **position** = ``Vector3(0, 0, 0)`` -Beginning corner. Typically has values lower than :ref:`end`. +The origin point. This is usually the corner on the bottom-left and back of the bounding box. .. rst-class:: classref-item-separator @@ -187,9 +187,9 @@ Beginning corner. Typically has values lower than :ref:`end` **size** = ``Vector3(0, 0, 0)`` -Size from :ref:`position` to :ref:`end`. Typically, all components are positive. +The bounding box's width, height, and depth starting from :ref:`position`. Setting this value also affects the :ref:`end` point. -If the size is negative, you can use :ref:`abs` to fix it. +\ **Note:** It's recommended setting the width, height, and depth to non-negative values. This is because most methods in Godot assume that the :ref:`position` is the bottom-left-back corner, and the :ref:`end` is the top-right-forward corner. To get an equivalent bounding box with non-negative size, use :ref:`abs`. .. rst-class:: classref-section-separator @@ -206,7 +206,7 @@ Constructor Descriptions :ref:`AABB` **AABB** **(** **)** -Constructs a default-initialized **AABB** with default (zero) values of :ref:`position` and :ref:`size`. +Constructs an **AABB** with its :ref:`position` and :ref:`size` set to :ref:`Vector3.ZERO`. .. rst-class:: classref-item-separator @@ -226,7 +226,7 @@ Constructs an **AABB** as a copy of the given **AABB**. :ref:`AABB` **AABB** **(** :ref:`Vector3` position, :ref:`Vector3` size **)** -Constructs an **AABB** from a position and size. +Constructs an **AABB** by ``position`` and ``size``. .. rst-class:: classref-section-separator @@ -243,7 +243,28 @@ Method Descriptions :ref:`AABB` **abs** **(** **)** |const| -Returns an AABB with equivalent position and size, modified so that the most-negative corner is the origin and the size is positive. +Returns an **AABB** equivalent to this bounding box, with its width, height, and depth modified to be non-negative values. + + +.. tabs:: + + .. code-tab:: gdscript + + var box = AABB(Vector3(5, 0, 5), Vector3(-20, -10, -5)) + var absolute = box.abs() + print(absolute.position) # Prints (-15, -10, 0) + print(absolute.size) # Prints (20, 10, 5) + + .. code-tab:: csharp + + var box = new Aabb(new Vector3(5, 0, 5), new Vector3(-20, -10, -5)); + var absolute = box.Abs(); + GD.Print(absolute.Position); // Prints (-15, -10, 0) + GD.Print(absolute.Size); // Prints (20, 10, 5) + + + +\ **Note:** It's recommended to use this method when :ref:`size` is negative, as most other methods in Godot assume that the :ref:`size`'s components are greater than ``0``. .. rst-class:: classref-item-separator @@ -255,7 +276,32 @@ Returns an AABB with equivalent position and size, modified so that the most-neg :ref:`bool` **encloses** **(** :ref:`AABB` with **)** |const| -Returns ``true`` if this **AABB** completely encloses another one. +Returns ``true`` if this bounding box *completely* encloses the ``with`` box. The edges of both boxes are included. + + +.. tabs:: + + .. code-tab:: gdscript + + var a = AABB(Vector3(0, 0, 0), Vector3(4, 4, 4)) + var b = AABB(Vector3(1, 1, 1), Vector3(3, 3, 3)) + var c = AABB(Vector3(2, 2, 2), Vector3(8, 8, 8)) + + print(a.encloses(a)) # Prints true + print(a.encloses(b)) # Prints true + print(a.encloses(c)) # Prints false + + .. code-tab:: csharp + + var a = new Aabb(new Vector3(0, 0, 0), new Vector3(4, 4, 4)); + var b = new Aabb(new Vector3(1, 1, 1), new Vector3(3, 3, 3)); + var c = new Aabb(new Vector3(2, 2, 2), new Vector3(8, 8, 8)); + + GD.Print(a.Encloses(a)); // Prints True + GD.Print(a.Encloses(b)); // Prints True + GD.Print(a.Encloses(c)); // Prints False + + .. rst-class:: classref-item-separator @@ -267,26 +313,34 @@ Returns ``true`` if this **AABB** completely encloses another one. :ref:`AABB` **expand** **(** :ref:`Vector3` to_point **)** |const| -Returns a copy of this **AABB** expanded to include a given point. - -\ **Example:**\ +Returns a copy of this bounding box expanded to align the edges with the given ``to_point``, if necessary. .. tabs:: .. code-tab:: gdscript - # 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)) + var box = AABB(Vector3(0, 0, 0), Vector3(5, 2, 5)) + + box = box.expand(Vector3(10, 0, 0)) + print(box.position) # Prints (0, 0, 0) + print(box.size) # Prints (10, 2, 5) + + box = box.expand(Vector3(-5, 0, 5)) + print(box.position) # Prints (-5, 0, 0) + print(box.size) # Prints (15, 2, 5) .. code-tab:: csharp - // position (-3, 2, 0), size (1, 1, 1) - var box = new Aabb(new Vector3(-3, 2, 0), new 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(new Vector3(0, -1, 2)); + var box = new Aabb(new Vector3(0, 0, 0), new Vector3(5, 2, 5)); + + box = box.Expand(new Vector3(10, 0, 0)); + GD.Print(box.Position); // Prints (0, 0, 0) + GD.Print(box.Size); // Prints (10, 2, 5) + + box = box.Expand(new Vector3(-5, 0, 5)); + GD.Print(box.Position); // Prints (-5, 0, 0) + GD.Print(box.Size); // Prints (15, 2, 5) @@ -300,7 +354,7 @@ Returns a copy of this **AABB** expanded to include a given point. :ref:`Vector3` **get_center** **(** **)** |const| -Returns the center of the **AABB**, which is equal to :ref:`position` + (:ref:`size` / 2). +Returns the center point of the bounding box. This is the same as ``position + (size / 2.0)``. .. rst-class:: classref-item-separator @@ -312,7 +366,7 @@ Returns the center of the **AABB**, which is equal to :ref:`position` **get_endpoint** **(** :ref:`int` idx **)** |const| -Gets the position of the 8 endpoints of the **AABB** in space. +Returns the position of one of the 8 vertices that compose this bounding box. With a ``idx`` of ``0`` this is the same as :ref:`position`, and a ``idx`` of ``7`` is the same as :ref:`end`. .. rst-class:: classref-item-separator @@ -324,7 +378,30 @@ Gets the position of the 8 endpoints of the **AABB** in space. :ref:`Vector3` **get_longest_axis** **(** **)** |const| -Returns the normalized longest axis of the **AABB**. +Returns the longest normalized axis of this bounding box's :ref:`size`, as a :ref:`Vector3` (:ref:`Vector3.RIGHT`, :ref:`Vector3.UP`, or :ref:`Vector3.BACK`). + + +.. tabs:: + + .. code-tab:: gdscript + + var box = AABB(Vector3(0, 0, 0), Vector3(2, 4, 8)) + + print(box.get_longest_axis()) # Prints (0, 0, 1) + print(box.get_longest_axis_index()) # Prints 2 + print(box.get_longest_axis_size()) # Prints 8 + + .. code-tab:: csharp + + var box = new Aabb(new Vector3(0, 0, 0), new Vector3(2, 4, 8)); + + GD.Print(box.GetLongestAxis()); // Prints (0, 0, 1) + GD.Print(box.GetLongestAxisIndex()); // Prints 2 + GD.Print(box.GetLongestAxisSize()); // Prints 8 + + + +See also :ref:`get_longest_axis_index` and :ref:`get_longest_axis_size`. .. rst-class:: classref-item-separator @@ -336,7 +413,9 @@ Returns the normalized longest axis of the **AABB**. :ref:`int` **get_longest_axis_index** **(** **)** |const| -Returns the index of the longest axis of the **AABB** (according to :ref:`Vector3`'s ``AXIS_*`` constants). +Returns the index to the longest axis of this bounding box's :ref:`size` (see :ref:`Vector3.AXIS_X`, :ref:`Vector3.AXIS_Y`, and :ref:`Vector3.AXIS_Z`). + +For an example, see :ref:`get_longest_axis`. .. rst-class:: classref-item-separator @@ -348,7 +427,9 @@ Returns the index of the longest axis of the **AABB** (according to :ref:`Vector :ref:`float` **get_longest_axis_size** **(** **)** |const| -Returns the scalar length of the longest axis of the **AABB**. +Returns the longest dimension of this bounding box's :ref:`size`. + +For an example, see :ref:`get_longest_axis`. .. rst-class:: classref-item-separator @@ -360,7 +441,30 @@ Returns the scalar length of the longest axis of the **AABB**. :ref:`Vector3` **get_shortest_axis** **(** **)** |const| -Returns the normalized shortest axis of the **AABB**. +Returns the shortest normaalized axis of this bounding box's :ref:`size`, as a :ref:`Vector3` (:ref:`Vector3.RIGHT`, :ref:`Vector3.UP`, or :ref:`Vector3.BACK`). + + +.. tabs:: + + .. code-tab:: gdscript + + var box = AABB(Vector3(0, 0, 0), Vector3(2, 4, 8)) + + print(box.get_shortest_axis()) # Prints (1, 0, 0) + print(box.get_shortest_axis_index()) # Prints 0 + print(box.get_shortest_axis_size()) # Prints 2 + + .. code-tab:: csharp + + var box = new Aabb(new Vector3(0, 0, 0), new Vector3(2, 4, 8)); + + GD.Print(box.GetShortestAxis()); // Prints (1, 0, 0) + GD.Print(box.GetShortestAxisIndex()); // Prints 0 + GD.Print(box.GetShortestAxisSize()); // Prints 2 + + + +See also :ref:`get_shortest_axis_index` and :ref:`get_shortest_axis_size`. .. rst-class:: classref-item-separator @@ -372,7 +476,9 @@ Returns the normalized shortest axis of the **AABB**. :ref:`int` **get_shortest_axis_index** **(** **)** |const| -Returns the index of the shortest axis of the **AABB** (according to :ref:`Vector3`::AXIS\* enum). +Returns the index to the shortest axis of this bounding box's :ref:`size` (see :ref:`Vector3.AXIS_X`, :ref:`Vector3.AXIS_Y`, and :ref:`Vector3.AXIS_Z`). + +For an example, see :ref:`get_shortest_axis`. .. rst-class:: classref-item-separator @@ -384,7 +490,9 @@ Returns the index of the shortest axis of the **AABB** (according to :ref:`Vecto :ref:`float` **get_shortest_axis_size** **(** **)** |const| -Returns the scalar length of the shortest axis of the **AABB**. +Returns the shortest dimension of this bounding box's :ref:`size`. + +For an example, see :ref:`get_shortest_axis`. .. rst-class:: classref-item-separator @@ -396,7 +504,7 @@ Returns the scalar length of the shortest axis of the **AABB**. :ref:`Vector3` **get_support** **(** :ref:`Vector3` dir **)** |const| -Returns the vertex of the AABB that's the farthest in a given direction. This point is commonly known as the support point in collision detection algorithms. +Returns the vertex's position of this bounding box that's the farthest in the given direction. This point is commonly known as the support point in collision detection algorithms. .. rst-class:: classref-item-separator @@ -408,7 +516,7 @@ Returns the vertex of the AABB that's the farthest in a given direction. This po :ref:`float` **get_volume** **(** **)** |const| -Returns the volume of the **AABB**. +Returns the bounding box's volume. This is equivalent to ``size.x * size.y * size.z``. See also :ref:`has_volume`. .. rst-class:: classref-item-separator @@ -420,7 +528,32 @@ Returns the volume of the **AABB**. :ref:`AABB` **grow** **(** :ref:`float` by **)** |const| -Returns a copy of the **AABB** grown a given number of units towards all the sides. +Returns a copy of this bounding box extended on all sides by the given amount ``by``. A negative amount shrinks the box instead. + + +.. tabs:: + + .. code-tab:: gdscript + + var a = AABB(Vector3(4, 4, 4), Vector3(8, 8, 8)).grow(4) + print(a.position) # Prints (0, 0, 0) + print(a.size) # Prints (16, 16, 16) + + var b = AABB(Vector3(0, 0, 0), Vector3(8, 4, 2)).grow(2) + print(b.position) # Prints (-2, -2, -2) + print(b.size) # Prints (12, 8, 6) + + .. code-tab:: csharp + + var a = new Aabb(new Vector3(4, 4, 4), new Vector3(8, 8, 8)).Grow(4); + GD.Print(a.Position); // Prints (0, 0, 0) + GD.Print(a.Size); // Prints (16, 16, 16) + + var b = new Aabb(new Vector3(0, 0, 0), new Vector3(8, 4, 2)).Grow(2); + GD.Print(b.Position); // Prints (-2, -2, -2) + GD.Print(b.Size); // Prints (12, 8, 6) + + .. rst-class:: classref-item-separator @@ -432,9 +565,9 @@ Returns a copy of the **AABB** grown a given number of units towards all the sid :ref:`bool` **has_point** **(** :ref:`Vector3` point **)** |const| -Returns ``true`` if the **AABB** contains a point. Points on the faces of the AABB are considered included, though float-point precision errors may impact the accuracy of such checks. +Returns ``true`` if the bounding box contains the given ``point``. By convention, points exactly on the right, top, and front sides are **not** included. -\ **Note:** This method is not reliable for **AABB** with a *negative size*. Use :ref:`abs` to get a positive sized equivalent **AABB** to check for contained points. +\ **Note:** This method is not reliable for **AABB** with a *negative* :ref:`size`. Use :ref:`abs` first to get a valid bounding box. .. rst-class:: classref-item-separator @@ -446,7 +579,7 @@ Returns ``true`` if the **AABB** contains a point. Points on the faces of the AA :ref:`bool` **has_surface** **(** **)** |const| -Returns ``true`` if the **AABB** has a surface or a length, and ``false`` if the **AABB** is empty (all components of :ref:`size` are zero or negative). +Returns ``true`` if this bounding box has a surface or a length, that is, at least one component of :ref:`size` is greater than ``0``. Otherwise, returns ``false``. .. rst-class:: classref-item-separator @@ -458,7 +591,7 @@ Returns ``true`` if the **AABB** has a surface or a length, and ``false`` if the :ref:`bool` **has_volume** **(** **)** |const| -Returns ``true`` if the **AABB** has a volume, and ``false`` if the **AABB** is flat, empty, or has a negative :ref:`size`. +Returns ``true`` if this bounding box's width, height, and depth are all positive. See also :ref:`get_volume`. .. rst-class:: classref-item-separator @@ -470,7 +603,32 @@ Returns ``true`` if the **AABB** has a volume, and ``false`` if the **AABB** is :ref:`AABB` **intersection** **(** :ref:`AABB` with **)** |const| -Returns the intersection between two **AABB**. An empty AABB (size ``(0, 0, 0)``) is returned on failure. +Returns the intersection between this bounding box and ``with``. If the boxes do not intersect, returns an empty **AABB**. If the boxes intersect at the edge, returns a flat **AABB** with no volume (see :ref:`has_surface` and :ref:`has_volume`). + + +.. tabs:: + + .. code-tab:: gdscript + + var box1 = AABB(Vector3(0, 0, 0), Vector3(5, 2, 8)) + var box2 = AABB(Vector3(2, 0, 2), Vector3(8, 4, 4)) + + var intersection = box1.intersection(box2) + print(intersection.position) # Prints (2, 0, 2) + print(intersection.size) # Prints (3, 2, 4) + + .. code-tab:: csharp + + var box1 = new Aabb(new Vector3(0, 0, 0), new Vector3(5, 2, 8)); + var box2 = new Aabb(new Vector3(2, 0, 2), new Vector3(8, 4, 4)); + + var intersection = box1.Intersection(box2); + GD.Print(intersection.Position); // Prints (2, 0, 2) + GD.Print(intersection.Size); // Prints (3, 2, 4) + + + +\ **Note:** If you only need to know whether two bounding boxes are intersecting, use :ref:`intersects`, instead. .. rst-class:: classref-item-separator @@ -482,7 +640,7 @@ Returns the intersection between two **AABB**. An empty AABB (size ``(0, 0, 0)`` :ref:`bool` **intersects** **(** :ref:`AABB` with **)** |const| -Returns ``true`` if the **AABB** overlaps with another. +Returns ``true`` if this bounding box overlaps with the box ``with``. The edges of both boxes are *always* excluded. .. rst-class:: classref-item-separator @@ -494,7 +652,7 @@ Returns ``true`` if the **AABB** overlaps with another. :ref:`bool` **intersects_plane** **(** :ref:`Plane` plane **)** |const| -Returns ``true`` if the **AABB** is on both sides of a plane. +Returns ``true`` if this bounding box is on both sides of the given ``plane``. .. rst-class:: classref-item-separator @@ -506,7 +664,9 @@ Returns ``true`` if the **AABB** is on both sides of a plane. :ref:`Variant` **intersects_ray** **(** :ref:`Vector3` from, :ref:`Vector3` dir **)** |const| -Returns the point of intersection of the given ray with this **AABB** or ``null`` if there is no intersection. Ray length is infinite. +Returns the first point where this bounding box and the given ray intersect, as a :ref:`Vector3`. If no intersection occurs, returns ``null``. + +The ray begin at ``from``, faces ``dir`` and extends towards infinity. .. rst-class:: classref-item-separator @@ -518,7 +678,9 @@ Returns the point of intersection of the given ray with this **AABB** or ``null` :ref:`Variant` **intersects_segment** **(** :ref:`Vector3` from, :ref:`Vector3` to **)** |const| -Returns the point of intersection between ``from`` and ``to`` with this **AABB** or ``null`` if there is no intersection. +Returns the first point where this bounding box and the given segment intersect, as a :ref:`Vector3`. If no intersection occurs, returns ``null``. + +The segment begins at ``from`` and ends at ``to``. .. rst-class:: classref-item-separator @@ -530,7 +692,7 @@ Returns the point of intersection between ``from`` and ``to`` with this **AABB** :ref:`bool` **is_equal_approx** **(** :ref:`AABB` aabb **)** |const| -Returns ``true`` if this **AABB** and ``aabb`` are approximately equal, by calling :ref:`@GlobalScope.is_equal_approx` on each component. +Returns ``true`` if this bounding box and ``aabb`` are approximately equal, by calling :ref:`Vector2.is_equal_approx` on the :ref:`position` and the :ref:`size`. .. rst-class:: classref-item-separator @@ -542,7 +704,7 @@ Returns ``true`` if this **AABB** and ``aabb`` are approximately equal, by calli :ref:`bool` **is_finite** **(** **)** |const| -Returns ``true`` if this **AABB** is finite, by calling :ref:`@GlobalScope.is_finite` on each component. +Returns ``true`` if this bounding box's values are finite, by calling :ref:`Vector2.is_finite` on the :ref:`position` and the :ref:`size`. .. rst-class:: classref-item-separator @@ -554,7 +716,7 @@ Returns ``true`` if this **AABB** is finite, by calling :ref:`@GlobalScope.is_fi :ref:`AABB` **merge** **(** :ref:`AABB` with **)** |const| -Returns a larger **AABB** that contains both this **AABB** and ``with``. +Returns an **AABB** that encloses both this bounding box and ``with`` around the edges. See also :ref:`encloses`. .. rst-class:: classref-section-separator @@ -571,7 +733,7 @@ Operator Descriptions :ref:`bool` **operator !=** **(** :ref:`AABB` right **)** -Returns ``true`` if the AABBs are not equal. +Returns ``true`` if the :ref:`position` or :ref:`size` of both bounding boxes are not equal. \ **Note:** Due to floating-point precision errors, consider using :ref:`is_equal_approx` instead, which is more reliable. @@ -601,7 +763,7 @@ For transforming by inverse of an affine transformation (e.g. with scaling) ``tr :ref:`bool` **operator ==** **(** :ref:`AABB` right **)** -Returns ``true`` if the AABBs are exactly equal. +Returns ``true`` if both :ref:`position` and :ref:`size` of the bounding boxes are exactly equal, respectively. \ **Note:** Due to floating-point precision errors, consider using :ref:`is_equal_approx` instead, which is more reliable. diff --git a/classes/class_acceptdialog.rst b/classes/class_acceptdialog.rst index 66ff89f96..946ebce4c 100644 --- a/classes/class_acceptdialog.rst +++ b/classes/class_acceptdialog.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AcceptDialog.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AcceptDialog.xml. .. _class_AcceptDialog: diff --git a/classes/class_aescontext.rst b/classes/class_aescontext.rst index b28ed7edd..f37ee93bb 100644 --- a/classes/class_aescontext.rst +++ b/classes/class_aescontext.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AESContext.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AESContext.xml. .. _class_AESContext: diff --git a/classes/class_animatablebody2d.rst b/classes/class_animatablebody2d.rst index 4faf8ddb2..00370a7a0 100644 --- a/classes/class_animatablebody2d.rst +++ b/classes/class_animatablebody2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimatableBody2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AnimatableBody2D.xml. .. _class_AnimatableBody2D: diff --git a/classes/class_animatablebody3d.rst b/classes/class_animatablebody3d.rst index df94c3369..47bac983d 100644 --- a/classes/class_animatablebody3d.rst +++ b/classes/class_animatablebody3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimatableBody3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AnimatableBody3D.xml. .. _class_AnimatableBody3D: diff --git a/classes/class_animatedsprite2d.rst b/classes/class_animatedsprite2d.rst index 14694f60e..8e8cc39a2 100644 --- a/classes/class_animatedsprite2d.rst +++ b/classes/class_animatedsprite2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimatedSprite2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AnimatedSprite2D.xml. .. _class_AnimatedSprite2D: diff --git a/classes/class_animatedsprite3d.rst b/classes/class_animatedsprite3d.rst index 00d764ef9..87f44f1d2 100644 --- a/classes/class_animatedsprite3d.rst +++ b/classes/class_animatedsprite3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimatedSprite3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AnimatedSprite3D.xml. .. _class_AnimatedSprite3D: diff --git a/classes/class_animatedtexture.rst b/classes/class_animatedtexture.rst index 32877b2fa..950019c60 100644 --- a/classes/class_animatedtexture.rst +++ b/classes/class_animatedtexture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimatedTexture.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AnimatedTexture.xml. .. _class_AnimatedTexture: diff --git a/classes/class_animation.rst b/classes/class_animation.rst index 2f8b3fc1a..8ae0a2706 100644 --- a/classes/class_animation.rst +++ b/classes/class_animation.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Animation.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Animation.xml. .. _class_Animation: @@ -27,22 +27,24 @@ This resource holds data that can be used to animate anything in the engine. Ani .. code-tab:: gdscript # This creates an animation that makes the node "Enemy" move to the right by - # 100 pixels in 0.5 seconds. + # 100 pixels in 2.0 seconds. var animation = Animation.new() var track_index = animation.add_track(Animation.TYPE_VALUE) animation.track_set_path(track_index, "Enemy:position:x") animation.track_insert_key(track_index, 0.0, 0) - animation.track_insert_key(track_index, 0.5, 100) + animation.track_insert_key(track_index, 2.0, 100) + animation.length = 2.0 .. code-tab:: csharp // This creates an animation that makes the node "Enemy" move to the right by - // 100 pixels in 0.5 seconds. + // 100 pixels in 2.0 seconds. var animation = new Animation(); int trackIndex = animation.AddTrack(Animation.TrackType.Value); animation.TrackSetPath(trackIndex, "Enemy:position:x"); animation.TrackInsertKey(trackIndex, 0.0f, 0); - animation.TrackInsertKey(trackIndex, 0.5f, 100); + animation.TrackInsertKey(trackIndex, 2.0f, 100); + animation.Length = 2.0f; diff --git a/classes/class_animationlibrary.rst b/classes/class_animationlibrary.rst index 3352195f8..36e57b66b 100644 --- a/classes/class_animationlibrary.rst +++ b/classes/class_animationlibrary.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimationLibrary.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AnimationLibrary.xml. .. _class_AnimationLibrary: diff --git a/classes/class_animationmixer.rst b/classes/class_animationmixer.rst index 6cfc7d39f..705705bdc 100644 --- a/classes/class_animationmixer.rst +++ b/classes/class_animationmixer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimationMixer.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AnimationMixer.xml. .. _class_AnimationMixer: diff --git a/classes/class_animationnode.rst b/classes/class_animationnode.rst index 0ff11fb79..6d80685d7 100644 --- a/classes/class_animationnode.rst +++ b/classes/class_animationnode.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimationNode.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AnimationNode.xml. .. _class_AnimationNode: @@ -245,7 +245,7 @@ When inheriting from :ref:`AnimationRootNode`, implemen :ref:`Dictionary` **_get_child_nodes** **(** **)** |virtual| |const| -When inheriting from :ref:`AnimationRootNode`, implement this virtual method to return all children animation nodes in order as a ``name: node`` dictionary. +When inheriting from :ref:`AnimationRootNode`, implement this virtual method to return all child animation nodes in order as a ``name: node`` dictionary. .. rst-class:: classref-item-separator @@ -359,7 +359,7 @@ Blend an input. This is only useful for animation nodes created for an :ref:`Ani :ref:`float` **blend_node** **(** :ref:`StringName` name, :ref:`AnimationNode` node, :ref:`float` time, :ref:`bool` seek, :ref:`bool` is_external_seeking, :ref:`float` blend, :ref:`FilterAction` filter=0, :ref:`bool` sync=true, :ref:`bool` test_only=false **)** -Blend another animation node (in case this animation node contains children animation nodes). This function is only useful if you inherit from :ref:`AnimationRootNode` instead, else editors will not display your animation node for addition. +Blend another animation node (in case this animation node contains child animation nodes). This function is only useful if you inherit from :ref:`AnimationRootNode` instead, otherwise editors will not display your animation node for addition. .. rst-class:: classref-item-separator diff --git a/classes/class_animationnodeadd2.rst b/classes/class_animationnodeadd2.rst index 64a130851..c5145ce5d 100644 --- a/classes/class_animationnodeadd2.rst +++ b/classes/class_animationnodeadd2.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimationNodeAdd2.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AnimationNodeAdd2.xml. .. _class_AnimationNodeAdd2: diff --git a/classes/class_animationnodeadd3.rst b/classes/class_animationnodeadd3.rst index 47d014cfb..f4681c55d 100644 --- a/classes/class_animationnodeadd3.rst +++ b/classes/class_animationnodeadd3.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimationNodeAdd3.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AnimationNodeAdd3.xml. .. _class_AnimationNodeAdd3: diff --git a/classes/class_animationnodeanimation.rst b/classes/class_animationnodeanimation.rst index 0402128ca..07a14e669 100644 --- a/classes/class_animationnodeanimation.rst +++ b/classes/class_animationnodeanimation.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimationNodeAnimation.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AnimationNodeAnimation.xml. .. _class_AnimationNodeAnimation: diff --git a/classes/class_animationnodeblend2.rst b/classes/class_animationnodeblend2.rst index f9cee33de..5eef601e4 100644 --- a/classes/class_animationnodeblend2.rst +++ b/classes/class_animationnodeblend2.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimationNodeBlend2.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AnimationNodeBlend2.xml. .. _class_AnimationNodeBlend2: diff --git a/classes/class_animationnodeblend3.rst b/classes/class_animationnodeblend3.rst index 67782a4af..a6be36eeb 100644 --- a/classes/class_animationnodeblend3.rst +++ b/classes/class_animationnodeblend3.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimationNodeBlend3.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AnimationNodeBlend3.xml. .. _class_AnimationNodeBlend3: diff --git a/classes/class_animationnodeblendspace1d.rst b/classes/class_animationnodeblendspace1d.rst index 6401bd179..0eb8a431e 100644 --- a/classes/class_animationnodeblendspace1d.rst +++ b/classes/class_animationnodeblendspace1d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimationNodeBlendSpace1D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AnimationNodeBlendSpace1D.xml. .. _class_AnimationNodeBlendSpace1D: diff --git a/classes/class_animationnodeblendspace2d.rst b/classes/class_animationnodeblendspace2d.rst index 3c18fb7f6..729ee2c65 100644 --- a/classes/class_animationnodeblendspace2d.rst +++ b/classes/class_animationnodeblendspace2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimationNodeBlendSpace2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AnimationNodeBlendSpace2D.xml. .. _class_AnimationNodeBlendSpace2D: diff --git a/classes/class_animationnodeblendtree.rst b/classes/class_animationnodeblendtree.rst index 3f2678462..8d86c7154 100644 --- a/classes/class_animationnodeblendtree.rst +++ b/classes/class_animationnodeblendtree.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimationNodeBlendTree.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AnimationNodeBlendTree.xml. .. _class_AnimationNodeBlendTree: diff --git a/classes/class_animationnodeoneshot.rst b/classes/class_animationnodeoneshot.rst index 8ce199e91..50c939e60 100644 --- a/classes/class_animationnodeoneshot.rst +++ b/classes/class_animationnodeoneshot.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimationNodeOneShot.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AnimationNodeOneShot.xml. .. _class_AnimationNodeOneShot: diff --git a/classes/class_animationnodeoutput.rst b/classes/class_animationnodeoutput.rst index e2a42ed16..a5c0610e6 100644 --- a/classes/class_animationnodeoutput.rst +++ b/classes/class_animationnodeoutput.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimationNodeOutput.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AnimationNodeOutput.xml. .. _class_AnimationNodeOutput: diff --git a/classes/class_animationnodestatemachine.rst b/classes/class_animationnodestatemachine.rst index dc2acc3a1..5fb9f8b4f 100644 --- a/classes/class_animationnodestatemachine.rst +++ b/classes/class_animationnodestatemachine.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimationNodeStateMachine.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AnimationNodeStateMachine.xml. .. _class_AnimationNodeStateMachine: @@ -146,7 +146,7 @@ Seeking to the beginning is treated as seeking to the beginning of the animation :ref:`StateMachineType` **STATE_MACHINE_TYPE_GROUPED** = ``2`` -This is a grouped state machine that can be controlled from a parent state machine. It does not work on standalone. There must be a state machine with :ref:`state_machine_type` of :ref:`STATE_MACHINE_TYPE_ROOT` or :ref:`STATE_MACHINE_TYPE_NESTED` in the parent or ancestor. +This is a grouped state machine that can be controlled from a parent state machine. It does not work independently. There must be a state machine with :ref:`state_machine_type` of :ref:`STATE_MACHINE_TYPE_ROOT` or :ref:`STATE_MACHINE_TYPE_NESTED` in the parent or ancestor. .. rst-class:: classref-section-separator diff --git a/classes/class_animationnodestatemachineplayback.rst b/classes/class_animationnodestatemachineplayback.rst index 95f1f16cb..fb1ff96a0 100644 --- a/classes/class_animationnodestatemachineplayback.rst +++ b/classes/class_animationnodestatemachineplayback.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimationNodeStateMachinePlayback.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AnimationNodeStateMachinePlayback.xml. .. _class_AnimationNodeStateMachinePlayback: diff --git a/classes/class_animationnodestatemachinetransition.rst b/classes/class_animationnodestatemachinetransition.rst index 97ab5127b..b02687326 100644 --- a/classes/class_animationnodestatemachinetransition.rst +++ b/classes/class_animationnodestatemachinetransition.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimationNodeStateMachineTransition.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AnimationNodeStateMachineTransition.xml. .. _class_AnimationNodeStateMachineTransition: diff --git a/classes/class_animationnodesub2.rst b/classes/class_animationnodesub2.rst index d5c78a348..012908ab5 100644 --- a/classes/class_animationnodesub2.rst +++ b/classes/class_animationnodesub2.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimationNodeSub2.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AnimationNodeSub2.xml. .. _class_AnimationNodeSub2: diff --git a/classes/class_animationnodesync.rst b/classes/class_animationnodesync.rst index 61f12ed8e..b3eb08424 100644 --- a/classes/class_animationnodesync.rst +++ b/classes/class_animationnodesync.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimationNodeSync.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AnimationNodeSync.xml. .. _class_AnimationNodeSync: diff --git a/classes/class_animationnodetimescale.rst b/classes/class_animationnodetimescale.rst index ae36d6398..a08a53500 100644 --- a/classes/class_animationnodetimescale.rst +++ b/classes/class_animationnodetimescale.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimationNodeTimeScale.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AnimationNodeTimeScale.xml. .. _class_AnimationNodeTimeScale: @@ -19,7 +19,7 @@ A time-scaling animation node used in :ref:`AnimationTree`. Description ----------- -Allows to scale the speed of the animation (or reverse it) in any children :ref:`AnimationNode`\ s. Setting it to ``0.0`` will pause the animation. +Allows to scale the speed of the animation (or reverse it) in any child :ref:`AnimationNode`\ s. Setting it to ``0.0`` will pause the animation. .. rst-class:: classref-introduction-group diff --git a/classes/class_animationnodetimeseek.rst b/classes/class_animationnodetimeseek.rst index dff81716d..7f1687f9e 100644 --- a/classes/class_animationnodetimeseek.rst +++ b/classes/class_animationnodetimeseek.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimationNodeTimeSeek.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AnimationNodeTimeSeek.xml. .. _class_AnimationNodeTimeSeek: diff --git a/classes/class_animationnodetransition.rst b/classes/class_animationnodetransition.rst index f4b40e2dd..ca7f2bee6 100644 --- a/classes/class_animationnodetransition.rst +++ b/classes/class_animationnodetransition.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimationNodeTransition.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AnimationNodeTransition.xml. .. _class_AnimationNodeTransition: diff --git a/classes/class_animationplayer.rst b/classes/class_animationplayer.rst index 7d61a8112..c38a79b62 100644 --- a/classes/class_animationplayer.rst +++ b/classes/class_animationplayer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimationPlayer.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AnimationPlayer.xml. .. _class_AnimationPlayer: diff --git a/classes/class_animationrootnode.rst b/classes/class_animationrootnode.rst index 92d035caf..710c724bc 100644 --- a/classes/class_animationrootnode.rst +++ b/classes/class_animationrootnode.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimationRootNode.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AnimationRootNode.xml. .. _class_AnimationRootNode: diff --git a/classes/class_animationtree.rst b/classes/class_animationtree.rst index 5198c2a47..b39477589 100644 --- a/classes/class_animationtree.rst +++ b/classes/class_animationtree.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimationTree.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AnimationTree.xml. .. _class_AnimationTree: diff --git a/classes/class_area2d.rst b/classes/class_area2d.rst index 1a3594d04..cccc7977c 100644 --- a/classes/class_area2d.rst +++ b/classes/class_area2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Area2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Area2D.xml. .. _class_Area2D: diff --git a/classes/class_area3d.rst b/classes/class_area3d.rst index 9608cf024..62cda9a97 100644 --- a/classes/class_area3d.rst +++ b/classes/class_area3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Area3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Area3D.xml. .. _class_Area3D: diff --git a/classes/class_array.rst b/classes/class_array.rst index dd4e7fcea..7ca3f7813 100644 --- a/classes/class_array.rst +++ b/classes/class_array.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Array.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Array.xml. .. _class_Array: @@ -259,7 +259,37 @@ Constructs an empty **Array**. :ref:`Array` **Array** **(** :ref:`Array` base, :ref:`int` type, :ref:`StringName` class_name, :ref:`Variant` script **)** -Creates a typed array from the ``base`` array. +Creates a typed array from the ``base`` array. All arguments are required. + +- ``type`` is the built-in type as a :ref:`Variant.Type` constant, for example :ref:`@GlobalScope.TYPE_INT`. + +- ``class_name`` is the **native** class name, for example :ref:`Node`. If ``type`` is not :ref:`@GlobalScope.TYPE_OBJECT`, must be an empty string. + +- ``script`` is the associated script. Must be a :ref:`Script` instance or ``null``. + +Examples: + +:: + + class_name MyNode + extends Node + + class MyClass: + pass + + func _ready(): + var a = Array([], TYPE_INT, &"", null) # Array[int] + var b = Array([], TYPE_OBJECT, &"Node", null) # Array[Node] + var c = Array([], TYPE_OBJECT, &"Node", MyNode) # Array[MyNode] + var d = Array([], TYPE_OBJECT, &"RefCounted", MyClass) # Array[MyClass] + +\ **Note:** This constructor can be useful if you want to create a typed array on the fly, but you are not required to use it. In GDScript you can use a temporary variable with the static type you need and then pass it: + +:: + + func _ready(): + var a: Array[int] = [] + some_func(a) .. rst-class:: classref-item-separator @@ -501,6 +531,12 @@ Returns the last element of the array. Prints an error and returns ``null`` if t Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a ``before`` specifier can be passed. If ``false``, the returned index comes after all existing entries of the value in the array. +:: + + var array = ["a", "b", "c", "c", "d", "e"] + print(array.bsearch("c", true)) # Prints 2, at the first matching element. + print(array.bsearch("c", false)) # Prints 4, after the last matching element, pointing to "d". + \ **Note:** Calling :ref:`bsearch` on an unsorted array results in unexpected behavior. .. rst-class:: classref-item-separator @@ -515,6 +551,8 @@ Finds the index of an existing value (or the insertion index that maintains sort Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search and a custom comparison method. Optionally, a ``before`` specifier can be passed. If ``false``, the returned index comes after all existing entries of the value in the array. The custom method receives two arguments (an element from the array and the value searched for) and must return ``true`` if the first argument is less than the second, and return ``false`` otherwise. +\ **Note:** The custom method must accept the two arguments in any order, you cannot rely on that the first argument will always be from the array. + \ **Note:** Calling :ref:`bsearch_custom` on an unsorted array results in unexpected behavior. .. rst-class:: classref-item-separator @@ -665,7 +703,7 @@ Returns the first element of the array. Prints an error and returns ``null`` if :ref:`int` **get_typed_builtin** **(** **)** |const| -Returns the :ref:`Variant.Type` constant for a typed array. If the **Array** is not typed, returns :ref:`@GlobalScope.TYPE_NIL`. +Returns the built-in type of the typed array as a :ref:`Variant.Type` constant. If the array is not typed, returns :ref:`@GlobalScope.TYPE_NIL`. .. rst-class:: classref-item-separator @@ -677,7 +715,7 @@ Returns the :ref:`Variant.Type` constant for a t :ref:`StringName` **get_typed_class_name** **(** **)** |const| -Returns a class name of a typed **Array** of type :ref:`@GlobalScope.TYPE_OBJECT`. +Returns the **native** class name of the typed array if the built-in type is :ref:`@GlobalScope.TYPE_OBJECT`. Otherwise, this method returns an empty string. .. rst-class:: classref-item-separator @@ -689,7 +727,7 @@ Returns a class name of a typed **Array** of type :ref:`@GlobalScope.TYPE_OBJECT :ref:`Variant` **get_typed_script** **(** **)** |const| -Returns the script associated with a typed array tied to a class name. +Returns the script associated with the typed array. This method returns a :ref:`Script` instance or ``null``. .. rst-class:: classref-item-separator @@ -936,7 +974,7 @@ Returns a random value from the target array. Prints an error and returns ``null :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. +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 unchanged 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. @@ -1047,6 +1085,8 @@ Removes an element from the array by index. If the index does not exist in the a Resizes the array to contain a different number of elements. If the array size is smaller, elements are cleared, if bigger, new elements are ``null``. Returns :ref:`@GlobalScope.OK` on success, or one of the other :ref:`Error` values if the operation failed. +Calling :ref:`resize` once and assigning the new values is faster than adding new elements one by one. + \ **Note:** This method acts in-place and doesn't return a modified array. .. rst-class:: classref-item-separator diff --git a/classes/class_arraymesh.rst b/classes/class_arraymesh.rst index 00e6b5d6e..24be3e76c 100644 --- a/classes/class_arraymesh.rst +++ b/classes/class_arraymesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ArrayMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ArrayMesh.xml. .. _class_ArrayMesh: diff --git a/classes/class_arrayoccluder3d.rst b/classes/class_arrayoccluder3d.rst index c9dbec81f..b0ec2a0bb 100644 --- a/classes/class_arrayoccluder3d.rst +++ b/classes/class_arrayoccluder3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ArrayOccluder3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ArrayOccluder3D.xml. .. _class_ArrayOccluder3D: diff --git a/classes/class_aspectratiocontainer.rst b/classes/class_aspectratiocontainer.rst index 54cd9722d..2f7edca85 100644 --- a/classes/class_aspectratiocontainer.rst +++ b/classes/class_aspectratiocontainer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AspectRatioContainer.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AspectRatioContainer.xml. .. _class_AspectRatioContainer: diff --git a/classes/class_astar2d.rst b/classes/class_astar2d.rst index 64e7de112..d44c03122 100644 --- a/classes/class_astar2d.rst +++ b/classes/class_astar2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AStar2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AStar2D.xml. .. _class_AStar2D: diff --git a/classes/class_astar3d.rst b/classes/class_astar3d.rst index 89f805f76..d59330775 100644 --- a/classes/class_astar3d.rst +++ b/classes/class_astar3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AStar3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AStar3D.xml. .. _class_AStar3D: diff --git a/classes/class_astargrid2d.rst b/classes/class_astargrid2d.rst index ccd712b40..0651b392d 100644 --- a/classes/class_astargrid2d.rst +++ b/classes/class_astargrid2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AStarGrid2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AStarGrid2D.xml. .. _class_AStarGrid2D: @@ -492,7 +492,7 @@ Returns an array with the IDs of the points that form the path found by AStar2D Returns an array with the points that are in the path found by **AStarGrid2D** between the given points. The array is ordered from the starting point to the ending point of the path. -\ **Note:** This method is not thread-safe. If called from a :ref:`Thread`, it will return an empty :ref:`PackedVector3Array` and will print an error message. +\ **Note:** This method is not thread-safe. If called from a :ref:`Thread`, it will return an empty :ref:`PackedVector2Array` and will print an error message. .. rst-class:: classref-item-separator diff --git a/classes/class_atlastexture.rst b/classes/class_atlastexture.rst index e030f88a7..610e62bda 100644 --- a/classes/class_atlastexture.rst +++ b/classes/class_atlastexture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AtlasTexture.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AtlasTexture.xml. .. _class_AtlasTexture: diff --git a/classes/class_audiobuslayout.rst b/classes/class_audiobuslayout.rst index 3ef224170..a9d1193d7 100644 --- a/classes/class_audiobuslayout.rst +++ b/classes/class_audiobuslayout.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioBusLayout.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AudioBusLayout.xml. .. _class_AudioBusLayout: diff --git a/classes/class_audioeffect.rst b/classes/class_audioeffect.rst index 1a8812c61..2e7608eec 100644 --- a/classes/class_audioeffect.rst +++ b/classes/class_audioeffect.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffect.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AudioEffect.xml. .. _class_AudioEffect: diff --git a/classes/class_audioeffectamplify.rst b/classes/class_audioeffectamplify.rst index e115333cb..865b25ef7 100644 --- a/classes/class_audioeffectamplify.rst +++ b/classes/class_audioeffectamplify.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectAmplify.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AudioEffectAmplify.xml. .. _class_AudioEffectAmplify: diff --git a/classes/class_audioeffectbandlimitfilter.rst b/classes/class_audioeffectbandlimitfilter.rst index eecb2230f..4921ae088 100644 --- a/classes/class_audioeffectbandlimitfilter.rst +++ b/classes/class_audioeffectbandlimitfilter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectBandLimitFilter.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AudioEffectBandLimitFilter.xml. .. _class_AudioEffectBandLimitFilter: diff --git a/classes/class_audioeffectbandpassfilter.rst b/classes/class_audioeffectbandpassfilter.rst index b82d4b4eb..3deb7a4b2 100644 --- a/classes/class_audioeffectbandpassfilter.rst +++ b/classes/class_audioeffectbandpassfilter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectBandPassFilter.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AudioEffectBandPassFilter.xml. .. _class_AudioEffectBandPassFilter: diff --git a/classes/class_audioeffectcapture.rst b/classes/class_audioeffectcapture.rst index 5fbea6185..3d1cc9f4a 100644 --- a/classes/class_audioeffectcapture.rst +++ b/classes/class_audioeffectcapture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectCapture.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AudioEffectCapture.xml. .. _class_AudioEffectCapture: diff --git a/classes/class_audioeffectchorus.rst b/classes/class_audioeffectchorus.rst index c54e8ad00..9c333849c 100644 --- a/classes/class_audioeffectchorus.rst +++ b/classes/class_audioeffectchorus.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectChorus.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AudioEffectChorus.xml. .. _class_AudioEffectChorus: diff --git a/classes/class_audioeffectcompressor.rst b/classes/class_audioeffectcompressor.rst index 118668037..b5e47d9ca 100644 --- a/classes/class_audioeffectcompressor.rst +++ b/classes/class_audioeffectcompressor.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectCompressor.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AudioEffectCompressor.xml. .. _class_AudioEffectCompressor: diff --git a/classes/class_audioeffectdelay.rst b/classes/class_audioeffectdelay.rst index fe3022267..454859eb5 100644 --- a/classes/class_audioeffectdelay.rst +++ b/classes/class_audioeffectdelay.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectDelay.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AudioEffectDelay.xml. .. _class_AudioEffectDelay: diff --git a/classes/class_audioeffectdistortion.rst b/classes/class_audioeffectdistortion.rst index e91d8fef5..e45c02934 100644 --- a/classes/class_audioeffectdistortion.rst +++ b/classes/class_audioeffectdistortion.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectDistortion.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AudioEffectDistortion.xml. .. _class_AudioEffectDistortion: diff --git a/classes/class_audioeffecteq.rst b/classes/class_audioeffecteq.rst index c132fb0eb..2185e4636 100644 --- a/classes/class_audioeffecteq.rst +++ b/classes/class_audioeffecteq.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectEQ.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AudioEffectEQ.xml. .. _class_AudioEffectEQ: diff --git a/classes/class_audioeffecteq10.rst b/classes/class_audioeffecteq10.rst index d1dc42c32..a3a191719 100644 --- a/classes/class_audioeffecteq10.rst +++ b/classes/class_audioeffecteq10.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectEQ10.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AudioEffectEQ10.xml. .. _class_AudioEffectEQ10: diff --git a/classes/class_audioeffecteq21.rst b/classes/class_audioeffecteq21.rst index b753bc6dd..f5a0657ca 100644 --- a/classes/class_audioeffecteq21.rst +++ b/classes/class_audioeffecteq21.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectEQ21.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AudioEffectEQ21.xml. .. _class_AudioEffectEQ21: diff --git a/classes/class_audioeffecteq6.rst b/classes/class_audioeffecteq6.rst index 098fd3a3f..f7ec6d018 100644 --- a/classes/class_audioeffecteq6.rst +++ b/classes/class_audioeffecteq6.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectEQ6.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AudioEffectEQ6.xml. .. _class_AudioEffectEQ6: diff --git a/classes/class_audioeffectfilter.rst b/classes/class_audioeffectfilter.rst index 0e92c34a8..520a1031f 100644 --- a/classes/class_audioeffectfilter.rst +++ b/classes/class_audioeffectfilter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectFilter.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AudioEffectFilter.xml. .. _class_AudioEffectFilter: diff --git a/classes/class_audioeffecthighpassfilter.rst b/classes/class_audioeffecthighpassfilter.rst index 94ec635c0..c623ab56f 100644 --- a/classes/class_audioeffecthighpassfilter.rst +++ b/classes/class_audioeffecthighpassfilter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectHighPassFilter.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AudioEffectHighPassFilter.xml. .. _class_AudioEffectHighPassFilter: diff --git a/classes/class_audioeffecthighshelffilter.rst b/classes/class_audioeffecthighshelffilter.rst index 5b3073dba..bf1d04e2c 100644 --- a/classes/class_audioeffecthighshelffilter.rst +++ b/classes/class_audioeffecthighshelffilter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectHighShelfFilter.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AudioEffectHighShelfFilter.xml. .. _class_AudioEffectHighShelfFilter: diff --git a/classes/class_audioeffectinstance.rst b/classes/class_audioeffectinstance.rst index 8ab1a42f4..9099f02fc 100644 --- a/classes/class_audioeffectinstance.rst +++ b/classes/class_audioeffectinstance.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectInstance.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AudioEffectInstance.xml. .. _class_AudioEffectInstance: diff --git a/classes/class_audioeffectlimiter.rst b/classes/class_audioeffectlimiter.rst index 67a2866af..e38f1e9ee 100644 --- a/classes/class_audioeffectlimiter.rst +++ b/classes/class_audioeffectlimiter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectLimiter.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AudioEffectLimiter.xml. .. _class_AudioEffectLimiter: diff --git a/classes/class_audioeffectlowpassfilter.rst b/classes/class_audioeffectlowpassfilter.rst index 17d4ec73d..04b4768ec 100644 --- a/classes/class_audioeffectlowpassfilter.rst +++ b/classes/class_audioeffectlowpassfilter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectLowPassFilter.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AudioEffectLowPassFilter.xml. .. _class_AudioEffectLowPassFilter: diff --git a/classes/class_audioeffectlowshelffilter.rst b/classes/class_audioeffectlowshelffilter.rst index 595fc3e93..58c99db36 100644 --- a/classes/class_audioeffectlowshelffilter.rst +++ b/classes/class_audioeffectlowshelffilter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectLowShelfFilter.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AudioEffectLowShelfFilter.xml. .. _class_AudioEffectLowShelfFilter: diff --git a/classes/class_audioeffectnotchfilter.rst b/classes/class_audioeffectnotchfilter.rst index 1a1172073..cfae13f33 100644 --- a/classes/class_audioeffectnotchfilter.rst +++ b/classes/class_audioeffectnotchfilter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectNotchFilter.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AudioEffectNotchFilter.xml. .. _class_AudioEffectNotchFilter: diff --git a/classes/class_audioeffectpanner.rst b/classes/class_audioeffectpanner.rst index cbfcd3d95..96126c84d 100644 --- a/classes/class_audioeffectpanner.rst +++ b/classes/class_audioeffectpanner.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectPanner.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AudioEffectPanner.xml. .. _class_AudioEffectPanner: diff --git a/classes/class_audioeffectphaser.rst b/classes/class_audioeffectphaser.rst index 1d77b88c8..c8097793d 100644 --- a/classes/class_audioeffectphaser.rst +++ b/classes/class_audioeffectphaser.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectPhaser.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AudioEffectPhaser.xml. .. _class_AudioEffectPhaser: diff --git a/classes/class_audioeffectpitchshift.rst b/classes/class_audioeffectpitchshift.rst index cc8515332..d67882763 100644 --- a/classes/class_audioeffectpitchshift.rst +++ b/classes/class_audioeffectpitchshift.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectPitchShift.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AudioEffectPitchShift.xml. .. _class_AudioEffectPitchShift: @@ -163,7 +163,7 @@ The oversampling factor to use. Higher values result in better quality, but are - void **set_pitch_scale** **(** :ref:`float` value **)** - :ref:`float` **get_pitch_scale** **(** **)** -The pitch scale to use. ``1.0`` is the default pitch and plays sounds unaltered. :ref:`pitch_scale` can range from ``0.0`` (infinitely low pitch, inaudible) to ``16`` (16 times higher than the initial pitch). +The pitch scale to use. ``1.0`` is the default pitch and plays sounds unaffected. :ref:`pitch_scale` can range from ``0.0`` (infinitely low pitch, inaudible) to ``16`` (16 times higher than the initial pitch). .. |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_audioeffectrecord.rst b/classes/class_audioeffectrecord.rst index 5b9c5aa25..7b47c1e3c 100644 --- a/classes/class_audioeffectrecord.rst +++ b/classes/class_audioeffectrecord.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectRecord.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AudioEffectRecord.xml. .. _class_AudioEffectRecord: diff --git a/classes/class_audioeffectreverb.rst b/classes/class_audioeffectreverb.rst index 5b7ca1e55..081945f6e 100644 --- a/classes/class_audioeffectreverb.rst +++ b/classes/class_audioeffectreverb.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectReverb.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AudioEffectReverb.xml. .. _class_AudioEffectReverb: diff --git a/classes/class_audioeffectspectrumanalyzer.rst b/classes/class_audioeffectspectrumanalyzer.rst index 428cd25da..d7a0c510d 100644 --- a/classes/class_audioeffectspectrumanalyzer.rst +++ b/classes/class_audioeffectspectrumanalyzer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectSpectrumAnalyzer.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AudioEffectSpectrumAnalyzer.xml. .. _class_AudioEffectSpectrumAnalyzer: diff --git a/classes/class_audioeffectspectrumanalyzerinstance.rst b/classes/class_audioeffectspectrumanalyzerinstance.rst index e6262df4f..491f704b6 100644 --- a/classes/class_audioeffectspectrumanalyzerinstance.rst +++ b/classes/class_audioeffectspectrumanalyzerinstance.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectSpectrumAnalyzerInstance.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AudioEffectSpectrumAnalyzerInstance.xml. .. _class_AudioEffectSpectrumAnalyzerInstance: diff --git a/classes/class_audioeffectstereoenhance.rst b/classes/class_audioeffectstereoenhance.rst index fe4586d53..fb6883a82 100644 --- a/classes/class_audioeffectstereoenhance.rst +++ b/classes/class_audioeffectstereoenhance.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectStereoEnhance.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AudioEffectStereoEnhance.xml. .. _class_AudioEffectStereoEnhance: diff --git a/classes/class_audiolistener2d.rst b/classes/class_audiolistener2d.rst index c6f29cc15..4b83fa7e9 100644 --- a/classes/class_audiolistener2d.rst +++ b/classes/class_audiolistener2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioListener2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AudioListener2D.xml. .. _class_AudioListener2D: diff --git a/classes/class_audiolistener3d.rst b/classes/class_audiolistener3d.rst index 4e744d489..2f086fa60 100644 --- a/classes/class_audiolistener3d.rst +++ b/classes/class_audiolistener3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioListener3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AudioListener3D.xml. .. _class_AudioListener3D: diff --git a/classes/class_audioserver.rst b/classes/class_audioserver.rst index 2aa1c5e25..a2d587ae5 100644 --- a/classes/class_audioserver.rst +++ b/classes/class_audioserver.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioServer.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AudioServer.xml. .. _class_AudioServer: @@ -744,9 +744,9 @@ Sets the volume of the bus at index ``bus_idx`` to ``volume_db``. void **set_enable_tagging_used_audio_streams** **(** :ref:`bool` enable **)** -.. container:: contribute +If set to ``true``, all instances of :ref:`AudioStreamPlayback` will call :ref:`AudioStreamPlayback._tag_used_streams` every mix step. - There is currently no description for this method. Please help us by :ref:`contributing one `! +\ **Note:** This is enabled by default in the editor, as it is used by editor plugins for the audio stream previews. .. rst-class:: classref-item-separator diff --git a/classes/class_audiostream.rst b/classes/class_audiostream.rst index 6b199a0da..45fe30f5f 100644 --- a/classes/class_audiostream.rst +++ b/classes/class_audiostream.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioStream.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AudioStream.xml. .. _class_AudioStream: @@ -79,9 +79,9 @@ Method Descriptions :ref:`int` **_get_beat_count** **(** **)** |virtual| |const| -.. container:: contribute +Overridable method. Should return the total number of beats of this audio stream. Used by the engine to determine the position of every beat. - There is currently no description for this method. Please help us by :ref:`contributing one `! +Ideally, the returned value should be based off the stream's sample rate (:ref:`AudioStreamWAV.mix_rate`, for example). .. rst-class:: classref-item-separator @@ -93,9 +93,9 @@ Method Descriptions :ref:`float` **_get_bpm** **(** **)** |virtual| |const| -.. container:: contribute +Overridable method. Should return the tempo of this audio stream, in beats per minute (BPM). Used by the engine to determine the position of every beat. - There is currently no description for this method. Please help us by :ref:`contributing one `! +Ideally, the returned value should be based off the stream's sample rate (:ref:`AudioStreamWAV.mix_rate`, for example). .. rst-class:: classref-item-separator @@ -107,9 +107,7 @@ Method Descriptions :ref:`float` **_get_length** **(** **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Override this method to customize the returned value of :ref:`get_length`. Should return the length of this audio stream, in seconds. .. rst-class:: classref-item-separator @@ -121,9 +119,7 @@ Method Descriptions :ref:`String` **_get_stream_name** **(** **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Override this method to customize the name assigned to this audio stream. Unused by the engine. .. rst-class:: classref-item-separator @@ -135,9 +131,7 @@ Method Descriptions :ref:`AudioStreamPlayback` **_instantiate_playback** **(** **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Override this method to customize the returned value of :ref:`instantiate_playback`. Should returned a new :ref:`AudioStreamPlayback` created when the stream is played (such as by an :ref:`AudioStreamPlayer`).. .. rst-class:: classref-item-separator @@ -149,9 +143,7 @@ Method Descriptions :ref:`bool` **_is_monophonic** **(** **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Override this method to customize the returned value of :ref:`is_monophonic`. Should return ``true`` if this audio stream only supports one channel. .. rst-class:: classref-item-separator @@ -175,7 +167,7 @@ Returns the length of the audio stream in seconds. :ref:`AudioStreamPlayback` **instantiate_playback** **(** **)** -Returns an AudioStreamPlayback. Useful for when you want to extend :ref:`_instantiate_playback` but call :ref:`instantiate_playback` from an internally held AudioStream subresource. An example of this can be found in the source files for ``AudioStreamRandomPitch::instantiate_playback``. +Returns a newly created :ref:`AudioStreamPlayback` intended to play this audio stream. Useful for when you want to extend :ref:`_instantiate_playback` but call :ref:`instantiate_playback` from an internally held AudioStream subresource. An example of this can be found in the source code for ``AudioStreamRandomPitch::instantiate_playback``. .. rst-class:: classref-item-separator @@ -187,7 +179,7 @@ Returns an AudioStreamPlayback. Useful for when you want to extend :ref:`_instan :ref:`bool` **is_monophonic** **(** **)** |const| -Returns true if this audio stream only supports monophonic playback, or false if the audio stream supports polyphony. +Returns ``true`` if this audio stream only supports one channel (*monophony*), or ``false`` if the audio stream supports two or more channels (*polyphony*). .. |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_audiostreamgenerator.rst b/classes/class_audiostreamgenerator.rst index 50fd87c89..b7408806b 100644 --- a/classes/class_audiostreamgenerator.rst +++ b/classes/class_audiostreamgenerator.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioStreamGenerator.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AudioStreamGenerator.xml. .. _class_AudioStreamGenerator: diff --git a/classes/class_audiostreamgeneratorplayback.rst b/classes/class_audiostreamgeneratorplayback.rst index 466daa3bb..dfca3f0c6 100644 --- a/classes/class_audiostreamgeneratorplayback.rst +++ b/classes/class_audiostreamgeneratorplayback.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioStreamGeneratorPlayback.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AudioStreamGeneratorPlayback.xml. .. _class_AudioStreamGeneratorPlayback: diff --git a/classes/class_audiostreammicrophone.rst b/classes/class_audiostreammicrophone.rst index 229d43b4d..9980b606d 100644 --- a/classes/class_audiostreammicrophone.rst +++ b/classes/class_audiostreammicrophone.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioStreamMicrophone.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AudioStreamMicrophone.xml. .. _class_AudioStreamMicrophone: diff --git a/classes/class_audiostreammp3.rst b/classes/class_audiostreammp3.rst index a44449ee9..2ae7dded4 100644 --- a/classes/class_audiostreammp3.rst +++ b/classes/class_audiostreammp3.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/minimp3/doc_classes/AudioStreamMP3.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/minimp3/doc_classes/AudioStreamMP3.xml. .. _class_AudioStreamMP3: diff --git a/classes/class_audiostreamoggvorbis.rst b/classes/class_audiostreamoggvorbis.rst index a8ddb0a83..c4afbcf5d 100644 --- a/classes/class_audiostreamoggvorbis.rst +++ b/classes/class_audiostreamoggvorbis.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/vorbis/doc_classes/AudioStreamOggVorbis.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/vorbis/doc_classes/AudioStreamOggVorbis.xml. .. _class_AudioStreamOggVorbis: diff --git a/classes/class_audiostreamplayback.rst b/classes/class_audiostreamplayback.rst index eb0ea7059..07281ccc4 100644 --- a/classes/class_audiostreamplayback.rst +++ b/classes/class_audiostreamplayback.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioStreamPlayback.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AudioStreamPlayback.xml. .. _class_AudioStreamPlayback: @@ -71,9 +71,7 @@ Method Descriptions :ref:`int` **_get_loop_count** **(** **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Overridable method. Should return how many times this audio stream has looped. Most built-in playbacks always return ``0``. .. rst-class:: classref-item-separator @@ -85,9 +83,7 @@ Method Descriptions :ref:`float` **_get_playback_position** **(** **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Overridable method. Should return the current progress along the audio stream, in seconds. .. rst-class:: classref-item-separator @@ -99,9 +95,7 @@ Method Descriptions :ref:`bool` **_is_playing** **(** **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Overridable method. Should return ``true`` if this playback is active and playing its audio stream. .. rst-class:: classref-item-separator @@ -113,9 +107,9 @@ Method Descriptions :ref:`int` **_mix** **(** AudioFrame* buffer, :ref:`float` rate_scale, :ref:`int` frames **)** |virtual| -.. container:: contribute +Override this method to customize how the audio stream is mixed. This method is called even if the playback is not active. - There is currently no description for this method. Please help us by :ref:`contributing one `! +\ **Note:** It is not useful to override this method in GDScript or C#. Only GDExtension can take advantage of it. .. rst-class:: classref-item-separator @@ -127,9 +121,7 @@ Method Descriptions void **_seek** **(** :ref:`float` position **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Override this method to customize what happens when seeking this audio stream at the given ``position``, such as by calling :ref:`AudioStreamPlayer.seek`. .. rst-class:: classref-item-separator @@ -141,9 +133,7 @@ void **_seek** **(** :ref:`float` position **)** |virtual| void **_start** **(** :ref:`float` from_pos **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Override this method to customize what happens when the playback starts at the given position, such as by calling :ref:`AudioStreamPlayer.play`. .. rst-class:: classref-item-separator @@ -155,9 +145,7 @@ void **_start** **(** :ref:`float` from_pos **)** |virtual| void **_stop** **(** **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Override this method to customize what happens when the playback is stopped, such as by calling :ref:`AudioStreamPlayer.stop`. .. rst-class:: classref-item-separator @@ -169,9 +157,7 @@ void **_stop** **(** **)** |virtual| void **_tag_used_streams** **(** **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Overridable method. Called whenever the audio stream is mixed if the playback is active and :ref:`AudioServer.set_enable_tagging_used_audio_streams` has been set to ``true``. Editor plugins may use this method to "tag" the current position along the audio stream and display it in a preview. .. |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_audiostreamplaybackoggvorbis.rst b/classes/class_audiostreamplaybackoggvorbis.rst index 173b7775f..c3d386c43 100644 --- a/classes/class_audiostreamplaybackoggvorbis.rst +++ b/classes/class_audiostreamplaybackoggvorbis.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/vorbis/doc_classes/AudioStreamPlaybackOggVorbis.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/vorbis/doc_classes/AudioStreamPlaybackOggVorbis.xml. .. _class_AudioStreamPlaybackOggVorbis: diff --git a/classes/class_audiostreamplaybackpolyphonic.rst b/classes/class_audiostreamplaybackpolyphonic.rst index 9f464c006..2cb644354 100644 --- a/classes/class_audiostreamplaybackpolyphonic.rst +++ b/classes/class_audiostreamplaybackpolyphonic.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioStreamPlaybackPolyphonic.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AudioStreamPlaybackPolyphonic.xml. .. _class_AudioStreamPlaybackPolyphonic: diff --git a/classes/class_audiostreamplaybackresampled.rst b/classes/class_audiostreamplaybackresampled.rst index f6c56ec2d..8864ef6d5 100644 --- a/classes/class_audiostreamplaybackresampled.rst +++ b/classes/class_audiostreamplaybackresampled.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioStreamPlaybackResampled.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AudioStreamPlaybackResampled.xml. .. _class_AudioStreamPlaybackResampled: diff --git a/classes/class_audiostreamplayer.rst b/classes/class_audiostreamplayer.rst index 6e42f4b52..ec3d103b7 100644 --- a/classes/class_audiostreamplayer.rst +++ b/classes/class_audiostreamplayer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioStreamPlayer.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AudioStreamPlayer.xml. .. _class_AudioStreamPlayer: diff --git a/classes/class_audiostreamplayer2d.rst b/classes/class_audiostreamplayer2d.rst index 3eb1bc99a..7ec7adac8 100644 --- a/classes/class_audiostreamplayer2d.rst +++ b/classes/class_audiostreamplayer2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioStreamPlayer2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AudioStreamPlayer2D.xml. .. _class_AudioStreamPlayer2D: diff --git a/classes/class_audiostreamplayer3d.rst b/classes/class_audiostreamplayer3d.rst index 3f886d09e..1880b3e12 100644 --- a/classes/class_audiostreamplayer3d.rst +++ b/classes/class_audiostreamplayer3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioStreamPlayer3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AudioStreamPlayer3D.xml. .. _class_AudioStreamPlayer3D: diff --git a/classes/class_audiostreampolyphonic.rst b/classes/class_audiostreampolyphonic.rst index e69cff156..1798a06ef 100644 --- a/classes/class_audiostreampolyphonic.rst +++ b/classes/class_audiostreampolyphonic.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioStreamPolyphonic.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AudioStreamPolyphonic.xml. .. _class_AudioStreamPolyphonic: diff --git a/classes/class_audiostreamrandomizer.rst b/classes/class_audiostreamrandomizer.rst index ce7fd5717..c323d8c53 100644 --- a/classes/class_audiostreamrandomizer.rst +++ b/classes/class_audiostreamrandomizer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioStreamRandomizer.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AudioStreamRandomizer.xml. .. _class_AudioStreamRandomizer: diff --git a/classes/class_audiostreamwav.rst b/classes/class_audiostreamwav.rst index 1e72eeb5e..4c4a929f4 100644 --- a/classes/class_audiostreamwav.rst +++ b/classes/class_audiostreamwav.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioStreamWAV.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AudioStreamWAV.xml. .. _class_AudioStreamWAV: diff --git a/classes/class_backbuffercopy.rst b/classes/class_backbuffercopy.rst index f16b2ff9f..66bb1e3f3 100644 --- a/classes/class_backbuffercopy.rst +++ b/classes/class_backbuffercopy.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/BackBufferCopy.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/BackBufferCopy.xml. .. _class_BackBufferCopy: diff --git a/classes/class_basebutton.rst b/classes/class_basebutton.rst index 54557496a..3a7b9503a 100644 --- a/classes/class_basebutton.rst +++ b/classes/class_basebutton.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/BaseButton.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/BaseButton.xml. .. _class_BaseButton: diff --git a/classes/class_basematerial3d.rst b/classes/class_basematerial3d.rst index 4b5dfbecf..048877072 100644 --- a/classes/class_basematerial3d.rst +++ b/classes/class_basematerial3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/BaseMaterial3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/BaseMaterial3D.xml. .. _class_BaseMaterial3D: @@ -479,7 +479,7 @@ enum **TextureFilter**: :ref:`TextureFilter` **TEXTURE_FILTER_NEAREST** = ``0`` -The texture filter reads from the nearest pixel only. The simplest and fastest method of filtering, but the texture will look pixelized. +The texture filter reads from the nearest pixel only. This makes the texture look pixelated from up close, and grainy from a distance (due to mipmaps not being sampled). .. _class_BaseMaterial3D_constant_TEXTURE_FILTER_LINEAR: @@ -487,7 +487,7 @@ The texture filter reads from the nearest pixel only. The simplest and fastest m :ref:`TextureFilter` **TEXTURE_FILTER_LINEAR** = ``1`` -The texture filter blends between the nearest 4 pixels. Use this when you want to avoid a pixelated style, but do not want mipmaps. +The texture filter blends between the nearest 4 pixels. This makes the texture look smooth from up close, and grainy from a distance (due to mipmaps not being sampled). .. _class_BaseMaterial3D_constant_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS: @@ -495,7 +495,7 @@ The texture filter blends between the nearest 4 pixels. Use this when you want t :ref:`TextureFilter` **TEXTURE_FILTER_NEAREST_WITH_MIPMAPS** = ``2`` -The texture filter reads from the nearest pixel in the nearest mipmap. The fastest way to read from textures with mipmaps. +The texture filter reads from the nearest pixel and blends between the nearest 2 mipmaps (or uses the nearest mipmap if :ref:`ProjectSettings.rendering/textures/default_filters/use_nearest_mipmap_filter` is ``true``). This makes the texture look pixelated from up close, and smooth from a distance. .. _class_BaseMaterial3D_constant_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS: @@ -503,7 +503,7 @@ The texture filter reads from the nearest pixel in the nearest mipmap. The faste :ref:`TextureFilter` **TEXTURE_FILTER_LINEAR_WITH_MIPMAPS** = ``3`` -The texture filter blends between the nearest 4 pixels and between the nearest 2 mipmaps. Use this for most cases as mipmaps are important to smooth out pixels that are far from the camera. +The texture filter blends between the nearest 4 pixels and between the nearest 2 mipmaps (or uses the nearest mipmap if :ref:`ProjectSettings.rendering/textures/default_filters/use_nearest_mipmap_filter` is ``true``). This makes the texture look smooth from up close, and smooth from a distance. .. _class_BaseMaterial3D_constant_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC: @@ -511,7 +511,7 @@ The texture filter blends between the nearest 4 pixels and between the nearest 2 :ref:`TextureFilter` **TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC** = ``4`` -The texture filter reads from the nearest pixel, but selects a mipmap based on the angle between the surface and the camera view. This reduces artifacts on surfaces that are almost in line with the camera. The anisotropic filtering level can be changed by adjusting :ref:`ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level`. +The texture filter reads from the nearest pixel and blends between 2 mipmaps (or uses the nearest mipmap if :ref:`ProjectSettings.rendering/textures/default_filters/use_nearest_mipmap_filter` is ``true``) based on the angle between the surface and the camera view. This makes the texture look pixelated from up close, and smooth from a distance. Anisotropic filtering improves texture quality on surfaces that are almost in line with the camera, but is slightly slower. The anisotropic filtering level can be changed by adjusting :ref:`ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level`. .. _class_BaseMaterial3D_constant_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC: @@ -519,7 +519,7 @@ The texture filter reads from the nearest pixel, but selects a mipmap based on t :ref:`TextureFilter` **TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC** = ``5`` -The texture filter blends between the nearest 4 pixels and selects a mipmap based on the angle between the surface and the camera view. This reduces artifacts on surfaces that are almost in line with the camera. This is the slowest of the filtering options, but results in the highest quality texturing. The anisotropic filtering level can be changed by adjusting :ref:`ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level`. +The texture filter blends between the nearest 4 pixels and blends between 2 mipmaps (or uses the nearest mipmap if :ref:`ProjectSettings.rendering/textures/default_filters/use_nearest_mipmap_filter` is ``true``) based on the angle between the surface and the camera view. This makes the texture look smooth from up close, and smooth from a distance. Anisotropic filtering improves texture quality on surfaces that are almost in line with the camera, but is slightly slower. The anisotropic filtering level can be changed by adjusting :ref:`ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level`. .. _class_BaseMaterial3D_constant_TEXTURE_FILTER_MAX: @@ -3108,7 +3108,7 @@ If ``true``, enables subsurface scattering transmittance. Only effective if :ref - void **set_texture** **(** :ref:`TextureParam` param, :ref:`Texture2D` texture **)** - :ref:`Texture2D` **get_texture** **(** :ref:`TextureParam` param **)** |const| -The texture to use for multiplying the intensity of the subsurface scattering transmitteance intensity. See also :ref:`subsurf_scatter_texture`. Ignored if :ref:`subsurf_scatter_skin_mode` is ``true``. +The texture to use for multiplying the intensity of the subsurface scattering transmittance intensity. See also :ref:`subsurf_scatter_texture`. Ignored if :ref:`subsurf_scatter_skin_mode` is ``true``. .. rst-class:: classref-item-separator diff --git a/classes/class_basis.rst b/classes/class_basis.rst index 8a64d8221..d37f571a3 100644 --- a/classes/class_basis.rst +++ b/classes/class_basis.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Basis.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Basis.xml. .. _class_Basis: @@ -17,13 +17,17 @@ A 3×3 matrix for representing 3D rotation and scale. Description ----------- -A 3×3 matrix used for representing 3D rotation and scale. Usually used as an orthogonal basis for a :ref:`Transform3D`. +The **Basis** built-in :ref:`Variant` type is a 3x3 `matrix `__ used to represent 3D rotation, scale, and shear. It is frequently used within a :ref:`Transform3D`. -Contains 3 vector fields X, Y and Z as its columns, which are typically interpreted as the local basis vectors of a transformation. For such use, it is composed of a scaling and a rotation matrix, in that order (M = R.S). +A **Basis** is composed by 3 axis vectors, each representing a column of the matrix: :ref:`x`, :ref:`y`, and :ref:`z`. The length of each axis (:ref:`Vector3.length`) influences the basis's scale, while the direction of all axes influence the rotation. Usually, these axes are perpendicular to one another. However, when you rotate any axis individually, the basis becomes sheared. Applying a sheared basis to a 3D model will make the model appear distorted. -Basis can also be accessed as an array of 3D vectors. These vectors are usually orthogonal to each other, but are not necessarily normalized (due to scaling). +A **Basis** is **orthogonal** if its axes are perpendicular to each other. A basis is **normalized** if the length of every axis is ``1``. A basis is **uniform** if all axes share the same length (see :ref:`get_scale`). A basis is **orthonormal** if it is both orthogonal and normalized, which allows it to only represent rotations. A basis is **conformal** if it is both orthogonal and uniform, which ensures it is not distorted. -For more information, read the "Matrices and transforms" documentation article. +For a general introduction, see the :doc:`Matrices and transforms <../tutorials/math/matrices_and_transforms>` tutorial. + +\ **Note:** Godot uses a `right-handed coordinate system `__, which is a common standard. For directions, the convention for built-in types like :ref:`Camera3D` is for -Z to point forward (+X is right, +Y is up, and +Z is back). Other objects may use different direction conventions. For more information, see the `Importing 3D Scenes <../tutorials/assets_pipeline/importing_scenes.html#d-asset-direction-conventions>`__ tutorial. + +\ **Note:** The basis matrices are exposed as `column-major `__ order, which is the same as OpenGL. However, they are stored internally in row-major order, which is the same as DirectX. .. note:: @@ -171,7 +175,26 @@ Constants **IDENTITY** = ``Basis(1, 0, 0, 0, 1, 0, 0, 0, 1)`` -The identity basis, with no rotation or scaling applied. +The identity basis. This is a basis with no rotation, no shear, and its scale being ``1``. This means that: + +- The :ref:`x` points right (:ref:`Vector3.RIGHT`); + +- The :ref:`y` points up (:ref:`Vector3.UP`); + +- The :ref:`z` points back (:ref:`Vector3.BACK`). + +:: + + var basis := Basis.IDENTITY + print("| X | Y | Z") + print("| %s | %s | %s" % [basis.x.x, basis.y.x, basis.z.x]) + print("| %s | %s | %s" % [basis.x.y, basis.y.y, basis.z.y]) + print("| %s | %s | %s" % [basis.x.z, basis.y.z, basis.z.z]) + # Prints: + # | X | Y | Z + # | 1 | 0 | 0 + # | 0 | 1 | 0 + # | 0 | 0 | 1 This is identical to creating :ref:`Basis` without any parameters. This constant can be used to make your code clearer, and for consistency with C#. @@ -181,7 +204,9 @@ This is identical to creating :ref:`Basis` withou **FLIP_X** = ``Basis(-1, 0, 0, 0, 1, 0, 0, 0, 1)`` -The basis that will flip something along the X axis when used in a transformation. +When any basis is multiplied by :ref:`FLIP_X`, it negates all components of the :ref:`x` axis (the X column). + +When :ref:`FLIP_X` is multiplied by any basis, it negates the :ref:`Vector3.x` component of all axes (the X row). .. _class_Basis_constant_FLIP_Y: @@ -189,7 +214,9 @@ The basis that will flip something along the X axis when used in a transformatio **FLIP_Y** = ``Basis(1, 0, 0, 0, -1, 0, 0, 0, 1)`` -The basis that will flip something along the Y axis when used in a transformation. +When any basis is multiplied by :ref:`FLIP_Y`, it negates all components of the :ref:`y` axis (the Y column). + +When :ref:`FLIP_Y` is multiplied by any basis, it negates the :ref:`Vector3.y` component of all axes (the Y row). .. _class_Basis_constant_FLIP_Z: @@ -197,7 +224,9 @@ The basis that will flip something along the Y axis when used in a transformatio **FLIP_Z** = ``Basis(1, 0, 0, 0, 1, 0, 0, 0, -1)`` -The basis that will flip something along the Z axis when used in a transformation. +When any basis is multiplied by :ref:`FLIP_Z`, it negates all components of the :ref:`z` axis (the Z column). + +When :ref:`FLIP_Z` is multiplied by any basis, it negates the :ref:`Vector3.z` component of all axes (the Z row). .. rst-class:: classref-section-separator @@ -214,7 +243,9 @@ Property Descriptions :ref:`Vector3` **x** = ``Vector3(1, 0, 0)`` -The basis matrix's X vector (column 0). Equivalent to array index ``0``. +The basis's X axis, and the column ``0`` of the matrix. + +On the identity basis, this vector points right (:ref:`Vector3.RIGHT`). .. rst-class:: classref-item-separator @@ -226,7 +257,9 @@ The basis matrix's X vector (column 0). Equivalent to array index ``0``. :ref:`Vector3` **y** = ``Vector3(0, 1, 0)`` -The basis matrix's Y vector (column 1). Equivalent to array index ``1``. +The basis's Y axis, and the column ``1`` of the matrix. + +On the identity basis, this vector points up (:ref:`Vector3.UP`). .. rst-class:: classref-item-separator @@ -238,7 +271,9 @@ The basis matrix's Y vector (column 1). Equivalent to array index ``1``. :ref:`Vector3` **z** = ``Vector3(0, 0, 1)`` -The basis matrix's Z vector (column 2). Equivalent to array index ``2``. +The basis's Z axis, and the column ``2`` of the matrix. + +On the identity basis, this vector points back (:ref:`Vector3.BACK`). .. rst-class:: classref-section-separator @@ -255,7 +290,7 @@ Constructor Descriptions :ref:`Basis` **Basis** **(** **)** -Constructs a default-initialized **Basis** set to :ref:`IDENTITY`. +Constructs a **Basis** identical to the :ref:`IDENTITY`. .. rst-class:: classref-item-separator @@ -275,7 +310,9 @@ Constructs a **Basis** as a copy of the given **Basis**. :ref:`Basis` **Basis** **(** :ref:`Vector3` axis, :ref:`float` angle **)** -Constructs a pure rotation basis matrix, rotated around the given ``axis`` by ``angle`` (in radians). The axis must be a normalized vector. +Constructs a **Basis** that only represents rotation, rotated around the ``axis`` by the given ``angle``, in radians. The axis must be a normalized vector. + +\ **Note:** This is the same as using :ref:`rotated` on the :ref:`IDENTITY` basis. With more than one angle consider using :ref:`from_euler`, instead. .. rst-class:: classref-item-separator @@ -285,7 +322,9 @@ Constructs a pure rotation basis matrix, rotated around the given ``axis`` by `` :ref:`Basis` **Basis** **(** :ref:`Quaternion` from **)** -Constructs a pure rotation basis matrix from the given quaternion. +Constructs a **Basis** that only represents rotation from the given :ref:`Quaternion`. + +\ **Note:** Quaternions *only* store rotation, not scale. Because of this, conversions from **Basis** to :ref:`Quaternion` cannot always be reversed. .. rst-class:: classref-item-separator @@ -295,7 +334,7 @@ Constructs a pure rotation basis matrix from the given quaternion. :ref:`Basis` **Basis** **(** :ref:`Vector3` x_axis, :ref:`Vector3` y_axis, :ref:`Vector3` z_axis **)** -Constructs a basis matrix from 3 axis vectors (matrix columns). +Constructs a **Basis** from 3 axis vectors. These are the columns of the basis matrix. .. rst-class:: classref-section-separator @@ -312,9 +351,13 @@ Method Descriptions :ref:`float` **determinant** **(** **)** |const| -Returns the determinant of the basis matrix. If the basis is uniformly scaled, its determinant is the square of the scale. +Returns the `determinant `__ of this basis's matrix. For advanced math, this number can be used to determine a few attributes: -A negative determinant means the basis has a negative scale. A zero determinant means the basis isn't invertible, and is usually considered invalid. +- If the determinant is exactly ``0``, the basis is not invertible (see :ref:`inverse`). + +- If the determinant is a negative number, the basis represents a negative scale. + +\ **Note:** If the basis's scale is the same for every axis, its determinant is always that scale by the power of 2. .. rst-class:: classref-item-separator @@ -326,7 +369,34 @@ A negative determinant means the basis has a negative scale. A zero determinant :ref:`Basis` **from_euler** **(** :ref:`Vector3` euler, :ref:`int` order=2 **)** |static| -Constructs a pure rotation Basis matrix from Euler angles in the specified Euler rotation order. By default, use YXZ order (most common). See the :ref:`EulerOrder` enum for possible values. +Constructs a new **Basis** that only represents rotation from the given :ref:`Vector3` of `Euler angles `__, in radians. + +- The :ref:`Vector3.x` should contain the angle around the :ref:`x` axis (pitch). + +- The :ref:`Vector3.y` should contain the angle around the :ref:`y` axis (yaw). + +- The :ref:`Vector3.z` should contain the angle around the :ref:`z` axis (roll). + + +.. tabs:: + + .. code-tab:: gdscript + + # Creates a Basis whose z axis points down. + var my_basis = Basis.from_euler(Vector3(TAU / 4, 0, 0)) + + print(my_basis.z) # Prints (0, -1, 0). + + .. code-tab:: csharp + + // Creates a Basis whose z axis points down. + var myBasis = Basis.FromEuler(new Vector3(Mathf.Tau / 4.0f, 0.0f, 0.0f)); + + GD.Print(myBasis.Z); // Prints (0, -1, 0). + + + +The order of each consecutive rotation can be changed with ``order`` (see :ref:`EulerOrder` constants). By default, the YXZ convention is used (:ref:`@GlobalScope.EULER_ORDER_YXZ`): the basis rotates first around the Y axis (yaw), then X (pitch), and lastly Z (roll). When using the opposite method :ref:`get_euler`, this order is reversed. .. rst-class:: classref-item-separator @@ -338,7 +408,30 @@ Constructs a pure rotation Basis matrix from Euler angles in the specified Euler :ref:`Basis` **from_scale** **(** :ref:`Vector3` scale **)** |static| -Constructs a pure scale basis matrix with no rotation or shearing. The scale values are set as the diagonal of the matrix, and the other parts of the matrix are zero. +Constructs a new **Basis** that only represents scale, with no rotation or shear, from the given ``scale`` vector. + + +.. tabs:: + + .. code-tab:: gdscript + + var my_basis = Basis.from_scale(Vector3(2, 4, 8)) + + print(my_basis.x) # Prints (2, 0, 0). + print(my_basis.y) # Prints (0, 4, 0). + print(my_basis.z) # Prints (0, 0, 8). + + .. code-tab:: csharp + + var myBasis = Basis.FromScale(new Vector3(2.0f, 4.0f, 8.0f)); + + GD.Print(myBasis.X); // Prints (2, 0, 0). + GD.Print(myBasis.Y); // Prints (0, 4, 0). + GD.Print(myBasis.Z); // Prints (0, 0, 8). + + + +\ **Note:** In linear algebra, the matrix of this basis is also known as a `diagonal matrix `__. .. rst-class:: classref-item-separator @@ -350,9 +443,19 @@ Constructs a pure scale basis matrix with no rotation or shearing. The scale val :ref:`Vector3` **get_euler** **(** :ref:`int` order=2 **)** |const| -Returns the basis's rotation in the form of Euler angles. The Euler order depends on the ``order`` parameter, by default it uses the YXZ convention: when decomposing, first Z, then X, and Y last. The returned vector contains the rotation angles in the format (X angle, Y angle, Z angle). +Returns this basis's rotation as a :ref:`Vector3` of `Euler angles `__, in radians. -Consider using the :ref:`get_rotation_quaternion` method instead, which returns a :ref:`Quaternion` quaternion instead of Euler angles. +- The :ref:`Vector3.x` contains the angle around the :ref:`x` axis (pitch); + +- The :ref:`Vector3.y` contains the angle around the :ref:`y` axis (yaw); + +- The :ref:`Vector3.z` contains the angle around the :ref:`z` axis (roll). + +The order of each consecutive rotation can be changed with ``order`` (see :ref:`EulerOrder` constants). By default, the YXZ convention is used (:ref:`@GlobalScope.EULER_ORDER_YXZ`): Z (roll) is calculated first, then X (pitch), and lastly Y (yaw). When using the opposite method :ref:`from_euler`, this order is reversed. + +\ **Note:** Euler angles are much more intuitive but are not suitable for 3D math. Because of this, consider using the :ref:`get_rotation_quaternion` method instead, which returns a :ref:`Quaternion`. + +\ **Note:** In the Inspector dock, a basis's rotation is often displayed in Euler angles (in degrees), as is the case with the :ref:`Node3D.rotation` property. .. rst-class:: classref-item-separator @@ -364,7 +467,9 @@ Consider using the :ref:`get_rotation_quaternion` **get_rotation_quaternion** **(** **)** |const| -Returns the basis's rotation in the form of a quaternion. See :ref:`get_euler` if you need Euler angles, but keep in mind quaternions should generally be preferred to Euler angles. +Returns this basis's rotation as a :ref:`Quaternion`. + +\ **Note:** Quatenions are much more suitable for 3D math but are less intuitive. For user interfaces, consider using the :ref:`get_euler` method, which returns Euler angles. .. rst-class:: classref-item-separator @@ -376,7 +481,40 @@ Returns the basis's rotation in the form of a quaternion. See :ref:`get_euler` **get_scale** **(** **)** |const| -Assuming that the matrix is the combination of a rotation and scaling, return the absolute value of scaling factors along each axis. +Returns the length of each axis of this basis, as a :ref:`Vector3`. If the basis is not sheared, this is the scaling factor. It is not affected by rotation. + + +.. tabs:: + + .. code-tab:: gdscript + + var my_basis = Basis( + Vector3(2, 0, 0), + Vector3(0, 4, 0), + Vector3(0, 0, 8) + ) + # Rotating the Basis in any way preserves its scale. + my_basis = my_basis.rotated(Vector3.UP, TAU / 2) + my_basis = my_basis.rotated(Vector3.RIGHT, TAU / 4) + + print(my_basis.get_scale()) # Prints (2, 4, 8). + + .. code-tab:: csharp + + var myBasis = new Basis( + Vector3(2.0f, 0.0f, 0.0f), + Vector3(0.0f, 4.0f, 0.0f), + Vector3(0.0f, 0.0f, 8.0f) + ); + // Rotating the Basis in any way preserves its scale. + myBasis = myBasis.Rotated(Vector3.Up, Mathf.Tau / 2.0f); + myBasis = myBasis.Rotated(Vector3.Right, Mathf.Tau / 4.0f); + + GD.Print(myBasis.Scale); // Prints (2, 4, 8). + + + +\ **Note:** If the value returned by :ref:`determinant` is negative, the scale is also negative. .. rst-class:: classref-item-separator @@ -388,7 +526,7 @@ Assuming that the matrix is the combination of a rotation and scaling, return th :ref:`Basis` **inverse** **(** **)** |const| -Returns the inverse of the matrix. +Returns the `inverse of this basis's matrix `__. .. rst-class:: classref-item-separator @@ -400,7 +538,7 @@ Returns the inverse of the matrix. :ref:`bool` **is_conformal** **(** **)** |const| -Returns ``true`` if the basis is conformal, meaning it preserves angles and distance ratios, and may only be composed of rotation and uniform scale. Returns ``false`` if the basis has non-uniform scale or shear/skew. This can be used to validate if the basis is non-distorted, which is important for physics and other use cases. +Returns ``true`` if this basis is conformal. A conformal basis is both *orthogonal* (the axes are perpendicular to each other) and *uniform* (the axes share the same length). This method can be especially useful during physics calculations. .. rst-class:: classref-item-separator @@ -436,11 +574,11 @@ Returns ``true`` if this basis is finite, by calling :ref:`@GlobalScope.is_finit :ref:`Basis` **looking_at** **(** :ref:`Vector3` target, :ref:`Vector3` up=Vector3(0, 1, 0), :ref:`bool` use_model_front=false **)** |static| -Creates a Basis with a rotation such that the forward axis (-Z) points towards the ``target`` position. +Creates a new **Basis** with a rotation such that the forward axis (-Z) points towards the ``target`` position. -The up axis (+Y) points as close to the ``up`` vector as possible while staying perpendicular to the forward axis. The resulting Basis is orthonormalized. The ``target`` and ``up`` vectors cannot be zero, and cannot be parallel to each other. +By default, the -Z axis (camera forward) is treated as forward (implies +X is right). If ``use_model_front`` is ``true``, the +Z axis (asset front) is treated as forward (implies +X is left) and points toward the ``target`` position. -If ``use_model_front`` is ``true``, the +Z axis (asset front) is treated as forward (implies +X is left) and points toward the ``target`` position. By default, the -Z axis (camera forward) is treated as forward (implies +X is right). +The up axis (+Y) points as close to the ``up`` vector as possible while staying perpendicular to the forward axis. The returned basis is orthonormalized (see :ref:`orthonormalized`). The ``target`` and ``up`` vectors cannot be :ref:`Vector3.ZERO`, and cannot be parallel to each other. .. rst-class:: classref-item-separator @@ -452,7 +590,33 @@ If ``use_model_front`` is ``true``, the +Z axis (asset front) is treated as forw :ref:`Basis` **orthonormalized** **(** **)** |const| -Returns the orthonormalized version of the matrix (useful to call from time to time to avoid rounding error for orthogonal matrices). This performs a Gram-Schmidt orthonormalization on the basis of the matrix. +Returns the orthonormalized version of this basis. An orthonormal basis is both *orthogonal* (the axes are perpendicular to each other) and *normalized* (the axes have a length of ``1``), which also means it can only represent rotation. + +It is often useful to call this method to avoid rounding errors on a rotating basis: + + +.. tabs:: + + .. code-tab:: gdscript + + # Rotate this Node3D every frame. + func _process(delta): + basis = basis.rotated(Vector3.UP, TAU * delta) + basis = basis.rotated(Vector3.RIGHT, TAU * delta) + + basis = basis.orthonormalized() + + .. code-tab:: csharp + + // Rotate this Node3D every frame. + public override void _Process(double delta) + { + Basis = Basis.Rotated(Vector3.Up, Mathf.Tau * (float)delta) + .Rotated(Vector3.Right, Mathf.Tau * (float)delta) + .Orthonormalized(); + } + + .. rst-class:: classref-item-separator @@ -464,7 +628,32 @@ Returns the orthonormalized version of the matrix (useful to call from time to t :ref:`Basis` **rotated** **(** :ref:`Vector3` axis, :ref:`float` angle **)** |const| -Introduce an additional rotation around the given axis by ``angle`` (in radians). The axis must be a normalized vector. +Returns this basis rotated around the given ``axis`` by ``angle`` (in radians). The ``axis`` must be a normalized vector (see :ref:`Vector3.normalized`). + +Positive values rotate this basis clockwise around the axis, while negative values rotate it counterclockwise. + + +.. tabs:: + + .. code-tab:: gdscript + + var my_basis = Basis.IDENTITY + var angle = TAU / 2 + + my_basis = my_basis.rotated(Vector3.UP, angle) # Rotate around the up axis (yaw). + my_basis = my_basis.rotated(Vector3.RIGHT, angle) # Rotate around the right axis (pitch). + my_basis = my_basis.rotated(Vector3.BACK, angle) # Rotate around the back axis (roll). + + .. code-tab:: csharp + + var myBasis = Basis.Identity; + var angle = Mathf.Tau / 2.0f; + + myBasis = myBasis.Rotated(Vector3.Up, angle); // Rotate around the up axis (yaw). + myBasis = myBasis.Rotated(Vector3.Right, angle); // Rotate around the right axis (pitch). + myBasis = myBasis.Rotated(Vector3.Back, angle); // Rotate around the back axis (roll). + + .. rst-class:: classref-item-separator @@ -476,7 +665,40 @@ Introduce an additional rotation around the given axis by ``angle`` (in radians) :ref:`Basis` **scaled** **(** :ref:`Vector3` scale **)** |const| -Introduce an additional scaling specified by the given 3D scaling factor. +Returns this basis with each axis's components scaled by the given ``scale``'s components. + +The basis matrix's rows are multiplied by ``scale``'s components. This operation is a global scale (relative to the parent). + + +.. tabs:: + + .. code-tab:: gdscript + + var my_basis = Basis( + Vector3(1, 1, 1), + Vector3(2, 2, 2), + Vector3(3, 3, 3) + ) + my_basis = my_basis.scaled(Vector3(0, 2, -2)) + + print(my_basis.x) # Prints (0, 2, -2). + print(my_basis.y) # Prints (0, 4, -4). + print(my_basis.z) # Prints (0, 6, -6). + + .. code-tab:: csharp + + var myBasis = new Basis( + new Vector3(1.0f, 1.0f, 1.0f), + new Vector3(2.0f, 2.0f, 2.0f), + new Vector3(3.0f, 3.0f, 3.0f) + ); + myBasis = myBasis.Scaled(new Vector3(0.0f, 2.0f, -2.0f)); + + GD.Print(myBasis.X); // Prints (0, 2, -2). + GD.Print(myBasis.Y); // Prints (0, 4, -4). + GD.Print(myBasis.Z); // Prints (0, 6, -6). + + .. rst-class:: classref-item-separator @@ -488,7 +710,20 @@ Introduce an additional scaling specified by the given 3D scaling factor. :ref:`Basis` **slerp** **(** :ref:`Basis` to, :ref:`float` weight **)** |const| -Assuming that the matrix is a proper rotation matrix, slerp performs a spherical-linear interpolation with another rotation matrix. +Performs a spherical-linear interpolation with the ``to`` basis, given a ``weight``. Both this basis and ``to`` should represent a rotation. + +\ **Example:** Smoothly rotate a :ref:`Node3D` to the target basis over time, with a :ref:`Tween`. + +:: + + var start_basis = Basis.IDENTITY + var target_basis = Basis.IDENTITY.rotated(Vector3.UP, TAU / 2) + + func _ready(): + create_tween().tween_method(interpolate, 0.0, 1.0, 5.0).set_trans(Tween.TRANS_EXPO) + + func interpolate(weight): + basis = start_basis.slerp(target_basis, weight) .. rst-class:: classref-item-separator @@ -500,7 +735,9 @@ Assuming that the matrix is a proper rotation matrix, slerp performs a spherical :ref:`float` **tdotx** **(** :ref:`Vector3` with **)** |const| -Transposed dot product with the X axis of the matrix. +Returns the transposed dot product between ``with`` and the :ref:`x` axis (see :ref:`transposed`). + +This is equivalent to ``basis.x.dot(vector)``. .. rst-class:: classref-item-separator @@ -512,7 +749,9 @@ Transposed dot product with the X axis of the matrix. :ref:`float` **tdoty** **(** :ref:`Vector3` with **)** |const| -Transposed dot product with the Y axis of the matrix. +Returns the transposed dot product between ``with`` and the :ref:`y` axis (see :ref:`transposed`). + +This is equivalent to ``basis.y.dot(vector)``. .. rst-class:: classref-item-separator @@ -524,7 +763,9 @@ Transposed dot product with the Y axis of the matrix. :ref:`float` **tdotz** **(** :ref:`Vector3` with **)** |const| -Transposed dot product with the Z axis of the matrix. +Returns the transposed dot product between ``with`` and the :ref:`z` axis (see :ref:`transposed`). + +This is equivalent to ``basis.z.dot(vector)``. .. rst-class:: classref-item-separator @@ -536,7 +777,38 @@ Transposed dot product with the Z axis of the matrix. :ref:`Basis` **transposed** **(** **)** |const| -Returns the transposed version of the matrix. +Returns the transposed version of this basis. This turns the basis matrix's columns into rows, and its rows into columns. + + +.. tabs:: + + .. code-tab:: gdscript + + var my_basis = Basis( + Vector3(1, 2, 3), + Vector3(4, 5, 6), + Vector3(7, 8, 9) + ) + my_basis = my_basis.transposed() + + print(my_basis.x) # Prints (1, 4, 7). + print(my_basis.y) # Prints (2, 5, 8). + print(my_basis.z) # Prints (3, 6, 9). + + .. code-tab:: csharp + + var myBasis = new Basis( + new Vector3(1.0f, 2.0f, 3.0f), + new Vector3(4.0f, 5.0f, 6.0f), + new Vector3(7.0f, 8.0f, 9.0f) + ); + myBasis = myBasis.Transposed(); + + GD.Print(myBasis.X); // Prints (1, 4, 7). + GD.Print(myBasis.Y); // Prints (2, 5, 8). + GD.Print(myBasis.Z); // Prints (3, 6, 9). + + .. rst-class:: classref-section-separator @@ -553,7 +825,7 @@ Operator Descriptions :ref:`bool` **operator !=** **(** :ref:`Basis` right **)** -Returns ``true`` if the **Basis** matrices are not equal. +Returns ``true`` if the components of both **Basis** matrices are not equal. \ **Note:** Due to floating-point precision errors, consider using :ref:`is_equal_approx` instead, which is more reliable. @@ -567,7 +839,9 @@ Returns ``true`` if the **Basis** matrices are not equal. :ref:`Basis` **operator *** **(** :ref:`Basis` right **)** -Composes these two basis matrices by multiplying them together. This has the effect of transforming the second basis (the child) by the first basis (the parent). +Transforms (multiplies) the ``right`` basis by this basis. + +This is the operation performed between parent and child :ref:`Node3D`\ s. .. rst-class:: classref-item-separator @@ -579,7 +853,22 @@ Composes these two basis matrices by multiplying them together. This has the eff :ref:`Vector3` **operator *** **(** :ref:`Vector3` right **)** -Transforms (multiplies) the :ref:`Vector3` by the given **Basis** matrix. +Transforms (multiplies) the ``right`` vector by this basis, returning a :ref:`Vector3`. + + +.. tabs:: + + .. code-tab:: gdscript + + var my_basis = Basis(Vector3(1, 1, 1), Vector3(1, 1, 1), Vector3(0, 2, 5)) + print(my_basis * Vector3(1, 2, 3)) # Prints (7, 3, 16) + + .. code-tab:: csharp + + var myBasis = new Basis(new Vector3(1, 1, 1), new Vector3(1, 1, 1), new Vector3(0, 2, 5)); + GD.Print(my_basis * new Vector3(1, 2, 3)); // Prints (7, 3, 16) + + .. rst-class:: classref-item-separator @@ -591,7 +880,7 @@ Transforms (multiplies) the :ref:`Vector3` by the given **Basis** :ref:`Basis` **operator *** **(** :ref:`float` right **)** -This operator multiplies all components of the **Basis**, which scales it uniformly. +Multiplies all components of the **Basis** by the given :ref:`float`. This affects the basis's scale uniformly, resizing all 3 axes by the ``right`` value. .. rst-class:: classref-item-separator @@ -603,7 +892,7 @@ This operator multiplies all components of the **Basis**, which scales it unifor :ref:`Basis` **operator *** **(** :ref:`int` right **)** -This operator multiplies all components of the **Basis**, which scales it uniformly. +Multiplies all components of the **Basis** by the given :ref:`int`. This affects the basis's scale uniformly, resizing all 3 axes by the ``right`` value. .. rst-class:: classref-item-separator @@ -615,7 +904,7 @@ This operator multiplies all components of the **Basis**, which scales it unifor :ref:`bool` **operator ==** **(** :ref:`Basis` right **)** -Returns ``true`` if the **Basis** matrices are exactly equal. +Returns ``true`` if the components of both **Basis** matrices are exactly equal. \ **Note:** Due to floating-point precision errors, consider using :ref:`is_equal_approx` instead, which is more reliable. @@ -629,7 +918,9 @@ Returns ``true`` if the **Basis** matrices are exactly equal. :ref:`Vector3` **operator []** **(** :ref:`int` index **)** -Access basis components using their index. ``b[0]`` is equivalent to ``b.x``, ``b[1]`` is equivalent to ``b.y``, and ``b[2]`` is equivalent to ``b.z``. +Accesses each axis (column) of this basis by their index. Index ``0`` is the same as :ref:`x`, index ``1`` is the same as :ref:`y`, and index ``2`` is the same as :ref:`z`. + +\ **Note:** In C++, this operator accesses the rows of the basis matrix, *not* the columns. For the same behavior as scripting languages, use the ``set_column`` and ``get_column`` methods. .. |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_bitmap.rst b/classes/class_bitmap.rst index 6ad3f5e32..eaa03e5ac 100644 --- a/classes/class_bitmap.rst +++ b/classes/class_bitmap.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/BitMap.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/BitMap.xml. .. _class_BitMap: diff --git a/classes/class_bone2d.rst b/classes/class_bone2d.rst index d4a59a3d7..71cc9be62 100644 --- a/classes/class_bone2d.rst +++ b/classes/class_bone2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Bone2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Bone2D.xml. .. _class_Bone2D: @@ -104,7 +104,7 @@ Method Descriptions void **apply_rest** **(** **)** -Stores the node's current transforms in :ref:`rest`. +Resets the bone to the rest pose. This is equivalent to setting :ref:`Node2D.transform` to :ref:`rest`. .. rst-class:: classref-item-separator diff --git a/classes/class_boneattachment3d.rst b/classes/class_boneattachment3d.rst index 5e1b43e35..15f88b611 100644 --- a/classes/class_boneattachment3d.rst +++ b/classes/class_boneattachment3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/BoneAttachment3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/BoneAttachment3D.xml. .. _class_BoneAttachment3D: diff --git a/classes/class_bonemap.rst b/classes/class_bonemap.rst index 580a2307e..16604f4e0 100644 --- a/classes/class_bonemap.rst +++ b/classes/class_bonemap.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/BoneMap.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/BoneMap.xml. .. _class_BoneMap: diff --git a/classes/class_bool.rst b/classes/class_bool.rst index 8ae33e6c0..bdd77dd73 100644 --- a/classes/class_bool.rst +++ b/classes/class_bool.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/bool.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/bool.xml. .. _class_bool: diff --git a/classes/class_boxcontainer.rst b/classes/class_boxcontainer.rst index acd05fb78..e1f28f098 100644 --- a/classes/class_boxcontainer.rst +++ b/classes/class_boxcontainer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/BoxContainer.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/BoxContainer.xml. .. _class_BoxContainer: diff --git a/classes/class_boxmesh.rst b/classes/class_boxmesh.rst index a4d69b3f0..2690ffa2d 100644 --- a/classes/class_boxmesh.rst +++ b/classes/class_boxmesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/BoxMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/BoxMesh.xml. .. _class_BoxMesh: diff --git a/classes/class_boxoccluder3d.rst b/classes/class_boxoccluder3d.rst index 9b250759d..f8ac2f828 100644 --- a/classes/class_boxoccluder3d.rst +++ b/classes/class_boxoccluder3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/BoxOccluder3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/BoxOccluder3D.xml. .. _class_BoxOccluder3D: diff --git a/classes/class_boxshape3d.rst b/classes/class_boxshape3d.rst index 65d0aa5ae..be017af05 100644 --- a/classes/class_boxshape3d.rst +++ b/classes/class_boxshape3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/BoxShape3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/BoxShape3D.xml. .. _class_BoxShape3D: diff --git a/classes/class_button.rst b/classes/class_button.rst index 5fed12417..1dfeab0c2 100644 --- a/classes/class_button.rst +++ b/classes/class_button.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Button.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Button.xml. .. _class_Button: diff --git a/classes/class_buttongroup.rst b/classes/class_buttongroup.rst index 2905b6bdf..b6c610f84 100644 --- a/classes/class_buttongroup.rst +++ b/classes/class_buttongroup.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ButtonGroup.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ButtonGroup.xml. .. _class_ButtonGroup: diff --git a/classes/class_callable.rst b/classes/class_callable.rst index 2014cbe6e..d803e3dfa 100644 --- a/classes/class_callable.rst +++ b/classes/class_callable.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Callable.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Callable.xml. .. _class_Callable: @@ -260,6 +260,8 @@ Calls the method represented by this **Callable** in deferred mode, i.e. at the func _ready(): grab_focus.call_deferred() +\ **Note:** Deferred calls are processed at idle time. Idle time happens mainly at the end of process and physics frames. In it, deferred calls will be run until there are none left, which means you can defer calls from other deferred calls and they'll still be run in the current idle time cycle. This means you should not call a method deferred from itself (or from a method called by it), as this causes infinite recursion the same way as if you had called the method directly. + See also :ref:`Object.call_deferred`. .. rst-class:: classref-item-separator diff --git a/classes/class_callbacktweener.rst b/classes/class_callbacktweener.rst index 8031aa724..0c5fab0c4 100644 --- a/classes/class_callbacktweener.rst +++ b/classes/class_callbacktweener.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CallbackTweener.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/CallbackTweener.xml. .. _class_CallbackTweener: diff --git a/classes/class_camera2d.rst b/classes/class_camera2d.rst index 440fc6a0e..27c9d631d 100644 --- a/classes/class_camera2d.rst +++ b/classes/class_camera2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Camera2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Camera2D.xml. .. _class_Camera2D: diff --git a/classes/class_camera3d.rst b/classes/class_camera3d.rst index 4d2d6ccce..e90fe7045 100644 --- a/classes/class_camera3d.rst +++ b/classes/class_camera3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Camera3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Camera3D.xml. .. _class_Camera3D: diff --git a/classes/class_cameraattributes.rst b/classes/class_cameraattributes.rst index 169b42d36..f028027e7 100644 --- a/classes/class_cameraattributes.rst +++ b/classes/class_cameraattributes.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CameraAttributes.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/CameraAttributes.xml. .. _class_CameraAttributes: diff --git a/classes/class_cameraattributesphysical.rst b/classes/class_cameraattributesphysical.rst index 899ed72d1..ccdc54285 100644 --- a/classes/class_cameraattributesphysical.rst +++ b/classes/class_cameraattributesphysical.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CameraAttributesPhysical.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/CameraAttributesPhysical.xml. .. _class_CameraAttributesPhysical: @@ -145,7 +145,7 @@ Only available when :ref:`ProjectSettings.rendering/lights_and_shadows/use_physi - void **set_shutter_speed** **(** :ref:`float` value **)** - :ref:`float` **get_shutter_speed** **(** **)** -Time for shutter to open and close, measured in seconds. A higher value will let in more light leading to a brighter image, while a lower amount will let in less light leading to a darker image. +Time for shutter to open and close, evaluated as ``1 / shutter_speed`` seconds. A higher value will allow less light (leading to a darker image), while a lower value will allow more light (leading to a brighter image). Only available when :ref:`ProjectSettings.rendering/lights_and_shadows/use_physical_light_units` is enabled. diff --git a/classes/class_cameraattributespractical.rst b/classes/class_cameraattributespractical.rst index 64eeae4e7..539c60d96 100644 --- a/classes/class_cameraattributespractical.rst +++ b/classes/class_cameraattributespractical.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CameraAttributesPractical.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/CameraAttributesPractical.xml. .. _class_CameraAttributesPractical: @@ -105,7 +105,7 @@ The minimum sensitivity (in ISO) used when calculating auto exposure. When calcu - void **set_dof_blur_amount** **(** :ref:`float` value **)** - :ref:`float` **get_dof_blur_amount** **(** **)** -Sets the maximum amount of blur. When using physically-based blur amounts, will instead act as a multiplier. High values lead to an increased amount of bluriness, but can be much more expensive to calculate. It is best to keep this as low as possible for a given art style. +Sets the maximum amount of blur. When using physically-based blur amounts, will instead act as a multiplier. High values lead to an increased amount of blurriness, but can be much more expensive to calculate. It is best to keep this as low as possible for a given art style. .. rst-class:: classref-item-separator diff --git a/classes/class_camerafeed.rst b/classes/class_camerafeed.rst index c4959eb44..5f857431d 100644 --- a/classes/class_camerafeed.rst +++ b/classes/class_camerafeed.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CameraFeed.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/CameraFeed.xml. .. _class_CameraFeed: diff --git a/classes/class_cameraserver.rst b/classes/class_cameraserver.rst index eecbd3e08..bbf6f6202 100644 --- a/classes/class_cameraserver.rst +++ b/classes/class_cameraserver.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CameraServer.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/CameraServer.xml. .. _class_CameraServer: diff --git a/classes/class_cameratexture.rst b/classes/class_cameratexture.rst index 49ec8a2c3..4ee0a6e00 100644 --- a/classes/class_cameratexture.rst +++ b/classes/class_cameratexture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CameraTexture.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/CameraTexture.xml. .. _class_CameraTexture: diff --git a/classes/class_canvasgroup.rst b/classes/class_canvasgroup.rst index 0a8e5bf56..688e1d363 100644 --- a/classes/class_canvasgroup.rst +++ b/classes/class_canvasgroup.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CanvasGroup.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/CanvasGroup.xml. .. _class_CanvasGroup: diff --git a/classes/class_canvasitem.rst b/classes/class_canvasitem.rst index 4fdd54522..68f64582a 100644 --- a/classes/class_canvasitem.rst +++ b/classes/class_canvasitem.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CanvasItem.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/CanvasItem.xml. .. _class_CanvasItem: @@ -288,7 +288,7 @@ The **CanvasItem** will inherit the filter from its parent. :ref:`TextureFilter` **TEXTURE_FILTER_NEAREST** = ``1`` -The texture filter reads from the nearest pixel only. The simplest and fastest method of filtering. Useful for pixel art. +The texture filter reads from the nearest pixel only. This makes the texture look pixelated from up close, and grainy from a distance (due to mipmaps not being sampled). .. _class_CanvasItem_constant_TEXTURE_FILTER_LINEAR: @@ -296,7 +296,7 @@ The texture filter reads from the nearest pixel only. The simplest and fastest m :ref:`TextureFilter` **TEXTURE_FILTER_LINEAR** = ``2`` -The texture filter blends between the nearest four pixels. Use this for most cases where you want to avoid a pixelated style. +The texture filter blends between the nearest 4 pixels. This makes the texture look smooth from up close, and grainy from a distance (due to mipmaps not being sampled). .. _class_CanvasItem_constant_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS: @@ -304,7 +304,9 @@ The texture filter blends between the nearest four pixels. Use this for most cas :ref:`TextureFilter` **TEXTURE_FILTER_NEAREST_WITH_MIPMAPS** = ``3`` -The texture filter reads from the nearest pixel in the nearest mipmap. This is the fastest way to read from textures with mipmaps. +The texture filter reads from the nearest pixel and blends between the nearest 2 mipmaps (or uses the nearest mipmap if :ref:`ProjectSettings.rendering/textures/default_filters/use_nearest_mipmap_filter` is ``true``). This makes the texture look pixelated from up close, and smooth from a distance. + +Use this for non-pixel art textures that may be viewed at a low scale (e.g. due to :ref:`Camera2D` zoom or sprite scaling), as mipmaps are important to smooth out pixels that are smaller than on-screen pixels. .. _class_CanvasItem_constant_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS: @@ -312,7 +314,9 @@ The texture filter reads from the nearest pixel in the nearest mipmap. This is t :ref:`TextureFilter` **TEXTURE_FILTER_LINEAR_WITH_MIPMAPS** = ``4`` -The texture filter blends between the nearest 4 pixels and between the nearest 2 mipmaps. Use this for non-pixel art textures that may be viewed at a low scale (e.g. due to :ref:`Camera2D` zoom), as mipmaps are important to smooth out pixels that are smaller than on-screen pixels. +The texture filter blends between the nearest 4 pixels and between the nearest 2 mipmaps (or uses the nearest mipmap if :ref:`ProjectSettings.rendering/textures/default_filters/use_nearest_mipmap_filter` is ``true``). This makes the texture look smooth from up close, and smooth from a distance. + +Use this for non-pixel art textures that may be viewed at a low scale (e.g. due to :ref:`Camera2D` zoom or sprite scaling), as mipmaps are important to smooth out pixels that are smaller than on-screen pixels. .. _class_CanvasItem_constant_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC: @@ -320,9 +324,9 @@ The texture filter blends between the nearest 4 pixels and between the nearest 2 :ref:`TextureFilter` **TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC** = ``5`` -The texture filter reads from the nearest pixel, but selects a mipmap based on the angle between the surface and the camera view. This reduces artifacts on surfaces that are almost in line with the camera. The anisotropic filtering level can be changed by adjusting :ref:`ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level`. +The texture filter reads from the nearest pixel and blends between 2 mipmaps (or uses the nearest mipmap if :ref:`ProjectSettings.rendering/textures/default_filters/use_nearest_mipmap_filter` is ``true``) based on the angle between the surface and the camera view. This makes the texture look pixelated from up close, and smooth from a distance. Anisotropic filtering improves texture quality on surfaces that are almost in line with the camera, but is slightly slower. The anisotropic filtering level can be changed by adjusting :ref:`ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level`. -\ **Note:** This texture filter is rarely useful in 2D projects. :ref:`TEXTURE_FILTER_NEAREST_WITH_MIPMAPS` is usually more appropriate. +\ **Note:** This texture filter is rarely useful in 2D projects. :ref:`TEXTURE_FILTER_NEAREST_WITH_MIPMAPS` is usually more appropriate in this case. .. _class_CanvasItem_constant_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC: @@ -330,9 +334,9 @@ The texture filter reads from the nearest pixel, but selects a mipmap based on t :ref:`TextureFilter` **TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC** = ``6`` -The texture filter blends between the nearest 4 pixels and selects a mipmap based on the angle between the surface and the camera view. This reduces artifacts on surfaces that are almost in line with the camera. This is the slowest of the filtering options, but results in the highest quality texturing. The anisotropic filtering level can be changed by adjusting :ref:`ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level`. +The texture filter blends between the nearest 4 pixels and blends between 2 mipmaps (or uses the nearest mipmap if :ref:`ProjectSettings.rendering/textures/default_filters/use_nearest_mipmap_filter` is ``true``) based on the angle between the surface and the camera view. This makes the texture look smooth from up close, and smooth from a distance. Anisotropic filtering improves texture quality on surfaces that are almost in line with the camera, but is slightly slower. The anisotropic filtering level can be changed by adjusting :ref:`ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level`. -\ **Note:** This texture filter is rarely useful in 2D projects. :ref:`TEXTURE_FILTER_LINEAR_WITH_MIPMAPS` is usually more appropriate. +\ **Note:** This texture filter is rarely useful in 2D projects. :ref:`TEXTURE_FILTER_LINEAR_WITH_MIPMAPS` is usually more appropriate in this case. .. _class_CanvasItem_constant_TEXTURE_FILTER_MAX: @@ -519,7 +523,7 @@ Property Descriptions - void **set_clip_children_mode** **(** :ref:`ClipChildrenMode` value **)** - :ref:`ClipChildrenMode` **get_clip_children_mode** **(** **)** -Allows the current node to clip children nodes, essentially acting as a mask. +Allows the current node to clip child nodes, essentially acting as a mask. .. rst-class:: classref-item-separator @@ -1428,7 +1432,7 @@ Returns ``true`` if global transform notifications are communicated to children. :ref:`bool` **is_visible_in_tree** **(** **)** |const| -Returns ``true`` if the node is present in the :ref:`SceneTree`, its :ref:`visible` property is ``true`` and all its ancestors are also visible. If any ancestor is hidden, this node will not be visible in the scene tree, and is consequently not drawn (see :ref:`_draw`). +Returns ``true`` if the node is present in the :ref:`SceneTree`, its :ref:`visible` property is ``true`` and all its ancestors are also visible. If any ancestor is hidden, this node will not be visible in the scene tree, and is therefore not drawn (see :ref:`_draw`). .. rst-class:: classref-item-separator @@ -1466,7 +1470,7 @@ void **move_to_front** **(** **)** Moves this node to display on top of its siblings. -Internally, the node is moved to the bottom of parent's children list. The method has no effect on nodes without a parent. +Internally, the node is moved to the bottom of parent's child list. The method has no effect on nodes without a parent. .. rst-class:: classref-item-separator diff --git a/classes/class_canvasitemmaterial.rst b/classes/class_canvasitemmaterial.rst index 9a244683f..a13e60078 100644 --- a/classes/class_canvasitemmaterial.rst +++ b/classes/class_canvasitemmaterial.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CanvasItemMaterial.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/CanvasItemMaterial.xml. .. _class_CanvasItemMaterial: diff --git a/classes/class_canvaslayer.rst b/classes/class_canvaslayer.rst index 9078e1419..fe550d903 100644 --- a/classes/class_canvaslayer.rst +++ b/classes/class_canvaslayer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CanvasLayer.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/CanvasLayer.xml. .. _class_CanvasLayer: diff --git a/classes/class_canvasmodulate.rst b/classes/class_canvasmodulate.rst index 0c8e1787f..8e1c2bcc9 100644 --- a/classes/class_canvasmodulate.rst +++ b/classes/class_canvasmodulate.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CanvasModulate.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/CanvasModulate.xml. .. _class_CanvasModulate: diff --git a/classes/class_canvastexture.rst b/classes/class_canvastexture.rst index 61e53b651..c75037989 100644 --- a/classes/class_canvastexture.rst +++ b/classes/class_canvastexture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CanvasTexture.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/CanvasTexture.xml. .. _class_CanvasTexture: @@ -21,7 +21,7 @@ Description **CanvasTexture** is an alternative to :ref:`ImageTexture` for 2D rendering. It allows using normal maps and specular maps in any node that inherits from :ref:`CanvasItem`. **CanvasTexture** also allows overriding the texture's filter and repeat mode independently of the node's properties (or the project settings). -\ **Note:** **CanvasTexture** cannot be used in 3D rendering. For physically-based materials in 3D, use :ref:`BaseMaterial3D` instead. +\ **Note:** **CanvasTexture** cannot be used in 3D. It will not display correctly when applied to any :ref:`VisualInstance3D`, such as :ref:`Sprite3D` or :ref:`Decal`. For physically-based materials in 3D, use :ref:`BaseMaterial3D` instead. .. rst-class:: classref-introduction-group diff --git a/classes/class_capsulemesh.rst b/classes/class_capsulemesh.rst index 9a6686e0c..7a1385d06 100644 --- a/classes/class_capsulemesh.rst +++ b/classes/class_capsulemesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CapsuleMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/CapsuleMesh.xml. .. _class_CapsuleMesh: diff --git a/classes/class_capsuleshape2d.rst b/classes/class_capsuleshape2d.rst index f845eb041..bca44e346 100644 --- a/classes/class_capsuleshape2d.rst +++ b/classes/class_capsuleshape2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CapsuleShape2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/CapsuleShape2D.xml. .. _class_CapsuleShape2D: diff --git a/classes/class_capsuleshape3d.rst b/classes/class_capsuleshape3d.rst index 4406449bd..fb9b27277 100644 --- a/classes/class_capsuleshape3d.rst +++ b/classes/class_capsuleshape3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CapsuleShape3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/CapsuleShape3D.xml. .. _class_CapsuleShape3D: diff --git a/classes/class_centercontainer.rst b/classes/class_centercontainer.rst index a5063b808..3c7cabc59 100644 --- a/classes/class_centercontainer.rst +++ b/classes/class_centercontainer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CenterContainer.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/CenterContainer.xml. .. _class_CenterContainer: diff --git a/classes/class_characterbody2d.rst b/classes/class_characterbody2d.rst index 1e9767c8f..de8b93873 100644 --- a/classes/class_characterbody2d.rst +++ b/classes/class_characterbody2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CharacterBody2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/CharacterBody2D.xml. .. _class_CharacterBody2D: diff --git a/classes/class_characterbody3d.rst b/classes/class_characterbody3d.rst index 27f0252ea..89d48ffe8 100644 --- a/classes/class_characterbody3d.rst +++ b/classes/class_characterbody3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CharacterBody3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/CharacterBody3D.xml. .. _class_CharacterBody3D: diff --git a/classes/class_charfxtransform.rst b/classes/class_charfxtransform.rst index 17c130e8f..bdc5685c0 100644 --- a/classes/class_charfxtransform.rst +++ b/classes/class_charfxtransform.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CharFXTransform.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/CharFXTransform.xml. .. _class_CharFXTransform: diff --git a/classes/class_checkbox.rst b/classes/class_checkbox.rst index c5cf9502a..2a0be9474 100644 --- a/classes/class_checkbox.rst +++ b/classes/class_checkbox.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CheckBox.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/CheckBox.xml. .. _class_CheckBox: diff --git a/classes/class_checkbutton.rst b/classes/class_checkbutton.rst index 6eb1ff05d..76e93829a 100644 --- a/classes/class_checkbutton.rst +++ b/classes/class_checkbutton.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CheckButton.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/CheckButton.xml. .. _class_CheckButton: diff --git a/classes/class_circleshape2d.rst b/classes/class_circleshape2d.rst index 7fb99a52b..00e6d737e 100644 --- a/classes/class_circleshape2d.rst +++ b/classes/class_circleshape2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CircleShape2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/CircleShape2D.xml. .. _class_CircleShape2D: diff --git a/classes/class_classdb.rst b/classes/class_classdb.rst index cad693197..81bddcee1 100644 --- a/classes/class_classdb.rst +++ b/classes/class_classdb.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ClassDB.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ClassDB.xml. .. _class_ClassDB: diff --git a/classes/class_codeedit.rst b/classes/class_codeedit.rst index 3d2ca0d1e..0f6ca45eb 100644 --- a/classes/class_codeedit.rst +++ b/classes/class_codeedit.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CodeEdit.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/CodeEdit.xml. .. _class_CodeEdit: diff --git a/classes/class_codehighlighter.rst b/classes/class_codehighlighter.rst index da00c53bd..c77d510f8 100644 --- a/classes/class_codehighlighter.rst +++ b/classes/class_codehighlighter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CodeHighlighter.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/CodeHighlighter.xml. .. _class_CodeHighlighter: diff --git a/classes/class_collisionobject2d.rst b/classes/class_collisionobject2d.rst index 65654ec68..66cf5412a 100644 --- a/classes/class_collisionobject2d.rst +++ b/classes/class_collisionobject2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CollisionObject2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/CollisionObject2D.xml. .. _class_CollisionObject2D: diff --git a/classes/class_collisionobject3d.rst b/classes/class_collisionobject3d.rst index 554625c2d..e422686d3 100644 --- a/classes/class_collisionobject3d.rst +++ b/classes/class_collisionobject3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CollisionObject3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/CollisionObject3D.xml. .. _class_CollisionObject3D: diff --git a/classes/class_collisionpolygon2d.rst b/classes/class_collisionpolygon2d.rst index 9ea51ee33..54db753a8 100644 --- a/classes/class_collisionpolygon2d.rst +++ b/classes/class_collisionpolygon2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CollisionPolygon2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/CollisionPolygon2D.xml. .. _class_CollisionPolygon2D: @@ -166,6 +166,8 @@ The margin used for one-way collision (in pixels). Higher values will make the s The polygon's list of vertices. Each point will be connected to the next, and the final point will be connected to the first. +\ **Note:** The returned vertices are in the local coordinate space of the given **CollisionPolygon2D**. + \ **Warning:** The returned value is a clone of the :ref:`PackedVector2Array`, not a reference. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` diff --git a/classes/class_collisionpolygon3d.rst b/classes/class_collisionpolygon3d.rst index 237788b2e..2458127b9 100644 --- a/classes/class_collisionpolygon3d.rst +++ b/classes/class_collisionpolygon3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CollisionPolygon3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/CollisionPolygon3D.xml. .. _class_CollisionPolygon3D: diff --git a/classes/class_collisionshape2d.rst b/classes/class_collisionshape2d.rst index 8f23ab246..458001547 100644 --- a/classes/class_collisionshape2d.rst +++ b/classes/class_collisionshape2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CollisionShape2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/CollisionShape2D.xml. .. _class_CollisionShape2D: diff --git a/classes/class_collisionshape3d.rst b/classes/class_collisionshape3d.rst index 50a0facfc..9656244a6 100644 --- a/classes/class_collisionshape3d.rst +++ b/classes/class_collisionshape3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CollisionShape3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/CollisionShape3D.xml. .. _class_CollisionShape3D: diff --git a/classes/class_color.rst b/classes/class_color.rst index a64c63d90..48bd25f9f 100644 --- a/classes/class_color.rst +++ b/classes/class_color.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Color.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Color.xml. .. _class_Color: @@ -17,7 +17,7 @@ A color represented in RGBA format. Description ----------- -A color represented in RGBA format by a red (:ref:`r`), green (:ref:`g`), blue (:ref:`b`), and alpha (:ref:`a`) component. Each component is a 16-bit floating-point value, usually ranging from ``0.0`` to ``1.0``. Some properties (such as :ref:`CanvasItem.modulate`) may support values greater than ``1.0``, for overbright or HDR (High Dynamic Range) colors. +A color represented in RGBA format by a red (:ref:`r`), green (:ref:`g`), blue (:ref:`b`), and alpha (:ref:`a`) component. Each component is a 32-bit floating-point value, usually ranging from ``0.0`` to ``1.0``. Some properties (such as :ref:`CanvasItem.modulate`) may support values greater than ``1.0``, for overbright or HDR (High Dynamic Range) colors. Colors can be created in various ways: By the various **Color** constructors, by static methods such as :ref:`from_hsv`, and by using a name from the set of standardized colors based on `X11 color names `__ with the addition of :ref:`TRANSPARENT`. GDScript also provides :ref:`@GDScript.Color8`, which uses integers from ``0`` to ``255`` and doesn't support overbright colors. diff --git a/classes/class_colorpicker.rst b/classes/class_colorpicker.rst index aa5f8e9a8..192ef8111 100644 --- a/classes/class_colorpicker.rst +++ b/classes/class_colorpicker.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ColorPicker.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ColorPicker.xml. .. _class_ColorPicker: diff --git a/classes/class_colorpickerbutton.rst b/classes/class_colorpickerbutton.rst index 08ef47004..1320eaf3c 100644 --- a/classes/class_colorpickerbutton.rst +++ b/classes/class_colorpickerbutton.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ColorPickerButton.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ColorPickerButton.xml. .. _class_ColorPickerButton: diff --git a/classes/class_colorrect.rst b/classes/class_colorrect.rst index 6a29a3214..485d06b5c 100644 --- a/classes/class_colorrect.rst +++ b/classes/class_colorrect.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ColorRect.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ColorRect.xml. .. _class_ColorRect: diff --git a/classes/class_compressedcubemap.rst b/classes/class_compressedcubemap.rst index 4a26c7050..1799a4fe0 100644 --- a/classes/class_compressedcubemap.rst +++ b/classes/class_compressedcubemap.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CompressedCubemap.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/CompressedCubemap.xml. .. _class_CompressedCubemap: @@ -19,7 +19,7 @@ An optionally compressed :ref:`Cubemap`. Description ----------- -A cubemap that is loaded from a ``.ccube`` file. This file format is internal to Godot; it is created by importing other image formats with the import system. **CompressedCubemap** can use one of 4 compresson methods: +A cubemap that is loaded from a ``.ccube`` file. This file format is internal to Godot; it is created by importing other image formats with the import system. **CompressedCubemap** can use one of 4 compression methods: - Lossless (WebP or PNG, uncompressed on the GPU) diff --git a/classes/class_compressedcubemaparray.rst b/classes/class_compressedcubemaparray.rst index 4a286e4ea..7521bee17 100644 --- a/classes/class_compressedcubemaparray.rst +++ b/classes/class_compressedcubemaparray.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CompressedCubemapArray.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/CompressedCubemapArray.xml. .. _class_CompressedCubemapArray: @@ -19,7 +19,7 @@ An optionally compressed :ref:`CubemapArray`. Description ----------- -A cubemap array that is loaded from a ``.ccubearray`` file. This file format is internal to Godot; it is created by importing other image formats with the import system. **CompressedCubemapArray** can use one of 4 compresson methods: +A cubemap array that is loaded from a ``.ccubearray`` file. This file format is internal to Godot; it is created by importing other image formats with the import system. **CompressedCubemapArray** can use one of 4 compression methods: - Lossless (WebP or PNG, uncompressed on the GPU) diff --git a/classes/class_compressedtexture2d.rst b/classes/class_compressedtexture2d.rst index 313b2f53e..74b44c172 100644 --- a/classes/class_compressedtexture2d.rst +++ b/classes/class_compressedtexture2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CompressedTexture2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/CompressedTexture2D.xml. .. _class_CompressedTexture2D: diff --git a/classes/class_compressedtexture2darray.rst b/classes/class_compressedtexture2darray.rst index a2d0381d2..538253072 100644 --- a/classes/class_compressedtexture2darray.rst +++ b/classes/class_compressedtexture2darray.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CompressedTexture2DArray.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/CompressedTexture2DArray.xml. .. _class_CompressedTexture2DArray: @@ -19,7 +19,7 @@ Array of 2-dimensional textures, optionally compressed. Description ----------- -A texture array that is loaded from a ``.ctexarray`` file. This file format is internal to Godot; it is created by importing other image formats with the import system. **CompressedTexture2DArray** can use one of 4 compresson methods: +A texture array that is loaded from a ``.ctexarray`` file. This file format is internal to Godot; it is created by importing other image formats with the import system. **CompressedTexture2DArray** can use one of 4 compression methods: - Lossless (WebP or PNG, uncompressed on the GPU) diff --git a/classes/class_compressedtexture3d.rst b/classes/class_compressedtexture3d.rst index 4a24f97fc..4c52361d3 100644 --- a/classes/class_compressedtexture3d.rst +++ b/classes/class_compressedtexture3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CompressedTexture3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/CompressedTexture3D.xml. .. _class_CompressedTexture3D: diff --git a/classes/class_compressedtexturelayered.rst b/classes/class_compressedtexturelayered.rst index df1355183..4e920efe3 100644 --- a/classes/class_compressedtexturelayered.rst +++ b/classes/class_compressedtexturelayered.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CompressedTextureLayered.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/CompressedTextureLayered.xml. .. _class_CompressedTextureLayered: diff --git a/classes/class_concavepolygonshape2d.rst b/classes/class_concavepolygonshape2d.rst index 83b4a241d..b6f594f9d 100644 --- a/classes/class_concavepolygonshape2d.rst +++ b/classes/class_concavepolygonshape2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ConcavePolygonShape2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ConcavePolygonShape2D.xml. .. _class_ConcavePolygonShape2D: diff --git a/classes/class_concavepolygonshape3d.rst b/classes/class_concavepolygonshape3d.rst index 268074f54..176cfc2e1 100644 --- a/classes/class_concavepolygonshape3d.rst +++ b/classes/class_concavepolygonshape3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ConcavePolygonShape3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ConcavePolygonShape3D.xml. .. _class_ConcavePolygonShape3D: diff --git a/classes/class_conetwistjoint3d.rst b/classes/class_conetwistjoint3d.rst index 11c9de633..70eb3660c 100644 --- a/classes/class_conetwistjoint3d.rst +++ b/classes/class_conetwistjoint3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ConeTwistJoint3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ConeTwistJoint3D.xml. .. _class_ConeTwistJoint3D: diff --git a/classes/class_configfile.rst b/classes/class_configfile.rst index a7c6ac56e..12d8e9119 100644 --- a/classes/class_configfile.rst +++ b/classes/class_configfile.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ConfigFile.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ConfigFile.xml. .. _class_ConfigFile: diff --git a/classes/class_confirmationdialog.rst b/classes/class_confirmationdialog.rst index bf95b4892..ae4102462 100644 --- a/classes/class_confirmationdialog.rst +++ b/classes/class_confirmationdialog.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ConfirmationDialog.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ConfirmationDialog.xml. .. _class_ConfirmationDialog: diff --git a/classes/class_container.rst b/classes/class_container.rst index 6411771ef..fcb028f05 100644 --- a/classes/class_container.rst +++ b/classes/class_container.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Container.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Container.xml. .. _class_Container: diff --git a/classes/class_control.rst b/classes/class_control.rst index dbd43913e..d126ef484 100644 --- a/classes/class_control.rst +++ b/classes/class_control.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Control.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Control.xml. .. _class_Control: diff --git a/classes/class_convexpolygonshape2d.rst b/classes/class_convexpolygonshape2d.rst index 036557c04..96f15785f 100644 --- a/classes/class_convexpolygonshape2d.rst +++ b/classes/class_convexpolygonshape2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ConvexPolygonShape2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ConvexPolygonShape2D.xml. .. _class_ConvexPolygonShape2D: diff --git a/classes/class_convexpolygonshape3d.rst b/classes/class_convexpolygonshape3d.rst index 564eeaf1c..7d7ecbc72 100644 --- a/classes/class_convexpolygonshape3d.rst +++ b/classes/class_convexpolygonshape3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ConvexPolygonShape3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ConvexPolygonShape3D.xml. .. _class_ConvexPolygonShape3D: diff --git a/classes/class_cpuparticles2d.rst b/classes/class_cpuparticles2d.rst index 878575815..5c44d9525 100644 --- a/classes/class_cpuparticles2d.rst +++ b/classes/class_cpuparticles2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CPUParticles2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/CPUParticles2D.xml. .. _class_CPUParticles2D: diff --git a/classes/class_cpuparticles3d.rst b/classes/class_cpuparticles3d.rst index 218c57d0e..64ee4607c 100644 --- a/classes/class_cpuparticles3d.rst +++ b/classes/class_cpuparticles3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CPUParticles3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/CPUParticles3D.xml. .. _class_CPUParticles3D: diff --git a/classes/class_crypto.rst b/classes/class_crypto.rst index e96642572..97c37f787 100644 --- a/classes/class_crypto.rst +++ b/classes/class_crypto.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Crypto.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Crypto.xml. .. _class_Crypto: diff --git a/classes/class_cryptokey.rst b/classes/class_cryptokey.rst index 32bce22d7..d0b226627 100644 --- a/classes/class_cryptokey.rst +++ b/classes/class_cryptokey.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CryptoKey.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/CryptoKey.xml. .. _class_CryptoKey: diff --git a/classes/class_csgbox3d.rst b/classes/class_csgbox3d.rst index ad217382c..a850cc27f 100644 --- a/classes/class_csgbox3d.rst +++ b/classes/class_csgbox3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/csg/doc_classes/CSGBox3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/csg/doc_classes/CSGBox3D.xml. .. _class_CSGBox3D: diff --git a/classes/class_csgcombiner3d.rst b/classes/class_csgcombiner3d.rst index e4a4528c7..e98a80181 100644 --- a/classes/class_csgcombiner3d.rst +++ b/classes/class_csgcombiner3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/csg/doc_classes/CSGCombiner3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/csg/doc_classes/CSGCombiner3D.xml. .. _class_CSGCombiner3D: diff --git a/classes/class_csgcylinder3d.rst b/classes/class_csgcylinder3d.rst index 005321b13..81f54876e 100644 --- a/classes/class_csgcylinder3d.rst +++ b/classes/class_csgcylinder3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/csg/doc_classes/CSGCylinder3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/csg/doc_classes/CSGCylinder3D.xml. .. _class_CSGCylinder3D: diff --git a/classes/class_csgmesh3d.rst b/classes/class_csgmesh3d.rst index b44bf5c4f..076aa0ff5 100644 --- a/classes/class_csgmesh3d.rst +++ b/classes/class_csgmesh3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/csg/doc_classes/CSGMesh3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/csg/doc_classes/CSGMesh3D.xml. .. _class_CSGMesh3D: diff --git a/classes/class_csgpolygon3d.rst b/classes/class_csgpolygon3d.rst index 37a2c9c44..923f4bd02 100644 --- a/classes/class_csgpolygon3d.rst +++ b/classes/class_csgpolygon3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/csg/doc_classes/CSGPolygon3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/csg/doc_classes/CSGPolygon3D.xml. .. _class_CSGPolygon3D: diff --git a/classes/class_csgprimitive3d.rst b/classes/class_csgprimitive3d.rst index a9ae4b316..9ad0c92dd 100644 --- a/classes/class_csgprimitive3d.rst +++ b/classes/class_csgprimitive3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/csg/doc_classes/CSGPrimitive3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/csg/doc_classes/CSGPrimitive3D.xml. .. _class_CSGPrimitive3D: diff --git a/classes/class_csgshape3d.rst b/classes/class_csgshape3d.rst index 9880e42cb..409db021b 100644 --- a/classes/class_csgshape3d.rst +++ b/classes/class_csgshape3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/csg/doc_classes/CSGShape3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/csg/doc_classes/CSGShape3D.xml. .. _class_CSGShape3D: diff --git a/classes/class_csgsphere3d.rst b/classes/class_csgsphere3d.rst index cf43c9e35..8ffc467b3 100644 --- a/classes/class_csgsphere3d.rst +++ b/classes/class_csgsphere3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/csg/doc_classes/CSGSphere3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/csg/doc_classes/CSGSphere3D.xml. .. _class_CSGSphere3D: diff --git a/classes/class_csgtorus3d.rst b/classes/class_csgtorus3d.rst index 24b4e4120..6059318eb 100644 --- a/classes/class_csgtorus3d.rst +++ b/classes/class_csgtorus3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/csg/doc_classes/CSGTorus3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/csg/doc_classes/CSGTorus3D.xml. .. _class_CSGTorus3D: diff --git a/classes/class_csharpscript.rst b/classes/class_csharpscript.rst index 154e7807e..989912d3e 100644 --- a/classes/class_csharpscript.rst +++ b/classes/class_csharpscript.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/mono/doc_classes/CSharpScript.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/mono/doc_classes/CSharpScript.xml. .. _class_CSharpScript: diff --git a/classes/class_cubemap.rst b/classes/class_cubemap.rst index 3aea299aa..e551a10da 100644 --- a/classes/class_cubemap.rst +++ b/classes/class_cubemap.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Cubemap.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Cubemap.xml. .. _class_Cubemap: diff --git a/classes/class_cubemaparray.rst b/classes/class_cubemaparray.rst index e9b4976c9..64e8b2c94 100644 --- a/classes/class_cubemaparray.rst +++ b/classes/class_cubemaparray.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CubemapArray.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/CubemapArray.xml. .. _class_CubemapArray: diff --git a/classes/class_curve.rst b/classes/class_curve.rst index 093e0056c..104e3bdcd 100644 --- a/classes/class_curve.rst +++ b/classes/class_curve.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Curve.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Curve.xml. .. _class_Curve: diff --git a/classes/class_curve2d.rst b/classes/class_curve2d.rst index 881032528..2776758ef 100644 --- a/classes/class_curve2d.rst +++ b/classes/class_curve2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Curve2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Curve2D.xml. .. _class_Curve2D: diff --git a/classes/class_curve3d.rst b/classes/class_curve3d.rst index 7290a30f6..5c2204208 100644 --- a/classes/class_curve3d.rst +++ b/classes/class_curve3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Curve3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Curve3D.xml. .. _class_Curve3D: diff --git a/classes/class_curvetexture.rst b/classes/class_curvetexture.rst index 26c7b1611..4d998afdf 100644 --- a/classes/class_curvetexture.rst +++ b/classes/class_curvetexture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CurveTexture.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/CurveTexture.xml. .. _class_CurveTexture: diff --git a/classes/class_curvexyztexture.rst b/classes/class_curvexyztexture.rst index 7f10d55d6..efe96f720 100644 --- a/classes/class_curvexyztexture.rst +++ b/classes/class_curvexyztexture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CurveXYZTexture.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/CurveXYZTexture.xml. .. _class_CurveXYZTexture: diff --git a/classes/class_cylindermesh.rst b/classes/class_cylindermesh.rst index 3ee943ee8..92deb5cf3 100644 --- a/classes/class_cylindermesh.rst +++ b/classes/class_cylindermesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CylinderMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/CylinderMesh.xml. .. _class_CylinderMesh: diff --git a/classes/class_cylindershape3d.rst b/classes/class_cylindershape3d.rst index f06d6d1cc..32cf7dee2 100644 --- a/classes/class_cylindershape3d.rst +++ b/classes/class_cylindershape3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CylinderShape3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/CylinderShape3D.xml. .. _class_CylinderShape3D: diff --git a/classes/class_dampedspringjoint2d.rst b/classes/class_dampedspringjoint2d.rst index 5681fd978..4fe7a9fad 100644 --- a/classes/class_dampedspringjoint2d.rst +++ b/classes/class_dampedspringjoint2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/DampedSpringJoint2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/DampedSpringJoint2D.xml. .. _class_DampedSpringJoint2D: diff --git a/classes/class_decal.rst b/classes/class_decal.rst index 7076acf53..5e57338ba 100644 --- a/classes/class_decal.rst +++ b/classes/class_decal.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Decal.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Decal.xml. .. _class_Decal: diff --git a/classes/class_dictionary.rst b/classes/class_dictionary.rst index 0664ca471..8d1c0d428 100644 --- a/classes/class_dictionary.rst +++ b/classes/class_dictionary.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Dictionary.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Dictionary.xml. .. _class_Dictionary: diff --git a/classes/class_diraccess.rst b/classes/class_diraccess.rst index 830a982bd..4975642ab 100644 --- a/classes/class_diraccess.rst +++ b/classes/class_diraccess.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/DirAccess.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/DirAccess.xml. .. _class_DirAccess: diff --git a/classes/class_directionallight2d.rst b/classes/class_directionallight2d.rst index 5d99424c3..dc7fcb3c1 100644 --- a/classes/class_directionallight2d.rst +++ b/classes/class_directionallight2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/DirectionalLight2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/DirectionalLight2D.xml. .. _class_DirectionalLight2D: diff --git a/classes/class_directionallight3d.rst b/classes/class_directionallight3d.rst index 27df5ffed..c83cc14aa 100644 --- a/classes/class_directionallight3d.rst +++ b/classes/class_directionallight3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/DirectionalLight3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/DirectionalLight3D.xml. .. _class_DirectionalLight3D: diff --git a/classes/class_displayserver.rst b/classes/class_displayserver.rst index 21d52fb25..952291b67 100644 --- a/classes/class_displayserver.rst +++ b/classes/class_displayserver.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/DisplayServer.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/DisplayServer.xml. .. _class_DisplayServer: @@ -462,7 +462,7 @@ Display server supports setting the mouse cursor shape to a custom image. **Wind :ref:`Feature` **FEATURE_NATIVE_DIALOG** = ``9`` -Display server supports spawning dialogs using the operating system's native look-and-feel. **macOS** +Display server supports spawning dialogs using the operating system's native look-and-feel. **Windows, macOS, Linux (X11)** .. _class_DisplayServer_constant_FEATURE_IME: @@ -1206,7 +1206,7 @@ enum **VSyncMode**: :ref:`VSyncMode` **VSYNC_DISABLED** = ``0`` -No vertical synchronization, which means the engine will display frames as fast as possible (tearing may be visible). Framerate is unlimited (notwithstanding :ref:`Engine.max_fps`). +No vertical synchronization, which means the engine will display frames as fast as possible (tearing may be visible). Framerate is unlimited (regardless of :ref:`Engine.max_fps`). .. _class_DisplayServer_constant_VSYNC_ENABLED: @@ -1214,7 +1214,7 @@ No vertical synchronization, which means the engine will display frames as fast :ref:`VSyncMode` **VSYNC_ENABLED** = ``1`` -Default vertical synchronization mode, the image is displayed only on vertical blanking intervals (no tearing is visible). Framerate is limited by the monitor refresh rate (notwithstanding :ref:`Engine.max_fps`). +Default vertical synchronization mode, the image is displayed only on vertical blanking intervals (no tearing is visible). Framerate is limited by the monitor refresh rate (regardless of :ref:`Engine.max_fps`). .. _class_DisplayServer_constant_VSYNC_ADAPTIVE: @@ -1222,7 +1222,7 @@ Default vertical synchronization mode, the image is displayed only on vertical b :ref:`VSyncMode` **VSYNC_ADAPTIVE** = ``2`` -Behaves like :ref:`VSYNC_DISABLED` when the framerate drops below the screen's refresh rate to reduce stuttering (tearing may be visible). Otherwise, vertical synchronization is enabled to avoid tearing. Framerate is limited by the monitor refresh rate (notwithstanding :ref:`Engine.max_fps`). Behaves like :ref:`VSYNC_ENABLED` when using the Compatibility rendering method. +Behaves like :ref:`VSYNC_DISABLED` when the framerate drops below the screen's refresh rate to reduce stuttering (tearing may be visible). Otherwise, vertical synchronization is enabled to avoid tearing. Framerate is limited by the monitor refresh rate (regardless of :ref:`Engine.max_fps`). Behaves like :ref:`VSYNC_ENABLED` when using the Compatibility rendering method. .. _class_DisplayServer_constant_VSYNC_MAILBOX: @@ -1230,7 +1230,7 @@ Behaves like :ref:`VSYNC_DISABLED` :ref:`VSyncMode` **VSYNC_MAILBOX** = ``3`` -Displays the most recent image in the queue on vertical blanking intervals, while rendering to the other images (no tearing is visible). Framerate is unlimited (notwithstanding :ref:`Engine.max_fps`). +Displays the most recent image in the queue on vertical blanking intervals, while rendering to the other images (no tearing is visible). Framerate is unlimited (regardless of :ref:`Engine.max_fps`). Although not guaranteed, the images can be rendered as fast as possible, which may reduce input lag (also called "Fast" V-Sync mode). :ref:`VSYNC_MAILBOX` works best when at least twice as many frames as the display refresh rate are rendered. Behaves like :ref:`VSYNC_ENABLED` when using the Compatibility rendering method. @@ -1401,7 +1401,7 @@ The ID of the main window spawned by the engine, which can be passed to methods **INVALID_WINDOW_ID** = ``-1`` -The ID that refers to a nonexisting window. This is be returned by some **DisplayServer** methods if no window matches the requested result. +The ID that refers to a nonexistent window. This is returned by some **DisplayServer** methods if no window matches the requested result. .. rst-class:: classref-section-separator diff --git a/classes/class_dtlsserver.rst b/classes/class_dtlsserver.rst index 08c1c0ef5..faa0920f5 100644 --- a/classes/class_dtlsserver.rst +++ b/classes/class_dtlsserver.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/DTLSServer.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/DTLSServer.xml. .. _class_DTLSServer: @@ -66,7 +66,7 @@ Below a small example of how to use it: { private DtlsServer _dtls = new DtlsServer(); private UdpServer _server = new UdpServer(); - private Godot.Collections.Array _peers = new Godot.Collections.Array(); + private Godot.Collections.Array _peers = new Godot.Collections.Array(); public override void _Ready() { @@ -80,8 +80,8 @@ Below a small example of how to use it: { while (Server.IsConnectionAvailable()) { - PacketPeerUDP peer = _server.TakeConnection(); - PacketPeerDTLS dtlsPeer = _dtls.TakeConnection(peer); + PacketPeerUdp peer = _server.TakeConnection(); + PacketPeerDtls dtlsPeer = _dtls.TakeConnection(peer); if (dtlsPeer.GetStatus() != PacketPeerDtls.Status.Handshaking) { continue; // It is normal that 50% of the connections fails due to cookie exchange. diff --git a/classes/class_editorcommandpalette.rst b/classes/class_editorcommandpalette.rst index 69ed8171c..88109b0ea 100644 --- a/classes/class_editorcommandpalette.rst +++ b/classes/class_editorcommandpalette.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorCommandPalette.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/EditorCommandPalette.xml. .. _class_EditorCommandPalette: diff --git a/classes/class_editordebuggerplugin.rst b/classes/class_editordebuggerplugin.rst index 54d8df979..e4130e044 100644 --- a/classes/class_editordebuggerplugin.rst +++ b/classes/class_editordebuggerplugin.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorDebuggerPlugin.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/EditorDebuggerPlugin.xml. .. _class_EditorDebuggerPlugin: diff --git a/classes/class_editordebuggersession.rst b/classes/class_editordebuggersession.rst index 8e485aff0..f4b23ae99 100644 --- a/classes/class_editordebuggersession.rst +++ b/classes/class_editordebuggersession.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorDebuggerSession.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/EditorDebuggerSession.xml. .. _class_EditorDebuggerSession: diff --git a/classes/class_editorexportplatform.rst b/classes/class_editorexportplatform.rst index 2d13cbe28..fe8fcf467 100644 --- a/classes/class_editorexportplatform.rst +++ b/classes/class_editorexportplatform.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorExportPlatform.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/EditorExportPlatform.xml. .. _class_EditorExportPlatform: @@ -30,7 +30,7 @@ Used in scripting by :ref:`EditorExportPlugin` to conf Tutorials --------- -- `$DOCS_URL/tutorials/platform/consoles.html `__ +- :doc:`Console support in Godot <../tutorials/platform/consoles>` .. rst-class:: classref-reftable-group diff --git a/classes/class_editorexportplatformandroid.rst b/classes/class_editorexportplatformandroid.rst index 0e7c5ce57..851f11667 100644 --- a/classes/class_editorexportplatformandroid.rst +++ b/classes/class_editorexportplatformandroid.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/platform/android/doc_classes/EditorExportPlatformAndroid.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/platform/android/doc_classes/EditorExportPlatformAndroid.xml. .. _class_EditorExportPlatformAndroid: @@ -264,6 +264,8 @@ Properties +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`permissions/persistent_activity` | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`permissions/post_notifications` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`permissions/process_outgoing_calls` | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`permissions/read_calendar` | @@ -834,7 +836,13 @@ If ``true``, package signing is enabled. :ref:`String` **package/unique_name** -Unique application identifier in a reverse-DNS format, can only contain alphanumeric characters (``A-Z``, ``a-z``, and ``0-9``), hyphens (``-``), and periods (``.``). +Unique application identifier in a reverse-DNS format. The reverse DNS format should preferably match a domain name you control, but this is not strictly required. For instance, if you own ``example.com``, your package unique name should preferably be of the form ``com.example.mygame``. This identifier can only contain lowercase alphanumeric characters (``a-z``, and ``0-9``), underscores (``_``), and periods (``.``). Each component of the reverse DNS format must start with a letter: for instance, ``com.example.8game`` is not valid. + +If ``$genname`` is present in the value, it will be replaced by the project name converted to lowercase. If there are invalid characters in the project name, they will be stripped. If all characters in the project name are stripped, ``$genname`` is replaced by ``noname``. + +\ **Note:** Changing the package name will cause the package to be considered as a new package, with its own installation and data paths. The new package won't be usable to update existing installations. + +\ **Note:** When publishing to Google Play, the package name must be *globally* unique. This means no other apps published on Google Play must be using the same package name as yours. Otherwise, you'll be prevented from publishing your app on Google Play. .. rst-class:: classref-item-separator @@ -1826,6 +1834,18 @@ Deprecated in API level 15. ---- +.. _class_EditorExportPlatformAndroid_property_permissions/post_notifications: + +.. rst-class:: classref-property + +:ref:`bool` **permissions/post_notifications** + +Allow an application to post notifications. Added in API level 33. See `Notification runtime permission `__. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorExportPlatformAndroid_property_permissions/process_outgoing_calls: .. rst-class:: classref-property diff --git a/classes/class_editorexportplatformios.rst b/classes/class_editorexportplatformios.rst index 87d757454..e2d484e73 100644 --- a/classes/class_editorexportplatformios.rst +++ b/classes/class_editorexportplatformios.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/platform/ios/doc_classes/EditorExportPlatformIOS.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/platform/ios/doc_classes/EditorExportPlatformIOS.xml. .. _class_EditorExportPlatformIOS: @@ -31,121 +31,415 @@ Properties .. table:: :widths: auto - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`application/app_store_team_id` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`application/bundle_identifier` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`application/code_sign_identity_debug` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`application/code_sign_identity_release` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`application/export_method_debug` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`application/export_method_release` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`application/export_project_only` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`application/icon_interpolation` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`application/launch_screens_interpolation` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`application/provisioning_profile_uuid_debug` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`application/provisioning_profile_uuid_release` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`application/short_version` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`application/signature` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`application/targeted_device_family` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`application/version` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`architectures/arm64` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`capabilities/access_wifi` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`capabilities/push_notifications` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`custom_template/debug` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`custom_template/release` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`icons/app_store_1024x1024` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`icons/ipad_76x76` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`icons/ipad_152x152` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`icons/ipad_167x167` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`icons/iphone_120x120` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`icons/iphone_180x180` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`icons/notification_40x40` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`icons/notification_60x60` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`icons/settings_58x58` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`icons/settings_87x87` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`icons/spotlight_40x40` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`icons/spotlight_80x80` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`landscape_launch_screens/ipad_1024x768` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`landscape_launch_screens/ipad_2048x1536` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`landscape_launch_screens/iphone_2208x1242` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`landscape_launch_screens/iphone_2436x1125` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`portrait_launch_screens/ipad_768x1024` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`portrait_launch_screens/ipad_1536x2048` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`portrait_launch_screens/iphone_640x960` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`portrait_launch_screens/iphone_640x1136` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`portrait_launch_screens/iphone_750x1334` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`portrait_launch_screens/iphone_1125x2436` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`portrait_launch_screens/iphone_1242x2208` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`privacy/camera_usage_description` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`privacy/camera_usage_description_localized` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`privacy/microphone_usage_description` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`privacy/microphone_usage_description_localized` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`privacy/photolibrary_usage_description` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`privacy/photolibrary_usage_description_localized` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`storyboard/custom_bg_color` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`storyboard/custom_image@2x` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`storyboard/custom_image@3x` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`storyboard/image_scale_mode` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`storyboard/use_custom_bg_color` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`storyboard/use_launch_screen_storyboard` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`user_data/accessible_from_files_app` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`user_data/accessible_from_itunes_sharing` | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/app_store_team_id` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/bundle_identifier` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/code_sign_identity_debug` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/code_sign_identity_release` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`application/export_method_debug` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`application/export_method_release` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`application/export_project_only` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`application/icon_interpolation` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`application/launch_screens_interpolation` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/provisioning_profile_uuid_debug` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/provisioning_profile_uuid_release` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/short_version` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/signature` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`application/targeted_device_family` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/version` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`architectures/arm64` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`capabilities/access_wifi` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`capabilities/push_notifications` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`custom_template/debug` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`custom_template/release` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/app_store_1024x1024` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/ipad_76x76` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/ipad_152x152` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/ipad_167x167` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/iphone_120x120` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/iphone_180x180` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/notification_40x40` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/notification_60x60` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/settings_58x58` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/settings_87x87` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/spotlight_40x40` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`icons/spotlight_80x80` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`landscape_launch_screens/ipad_1024x768` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`landscape_launch_screens/ipad_2048x1536` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`landscape_launch_screens/iphone_2208x1242` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`landscape_launch_screens/iphone_2436x1125` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`portrait_launch_screens/ipad_768x1024` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`portrait_launch_screens/ipad_1536x2048` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`portrait_launch_screens/iphone_640x960` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`portrait_launch_screens/iphone_640x1136` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`portrait_launch_screens/iphone_750x1334` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`portrait_launch_screens/iphone_1125x2436` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`portrait_launch_screens/iphone_1242x2208` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/active_keyboard_access_reasons` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`privacy/camera_usage_description` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`privacy/camera_usage_description_localized` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/advertising_data/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/advertising_data/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/advertising_data/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/advertising_data/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/audio_data/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/audio_data/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/audio_data/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/audio_data/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/browsing_history/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/browsing_history/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/browsing_history/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/browsing_history/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/coarse_location/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/coarse_location/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/coarse_location/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/coarse_location/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/contacts/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/contacts/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/contacts/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/contacts/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/crash_data/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/crash_data/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/crash_data/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/crash_data/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/credit_info/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/credit_info/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/credit_info/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/credit_info/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/customer_support/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/customer_support/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/customer_support/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/customer_support/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/device_id/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/device_id/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/device_id/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/device_id/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/email_address/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/email_address/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/email_address/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/email_address/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/emails_or_text_messages/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/emails_or_text_messages/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/emails_or_text_messages/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/emails_or_text_messages/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/environment_scanning/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/environment_scanning/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/environment_scanning/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/environment_scanning/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/fitness/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/fitness/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/fitness/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/fitness/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/gameplay_content/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/gameplay_content/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/gameplay_content/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/gameplay_content/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/hands/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/hands/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/hands/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/hands/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/head/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/head/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/head/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/head/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/health/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/health/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/health/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/health/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/name/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/name/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/name/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/name/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_contact_info/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/other_contact_info/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_contact_info/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_contact_info/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_data_types/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/other_data_types/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_data_types/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_data_types/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_diagnostic_data/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/other_diagnostic_data/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_diagnostic_data/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_diagnostic_data/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_financial_info/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/other_financial_info/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_financial_info/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_financial_info/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_usage_data/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/other_usage_data/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_usage_data/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_usage_data/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_user_content/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/other_user_content/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_user_content/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/other_user_content/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/payment_info/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/payment_info/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/payment_info/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/payment_info/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/performance_data/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/performance_data/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/performance_data/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/performance_data/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/phone_number/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/phone_number/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/phone_number/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/phone_number/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/photos_or_videos/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/photos_or_videos/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/photos_or_videos/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/photos_or_videos/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/physical_address/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/physical_address/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/physical_address/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/physical_address/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/precise_location/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/precise_location/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/precise_location/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/precise_location/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/product_interaction/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/product_interaction/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/product_interaction/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/product_interaction/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/purchase_history/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/purchase_history/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/purchase_history/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/purchase_history/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/search_hhistory/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/search_hhistory/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/search_hhistory/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/search_hhistory/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/sensitive_info/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/sensitive_info/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/sensitive_info/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/sensitive_info/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/user_id/collected` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/collected_data/user_id/collection_purposes` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/user_id/linked_to_user` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/collected_data/user_id/used_for_tracking` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/disk_space_access_reasons` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/file_timestamp_access_reasons` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`privacy/microphone_usage_description` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`privacy/microphone_usage_description_localized` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`privacy/photolibrary_usage_description` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`privacy/photolibrary_usage_description_localized` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/system_boot_time_access_reasons` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`privacy/tracking_domains` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`privacy/tracking_enabled` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`privacy/user_defaults_access_reasons` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`storyboard/custom_bg_color` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`storyboard/custom_image@2x` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`storyboard/custom_image@3x` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`storyboard/image_scale_mode` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`storyboard/use_custom_bg_color` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`storyboard/use_launch_screen_storyboard` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`user_data/accessible_from_files_app` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`user_data/accessible_from_itunes_sharing` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -676,6 +970,18 @@ Application launch screen image file. If left empty, it will fallback to :ref:`P ---- +.. _class_EditorExportPlatformIOS_property_privacy/active_keyboard_access_reasons: + +.. rst-class:: classref-property + +:ref:`int` **privacy/active_keyboard_access_reasons** + +The reasons your app use active keyboard API. See `Describing use of required reason API `__. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorExportPlatformIOS_property_privacy/camera_usage_description: .. rst-class:: classref-property @@ -700,6 +1006,1710 @@ A message displayed when requesting access to the device's camera (localized). ---- +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/advertising_data/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/advertising_data/collected** + +Indicates whether your app collects advertising data. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/advertising_data/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/advertising_data/collection_purposes** + +The reasons your app collects advertising data. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/advertising_data/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/advertising_data/linked_to_user** + +Indicates whether your app links advertising data to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/advertising_data/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/advertising_data/used_for_tracking** + +Indicates whether your app uses advertising data for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/audio_data/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/audio_data/collected** + +Indicates whether your app collects audio data data. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/audio_data/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/audio_data/collection_purposes** + +The reasons your app collects audio data. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/audio_data/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/audio_data/linked_to_user** + +Indicates whether your app links audio data data to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/audio_data/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/audio_data/used_for_tracking** + +Indicates whether your app uses audio data data for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/browsing_history/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/browsing_history/collected** + +Indicates whether your app collects browsing history. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/browsing_history/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/browsing_history/collection_purposes** + +The reasons your app collects browsing history. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/browsing_history/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/browsing_history/linked_to_user** + +Indicates whether your app links browsing history to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/browsing_history/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/browsing_history/used_for_tracking** + +Indicates whether your app uses browsing history for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/coarse_location/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/coarse_location/collected** + +Indicates whether your app collects coarse location data. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/coarse_location/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/coarse_location/collection_purposes** + +The reasons your app collects coarse location data. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/coarse_location/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/coarse_location/linked_to_user** + +Indicates whether your app links coarse location data to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/coarse_location/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/coarse_location/used_for_tracking** + +Indicates whether your app uses coarse location data for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/contacts/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/contacts/collected** + +Indicates whether your app collects contacts. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/contacts/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/contacts/collection_purposes** + +The reasons your app collects contacts. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/contacts/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/contacts/linked_to_user** + +Indicates whether your app links contacts to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/contacts/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/contacts/used_for_tracking** + +Indicates whether your app uses contacts for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/crash_data/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/crash_data/collected** + +Indicates whether your app collects crash data. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/crash_data/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/crash_data/collection_purposes** + +The reasons your app collects crash data. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/crash_data/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/crash_data/linked_to_user** + +Indicates whether your app links crash data to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/crash_data/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/crash_data/used_for_tracking** + +Indicates whether your app uses crash data for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/credit_info/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/credit_info/collected** + +Indicates whether your app collects credit information. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/credit_info/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/credit_info/collection_purposes** + +The reasons your app collects credit information. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/credit_info/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/credit_info/linked_to_user** + +Indicates whether your app links credit information to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/credit_info/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/credit_info/used_for_tracking** + +Indicates whether your app uses credit information for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/customer_support/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/customer_support/collected** + +Indicates whether your app collects customer support data. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/customer_support/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/customer_support/collection_purposes** + +The reasons your app collects customer support data. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/customer_support/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/customer_support/linked_to_user** + +Indicates whether your app links customer support data to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/customer_support/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/customer_support/used_for_tracking** + +Indicates whether your app uses customer support data for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/device_id/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/device_id/collected** + +Indicates whether your app collects device IDs. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/device_id/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/device_id/collection_purposes** + +The reasons your app collects device IDs. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/device_id/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/device_id/linked_to_user** + +Indicates whether your app links device IDs to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/device_id/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/device_id/used_for_tracking** + +Indicates whether your app uses device IDs for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/email_address/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/email_address/collected** + +Indicates whether your app collects email address. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/email_address/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/email_address/collection_purposes** + +The reasons your app collects email address. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/email_address/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/email_address/linked_to_user** + +Indicates whether your app links email address to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/email_address/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/email_address/used_for_tracking** + +Indicates whether your app uses email address for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/emails_or_text_messages/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/emails_or_text_messages/collected** + +Indicates whether your app collects emails or text messages. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/emails_or_text_messages/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/emails_or_text_messages/collection_purposes** + +The reasons your app collects emails or text messages. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/emails_or_text_messages/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/emails_or_text_messages/linked_to_user** + +Indicates whether your app links emails or text messages to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/emails_or_text_messages/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/emails_or_text_messages/used_for_tracking** + +Indicates whether your app uses emails or text messages for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/environment_scanning/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/environment_scanning/collected** + +Indicates whether your app collects environment scanning data. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/environment_scanning/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/environment_scanning/collection_purposes** + +The reasons your app collects environment scanning data. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/environment_scanning/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/environment_scanning/linked_to_user** + +Indicates whether your app links environment scanning data to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/environment_scanning/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/environment_scanning/used_for_tracking** + +Indicates whether your app uses environment scanning data for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/fitness/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/fitness/collected** + +Indicates whether your app collects fitness and exercise data. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/fitness/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/fitness/collection_purposes** + +The reasons your app collects fitness and exercise data. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/fitness/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/fitness/linked_to_user** + +Indicates whether your app links fitness and exercise data to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/fitness/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/fitness/used_for_tracking** + +Indicates whether your app uses fitness and exercise data for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/gameplay_content/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/gameplay_content/collected** + +Indicates whether your app collects gameplay content. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/gameplay_content/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/gameplay_content/collection_purposes** + +The reasons your app collects gameplay content. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/gameplay_content/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/gameplay_content/linked_to_user** + +Indicates whether your app links gameplay content to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/gameplay_content/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/gameplay_content/used_for_tracking** + +Indicates whether your app uses gameplay content for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/hands/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/hands/collected** + +Indicates whether your app collects user's hand structure and hand movements. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/hands/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/hands/collection_purposes** + +The reasons your app collects user's hand structure and hand movements. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/hands/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/hands/linked_to_user** + +Indicates whether your app links user's hand structure and hand movements to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/hands/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/hands/used_for_tracking** + +Indicates whether your app uses user's hand structure and hand movements for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/head/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/head/collected** + +Indicates whether your app collects user's head movement. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/head/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/head/collection_purposes** + +The reasons your app collects user's head movement. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/head/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/head/linked_to_user** + +Indicates whether your app links user's head movement to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/head/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/head/used_for_tracking** + +Indicates whether your app uses user's head movement for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/health/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/health/collected** + +Indicates whether your app collects health and medical data. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/health/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/health/collection_purposes** + +The reasons your app collects health and medical data. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/health/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/health/linked_to_user** + +Indicates whether your app links health and medical data to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/health/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/health/used_for_tracking** + +Indicates whether your app uses health and medical data for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/name/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/name/collected** + +Indicates whether your app collects user's name. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/name/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/name/collection_purposes** + +The reasons your app collects user's name. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/name/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/name/linked_to_user** + +Indicates whether your app links user's name to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/name/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/name/used_for_tracking** + +Indicates whether your app uses user's name for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/other_contact_info/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_contact_info/collected** + +Indicates whether your app collects any other contact information. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/other_contact_info/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/other_contact_info/collection_purposes** + +The reasons your app collects any other contact information. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/other_contact_info/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_contact_info/linked_to_user** + +Indicates whether your app links any other contact information to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/other_contact_info/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_contact_info/used_for_tracking** + +Indicates whether your app uses any other contact information for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/other_data_types/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_data_types/collected** + +Indicates whether your app collects any other data. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/other_data_types/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/other_data_types/collection_purposes** + +The reasons your app collects any other data. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/other_data_types/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_data_types/linked_to_user** + +Indicates whether your app links any other data to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/other_data_types/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_data_types/used_for_tracking** + +Indicates whether your app uses any other data for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/other_diagnostic_data/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_diagnostic_data/collected** + +Indicates whether your app collects any other diagnostic data. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/other_diagnostic_data/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/other_diagnostic_data/collection_purposes** + +The reasons your app collects any other diagnostic data. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/other_diagnostic_data/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_diagnostic_data/linked_to_user** + +Indicates whether your app links any other diagnostic data to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/other_diagnostic_data/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_diagnostic_data/used_for_tracking** + +Indicates whether your app uses any other diagnostic data for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/other_financial_info/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_financial_info/collected** + +Indicates whether your app collects any other financial information. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/other_financial_info/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/other_financial_info/collection_purposes** + +The reasons your app collects any other financial information. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/other_financial_info/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_financial_info/linked_to_user** + +Indicates whether your app links any other financial information to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/other_financial_info/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_financial_info/used_for_tracking** + +Indicates whether your app uses any other financial information for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/other_usage_data/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_usage_data/collected** + +Indicates whether your app collects any other usage data. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/other_usage_data/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/other_usage_data/collection_purposes** + +The reasons your app collects any other usage data. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/other_usage_data/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_usage_data/linked_to_user** + +Indicates whether your app links any other usage data to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/other_usage_data/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_usage_data/used_for_tracking** + +Indicates whether your app uses any other usage data for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/other_user_content/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_user_content/collected** + +Indicates whether your app collects any other user generated content. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/other_user_content/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/other_user_content/collection_purposes** + +The reasons your app collects any other user generated content. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/other_user_content/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_user_content/linked_to_user** + +Indicates whether your app links any other user generated content to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/other_user_content/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/other_user_content/used_for_tracking** + +Indicates whether your app uses any other user generated content for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/payment_info/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/payment_info/collected** + +Indicates whether your app collects payment information. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/payment_info/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/payment_info/collection_purposes** + +The reasons your app collects payment information. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/payment_info/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/payment_info/linked_to_user** + +Indicates whether your app links payment information to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/payment_info/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/payment_info/used_for_tracking** + +Indicates whether your app uses payment information for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/performance_data/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/performance_data/collected** + +Indicates whether your app collects performance data. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/performance_data/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/performance_data/collection_purposes** + +The reasons your app collects performance data. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/performance_data/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/performance_data/linked_to_user** + +Indicates whether your app links performance data to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/performance_data/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/performance_data/used_for_tracking** + +Indicates whether your app uses performance data for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/phone_number/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/phone_number/collected** + +Indicates whether your app collects phone number. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/phone_number/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/phone_number/collection_purposes** + +The reasons your app collects phone number. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/phone_number/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/phone_number/linked_to_user** + +Indicates whether your app links phone number to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/phone_number/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/phone_number/used_for_tracking** + +Indicates whether your app uses phone number for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/photos_or_videos/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/photos_or_videos/collected** + +Indicates whether your app collects photos or videos. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/photos_or_videos/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/photos_or_videos/collection_purposes** + +The reasons your app collects photos or videos. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/photos_or_videos/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/photos_or_videos/linked_to_user** + +Indicates whether your app links photos or videos to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/photos_or_videos/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/photos_or_videos/used_for_tracking** + +Indicates whether your app uses photos or videos for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/physical_address/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/physical_address/collected** + +Indicates whether your app collects physical address. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/physical_address/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/physical_address/collection_purposes** + +The reasons your app collects physical address. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/physical_address/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/physical_address/linked_to_user** + +Indicates whether your app links physical address to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/physical_address/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/physical_address/used_for_tracking** + +Indicates whether your app uses physical address for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/precise_location/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/precise_location/collected** + +Indicates whether your app collects precise location data. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/precise_location/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/precise_location/collection_purposes** + +The reasons your app collects precise location data. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/precise_location/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/precise_location/linked_to_user** + +Indicates whether your app links precise location data to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/precise_location/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/precise_location/used_for_tracking** + +Indicates whether your app uses precise location data for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/product_interaction/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/product_interaction/collected** + +Indicates whether your app collects product interaction data. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/product_interaction/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/product_interaction/collection_purposes** + +The reasons your app collects product interaction data. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/product_interaction/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/product_interaction/linked_to_user** + +Indicates whether your app links product interaction data to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/product_interaction/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/product_interaction/used_for_tracking** + +Indicates whether your app uses product interaction data for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/purchase_history/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/purchase_history/collected** + +Indicates whether your app collects purchase history. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/purchase_history/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/purchase_history/collection_purposes** + +The reasons your app collects purchase history. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/purchase_history/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/purchase_history/linked_to_user** + +Indicates whether your app links purchase history to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/purchase_history/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/purchase_history/used_for_tracking** + +Indicates whether your app uses purchase history for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/search_hhistory/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/search_hhistory/collected** + +Indicates whether your app collects search history. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/search_hhistory/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/search_hhistory/collection_purposes** + +The reasons your app collects search history. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/search_hhistory/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/search_hhistory/linked_to_user** + +Indicates whether your app links search history to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/search_hhistory/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/search_hhistory/used_for_tracking** + +Indicates whether your app uses search history for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/sensitive_info/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/sensitive_info/collected** + +Indicates whether your app collects sensitive user information. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/sensitive_info/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/sensitive_info/collection_purposes** + +The reasons your app collects sensitive user information. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/sensitive_info/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/sensitive_info/linked_to_user** + +Indicates whether your app links sensitive user information to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/sensitive_info/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/sensitive_info/used_for_tracking** + +Indicates whether your app uses sensitive user information for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/user_id/collected: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/user_id/collected** + +Indicates whether your app collects user IDs. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/user_id/collection_purposes: + +.. rst-class:: classref-property + +:ref:`int` **privacy/collected_data/user_id/collection_purposes** + +The reasons your app collects user IDs. See `Describing data use in privacy manifests `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/user_id/linked_to_user: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/user_id/linked_to_user** + +Indicates whether your app links user IDs to the user's identity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/collected_data/user_id/used_for_tracking: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/collected_data/user_id/used_for_tracking** + +Indicates whether your app uses user IDs for tracking. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/disk_space_access_reasons: + +.. rst-class:: classref-property + +:ref:`int` **privacy/disk_space_access_reasons** + +The reasons your app use free disk space API. See `Describing use of required reason API `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/file_timestamp_access_reasons: + +.. rst-class:: classref-property + +:ref:`int` **privacy/file_timestamp_access_reasons** + +The reasons your app use file timestamp/metadata API. See `Describing use of required reason API `__. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorExportPlatformIOS_property_privacy/microphone_usage_description: .. rst-class:: classref-property @@ -748,6 +2758,54 @@ A message displayed when requesting access to the user's photo library (localize ---- +.. _class_EditorExportPlatformIOS_property_privacy/system_boot_time_access_reasons: + +.. rst-class:: classref-property + +:ref:`int` **privacy/system_boot_time_access_reasons** + +The reasons your app use system boot time / absolute time API. See `Describing use of required reason API `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/tracking_domains: + +.. rst-class:: classref-property + +:ref:`PackedStringArray` **privacy/tracking_domains** + +The list of internet domains your app connects to that engage in tracking. See `Privacy manifest files `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/tracking_enabled: + +.. rst-class:: classref-property + +:ref:`bool` **privacy/tracking_enabled** + +Indicates whether your app uses data for tracking. See `Privacy manifest files `__. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformIOS_property_privacy/user_defaults_access_reasons: + +.. rst-class:: classref-property + +:ref:`int` **privacy/user_defaults_access_reasons** + +The reasons your app use user defaults API. See `Describing use of required reason API `__. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorExportPlatformIOS_property_storyboard/custom_bg_color: .. rst-class:: classref-property diff --git a/classes/class_editorexportplatformlinuxbsd.rst b/classes/class_editorexportplatformlinuxbsd.rst index 7d1d33de8..bdd15a50a 100644 --- a/classes/class_editorexportplatformlinuxbsd.rst +++ b/classes/class_editorexportplatformlinuxbsd.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/platform/linuxbsd/doc_classes/EditorExportPlatformLinuxBSD.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/platform/linuxbsd/doc_classes/EditorExportPlatformLinuxBSD.xml. .. _class_EditorExportPlatformLinuxBSD: diff --git a/classes/class_editorexportplatformmacos.rst b/classes/class_editorexportplatformmacos.rst index f0dd193e2..7487d43c9 100644 --- a/classes/class_editorexportplatformmacos.rst +++ b/classes/class_editorexportplatformmacos.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/platform/macos/doc_classes/EditorExportPlatformMacOS.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/platform/macos/doc_classes/EditorExportPlatformMacOS.xml. .. _class_EditorExportPlatformMacOS: diff --git a/classes/class_editorexportplatformpc.rst b/classes/class_editorexportplatformpc.rst index e30e1e4d5..6e5d6c6d3 100644 --- a/classes/class_editorexportplatformpc.rst +++ b/classes/class_editorexportplatformpc.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorExportPlatformPC.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/EditorExportPlatformPC.xml. .. _class_EditorExportPlatformPC: diff --git a/classes/class_editorexportplatformweb.rst b/classes/class_editorexportplatformweb.rst index 3d661d432..019652dfc 100644 --- a/classes/class_editorexportplatformweb.rst +++ b/classes/class_editorexportplatformweb.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/platform/web/doc_classes/EditorExportPlatformWeb.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/platform/web/doc_classes/EditorExportPlatformWeb.xml. .. _class_EditorExportPlatformWeb: @@ -16,6 +16,15 @@ Exporter for the Web. .. rst-class:: classref-introduction-group +Description +----------- + +The Web exporter customizes how a web build is handled. In the editor's "Export" window, it is created when adding a new "Web" preset. + +\ **Note:** Godot on Web is rendered inside a ```` tag. Normally, the canvas cannot be positioned or resized manually, but otherwise acts as the main :ref:`Window` of the application. + +.. rst-class:: classref-introduction-group + Tutorials --------- @@ -86,7 +95,7 @@ Property Descriptions :ref:`String` **custom_template/debug** -Path to the custom export template. If left empty, default template is used. +File path to the custom export template used for debug builds. If left empty, the default template is used. .. rst-class:: classref-item-separator @@ -98,7 +107,7 @@ Path to the custom export template. If left empty, default template is used. :ref:`String` **custom_template/release** -Path to the custom export template. If left empty, default template is used. +File path to the custom export template used for release builds. If left empty, the default template is used. .. rst-class:: classref-item-separator @@ -110,7 +119,13 @@ Path to the custom export template. If left empty, default template is used. :ref:`int` **html/canvas_resize_policy** -The canvas resize policy determines how the canvas should be resized by Godot. +Determines how the canvas should be resized by Godot. + +- **None:** The canvas is not automatically resized. + +- **Project:** The size of the canvas is dependent on the :ref:`ProjectSettings`. + +- **Adaptive:** The canvas is automatically resized to fit as much of the web page as possible. .. rst-class:: classref-item-separator @@ -122,9 +137,9 @@ The canvas resize policy determines how the canvas should be resized by Godot. :ref:`String` **html/custom_html_shell** -.. container:: contribute +The custom HTML page that wraps the exported web build. If left empty, the default HTML shell is used. - There is currently no description for this property. Please help us by :ref:`contributing one `! +For more information, see the :doc:`Customizing HTML5 Shell <../tutorials/platform/web/customizing_html5_shell>` tutorial. .. rst-class:: classref-item-separator @@ -136,9 +151,9 @@ The canvas resize policy determines how the canvas should be resized by Godot. :ref:`bool` **html/experimental_virtual_keyboard** -.. container:: contribute +If ``true``, embeds support for a virtual keyboard into the web page, which is shown when necessary on touchscreen devices. - There is currently no description for this property. Please help us by :ref:`contributing one `! +\ **Warning:** This feature is experimental and may be changed in a future release. .. rst-class:: classref-item-separator @@ -150,9 +165,7 @@ The canvas resize policy determines how the canvas should be resized by Godot. :ref:`bool` **html/export_icon** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +If ``true``, the project icon will be used as the favicon for this application's web page. .. rst-class:: classref-item-separator @@ -164,9 +177,7 @@ The canvas resize policy determines how the canvas should be resized by Godot. :ref:`bool` **html/focus_canvas_on_start** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +If ``true``, the canvas will be focused as soon as the application is loaded, if the browser window is already in focus. .. rst-class:: classref-item-separator @@ -178,9 +189,9 @@ The canvas resize policy determines how the canvas should be resized by Godot. :ref:`String` **html/head_include** -.. container:: contribute +Additional HTML tags to include inside the ````, such as ```` tags. - There is currently no description for this property. Please help us by :ref:`contributing one `! +\ **Note:** You do not need to add a ```` tag, as it is automatically included based on the project's name. .. rst-class:: classref-item-separator @@ -192,9 +203,7 @@ The canvas resize policy determines how the canvas should be resized by Godot. :ref:`Color<class_Color>` **progressive_web_app/background_color** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +The background color used behind the web application. .. rst-class:: classref-item-separator @@ -206,9 +215,15 @@ The canvas resize policy determines how the canvas should be resized by Godot. :ref:`int<class_int>` **progressive_web_app/display** -.. container:: contribute +The `display mode <https://developer.mozilla.org/en-US/docs/Web/Manifest/display/>`__ to use for this progressive web application. Different browsers and platforms may not behave the same. - There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +- **Fullscreen:** Displays the app in fullscreen and hides all of the browser's UI elements. + +- **Standalone:** Displays the app in a separate window and hides all of the browser's UI elements. + +- **Minimal UI:** Displays the app in a separate window and only shows the browser's UI elements for navigation. + +- **Browser:** Displays the app as a normal web page. .. rst-class:: classref-item-separator @@ -220,9 +235,7 @@ The canvas resize policy determines how the canvas should be resized by Godot. :ref:`bool<class_bool>` **progressive_web_app/enabled** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +If ``true``, turns this web build into a `progressive web application <https://en.wikipedia.org/wiki/Progressive_web_app>`__ (PWA). .. rst-class:: classref-item-separator @@ -234,9 +247,9 @@ The canvas resize policy determines how the canvas should be resized by Godot. :ref:`String<class_String>` **progressive_web_app/icon_144x144** -.. container:: contribute +File path to the smallest icon for this web application. If not defined, defaults to the project icon. - There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +\ **Note:** If the icon is not 144x144, it will be automatically resized for the final build. .. rst-class:: classref-item-separator @@ -248,9 +261,9 @@ The canvas resize policy determines how the canvas should be resized by Godot. :ref:`String<class_String>` **progressive_web_app/icon_180x180** -.. container:: contribute +File path to the small icon for this web application. If not defined, defaults to the project icon. - There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +\ **Note:** If the icon is not 180x180, it will be automatically resized for the final build. .. rst-class:: classref-item-separator @@ -262,9 +275,9 @@ The canvas resize policy determines how the canvas should be resized by Godot. :ref:`String<class_String>` **progressive_web_app/icon_512x512** -.. container:: contribute +File path to the smallest icon for this web application. If not defined, defaults to the project icon. - There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +\ **Note:** If the icon is not 512x512, it will be automatically resized for the final build. .. rst-class:: classref-item-separator @@ -276,9 +289,7 @@ The canvas resize policy determines how the canvas should be resized by Godot. :ref:`String<class_String>` **progressive_web_app/offline_page** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +The page to display, should the server hosting the page not be available. This page is saved in the client's machine. .. rst-class:: classref-item-separator @@ -290,9 +301,13 @@ The canvas resize policy determines how the canvas should be resized by Godot. :ref:`int<class_int>` **progressive_web_app/orientation** -.. container:: contribute +The orientation to use when the web application is run through a mobile device. - There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +- **Any:** No orientation is forced. + +- **Landscape:** Forces a horizontal layout (wider than it is taller). + +- **Portrait:** Forces a vertical layout (taller than it is wider). .. rst-class:: classref-item-separator @@ -304,9 +319,7 @@ The canvas resize policy determines how the canvas should be resized by Godot. :ref:`bool<class_bool>` **variant/extensions_support** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +If ``true`` enables :ref:`GDExtension<class_GDExtension>` support for this web build. .. rst-class:: classref-item-separator @@ -318,9 +331,7 @@ The canvas resize policy determines how the canvas should be resized by Godot. :ref:`bool<class_bool>` **vram_texture_compression/for_desktop** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +If ``true``, allows textures to be optimized for desktop through the S3TC algorithm. .. rst-class:: classref-item-separator @@ -332,9 +343,7 @@ The canvas resize policy determines how the canvas should be resized by Godot. :ref:`bool<class_bool>` **vram_texture_compression/for_mobile** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +If ``true`` allows textures to be optimized for mobile through the ETC2 algorithm. .. |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_editorexportplatformwindows.rst b/classes/class_editorexportplatformwindows.rst index 2199ab1d5..ed0d1b5c8 100644 --- a/classes/class_editorexportplatformwindows.rst +++ b/classes/class_editorexportplatformwindows.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/platform/windows/doc_classes/EditorExportPlatformWindows.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/platform/windows/doc_classes/EditorExportPlatformWindows.xml. .. _class_EditorExportPlatformWindows: diff --git a/classes/class_editorexportplugin.rst b/classes/class_editorexportplugin.rst index 80756ab04..c9e7887b5 100644 --- a/classes/class_editorexportplugin.rst +++ b/classes/class_editorexportplugin.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorExportPlugin.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/EditorExportPlugin.xml. .. _class_EditorExportPlugin: diff --git a/classes/class_editorfeatureprofile.rst b/classes/class_editorfeatureprofile.rst index 2b05b8f9f..fe03af35e 100644 --- a/classes/class_editorfeatureprofile.rst +++ b/classes/class_editorfeatureprofile.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorFeatureProfile.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/EditorFeatureProfile.xml. .. _class_EditorFeatureProfile: diff --git a/classes/class_editorfiledialog.rst b/classes/class_editorfiledialog.rst index 785b372f7..795c356e7 100644 --- a/classes/class_editorfiledialog.rst +++ b/classes/class_editorfiledialog.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorFileDialog.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/EditorFileDialog.xml. .. _class_EditorFileDialog: diff --git a/classes/class_editorfilesystem.rst b/classes/class_editorfilesystem.rst index e18322711..4b4fdf656 100644 --- a/classes/class_editorfilesystem.rst +++ b/classes/class_editorfilesystem.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorFileSystem.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/EditorFileSystem.xml. .. _class_EditorFileSystem: diff --git a/classes/class_editorfilesystemdirectory.rst b/classes/class_editorfilesystemdirectory.rst index 273250b61..4e2392c8a 100644 --- a/classes/class_editorfilesystemdirectory.rst +++ b/classes/class_editorfilesystemdirectory.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorFileSystemDirectory.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/EditorFileSystemDirectory.xml. .. _class_EditorFileSystemDirectory: diff --git a/classes/class_editorfilesystemimportformatsupportquery.rst b/classes/class_editorfilesystemimportformatsupportquery.rst index 66e9a1693..cd1a1f8cf 100644 --- a/classes/class_editorfilesystemimportformatsupportquery.rst +++ b/classes/class_editorfilesystemimportformatsupportquery.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorFileSystemImportFormatSupportQuery.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/EditorFileSystemImportFormatSupportQuery.xml. .. _class_EditorFileSystemImportFormatSupportQuery: diff --git a/classes/class_editorimportplugin.rst b/classes/class_editorimportplugin.rst index 06e16c135..1a7a381d3 100644 --- a/classes/class_editorimportplugin.rst +++ b/classes/class_editorimportplugin.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorImportPlugin.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/EditorImportPlugin.xml. .. _class_EditorImportPlugin: diff --git a/classes/class_editorinspector.rst b/classes/class_editorinspector.rst index 98b057acd..a49f1a289 100644 --- a/classes/class_editorinspector.rst +++ b/classes/class_editorinspector.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorInspector.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/EditorInspector.xml. .. _class_EditorInspector: diff --git a/classes/class_editorinspectorplugin.rst b/classes/class_editorinspectorplugin.rst index 30b1c5852..172a3ea7b 100644 --- a/classes/class_editorinspectorplugin.rst +++ b/classes/class_editorinspectorplugin.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorInspectorPlugin.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/EditorInspectorPlugin.xml. .. _class_EditorInspectorPlugin: diff --git a/classes/class_editorinterface.rst b/classes/class_editorinterface.rst index fc3f8b452..804d5b7b4 100644 --- a/classes/class_editorinterface.rst +++ b/classes/class_editorinterface.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorInterface.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/EditorInterface.xml. .. _class_EditorInterface: diff --git a/classes/class_editornode3dgizmo.rst b/classes/class_editornode3dgizmo.rst index 386ed1a4d..f874aa284 100644 --- a/classes/class_editornode3dgizmo.rst +++ b/classes/class_editornode3dgizmo.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorNode3DGizmo.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/EditorNode3DGizmo.xml. .. _class_EditorNode3DGizmo: @@ -29,6 +29,8 @@ Methods .. table:: :widths: auto + +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_begin_handle_action<class_EditorNode3DGizmo_private_method__begin_handle_action>` **(** :ref:`int<class_int>` id, :ref:`bool<class_bool>` secondary **)** |virtual| | +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_commit_handle<class_EditorNode3DGizmo_private_method__commit_handle>` **(** :ref:`int<class_int>` id, :ref:`bool<class_bool>` secondary, :ref:`Variant<class_Variant>` restore, :ref:`bool<class_bool>` cancel **)** |virtual| | +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -88,6 +90,20 @@ Methods Method Descriptions ------------------- +.. _class_EditorNode3DGizmo_private_method__begin_handle_action: + +.. rst-class:: classref-method + +void **_begin_handle_action** **(** :ref:`int<class_int>` id, :ref:`bool<class_bool>` secondary **)** |virtual| + +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorNode3DGizmo_private_method__commit_handle: .. rst-class:: classref-method diff --git a/classes/class_editornode3dgizmoplugin.rst b/classes/class_editornode3dgizmoplugin.rst index 864e37140..f2b44dc48 100644 --- a/classes/class_editornode3dgizmoplugin.rst +++ b/classes/class_editornode3dgizmoplugin.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorNode3DGizmoPlugin.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/EditorNode3DGizmoPlugin.xml. .. _class_EditorNode3DGizmoPlugin: @@ -38,6 +38,8 @@ Methods .. table:: :widths: auto + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_begin_handle_action<class_EditorNode3DGizmoPlugin_private_method__begin_handle_action>` **(** :ref:`EditorNode3DGizmo<class_EditorNode3DGizmo>` gizmo, :ref:`int<class_int>` handle_id, :ref:`bool<class_bool>` secondary **)** |virtual| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool<class_bool>` | :ref:`_can_be_hidden<class_EditorNode3DGizmoPlugin_private_method__can_be_hidden>` **(** **)** |virtual| |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -93,6 +95,20 @@ Methods Method Descriptions ------------------- +.. _class_EditorNode3DGizmoPlugin_private_method__begin_handle_action: + +.. rst-class:: classref-method + +void **_begin_handle_action** **(** :ref:`EditorNode3DGizmo<class_EditorNode3DGizmo>` gizmo, :ref:`int<class_int>` handle_id, :ref:`bool<class_bool>` secondary **)** |virtual| + +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorNode3DGizmoPlugin_private_method__can_be_hidden: .. rst-class:: classref-method diff --git a/classes/class_editorpaths.rst b/classes/class_editorpaths.rst index a8deebe48..bd5d168e1 100644 --- a/classes/class_editorpaths.rst +++ b/classes/class_editorpaths.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorPaths.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/EditorPaths.xml. .. _class_EditorPaths: diff --git a/classes/class_editorplugin.rst b/classes/class_editorplugin.rst index e07b9af24..c6f2db119 100644 --- a/classes/class_editorplugin.rst +++ b/classes/class_editorplugin.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorPlugin.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/EditorPlugin.xml. .. _class_EditorPlugin: @@ -956,7 +956,7 @@ Use :ref:`_set_window_layout<class_EditorPlugin_private_method__set_window_layou Implement this function if your plugin edits a specific type of object (Resource or Node). If you return ``true``, then you will get the functions :ref:`_edit<class_EditorPlugin_private_method__edit>` and :ref:`_make_visible<class_EditorPlugin_private_method__make_visible>` called when the editor requests them. If you have declared the methods :ref:`_forward_canvas_gui_input<class_EditorPlugin_private_method__forward_canvas_gui_input>` and :ref:`_forward_3d_gui_input<class_EditorPlugin_private_method__forward_3d_gui_input>` these will be called too. -\ **Note:** Each plugin should handle only one type of objects at a time. If a plugin handes more types of objects and they are edited at the same time, it will result in errors. +\ **Note:** Each plugin should handle only one type of objects at a time. If a plugin handles more types of objects and they are edited at the same time, it will result in errors. .. rst-class:: classref-item-separator diff --git a/classes/class_editorproperty.rst b/classes/class_editorproperty.rst index b37f4d123..c9c547f2c 100644 --- a/classes/class_editorproperty.rst +++ b/classes/class_editorproperty.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorProperty.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/EditorProperty.xml. .. _class_EditorProperty: diff --git a/classes/class_editorresourceconversionplugin.rst b/classes/class_editorresourceconversionplugin.rst index 1e92dd2db..47cba2c9e 100644 --- a/classes/class_editorresourceconversionplugin.rst +++ b/classes/class_editorresourceconversionplugin.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorResourceConversionPlugin.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/EditorResourceConversionPlugin.xml. .. _class_EditorResourceConversionPlugin: diff --git a/classes/class_editorresourcepicker.rst b/classes/class_editorresourcepicker.rst index 5dd997b6a..d94e8c1a3 100644 --- a/classes/class_editorresourcepicker.rst +++ b/classes/class_editorresourcepicker.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorResourcePicker.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/EditorResourcePicker.xml. .. _class_EditorResourcePicker: diff --git a/classes/class_editorresourcepreview.rst b/classes/class_editorresourcepreview.rst index 71ca8f376..e9d8d41fc 100644 --- a/classes/class_editorresourcepreview.rst +++ b/classes/class_editorresourcepreview.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorResourcePreview.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/EditorResourcePreview.xml. .. _class_EditorResourcePreview: diff --git a/classes/class_editorresourcepreviewgenerator.rst b/classes/class_editorresourcepreviewgenerator.rst index 88db86c8e..6bb4a97ca 100644 --- a/classes/class_editorresourcepreviewgenerator.rst +++ b/classes/class_editorresourcepreviewgenerator.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorResourcePreviewGenerator.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/EditorResourcePreviewGenerator.xml. .. _class_EditorResourcePreviewGenerator: diff --git a/classes/class_editorresourcetooltipplugin.rst b/classes/class_editorresourcetooltipplugin.rst index 0acf9d46c..3263464ad 100644 --- a/classes/class_editorresourcetooltipplugin.rst +++ b/classes/class_editorresourcetooltipplugin.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorResourceTooltipPlugin.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/EditorResourceTooltipPlugin.xml. .. _class_EditorResourceTooltipPlugin: diff --git a/classes/class_editorsceneformatimporter.rst b/classes/class_editorsceneformatimporter.rst index 2bd45a544..3004a90e5 100644 --- a/classes/class_editorsceneformatimporter.rst +++ b/classes/class_editorsceneformatimporter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorSceneFormatImporter.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/EditorSceneFormatImporter.xml. .. _class_EditorSceneFormatImporter: diff --git a/classes/class_editorsceneformatimporterblend.rst b/classes/class_editorsceneformatimporterblend.rst index cf4875a8a..0e9b3755f 100644 --- a/classes/class_editorsceneformatimporterblend.rst +++ b/classes/class_editorsceneformatimporterblend.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/gltf/doc_classes/EditorSceneFormatImporterBlend.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/gltf/doc_classes/EditorSceneFormatImporterBlend.xml. .. _class_EditorSceneFormatImporterBlend: diff --git a/classes/class_editorsceneformatimporterfbx.rst b/classes/class_editorsceneformatimporterfbx.rst index d1ad78a1d..2ba662041 100644 --- a/classes/class_editorsceneformatimporterfbx.rst +++ b/classes/class_editorsceneformatimporterfbx.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/gltf/doc_classes/EditorSceneFormatImporterFBX.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/gltf/doc_classes/EditorSceneFormatImporterFBX.xml. .. _class_EditorSceneFormatImporterFBX: diff --git a/classes/class_editorsceneformatimportergltf.rst b/classes/class_editorsceneformatimportergltf.rst index ff958808b..29b6ea587 100644 --- a/classes/class_editorsceneformatimportergltf.rst +++ b/classes/class_editorsceneformatimportergltf.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/gltf/doc_classes/EditorSceneFormatImporterGLTF.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/gltf/doc_classes/EditorSceneFormatImporterGLTF.xml. .. _class_EditorSceneFormatImporterGLTF: diff --git a/classes/class_editorscenepostimport.rst b/classes/class_editorscenepostimport.rst index 85ef31deb..a6aa03f25 100644 --- a/classes/class_editorscenepostimport.rst +++ b/classes/class_editorscenepostimport.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorScenePostImport.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/EditorScenePostImport.xml. .. _class_EditorScenePostImport: diff --git a/classes/class_editorscenepostimportplugin.rst b/classes/class_editorscenepostimportplugin.rst index 90c4cfd2c..2cf543239 100644 --- a/classes/class_editorscenepostimportplugin.rst +++ b/classes/class_editorscenepostimportplugin.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorScenePostImportPlugin.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/EditorScenePostImportPlugin.xml. .. _class_EditorScenePostImportPlugin: diff --git a/classes/class_editorscript.rst b/classes/class_editorscript.rst index 1d8aebe34..181bbe075 100644 --- a/classes/class_editorscript.rst +++ b/classes/class_editorscript.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorScript.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/EditorScript.xml. .. _class_EditorScript: diff --git a/classes/class_editorscriptpicker.rst b/classes/class_editorscriptpicker.rst index 860aff9d3..0e0dd519c 100644 --- a/classes/class_editorscriptpicker.rst +++ b/classes/class_editorscriptpicker.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorScriptPicker.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/EditorScriptPicker.xml. .. _class_EditorScriptPicker: diff --git a/classes/class_editorselection.rst b/classes/class_editorselection.rst index 4d3282224..0eaec49b6 100644 --- a/classes/class_editorselection.rst +++ b/classes/class_editorselection.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorSelection.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/EditorSelection.xml. .. _class_EditorSelection: diff --git a/classes/class_editorsettings.rst b/classes/class_editorsettings.rst index 1c51943a5..fa027fa11 100644 --- a/classes/class_editorsettings.rst +++ b/classes/class_editorsettings.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorSettings.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/EditorSettings.xml. .. _class_EditorSettings: @@ -2485,9 +2485,9 @@ The icon and font color scheme to use in the editor. - **Auto** determines the color scheme to use automatically based on :ref:`interface/theme/base_color<class_EditorSettings_property_interface/theme/base_color>`. -- **Dark** makes fonts and icons light (suitable for dark themes). +- **Dark** makes fonts and icons dark (suitable for light themes). Icon colors are automatically converted by the editor following the set of rules defined in `this file <https://github.com/godotengine/godot/blob/master/editor/editor_themes.cpp>`__. -- **Light** makes fonts and icons dark (suitable for light themes). Icon colors are automatically converted by the editor following `this set of rules <https://github.com/godotengine/godot/blob/master/editor/editor_themes.cpp#L135>`__. +- **Light** makes fonts and icons light (suitable for dark themes). .. rst-class:: classref-item-separator diff --git a/classes/class_editorspinslider.rst b/classes/class_editorspinslider.rst index 050cbe67c..a85b633c8 100644 --- a/classes/class_editorspinslider.rst +++ b/classes/class_editorspinslider.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorSpinSlider.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/EditorSpinSlider.xml. .. _class_EditorSpinSlider: diff --git a/classes/class_editorsyntaxhighlighter.rst b/classes/class_editorsyntaxhighlighter.rst index 4ac44786d..b67c492e7 100644 --- a/classes/class_editorsyntaxhighlighter.rst +++ b/classes/class_editorsyntaxhighlighter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorSyntaxHighlighter.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/EditorSyntaxHighlighter.xml. .. _class_EditorSyntaxHighlighter: diff --git a/classes/class_editortranslationparserplugin.rst b/classes/class_editortranslationparserplugin.rst index 0b612e108..7198761e1 100644 --- a/classes/class_editortranslationparserplugin.rst +++ b/classes/class_editortranslationparserplugin.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorTranslationParserPlugin.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/EditorTranslationParserPlugin.xml. .. _class_EditorTranslationParserPlugin: diff --git a/classes/class_editorundoredomanager.rst b/classes/class_editorundoredomanager.rst index 9b57fe36c..379d5b76f 100644 --- a/classes/class_editorundoredomanager.rst +++ b/classes/class_editorundoredomanager.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorUndoRedoManager.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/EditorUndoRedoManager.xml. .. _class_EditorUndoRedoManager: diff --git a/classes/class_editorvcsinterface.rst b/classes/class_editorvcsinterface.rst index ff8c1e467..94d79a5ae 100644 --- a/classes/class_editorvcsinterface.rst +++ b/classes/class_editorvcsinterface.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorVCSInterface.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/EditorVCSInterface.xml. .. _class_EditorVCSInterface: diff --git a/classes/class_encodedobjectasid.rst b/classes/class_encodedobjectasid.rst index 662dd39d5..b236a3536 100644 --- a/classes/class_encodedobjectasid.rst +++ b/classes/class_encodedobjectasid.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EncodedObjectAsID.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/EncodedObjectAsID.xml. .. _class_EncodedObjectAsID: diff --git a/classes/class_enetconnection.rst b/classes/class_enetconnection.rst index aab015037..127507e07 100644 --- a/classes/class_enetconnection.rst +++ b/classes/class_enetconnection.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/enet/doc_classes/ENetConnection.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/enet/doc_classes/ENetConnection.xml. .. _class_ENetConnection: diff --git a/classes/class_enetmultiplayerpeer.rst b/classes/class_enetmultiplayerpeer.rst index 15d016ede..c60c4d717 100644 --- a/classes/class_enetmultiplayerpeer.rst +++ b/classes/class_enetmultiplayerpeer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/enet/doc_classes/ENetMultiplayerPeer.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/enet/doc_classes/ENetMultiplayerPeer.xml. .. _class_ENetMultiplayerPeer: diff --git a/classes/class_enetpacketpeer.rst b/classes/class_enetpacketpeer.rst index 78755e1f9..5291669ae 100644 --- a/classes/class_enetpacketpeer.rst +++ b/classes/class_enetpacketpeer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/enet/doc_classes/ENetPacketPeer.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/enet/doc_classes/ENetPacketPeer.xml. .. _class_ENetPacketPeer: diff --git a/classes/class_engine.rst b/classes/class_engine.rst index 632de147e..34edd97b7 100644 --- a/classes/class_engine.rst +++ b/classes/class_engine.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Engine.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Engine.xml. .. _class_Engine: @@ -167,7 +167,7 @@ Controls the maximum number of physics steps that can be simulated each rendered - void **set_physics_jitter_fix** **(** :ref:`float<class_float>` value **)** - :ref:`float<class_float>` **get_physics_jitter_fix** **(** **)** -Controls how much physics ticks are synchronized with real time. For 0 or less, the ticks are synchronized. Such values are recommended for network games, where clock synchronization matters. Higher values cause higher deviation of the in-game clock and real clock but smooth out framerate jitters. The default value of 0.5 should be fine for most; values above 2 could cause the game to react to dropped frames with a noticeable delay and are not recommended. +Controls how much physics ticks are synchronized with real time. For 0 or less, the ticks are synchronized. Such values are recommended for network games, where clock synchronization matters. Higher values cause higher deviation of the in-game clock and real clock but smooth out framerate jitters. The default value of 0.5 should be good enough for most; values above 2 could cause the game to react to dropped frames with a noticeable delay and are not recommended. \ **Note:** For best results, when using a custom physics interpolation solution, the physics jitter fix should be disabled by setting :ref:`physics_jitter_fix<class_Engine_property_physics_jitter_fix>` to ``0``. diff --git a/classes/class_enginedebugger.rst b/classes/class_enginedebugger.rst index f0c828bbd..5fd449434 100644 --- a/classes/class_enginedebugger.rst +++ b/classes/class_enginedebugger.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EngineDebugger.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/EngineDebugger.xml. .. _class_EngineDebugger: diff --git a/classes/class_engineprofiler.rst b/classes/class_engineprofiler.rst index 1ce9f9d19..fcd58173c 100644 --- a/classes/class_engineprofiler.rst +++ b/classes/class_engineprofiler.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EngineProfiler.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/EngineProfiler.xml. .. _class_EngineProfiler: diff --git a/classes/class_environment.rst b/classes/class_environment.rst index 57d3b4eae..62340dcb1 100644 --- a/classes/class_environment.rst +++ b/classes/class_environment.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Environment.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Environment.xml. .. _class_Environment: diff --git a/classes/class_expression.rst b/classes/class_expression.rst index 1345418df..c4f24b7ce 100644 --- a/classes/class_expression.rst +++ b/classes/class_expression.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Expression.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Expression.xml. .. _class_Expression: diff --git a/classes/class_fastnoiselite.rst b/classes/class_fastnoiselite.rst index 6a85375f3..6b3a7b81f 100644 --- a/classes/class_fastnoiselite.rst +++ b/classes/class_fastnoiselite.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/noise/doc_classes/FastNoiseLite.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/noise/doc_classes/FastNoiseLite.xml. .. _class_FastNoiseLite: diff --git a/classes/class_fileaccess.rst b/classes/class_fileaccess.rst index 2e00a7bc5..64e4e3623 100644 --- a/classes/class_fileaccess.rst +++ b/classes/class_fileaccess.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/FileAccess.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/FileAccess.xml. .. _class_FileAccess: @@ -234,6 +234,8 @@ Opens the file for read operations. The cursor is positioned at the beginning of Opens the file for write operations. The file is created if it does not exist, and truncated if it does. +\ **Note:** When creating a file it must be in an already existing directory. To recursively create directories for a file path, see :ref:`DirAccess.make_dir_recursive<class_DirAccess_method_make_dir_recursive>`). + .. _class_FileAccess_constant_READ_WRITE: .. rst-class:: classref-enumeration-constant @@ -250,6 +252,8 @@ Opens the file for read and write operations. Does not truncate the file. The cu Opens the file for read and write operations. The file is created if it does not exist, and truncated if it does. The cursor is positioned at the beginning of the file. +\ **Note:** When creating a file it must be in an already existing directory. To recursively create directories for a file path, see :ref:`DirAccess.make_dir_recursive<class_DirAccess_method_make_dir_recursive>`). + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_filedialog.rst b/classes/class_filedialog.rst index 22831cdb8..1cac33e11 100644 --- a/classes/class_filedialog.rst +++ b/classes/class_filedialog.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/FileDialog.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/FileDialog.xml. .. _class_FileDialog: diff --git a/classes/class_filesystemdock.rst b/classes/class_filesystemdock.rst index 2f9f4f8d3..07a6b043f 100644 --- a/classes/class_filesystemdock.rst +++ b/classes/class_filesystemdock.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/FileSystemDock.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/FileSystemDock.xml. .. _class_FileSystemDock: diff --git a/classes/class_float.rst b/classes/class_float.rst index cce7f5987..a457298c2 100644 --- a/classes/class_float.rst +++ b/classes/class_float.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/float.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/float.xml. .. _class_float: diff --git a/classes/class_flowcontainer.rst b/classes/class_flowcontainer.rst index f1102e108..c480a5366 100644 --- a/classes/class_flowcontainer.rst +++ b/classes/class_flowcontainer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/FlowContainer.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/FlowContainer.xml. .. _class_FlowContainer: @@ -182,7 +182,7 @@ Theme Property Descriptions :ref:`int<class_int>` **h_separation** = ``4`` -The horizontal separation of children nodes. +The horizontal separation of child nodes. .. rst-class:: classref-item-separator @@ -194,7 +194,7 @@ The horizontal separation of children nodes. :ref:`int<class_int>` **v_separation** = ``4`` -The vertical separation of children nodes. +The vertical separation of child nodes. .. |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_fogmaterial.rst b/classes/class_fogmaterial.rst index 973c1840f..4acf1a556 100644 --- a/classes/class_fogmaterial.rst +++ b/classes/class_fogmaterial.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/FogMaterial.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/FogMaterial.xml. .. _class_FogMaterial: diff --git a/classes/class_fogvolume.rst b/classes/class_fogvolume.rst index 4cf4edc9f..7acb0b6df 100644 --- a/classes/class_fogvolume.rst +++ b/classes/class_fogvolume.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/FogVolume.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/FogVolume.xml. .. _class_FogVolume: diff --git a/classes/class_font.rst b/classes/class_font.rst index 11f5a46d3..4f1d930b4 100644 --- a/classes/class_font.rst +++ b/classes/class_font.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Font.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Font.xml. .. _class_Font: @@ -258,7 +258,7 @@ Returns the average font ascent (number of pixels above the baseline). :ref:`Vector2<class_Vector2>` **get_char_size** **(** :ref:`int<class_int>` char, :ref:`int<class_int>` font_size **)** |const| -Returns the size of a character, optionally taking kerning into account if the next character is provided. +Returns the size of a character. Does not take kerning into account. \ **Note:** Do not use this function to calculate width of the string character by character, use :ref:`get_string_size<class_Font_method_get_string_size>` or :ref:`TextLine<class_TextLine>` instead. The height returned is the font height (see also :ref:`get_height<class_Font_method_get_height>`) and has no relation to the glyph height. diff --git a/classes/class_fontfile.rst b/classes/class_fontfile.rst index e808a1206..1faa507f3 100644 --- a/classes/class_fontfile.rst +++ b/classes/class_fontfile.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/FontFile.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/FontFile.xml. .. _class_FontFile: diff --git a/classes/class_fontvariation.rst b/classes/class_fontvariation.rst index 754aa0b63..58cbf9b4d 100644 --- a/classes/class_fontvariation.rst +++ b/classes/class_fontvariation.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/FontVariation.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/FontVariation.xml. .. _class_FontVariation: diff --git a/classes/class_gdextension.rst b/classes/class_gdextension.rst index 2b6cf2dfe..1c5ee8b6f 100644 --- a/classes/class_gdextension.rst +++ b/classes/class_gdextension.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/GDExtension.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/GDExtension.xml. .. _class_GDExtension: diff --git a/classes/class_gdextensionmanager.rst b/classes/class_gdextensionmanager.rst index 9c278824f..71d09be7d 100644 --- a/classes/class_gdextensionmanager.rst +++ b/classes/class_gdextensionmanager.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/GDExtensionManager.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/GDExtensionManager.xml. .. _class_GDExtensionManager: diff --git a/classes/class_gdscript.rst b/classes/class_gdscript.rst index e40c0ea83..21c37b490 100644 --- a/classes/class_gdscript.rst +++ b/classes/class_gdscript.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/gdscript/doc_classes/GDScript.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/gdscript/doc_classes/GDScript.xml. .. _class_GDScript: diff --git a/classes/class_generic6dofjoint3d.rst b/classes/class_generic6dofjoint3d.rst index 8d623aa46..53a358ab5 100644 --- a/classes/class_generic6dofjoint3d.rst +++ b/classes/class_generic6dofjoint3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Generic6DOFJoint3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Generic6DOFJoint3D.xml. .. _class_Generic6DOFJoint3D: diff --git a/classes/class_geometry2d.rst b/classes/class_geometry2d.rst index c7c2604d6..ff564092a 100644 --- a/classes/class_geometry2d.rst +++ b/classes/class_geometry2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Geometry2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Geometry2D.xml. .. _class_Geometry2D: diff --git a/classes/class_geometry3d.rst b/classes/class_geometry3d.rst index 9c9e34427..77a352d05 100644 --- a/classes/class_geometry3d.rst +++ b/classes/class_geometry3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Geometry3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Geometry3D.xml. .. _class_Geometry3D: diff --git a/classes/class_geometryinstance3d.rst b/classes/class_geometryinstance3d.rst index 7de3a2972..e20b673af 100644 --- a/classes/class_geometryinstance3d.rst +++ b/classes/class_geometryinstance3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/GeometryInstance3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/GeometryInstance3D.xml. .. _class_GeometryInstance3D: @@ -153,7 +153,7 @@ enum **GIMode**: :ref:`GIMode<enum_GeometryInstance3D_GIMode>` **GI_MODE_DISABLED** = ``0`` -Disabled global illumination mode. Use for dynamic objects that do not contribute to global illumination (such as characters). When using :ref:`VoxelGI<class_VoxelGI>` and SDFGI, the geometry will *receive* indirect lighting and reflections but the geometry will not be considered in GI baking. When using :ref:`LightmapGI<class_LightmapGI>`, the object will receive indirect lighting using lightmap probes instead of using the baked lightmap texture. +Disabled global illumination mode. Use for dynamic objects that do not contribute to global illumination (such as characters). When using :ref:`VoxelGI<class_VoxelGI>` and SDFGI, the geometry will *receive* indirect lighting and reflections but the geometry will not be considered in GI baking. .. _class_GeometryInstance3D_constant_GI_MODE_STATIC: @@ -169,7 +169,7 @@ Baked global illumination mode. Use for static objects that contribute to global :ref:`GIMode<enum_GeometryInstance3D_GIMode>` **GI_MODE_DYNAMIC** = ``2`` -Dynamic global illumination mode. Use for dynamic objects that contribute to global illumination. This GI mode is only effective when using :ref:`VoxelGI<class_VoxelGI>`, but it has a higher performance impact than :ref:`GI_MODE_STATIC<class_GeometryInstance3D_constant_GI_MODE_STATIC>`. When using other GI methods, this will act the same as :ref:`GI_MODE_DISABLED<class_GeometryInstance3D_constant_GI_MODE_DISABLED>`. +Dynamic global illumination mode. Use for dynamic objects that contribute to global illumination. This GI mode is only effective when using :ref:`VoxelGI<class_VoxelGI>`, but it has a higher performance impact than :ref:`GI_MODE_STATIC<class_GeometryInstance3D_constant_GI_MODE_STATIC>`. When using other GI methods, this will act the same as :ref:`GI_MODE_DISABLED<class_GeometryInstance3D_constant_GI_MODE_DISABLED>`. When using :ref:`LightmapGI<class_LightmapGI>`, the object will receive indirect lighting using lightmap probes instead of using the baked lightmap texture. .. rst-class:: classref-item-separator @@ -292,7 +292,7 @@ The selected shadow casting flag. See :ref:`ShadowCastingSetting<enum_GeometryIn - void **set_custom_aabb** **(** :ref:`AABB<class_AABB>` value **)** - :ref:`AABB<class_AABB>` **get_custom_aabb** **(** **)** -Overrides the bounding box of this node with a custom one. This can be used to avoid the expensive :ref:`AABB<class_AABB>` recalculation that happens when a skeleton is used with a :ref:`MeshInstance3D<class_MeshInstance3D>` or to have fine control over the :ref:`MeshInstance3D<class_MeshInstance3D>`'s bounding box. To use the default AABB, set value to an :ref:`AABB<class_AABB>` with all fields set to ``0.0``. To avoid frustum culling, set :ref:`custom_aabb<class_GeometryInstance3D_property_custom_aabb>` to a very large AABB that covers your entire game world such as ``AABB(-10000, -10000, -10000, 20000, 20000, 20000)``. To disable all forms of culling (including occlusion culling), call :ref:`RenderingServer.instance_set_ignore_culling<class_RenderingServer_method_instance_set_ignore_culling>` on the **GeometryInstance3D**'s :ref:`RID<class_RID>`. +Overrides the bounding box of this node with a custom one. This can be used to avoid the expensive :ref:`AABB<class_AABB>` recalculation that happens when a skeleton is used with a :ref:`MeshInstance3D<class_MeshInstance3D>` or to have precise control over the :ref:`MeshInstance3D<class_MeshInstance3D>`'s bounding box. To use the default AABB, set value to an :ref:`AABB<class_AABB>` with all fields set to ``0.0``. To avoid frustum culling, set :ref:`custom_aabb<class_GeometryInstance3D_property_custom_aabb>` to a very large AABB that covers your entire game world such as ``AABB(-10000, -10000, -10000, 20000, 20000, 20000)``. To disable all forms of culling (including occlusion culling), call :ref:`RenderingServer.instance_set_ignore_culling<class_RenderingServer_method_instance_set_ignore_culling>` on the **GeometryInstance3D**'s :ref:`RID<class_RID>`. .. rst-class:: classref-item-separator diff --git a/classes/class_gltfaccessor.rst b/classes/class_gltfaccessor.rst index 30fd10eeb..e0806823c 100644 --- a/classes/class_gltfaccessor.rst +++ b/classes/class_gltfaccessor.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/gltf/doc_classes/GLTFAccessor.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/gltf/doc_classes/GLTFAccessor.xml. .. _class_GLTFAccessor: diff --git a/classes/class_gltfanimation.rst b/classes/class_gltfanimation.rst index 7959e1f2a..cbbe9a9d9 100644 --- a/classes/class_gltfanimation.rst +++ b/classes/class_gltfanimation.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/gltf/doc_classes/GLTFAnimation.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/gltf/doc_classes/GLTFAnimation.xml. .. _class_GLTFAnimation: diff --git a/classes/class_gltfbufferview.rst b/classes/class_gltfbufferview.rst index 44a5d4b03..60267a5e5 100644 --- a/classes/class_gltfbufferview.rst +++ b/classes/class_gltfbufferview.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/gltf/doc_classes/GLTFBufferView.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/gltf/doc_classes/GLTFBufferView.xml. .. _class_GLTFBufferView: diff --git a/classes/class_gltfcamera.rst b/classes/class_gltfcamera.rst index ec5316854..c09cd4330 100644 --- a/classes/class_gltfcamera.rst +++ b/classes/class_gltfcamera.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/gltf/doc_classes/GLTFCamera.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/gltf/doc_classes/GLTFCamera.xml. .. _class_GLTFCamera: diff --git a/classes/class_gltfdocument.rst b/classes/class_gltfdocument.rst index 0ee16d800..2278aefa6 100644 --- a/classes/class_gltfdocument.rst +++ b/classes/class_gltfdocument.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/gltf/doc_classes/GLTFDocument.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/gltf/doc_classes/GLTFDocument.xml. .. _class_GLTFDocument: diff --git a/classes/class_gltfdocumentextension.rst b/classes/class_gltfdocumentextension.rst index b37cdc84d..e7f564aba 100644 --- a/classes/class_gltfdocumentextension.rst +++ b/classes/class_gltfdocumentextension.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/gltf/doc_classes/GLTFDocumentExtension.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/gltf/doc_classes/GLTFDocumentExtension.xml. .. _class_GLTFDocumentExtension: diff --git a/classes/class_gltfdocumentextensionconvertimportermesh.rst b/classes/class_gltfdocumentextensionconvertimportermesh.rst index 08e01476b..5b5e57606 100644 --- a/classes/class_gltfdocumentextensionconvertimportermesh.rst +++ b/classes/class_gltfdocumentextensionconvertimportermesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/gltf/doc_classes/GLTFDocumentExtensionConvertImporterMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/gltf/doc_classes/GLTFDocumentExtensionConvertImporterMesh.xml. .. _class_GLTFDocumentExtensionConvertImporterMesh: diff --git a/classes/class_gltflight.rst b/classes/class_gltflight.rst index a8bed0c99..ae301568c 100644 --- a/classes/class_gltflight.rst +++ b/classes/class_gltflight.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/gltf/doc_classes/GLTFLight.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/gltf/doc_classes/GLTFLight.xml. .. _class_GLTFLight: diff --git a/classes/class_gltfmesh.rst b/classes/class_gltfmesh.rst index 5829f630c..19d178ca9 100644 --- a/classes/class_gltfmesh.rst +++ b/classes/class_gltfmesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/gltf/doc_classes/GLTFMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/gltf/doc_classes/GLTFMesh.xml. .. _class_GLTFMesh: diff --git a/classes/class_gltfnode.rst b/classes/class_gltfnode.rst index 396bb8e18..0fa7adea7 100644 --- a/classes/class_gltfnode.rst +++ b/classes/class_gltfnode.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/gltf/doc_classes/GLTFNode.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/gltf/doc_classes/GLTFNode.xml. .. _class_GLTFNode: @@ -117,7 +117,7 @@ If this GLTF node is a camera, the index of the :ref:`GLTFCamera<class_GLTFCamer - void **set_children** **(** :ref:`PackedInt32Array<class_PackedInt32Array>` value **)** - :ref:`PackedInt32Array<class_PackedInt32Array>` **get_children** **(** **)** -The indices of the children nodes in the :ref:`GLTFState<class_GLTFState>`. If this GLTF node has no children, this will be an empty array. +The indices of the child nodes in the :ref:`GLTFState<class_GLTFState>`. If this GLTF node has no children, this will be an empty array. .. rst-class:: classref-item-separator diff --git a/classes/class_gltfphysicsbody.rst b/classes/class_gltfphysicsbody.rst index 65e4847fa..963f77c49 100644 --- a/classes/class_gltfphysicsbody.rst +++ b/classes/class_gltfphysicsbody.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/gltf/doc_classes/GLTFPhysicsBody.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/gltf/doc_classes/GLTFPhysicsBody.xml. .. _class_GLTFPhysicsBody: diff --git a/classes/class_gltfphysicsshape.rst b/classes/class_gltfphysicsshape.rst index 7756f5ff7..399497196 100644 --- a/classes/class_gltfphysicsshape.rst +++ b/classes/class_gltfphysicsshape.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/gltf/doc_classes/GLTFPhysicsShape.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/gltf/doc_classes/GLTFPhysicsShape.xml. .. _class_GLTFPhysicsShape: diff --git a/classes/class_gltfskeleton.rst b/classes/class_gltfskeleton.rst index f864657c3..d236e258e 100644 --- a/classes/class_gltfskeleton.rst +++ b/classes/class_gltfskeleton.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/gltf/doc_classes/GLTFSkeleton.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/gltf/doc_classes/GLTFSkeleton.xml. .. _class_GLTFSkeleton: diff --git a/classes/class_gltfskin.rst b/classes/class_gltfskin.rst index 78424c80d..91aef51eb 100644 --- a/classes/class_gltfskin.rst +++ b/classes/class_gltfskin.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/gltf/doc_classes/GLTFSkin.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/gltf/doc_classes/GLTFSkin.xml. .. _class_GLTFSkin: diff --git a/classes/class_gltfspecgloss.rst b/classes/class_gltfspecgloss.rst index 4b632f348..0e3ae7d78 100644 --- a/classes/class_gltfspecgloss.rst +++ b/classes/class_gltfspecgloss.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/gltf/doc_classes/GLTFSpecGloss.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/gltf/doc_classes/GLTFSpecGloss.xml. .. _class_GLTFSpecGloss: diff --git a/classes/class_gltfstate.rst b/classes/class_gltfstate.rst index d2f103e78..fb4746aa8 100644 --- a/classes/class_gltfstate.rst +++ b/classes/class_gltfstate.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/gltf/doc_classes/GLTFState.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/gltf/doc_classes/GLTFState.xml. .. _class_GLTFState: diff --git a/classes/class_gltftexture.rst b/classes/class_gltftexture.rst index ce77f726f..38fb4a988 100644 --- a/classes/class_gltftexture.rst +++ b/classes/class_gltftexture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/gltf/doc_classes/GLTFTexture.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/gltf/doc_classes/GLTFTexture.xml. .. _class_GLTFTexture: diff --git a/classes/class_gltftexturesampler.rst b/classes/class_gltftexturesampler.rst index 9808ea314..813a94f50 100644 --- a/classes/class_gltftexturesampler.rst +++ b/classes/class_gltftexturesampler.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/gltf/doc_classes/GLTFTextureSampler.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/gltf/doc_classes/GLTFTextureSampler.xml. .. _class_GLTFTextureSampler: diff --git a/classes/class_godotsharp.rst b/classes/class_godotsharp.rst index a47a343df..87c568cb3 100644 --- a/classes/class_godotsharp.rst +++ b/classes/class_godotsharp.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/mono/doc_classes/GodotSharp.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/mono/doc_classes/GodotSharp.xml. .. _class_GodotSharp: diff --git a/classes/class_gpuparticles2d.rst b/classes/class_gpuparticles2d.rst index 541020cbb..27fcd8394 100644 --- a/classes/class_gpuparticles2d.rst +++ b/classes/class_gpuparticles2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/GPUParticles2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/GPUParticles2D.xml. .. _class_GPUParticles2D: diff --git a/classes/class_gpuparticles3d.rst b/classes/class_gpuparticles3d.rst index 1266893fc..bb1a704d9 100644 --- a/classes/class_gpuparticles3d.rst +++ b/classes/class_gpuparticles3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/GPUParticles3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/GPUParticles3D.xml. .. _class_GPUParticles3D: diff --git a/classes/class_gpuparticlesattractor3d.rst b/classes/class_gpuparticlesattractor3d.rst index 9a71165c7..b9adc1ce2 100644 --- a/classes/class_gpuparticlesattractor3d.rst +++ b/classes/class_gpuparticlesattractor3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/GPUParticlesAttractor3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/GPUParticlesAttractor3D.xml. .. _class_GPUParticlesAttractor3D: diff --git a/classes/class_gpuparticlesattractorbox3d.rst b/classes/class_gpuparticlesattractorbox3d.rst index 4aa9e1464..49928201a 100644 --- a/classes/class_gpuparticlesattractorbox3d.rst +++ b/classes/class_gpuparticlesattractorbox3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/GPUParticlesAttractorBox3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/GPUParticlesAttractorBox3D.xml. .. _class_GPUParticlesAttractorBox3D: diff --git a/classes/class_gpuparticlesattractorsphere3d.rst b/classes/class_gpuparticlesattractorsphere3d.rst index 23f734825..6da83b0e0 100644 --- a/classes/class_gpuparticlesattractorsphere3d.rst +++ b/classes/class_gpuparticlesattractorsphere3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/GPUParticlesAttractorSphere3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/GPUParticlesAttractorSphere3D.xml. .. _class_GPUParticlesAttractorSphere3D: diff --git a/classes/class_gpuparticlesattractorvectorfield3d.rst b/classes/class_gpuparticlesattractorvectorfield3d.rst index 09e9ac477..23c85eb43 100644 --- a/classes/class_gpuparticlesattractorvectorfield3d.rst +++ b/classes/class_gpuparticlesattractorvectorfield3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/GPUParticlesAttractorVectorField3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/GPUParticlesAttractorVectorField3D.xml. .. _class_GPUParticlesAttractorVectorField3D: diff --git a/classes/class_gpuparticlescollision3d.rst b/classes/class_gpuparticlescollision3d.rst index 10336abf6..56016721a 100644 --- a/classes/class_gpuparticlescollision3d.rst +++ b/classes/class_gpuparticlescollision3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/GPUParticlesCollision3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/GPUParticlesCollision3D.xml. .. _class_GPUParticlesCollision3D: diff --git a/classes/class_gpuparticlescollisionbox3d.rst b/classes/class_gpuparticlescollisionbox3d.rst index f9edbd50f..3c9592dae 100644 --- a/classes/class_gpuparticlescollisionbox3d.rst +++ b/classes/class_gpuparticlescollisionbox3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/GPUParticlesCollisionBox3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/GPUParticlesCollisionBox3D.xml. .. _class_GPUParticlesCollisionBox3D: diff --git a/classes/class_gpuparticlescollisionheightfield3d.rst b/classes/class_gpuparticlescollisionheightfield3d.rst index 6ad59791f..c04d1d169 100644 --- a/classes/class_gpuparticlescollisionheightfield3d.rst +++ b/classes/class_gpuparticlescollisionheightfield3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/GPUParticlesCollisionHeightField3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/GPUParticlesCollisionHeightField3D.xml. .. _class_GPUParticlesCollisionHeightField3D: diff --git a/classes/class_gpuparticlescollisionsdf3d.rst b/classes/class_gpuparticlescollisionsdf3d.rst index e02af0bdb..774269b46 100644 --- a/classes/class_gpuparticlescollisionsdf3d.rst +++ b/classes/class_gpuparticlescollisionsdf3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/GPUParticlesCollisionSDF3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/GPUParticlesCollisionSDF3D.xml. .. _class_GPUParticlesCollisionSDF3D: diff --git a/classes/class_gpuparticlescollisionsphere3d.rst b/classes/class_gpuparticlescollisionsphere3d.rst index d45e0a5e9..47c6c514e 100644 --- a/classes/class_gpuparticlescollisionsphere3d.rst +++ b/classes/class_gpuparticlescollisionsphere3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/GPUParticlesCollisionSphere3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/GPUParticlesCollisionSphere3D.xml. .. _class_GPUParticlesCollisionSphere3D: diff --git a/classes/class_gradient.rst b/classes/class_gradient.rst index 4d2c12552..518ad934c 100644 --- a/classes/class_gradient.rst +++ b/classes/class_gradient.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Gradient.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Gradient.xml. .. _class_Gradient: diff --git a/classes/class_gradienttexture1d.rst b/classes/class_gradienttexture1d.rst index a3de6fa78..a5963455f 100644 --- a/classes/class_gradienttexture1d.rst +++ b/classes/class_gradienttexture1d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/GradientTexture1D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/GradientTexture1D.xml. .. _class_GradientTexture1D: diff --git a/classes/class_gradienttexture2d.rst b/classes/class_gradienttexture2d.rst index 69898a04e..cbf2f985d 100644 --- a/classes/class_gradienttexture2d.rst +++ b/classes/class_gradienttexture2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/GradientTexture2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/GradientTexture2D.xml. .. _class_GradientTexture2D: diff --git a/classes/class_graphedit.rst b/classes/class_graphedit.rst index 56ba0cb75..87853812d 100644 --- a/classes/class_graphedit.rst +++ b/classes/class_graphedit.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/GraphEdit.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/GraphEdit.xml. .. _class_GraphEdit: @@ -194,7 +194,7 @@ Signals **begin_node_move** **(** **)** -Emitted at the beginning of a GraphNode movement. +Emitted at the beginning of a :ref:`GraphElement<class_GraphElement>`'s movement. .. rst-class:: classref-item-separator @@ -266,7 +266,7 @@ Emitted when user drags a connection from an output port into the empty space of **copy_nodes_request** **(** **)** -Emitted when the user presses :kbd:`Ctrl + C`. +Emitted when this **GraphEdit** captures a ``ui_copy`` action (:kbd:`Ctrl + C` by default). In general, this signal indicates that the selected :ref:`GraphElement<class_GraphElement>`\ s should be copied. .. rst-class:: classref-item-separator @@ -278,7 +278,9 @@ Emitted when the user presses :kbd:`Ctrl + C`. **delete_nodes_request** **(** :ref:`StringName[]<class_StringName>` nodes **)** -Emitted when attempting to remove a GraphNode from the GraphEdit. Provides a list of node names to be removed (all selected nodes, excluding nodes without closing button). +Emitted when this **GraphEdit** captures a ``ui_graph_delete`` action (:kbd:`Delete` by default). + +\ ``nodes`` is an array of node names that should be removed. These usually include all selected nodes. .. rst-class:: classref-item-separator @@ -302,7 +304,7 @@ Emitted to the GraphEdit when the connection between ``from_port`` of ``from_nod **duplicate_nodes_request** **(** **)** -Emitted when a GraphNode is attempted to be duplicated in the GraphEdit. +Emitted when this **GraphEdit** captures a ``ui_graph_duplicate`` action (:kbd:`Ctrl + D` by default). In general, this signal indicates that the selected :ref:`GraphElement<class_GraphElement>`\ s should be duplicated. .. rst-class:: classref-item-separator @@ -314,7 +316,7 @@ Emitted when a GraphNode is attempted to be duplicated in the GraphEdit. **end_node_move** **(** **)** -Emitted at the end of a GraphNode movement. +Emitted at the end of a :ref:`GraphElement<class_GraphElement>`'s movement. .. rst-class:: classref-item-separator @@ -326,9 +328,7 @@ Emitted at the end of a GraphNode movement. **node_deselected** **(** :ref:`Node<class_Node>` node **)** -.. container:: contribute - - There is currently no description for this signal. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Emitted when the given :ref:`GraphElement<class_GraphElement>` node is deselected. .. rst-class:: classref-item-separator @@ -340,7 +340,7 @@ Emitted at the end of a GraphNode movement. **node_selected** **(** :ref:`Node<class_Node>` node **)** -Emitted when a GraphNode is selected. +Emitted when the given :ref:`GraphElement<class_GraphElement>` node is selected. .. rst-class:: classref-item-separator @@ -352,7 +352,7 @@ Emitted when a GraphNode is selected. **paste_nodes_request** **(** **)** -Emitted when the user presses :kbd:`Ctrl + V`. +Emitted when this **GraphEdit** captures a ``ui_paste`` action (:kbd:`Ctrl + V` by default). In general, this signal indicates that previously copied :ref:`GraphElement<class_GraphElement>`\ s should be pasted. .. rst-class:: classref-item-separator @@ -1010,7 +1010,7 @@ Returns the points which would make up a connection between ``from_node`` and `` :ref:`Dictionary[]<class_Dictionary>` **get_connection_list** **(** **)** |const| -Returns an Array containing the list of connections. A connection consists in a structure of the form ``{ from_port: 0, from: "GraphNode name 0", to_port: 1, to: "GraphNode name 1" }``. +Returns an Array containing the list of connections. A connection consists in a structure of the form ``{ from_port: 0, from_node: "GraphNode name 0", to_port: 1, to_node: "GraphNode name 1" }``. .. rst-class:: classref-item-separator diff --git a/classes/class_graphelement.rst b/classes/class_graphelement.rst index 13b348785..6da93419a 100644 --- a/classes/class_graphelement.rst +++ b/classes/class_graphelement.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/GraphElement.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/GraphElement.xml. .. _class_GraphElement: diff --git a/classes/class_graphnode.rst b/classes/class_graphnode.rst index 75aa4747a..b0223a282 100644 --- a/classes/class_graphnode.rst +++ b/classes/class_graphnode.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/GraphNode.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/GraphNode.xml. .. _class_GraphNode: diff --git a/classes/class_gridcontainer.rst b/classes/class_gridcontainer.rst index 5d914852a..032a5c753 100644 --- a/classes/class_gridcontainer.rst +++ b/classes/class_gridcontainer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/GridContainer.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/GridContainer.xml. .. _class_GridContainer: @@ -95,7 +95,7 @@ Theme Property Descriptions :ref:`int<class_int>` **h_separation** = ``4`` -The horizontal separation of children nodes. +The horizontal separation of child nodes. .. rst-class:: classref-item-separator @@ -107,7 +107,7 @@ The horizontal separation of children nodes. :ref:`int<class_int>` **v_separation** = ``4`` -The vertical separation of children nodes. +The vertical separation of child nodes. .. |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_gridmap.rst b/classes/class_gridmap.rst index b0a1bb4f4..680e079a3 100644 --- a/classes/class_gridmap.rst +++ b/classes/class_gridmap.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/gridmap/doc_classes/GridMap.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/gridmap/doc_classes/GridMap.xml. .. _class_GridMap: diff --git a/classes/class_groovejoint2d.rst b/classes/class_groovejoint2d.rst index 141e85de6..c4e873b32 100644 --- a/classes/class_groovejoint2d.rst +++ b/classes/class_groovejoint2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/GrooveJoint2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/GrooveJoint2D.xml. .. _class_GrooveJoint2D: diff --git a/classes/class_hashingcontext.rst b/classes/class_hashingcontext.rst index d20520a10..153183c27 100644 --- a/classes/class_hashingcontext.rst +++ b/classes/class_hashingcontext.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/HashingContext.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/HashingContext.xml. .. _class_HashingContext: diff --git a/classes/class_hboxcontainer.rst b/classes/class_hboxcontainer.rst index 7c94048cb..66e480bc6 100644 --- a/classes/class_hboxcontainer.rst +++ b/classes/class_hboxcontainer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/HBoxContainer.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/HBoxContainer.xml. .. _class_HBoxContainer: diff --git a/classes/class_heightmapshape3d.rst b/classes/class_heightmapshape3d.rst index 1f9c62962..5497ba533 100644 --- a/classes/class_heightmapshape3d.rst +++ b/classes/class_heightmapshape3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/HeightMapShape3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/HeightMapShape3D.xml. .. _class_HeightMapShape3D: diff --git a/classes/class_hflowcontainer.rst b/classes/class_hflowcontainer.rst index a2ff05310..4f32304f6 100644 --- a/classes/class_hflowcontainer.rst +++ b/classes/class_hflowcontainer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/HFlowContainer.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/HFlowContainer.xml. .. _class_HFlowContainer: diff --git a/classes/class_hingejoint3d.rst b/classes/class_hingejoint3d.rst index a98df7aa4..5327dfb48 100644 --- a/classes/class_hingejoint3d.rst +++ b/classes/class_hingejoint3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/HingeJoint3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/HingeJoint3D.xml. .. _class_HingeJoint3D: diff --git a/classes/class_hmaccontext.rst b/classes/class_hmaccontext.rst index 484a5e575..6e23006f2 100644 --- a/classes/class_hmaccontext.rst +++ b/classes/class_hmaccontext.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/HMACContext.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/HMACContext.xml. .. _class_HMACContext: diff --git a/classes/class_hscrollbar.rst b/classes/class_hscrollbar.rst index a4193b85b..8c57de52e 100644 --- a/classes/class_hscrollbar.rst +++ b/classes/class_hscrollbar.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/HScrollBar.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/HScrollBar.xml. .. _class_HScrollBar: diff --git a/classes/class_hseparator.rst b/classes/class_hseparator.rst index 883c63ad5..5d528936c 100644 --- a/classes/class_hseparator.rst +++ b/classes/class_hseparator.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/HSeparator.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/HSeparator.xml. .. _class_HSeparator: diff --git a/classes/class_hslider.rst b/classes/class_hslider.rst index 82c2e03f8..eb34a784c 100644 --- a/classes/class_hslider.rst +++ b/classes/class_hslider.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/HSlider.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/HSlider.xml. .. _class_HSlider: diff --git a/classes/class_hsplitcontainer.rst b/classes/class_hsplitcontainer.rst index bc00d1045..d3c6dbf5a 100644 --- a/classes/class_hsplitcontainer.rst +++ b/classes/class_hsplitcontainer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/HSplitContainer.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/HSplitContainer.xml. .. _class_HSplitContainer: diff --git a/classes/class_httpclient.rst b/classes/class_httpclient.rst index 5d1309c76..ee7fd7785 100644 --- a/classes/class_httpclient.rst +++ b/classes/class_httpclient.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/HTTPClient.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/HTTPClient.xml. .. _class_HTTPClient: @@ -1081,9 +1081,9 @@ To create a POST request with query strings to push to the server, do: .. code-tab:: csharp var fields = new Godot.Collections.Dictionary { { "username", "user" }, { "password", "pass" } }; - string queryString = new HTTPClient().QueryStringFromDict(fields); + string queryString = new HttpClient().QueryStringFromDict(fields); string[] headers = { "Content-Type: application/x-www-form-urlencoded", $"Content-Length: {queryString.Length}" }; - var result = new HTTPClient().Request(HTTPClient.Method.Post, "index.php", headers, queryString); + var result = new HttpClient().Request(HttpClient.Method.Post, "index.php", headers, queryString); diff --git a/classes/class_httprequest.rst b/classes/class_httprequest.rst index 9856b5c0c..ba936c862 100644 --- a/classes/class_httprequest.rst +++ b/classes/class_httprequest.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/HTTPRequest.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/HTTPRequest.xml. .. _class_HTTPRequest: @@ -67,7 +67,7 @@ Can be used to make HTTP requests, i.e. download or upload files or web content public override void _Ready() { // Create an HTTP request node and connect its completion signal. - var httpRequest = new HTTPRequest(); + var httpRequest = new HttpRequest(); AddChild(httpRequest); httpRequest.RequestCompleted += HttpRequestCompleted; @@ -85,7 +85,7 @@ Can be used to make HTTP requests, i.e. download or upload files or web content { { "name", "Godette" } }); - error = httpRequest.Request("https://httpbin.org/post", null, HTTPClient.Method.Post, body); + error = httpRequest.Request("https://httpbin.org/post", null, HttpClient.Method.Post, body); if (error != Error.Ok) { GD.PushError("An error occurred in the HTTP request."); @@ -145,7 +145,7 @@ Can be used to make HTTP requests, i.e. download or upload files or web content public override void _Ready() { // Create an HTTP request node and connect its completion signal. - var httpRequest = new HTTPRequest(); + var httpRequest = new HttpRequest(); AddChild(httpRequest); httpRequest.RequestCompleted += HttpRequestCompleted; @@ -160,7 +160,7 @@ Can be used to make HTTP requests, i.e. download or upload files or web content // Called when the HTTP request is completed. private void HttpRequestCompleted(long result, long responseCode, string[] headers, byte[] body) { - if (result != (long)HTTPRequest.Result.Success) + if (result != (long)HttpRequest.Result.Success) { GD.PushError("Image couldn't be downloaded. Try a different image."); } diff --git a/classes/class_image.rst b/classes/class_image.rst index 68a47239f..60fadfa8d 100644 --- a/classes/class_image.rst +++ b/classes/class_image.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Image.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Image.xml. .. _class_Image: @@ -275,7 +275,7 @@ OpenGL texture format ``RGBA`` with four components, each with a bitdepth of 4. :ref:`Format<enum_Image_Format>` **FORMAT_RGB565** = ``7`` - +OpenGL texture format ``RGB`` with three components. Red and blue have a bitdepth of 5, and green has a bitdepth of 6. .. _class_Image_constant_FORMAT_RF: @@ -497,7 +497,7 @@ Texture format that uses `BPTC <https://www.khronos.org/opengl/wiki/BPTC_Texture :ref:`Format<enum_Image_Format>` **FORMAT_ETC2_RA_AS_RG** = ``33`` - +`Ericsson Texture Compression format 2 <https://en.wikipedia.org/wiki/Ericsson_Texture_Compression#ETC2_and_EAC>`__ (``RGBA8`` variant), which compresses RA data and interprets it as two channels (red and green). See also :ref:`FORMAT_ETC2_RGBA8<class_Image_constant_FORMAT_ETC2_RGBA8>`. .. _class_Image_constant_FORMAT_DXT5_RA_AS_RG: @@ -505,7 +505,7 @@ Texture format that uses `BPTC <https://www.khronos.org/opengl/wiki/BPTC_Texture :ref:`Format<enum_Image_Format>` **FORMAT_DXT5_RA_AS_RG** = ``34`` - +The `S3TC <https://en.wikipedia.org/wiki/S3_Texture_Compression>`__ texture format also known as Block Compression 3 or BC3, which compresses RA data and interprets it as two channels (red and green). See also :ref:`FORMAT_DXT5<class_Image_constant_FORMAT_DXT5>`. .. _class_Image_constant_FORMAT_ASTC_4x4: @@ -603,7 +603,7 @@ On the other hand, if the image already has mipmaps, they will be used, and a ne :ref:`Interpolation<enum_Image_Interpolation>` **INTERPOLATE_LANCZOS** = ``4`` -Performs Lanczos interpolation. This is the slowest image resizing mode, but it typically gives the best results, especially when downscalng images. +Performs Lanczos interpolation. This is the slowest image resizing mode, but it typically gives the best results, especially when downscaling images. .. rst-class:: classref-item-separator @@ -713,7 +713,7 @@ enum **UsedChannels**: :ref:`UsedChannels<enum_Image_UsedChannels>` **USED_CHANNELS_L** = ``0`` - +The image only uses one channel for luminance (grayscale). .. _class_Image_constant_USED_CHANNELS_LA: @@ -721,7 +721,7 @@ enum **UsedChannels**: :ref:`UsedChannels<enum_Image_UsedChannels>` **USED_CHANNELS_LA** = ``1`` - +The image uses two channels for luminance and alpha, respectively. .. _class_Image_constant_USED_CHANNELS_R: @@ -729,7 +729,7 @@ enum **UsedChannels**: :ref:`UsedChannels<enum_Image_UsedChannels>` **USED_CHANNELS_R** = ``2`` - +The image only uses the red channel. .. _class_Image_constant_USED_CHANNELS_RG: @@ -737,7 +737,7 @@ enum **UsedChannels**: :ref:`UsedChannels<enum_Image_UsedChannels>` **USED_CHANNELS_RG** = ``3`` - +The image uses two channels for red and green. .. _class_Image_constant_USED_CHANNELS_RGB: @@ -745,7 +745,7 @@ enum **UsedChannels**: :ref:`UsedChannels<enum_Image_UsedChannels>` **USED_CHANNELS_RGB** = ``4`` - +The image uses three channels for red, green, and blue. .. _class_Image_constant_USED_CHANNELS_RGBA: @@ -753,7 +753,7 @@ enum **UsedChannels**: :ref:`UsedChannels<enum_Image_UsedChannels>` **USED_CHANNELS_RGBA** = ``5`` - +The image uses four channels for red, green, blue, and alpha. .. rst-class:: classref-item-separator @@ -872,9 +872,7 @@ Method Descriptions void **adjust_bcs** **(** :ref:`float<class_float>` brightness, :ref:`float<class_float>` contrast, :ref:`float<class_float>` saturation **)** -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Adjusts this image's ``brightness``, ``contrast``, and ``saturation`` by the given values. Does not work if the image is compressed (see :ref:`is_compressed<class_Image_method_is_compressed>`). .. rst-class:: classref-item-separator @@ -1090,9 +1088,7 @@ Returns :ref:`ALPHA_BLEND<class_Image_constant_ALPHA_BLEND>` if the image has da :ref:`UsedChannels<enum_Image_UsedChannels>` **detect_used_channels** **(** :ref:`CompressSource<enum_Image_CompressSource>` source=0 **)** |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Returns the color channels used by this image, as one of the :ref:`UsedChannels<enum_Image_UsedChannels>` constants. If the image is compressed, the original ``source`` must be specified. .. rst-class:: classref-item-separator diff --git a/classes/class_imageformatloader.rst b/classes/class_imageformatloader.rst index 19a9142f9..37679ae31 100644 --- a/classes/class_imageformatloader.rst +++ b/classes/class_imageformatloader.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ImageFormatLoader.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ImageFormatLoader.xml. .. _class_ImageFormatLoader: diff --git a/classes/class_imageformatloaderextension.rst b/classes/class_imageformatloaderextension.rst index 60143b90e..b7822a301 100644 --- a/classes/class_imageformatloaderextension.rst +++ b/classes/class_imageformatloaderextension.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ImageFormatLoaderExtension.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ImageFormatLoaderExtension.xml. .. _class_ImageFormatLoaderExtension: diff --git a/classes/class_imagetexture.rst b/classes/class_imagetexture.rst index ba21eb26a..93d00ae69 100644 --- a/classes/class_imagetexture.rst +++ b/classes/class_imagetexture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ImageTexture.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ImageTexture.xml. .. _class_ImageTexture: diff --git a/classes/class_imagetexture3d.rst b/classes/class_imagetexture3d.rst index 9a7f9873c..e83684f01 100644 --- a/classes/class_imagetexture3d.rst +++ b/classes/class_imagetexture3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ImageTexture3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ImageTexture3D.xml. .. _class_ImageTexture3D: diff --git a/classes/class_imagetexturelayered.rst b/classes/class_imagetexturelayered.rst index e20ce6bd3..dad070b78 100644 --- a/classes/class_imagetexturelayered.rst +++ b/classes/class_imagetexturelayered.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ImageTextureLayered.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ImageTextureLayered.xml. .. _class_ImageTextureLayered: diff --git a/classes/class_immediatemesh.rst b/classes/class_immediatemesh.rst index 545b2f797..4178898f4 100644 --- a/classes/class_immediatemesh.rst +++ b/classes/class_immediatemesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ImmediateMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ImmediateMesh.xml. .. _class_ImmediateMesh: diff --git a/classes/class_importermesh.rst b/classes/class_importermesh.rst index 712bbeede..cbdfc09af 100644 --- a/classes/class_importermesh.rst +++ b/classes/class_importermesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ImporterMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ImporterMesh.xml. .. _class_ImporterMesh: diff --git a/classes/class_importermeshinstance3d.rst b/classes/class_importermeshinstance3d.rst index b9bfc1d0b..5c34c53cf 100644 --- a/classes/class_importermeshinstance3d.rst +++ b/classes/class_importermeshinstance3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ImporterMeshInstance3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ImporterMeshInstance3D.xml. .. _class_ImporterMeshInstance3D: diff --git a/classes/class_input.rst b/classes/class_input.rst index b36ec4869..c52d8ca99 100644 --- a/classes/class_input.rst +++ b/classes/class_input.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Input.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Input.xml. .. _class_Input: @@ -903,6 +903,8 @@ Feeds an :ref:`InputEvent<class_InputEvent>` to the game. Can be used to artific +\ **Note:** Calling this function has no influence on the operating system. So for example sending an :ref:`InputEventMouseMotion<class_InputEventMouseMotion>` will not move the OS mouse cursor to the specified position (use :ref:`warp_mouse<class_Input_method_warp_mouse>` instead) and sending :kbd:`Alt/Cmd + Tab` as :ref:`InputEventKey<class_InputEventKey>` won't toggle between active windows. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_inputevent.rst b/classes/class_inputevent.rst index 15ae7e10b..d6d00772e 100644 --- a/classes/class_inputevent.rst +++ b/classes/class_inputevent.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/InputEvent.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/InputEvent.xml. .. _class_InputEvent: diff --git a/classes/class_inputeventaction.rst b/classes/class_inputeventaction.rst index 5471ce674..396455664 100644 --- a/classes/class_inputeventaction.rst +++ b/classes/class_inputeventaction.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/InputEventAction.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/InputEventAction.xml. .. _class_InputEventAction: diff --git a/classes/class_inputeventfromwindow.rst b/classes/class_inputeventfromwindow.rst index 063ee5c02..3692c301c 100644 --- a/classes/class_inputeventfromwindow.rst +++ b/classes/class_inputeventfromwindow.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/InputEventFromWindow.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/InputEventFromWindow.xml. .. _class_InputEventFromWindow: diff --git a/classes/class_inputeventgesture.rst b/classes/class_inputeventgesture.rst index 5153fcf50..0321eeb00 100644 --- a/classes/class_inputeventgesture.rst +++ b/classes/class_inputeventgesture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/InputEventGesture.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/InputEventGesture.xml. .. _class_InputEventGesture: diff --git a/classes/class_inputeventjoypadbutton.rst b/classes/class_inputeventjoypadbutton.rst index ba3001a3d..09b53a894 100644 --- a/classes/class_inputeventjoypadbutton.rst +++ b/classes/class_inputeventjoypadbutton.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/InputEventJoypadButton.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/InputEventJoypadButton.xml. .. _class_InputEventJoypadButton: @@ -98,7 +98,9 @@ If ``true``, the button's state is pressed. If ``false``, the button's state is - void **set_pressure** **(** :ref:`float<class_float>` value **)** - :ref:`float<class_float>` **get_pressure** **(** **)** -Represents the pressure the user puts on the button with their finger, if the controller supports it. Ranges from ``0`` to ``1``. +Represents the pressure the user puts on a pressure-sensitive button. + +\ *Deprecated.* This property is never set by the engine and is always ``0``. .. |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_inputeventjoypadmotion.rst b/classes/class_inputeventjoypadmotion.rst index c207962cf..a3015a2fb 100644 --- a/classes/class_inputeventjoypadmotion.rst +++ b/classes/class_inputeventjoypadmotion.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/InputEventJoypadMotion.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/InputEventJoypadMotion.xml. .. _class_InputEventJoypadMotion: diff --git a/classes/class_inputeventkey.rst b/classes/class_inputeventkey.rst index b3606a1e9..0ce966ec5 100644 --- a/classes/class_inputeventkey.rst +++ b/classes/class_inputeventkey.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/InputEventKey.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/InputEventKey.xml. .. _class_InputEventKey: diff --git a/classes/class_inputeventmagnifygesture.rst b/classes/class_inputeventmagnifygesture.rst index e713ee6a5..4fe224de7 100644 --- a/classes/class_inputeventmagnifygesture.rst +++ b/classes/class_inputeventmagnifygesture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/InputEventMagnifyGesture.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/InputEventMagnifyGesture.xml. .. _class_InputEventMagnifyGesture: diff --git a/classes/class_inputeventmidi.rst b/classes/class_inputeventmidi.rst index 901b52158..6dcc2492c 100644 --- a/classes/class_inputeventmidi.rst +++ b/classes/class_inputeventmidi.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/InputEventMIDI.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/InputEventMIDI.xml. .. _class_InputEventMIDI: @@ -12,18 +12,18 @@ InputEventMIDI **Inherits:** :ref:`InputEvent<class_InputEvent>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>` -Represents an input event from a MIDI device, such as a piano. +Represents a MIDI message from a MIDI device, such as a musical keyboard. .. rst-class:: classref-introduction-group Description ----------- -InputEventMIDI allows receiving input events from MIDI (Musical Instrument Digital Interface) devices such as a piano. +InputEventMIDI stores information about messages from `MIDI <https://en.wikipedia.org/wiki/MIDI>`__ (Musical Instrument Digital Interface) devices. These may include musical keyboards, synthesizers, and drum machines. -MIDI signals can be sent over a 5-pin MIDI connector or over USB, if your device supports both be sure to check the settings in the device to see which output it's using. +MIDI messages can be received over a 5-pin MIDI connector or over USB. If your device supports both be sure to check the settings in the device to see which output it is using. -To receive input events from MIDI devices, you need to call :ref:`OS.open_midi_inputs<class_OS_method_open_midi_inputs>`. You can check which devices are detected using :ref:`OS.get_connected_midi_inputs<class_OS_method_get_connected_midi_inputs>`. +By default, Godot does not detect MIDI devices. You need to call :ref:`OS.open_midi_inputs<class_OS_method_open_midi_inputs>`, first. You can check which devices are detected with :ref:`OS.get_connected_midi_inputs<class_OS_method_get_connected_midi_inputs>`, and close the connection with :ref:`OS.close_midi_inputs<class_OS_method_close_midi_inputs>`. .. tabs:: @@ -38,16 +38,16 @@ To receive input events from MIDI devices, you need to call :ref:`OS.open_midi_i if input_event is InputEventMIDI: _print_midi_info(input_event) - func _print_midi_info(midi_event: InputEventMIDI): + func _print_midi_info(midi_event): print(midi_event) - print("Channel " + str(midi_event.channel)) - print("Message " + str(midi_event.message)) - print("Pitch " + str(midi_event.pitch)) - print("Velocity " + str(midi_event.velocity)) - print("Instrument " + str(midi_event.instrument)) - print("Pressure " + str(midi_event.pressure)) - print("Controller number: " + str(midi_event.controller_number)) - print("Controller value: " + str(midi_event.controller_value)) + print("Channel ", midi_event.channel) + print("Message ", midi_event.message) + print("Pitch ", midi_event.pitch) + print("Velocity ", midi_event.velocity) + print("Instrument ", midi_event.instrument) + print("Pressure ", midi_event.pressure) + print("Controller number: ", midi_event.controller_number) + print("Controller value: ", midi_event.controller_value) .. code-tab:: csharp @@ -57,15 +57,15 @@ To receive input events from MIDI devices, you need to call :ref:`OS.open_midi_i GD.Print(OS.GetConnectedMidiInputs()); } - public override void _Input(InputEvent @event) + public override void _Input(InputEvent inputEvent) { - if (@event is InputEventMIDI midiEvent) + if (inputEvent is InputEventMidi midiEvent) { PrintMIDIInfo(midiEvent); } } - private void PrintMIDIInfo(InputEventMIDI midiEvent) + private void PrintMIDIInfo(InputEventMidi midiEvent) { GD.Print(midiEvent); GD.Print($"Channel {midiEvent.Channel}"); @@ -80,7 +80,7 @@ To receive input events from MIDI devices, you need to call :ref:`OS.open_midi_i -Note that Godot does not currently support MIDI output, so there is no way to emit MIDI signals from Godot. Only MIDI input works. +\ **Note:** Godot does not support MIDI output, so there is no way to emit MIDI messages from Godot. Only MIDI input is supported. .. rst-class:: classref-introduction-group @@ -139,7 +139,7 @@ Property Descriptions - void **set_channel** **(** :ref:`int<class_int>` value **)** - :ref:`int<class_int>` **get_channel** **(** **)** -The MIDI channel of this input event. There are 16 channels, so this value ranges from 0 to 15. MIDI channel 9 is reserved for the use with percussion instruments, the rest of the channels are for non-percussion instruments. +The MIDI channel of this message, ranging from ``0`` to ``15``. MIDI channel ``9`` is reserved for percussion instruments. .. rst-class:: classref-item-separator @@ -156,7 +156,7 @@ The MIDI channel of this input event. There are 16 channels, so this value range - void **set_controller_number** **(** :ref:`int<class_int>` value **)** - :ref:`int<class_int>` **get_controller_number** **(** **)** -If the message is :ref:`@GlobalScope.MIDI_MESSAGE_CONTROL_CHANGE<class_@GlobalScope_constant_MIDI_MESSAGE_CONTROL_CHANGE>`, this indicates the controller number, otherwise this is zero. Controllers include devices such as pedals and levers. +The unique number of the controller, if :ref:`message<class_InputEventMIDI_property_message>` is :ref:`@GlobalScope.MIDI_MESSAGE_CONTROL_CHANGE<class_@GlobalScope_constant_MIDI_MESSAGE_CONTROL_CHANGE>`, otherwise this is ``0``. This value can be used to identify sliders for volume, balance, and panning, as well as switches and pedals on the MIDI device. See the `General MIDI specification <https://en.wikipedia.org/wiki/General_MIDI#Controller_events>`__ for a small list. .. rst-class:: classref-item-separator @@ -173,7 +173,7 @@ If the message is :ref:`@GlobalScope.MIDI_MESSAGE_CONTROL_CHANGE<class_@GlobalSc - void **set_controller_value** **(** :ref:`int<class_int>` value **)** - :ref:`int<class_int>` **get_controller_value** **(** **)** -If the message is :ref:`@GlobalScope.MIDI_MESSAGE_CONTROL_CHANGE<class_@GlobalScope_constant_MIDI_MESSAGE_CONTROL_CHANGE>`, this indicates the controller value, otherwise this is zero. Controllers include devices such as pedals and levers. +The value applied to the controller. If :ref:`message<class_InputEventMIDI_property_message>` is :ref:`@GlobalScope.MIDI_MESSAGE_CONTROL_CHANGE<class_@GlobalScope_constant_MIDI_MESSAGE_CONTROL_CHANGE>`, this value ranges from ``0`` to ``127``, otherwise it is ``0``. See also :ref:`controller_value<class_InputEventMIDI_property_controller_value>`. .. rst-class:: classref-item-separator @@ -190,7 +190,9 @@ If the message is :ref:`@GlobalScope.MIDI_MESSAGE_CONTROL_CHANGE<class_@GlobalSc - void **set_instrument** **(** :ref:`int<class_int>` value **)** - :ref:`int<class_int>` **get_instrument** **(** **)** -The instrument of this input event. This value ranges from 0 to 127. Refer to the instrument list on the General MIDI wikipedia article to see a list of instruments, except that this value is 0-index, so subtract one from every number on that chart. A standard piano will have an instrument number of 0. +The instrument (also called *program* or *preset*) used on this MIDI message. This value ranges from ``0`` to ``127``. + +To see what each value means, refer to the `General MIDI's instrument list <https://en.wikipedia.org/wiki/General_MIDI#Program_change_events>`__. Keep in mind that the list is off by 1 because it does not begin from 0. A value of ``0`` corresponds to the acoustic grand piano. .. rst-class:: classref-item-separator @@ -207,15 +209,9 @@ The instrument of this input event. This value ranges from 0 to 127. Refer to th - void **set_message** **(** :ref:`MIDIMessage<enum_@GlobalScope_MIDIMessage>` value **)** - :ref:`MIDIMessage<enum_@GlobalScope_MIDIMessage>` **get_message** **(** **)** -Returns a value indicating the type of message for this MIDI signal. This is a member of the :ref:`MIDIMessage<enum_@GlobalScope_MIDIMessage>` enum. +Represents the type of MIDI message (see the :ref:`MIDIMessage<enum_@GlobalScope_MIDIMessage>` enum). -For MIDI messages between 0x80 and 0xEF, only the left half of the bits are returned as this value, as the other part is the channel (ex: 0x94 becomes 0x9). For MIDI messages from 0xF0 to 0xFF, the value is returned as-is. - -Notes will return :ref:`@GlobalScope.MIDI_MESSAGE_NOTE_ON<class_@GlobalScope_constant_MIDI_MESSAGE_NOTE_ON>` when activated, but they might not always return :ref:`@GlobalScope.MIDI_MESSAGE_NOTE_OFF<class_@GlobalScope_constant_MIDI_MESSAGE_NOTE_OFF>` when deactivated, therefore your code should treat the input as stopped if some period of time has passed. - -Some MIDI devices may send :ref:`@GlobalScope.MIDI_MESSAGE_NOTE_ON<class_@GlobalScope_constant_MIDI_MESSAGE_NOTE_ON>` with zero velocity instead of :ref:`@GlobalScope.MIDI_MESSAGE_NOTE_OFF<class_@GlobalScope_constant_MIDI_MESSAGE_NOTE_OFF>`. - -For more information, see the note in :ref:`velocity<class_InputEventMIDI_property_velocity>` and the MIDI message status byte list chart linked above. +For more information, see the `MIDI message status byte list chart <https://www.midi.org/specifications-old/item/table-2-expanded-messages-list-status-bytes>`__. .. rst-class:: classref-item-separator @@ -232,7 +228,9 @@ For more information, see the note in :ref:`velocity<class_InputEventMIDI_proper - void **set_pitch** **(** :ref:`int<class_int>` value **)** - :ref:`int<class_int>` **get_pitch** **(** **)** -The pitch index number of this MIDI signal. This value ranges from 0 to 127. On a piano, middle C is 60, and A440 is 69, see the "MIDI note" column of the piano key frequency chart on Wikipedia for more information. +The pitch index number of this MIDI message. This value ranges from ``0`` to ``127``. + +On a piano, the **middle C** is ``60``, followed by a **C-sharp** (``61``), then a **D** (``62``), and so on. Each octave is split in offsets of 12. See the "MIDI note number" column of the `piano key frequency chart <https://en.wikipedia.org/wiki/Piano_key_frequencies>`__ a full list. .. rst-class:: classref-item-separator @@ -249,7 +247,9 @@ The pitch index number of this MIDI signal. This value ranges from 0 to 127. On - void **set_pressure** **(** :ref:`int<class_int>` value **)** - :ref:`int<class_int>` **get_pressure** **(** **)** -The pressure of the MIDI signal. This value ranges from 0 to 127. For many devices, this value is always zero. +The strength of the key being pressed. This value ranges from ``0`` to ``127``. + +\ **Note:** For many devices, this value is always ``0``. Other devices such as musical keyboards may simulate pressure by changing the :ref:`velocity<class_InputEventMIDI_property_velocity>`, instead. .. rst-class:: classref-item-separator @@ -266,9 +266,16 @@ The pressure of the MIDI signal. This value ranges from 0 to 127. For many devic - void **set_velocity** **(** :ref:`int<class_int>` value **)** - :ref:`int<class_int>` **get_velocity** **(** **)** -The velocity of the MIDI signal. This value ranges from 0 to 127. For a piano, this corresponds to how quickly the key was pressed, and is rarely above about 110 in practice. +The velocity of the MIDI message. This value ranges from ``0`` to ``127``. For a musical keyboard, this corresponds to how quickly the key was pressed, and is rarely above ``110`` in practice. -\ **Note:** Some MIDI devices may send a :ref:`@GlobalScope.MIDI_MESSAGE_NOTE_ON<class_@GlobalScope_constant_MIDI_MESSAGE_NOTE_ON>` message with zero velocity and expect this to be treated the same as a :ref:`@GlobalScope.MIDI_MESSAGE_NOTE_OFF<class_@GlobalScope_constant_MIDI_MESSAGE_NOTE_OFF>` message, but device implementations vary so Godot reports event data exactly as received. Depending on the hardware and the needs of the game/app, this MIDI quirk can be handled robustly with a couple lines of script (check for :ref:`@GlobalScope.MIDI_MESSAGE_NOTE_ON<class_@GlobalScope_constant_MIDI_MESSAGE_NOTE_ON>` with velocity zero). +\ **Note:** Some MIDI devices may send a :ref:`@GlobalScope.MIDI_MESSAGE_NOTE_ON<class_@GlobalScope_constant_MIDI_MESSAGE_NOTE_ON>` message with ``0`` velocity and expect it to be treated the same as a :ref:`@GlobalScope.MIDI_MESSAGE_NOTE_OFF<class_@GlobalScope_constant_MIDI_MESSAGE_NOTE_OFF>` message. If necessary, this can be handled with a few lines of code: + +:: + + func _input(event): + if event is InputEventMIDI: + if event.message == MIDI_MESSAGE_NOTE_ON and event.velocity > 0: + print("Note pressed!") .. |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_inputeventmouse.rst b/classes/class_inputeventmouse.rst index bc5101d31..434f3176b 100644 --- a/classes/class_inputeventmouse.rst +++ b/classes/class_inputeventmouse.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/InputEventMouse.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/InputEventMouse.xml. .. _class_InputEventMouse: diff --git a/classes/class_inputeventmousebutton.rst b/classes/class_inputeventmousebutton.rst index 91977e5bd..c2402d650 100644 --- a/classes/class_inputeventmousebutton.rst +++ b/classes/class_inputeventmousebutton.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/InputEventMouseButton.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/InputEventMouseButton.xml. .. _class_InputEventMouseButton: diff --git a/classes/class_inputeventmousemotion.rst b/classes/class_inputeventmousemotion.rst index 0db5337e9..18b0891ce 100644 --- a/classes/class_inputeventmousemotion.rst +++ b/classes/class_inputeventmousemotion.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/InputEventMouseMotion.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/InputEventMouseMotion.xml. .. _class_InputEventMouseMotion: diff --git a/classes/class_inputeventpangesture.rst b/classes/class_inputeventpangesture.rst index 4da467b18..45fb4968a 100644 --- a/classes/class_inputeventpangesture.rst +++ b/classes/class_inputeventpangesture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/InputEventPanGesture.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/InputEventPanGesture.xml. .. _class_InputEventPanGesture: diff --git a/classes/class_inputeventscreendrag.rst b/classes/class_inputeventscreendrag.rst index 9807d00bd..947ffe5c8 100644 --- a/classes/class_inputeventscreendrag.rst +++ b/classes/class_inputeventscreendrag.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/InputEventScreenDrag.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/InputEventScreenDrag.xml. .. _class_InputEventScreenDrag: @@ -106,7 +106,7 @@ Returns ``true`` when using the eraser end of a stylus pen. - void **set_position** **(** :ref:`Vector2<class_Vector2>` value **)** - :ref:`Vector2<class_Vector2>` **get_position** **(** **)** -The drag position. +The drag position in the viewport the node is in, using the coordinate system of this viewport. .. rst-class:: classref-item-separator diff --git a/classes/class_inputeventscreentouch.rst b/classes/class_inputeventscreentouch.rst index c7e4ee170..00622c65e 100644 --- a/classes/class_inputeventscreentouch.rst +++ b/classes/class_inputeventscreentouch.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/InputEventScreenTouch.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/InputEventScreenTouch.xml. .. _class_InputEventScreenTouch: @@ -119,7 +119,7 @@ The touch index in the case of a multi-touch event. One index = one finger. - void **set_position** **(** :ref:`Vector2<class_Vector2>` value **)** - :ref:`Vector2<class_Vector2>` **get_position** **(** **)** -The touch position, in screen (global) coordinates. +The touch position in the viewport the node is in, using the coordinate system of this viewport. .. rst-class:: classref-item-separator diff --git a/classes/class_inputeventshortcut.rst b/classes/class_inputeventshortcut.rst index d405d4037..9f6a5218d 100644 --- a/classes/class_inputeventshortcut.rst +++ b/classes/class_inputeventshortcut.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/InputEventShortcut.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/InputEventShortcut.xml. .. _class_InputEventShortcut: diff --git a/classes/class_inputeventwithmodifiers.rst b/classes/class_inputeventwithmodifiers.rst index 10da1189b..22088bfba 100644 --- a/classes/class_inputeventwithmodifiers.rst +++ b/classes/class_inputeventwithmodifiers.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/InputEventWithModifiers.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/InputEventWithModifiers.xml. .. _class_InputEventWithModifiers: diff --git a/classes/class_inputmap.rst b/classes/class_inputmap.rst index 9c172223c..997f4de41 100644 --- a/classes/class_inputmap.rst +++ b/classes/class_inputmap.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/InputMap.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/InputMap.xml. .. _class_InputMap: diff --git a/classes/class_instanceplaceholder.rst b/classes/class_instanceplaceholder.rst index d57409b63..a3c2fed08 100644 --- a/classes/class_instanceplaceholder.rst +++ b/classes/class_instanceplaceholder.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/InstancePlaceholder.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/InstancePlaceholder.xml. .. _class_InstancePlaceholder: diff --git a/classes/class_int.rst b/classes/class_int.rst index edcdee797..ac5132d77 100644 --- a/classes/class_int.rst +++ b/classes/class_int.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/int.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/int.xml. .. _class_int: diff --git a/classes/class_intervaltweener.rst b/classes/class_intervaltweener.rst index 7ecf776f0..c8f492391 100644 --- a/classes/class_intervaltweener.rst +++ b/classes/class_intervaltweener.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/IntervalTweener.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/IntervalTweener.xml. .. _class_IntervalTweener: diff --git a/classes/class_ip.rst b/classes/class_ip.rst index 8fa1e92cf..c178cad33 100644 --- a/classes/class_ip.rst +++ b/classes/class_ip.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/IP.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/IP.xml. .. _class_IP: diff --git a/classes/class_itemlist.rst b/classes/class_itemlist.rst index 0fb2dd233..0eb6d5e22 100644 --- a/classes/class_itemlist.rst +++ b/classes/class_itemlist.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ItemList.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ItemList.xml. .. _class_ItemList: diff --git a/classes/class_javaclass.rst b/classes/class_javaclass.rst index 7ab5101cc..346d549fe 100644 --- a/classes/class_javaclass.rst +++ b/classes/class_javaclass.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/JavaClass.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/JavaClass.xml. .. _class_JavaClass: diff --git a/classes/class_javaclasswrapper.rst b/classes/class_javaclasswrapper.rst index d36918c96..d5ddc2462 100644 --- a/classes/class_javaclasswrapper.rst +++ b/classes/class_javaclasswrapper.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/JavaClassWrapper.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/JavaClassWrapper.xml. .. _class_JavaClassWrapper: diff --git a/classes/class_javascriptbridge.rst b/classes/class_javascriptbridge.rst index d8be160c7..70aef21f6 100644 --- a/classes/class_javascriptbridge.rst +++ b/classes/class_javascriptbridge.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/JavaScriptBridge.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/JavaScriptBridge.xml. .. _class_JavaScriptBridge: diff --git a/classes/class_javascriptobject.rst b/classes/class_javascriptobject.rst index 5bf84788e..c4f3948e6 100644 --- a/classes/class_javascriptobject.rst +++ b/classes/class_javascriptobject.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/JavaScriptObject.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/JavaScriptObject.xml. .. _class_JavaScriptObject: diff --git a/classes/class_jnisingleton.rst b/classes/class_jnisingleton.rst index 11a01e358..29dbf1bed 100644 --- a/classes/class_jnisingleton.rst +++ b/classes/class_jnisingleton.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/JNISingleton.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/JNISingleton.xml. .. _class_JNISingleton: diff --git a/classes/class_joint2d.rst b/classes/class_joint2d.rst index 3ebcea0d7..ae4f4d3dc 100644 --- a/classes/class_joint2d.rst +++ b/classes/class_joint2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Joint2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Joint2D.xml. .. _class_Joint2D: diff --git a/classes/class_joint3d.rst b/classes/class_joint3d.rst index d6bf3fe9a..d88079094 100644 --- a/classes/class_joint3d.rst +++ b/classes/class_joint3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Joint3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Joint3D.xml. .. _class_Joint3D: diff --git a/classes/class_json.rst b/classes/class_json.rst index a9d4a0a29..6a0b5af7a 100644 --- a/classes/class_json.rst +++ b/classes/class_json.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/JSON.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/JSON.xml. .. _class_JSON: diff --git a/classes/class_jsonrpc.rst b/classes/class_jsonrpc.rst index fc22403e7..e964cd176 100644 --- a/classes/class_jsonrpc.rst +++ b/classes/class_jsonrpc.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/JSONRPC.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/JSONRPC.xml. .. _class_JSONRPC: diff --git a/classes/class_kinematiccollision2d.rst b/classes/class_kinematiccollision2d.rst index 02ea72795..813a76060 100644 --- a/classes/class_kinematiccollision2d.rst +++ b/classes/class_kinematiccollision2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/KinematicCollision2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/KinematicCollision2D.xml. .. _class_KinematicCollision2D: diff --git a/classes/class_kinematiccollision3d.rst b/classes/class_kinematiccollision3d.rst index c75471676..bcf5c7214 100644 --- a/classes/class_kinematiccollision3d.rst +++ b/classes/class_kinematiccollision3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/KinematicCollision3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/KinematicCollision3D.xml. .. _class_KinematicCollision3D: diff --git a/classes/class_label.rst b/classes/class_label.rst index a2fc0ea11..4017bb5ca 100644 --- a/classes/class_label.rst +++ b/classes/class_label.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Label.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Label.xml. .. _class_Label: @@ -586,6 +586,8 @@ Text outline size. \ **Note:** If using a font with :ref:`FontFile.multichannel_signed_distance_field<class_FontFile_property_multichannel_signed_distance_field>` enabled, its :ref:`FontFile.msdf_pixel_range<class_FontFile_property_msdf_pixel_range>` must be set to at least *twice* the value of :ref:`outline_size<class_Label_theme_constant_outline_size>` for outline rendering to look correct. Otherwise, the outline may appear to be cut off earlier than intended. +\ **Note:** Using a value that is larger than half the font size is not recommended, as the font outline may fail to be fully closed in this case. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_label3d.rst b/classes/class_label3d.rst index c62dd96a0..93f92ed00 100644 --- a/classes/class_label3d.rst +++ b/classes/class_label3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Label3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Label3D.xml. .. _class_Label3D: diff --git a/classes/class_labelsettings.rst b/classes/class_labelsettings.rst index 57c7a3ad6..9abfad669 100644 --- a/classes/class_labelsettings.rst +++ b/classes/class_labelsettings.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/LabelSettings.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/LabelSettings.xml. .. _class_LabelSettings: diff --git a/classes/class_light2d.rst b/classes/class_light2d.rst index 1e6df3b14..920f2aa36 100644 --- a/classes/class_light2d.rst +++ b/classes/class_light2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Light2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Light2D.xml. .. _class_Light2D: diff --git a/classes/class_light3d.rst b/classes/class_light3d.rst index a1d86de7c..0b2aab3c1 100644 --- a/classes/class_light3d.rst +++ b/classes/class_light3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Light3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Light3D.xml. .. _class_Light3D: diff --git a/classes/class_lightmapgi.rst b/classes/class_lightmapgi.rst index 9b9bf0166..67ec5ab16 100644 --- a/classes/class_lightmapgi.rst +++ b/classes/class_lightmapgi.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/LightmapGI.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/LightmapGI.xml. .. _class_LightmapGI: @@ -29,7 +29,7 @@ The **LightmapGI** node is used to compute and store baked lightmaps. Lightmaps \ **Note:** Lightmap baking on :ref:`CSGShape3D<class_CSGShape3D>`\ s and :ref:`PrimitiveMesh<class_PrimitiveMesh>`\ es is not supported, as these cannot store UV2 data required for baking. -\ **Note:** If no custom lightmappers are installed, **LightmapGI** can only be baked when using the Vulkan backend (Forward+ or Mobile), not OpenGL. +\ **Note:** If no custom lightmappers are installed, **LightmapGI** can only be baked when using the Vulkan backend (Forward+ or Mobile), not OpenGL. Additionally, **LightmapGI** rendering is not currently supported when using the OpenGL backend (Compatibility). .. rst-class:: classref-introduction-group diff --git a/classes/class_lightmapgidata.rst b/classes/class_lightmapgidata.rst index c8bbcd6fc..095947950 100644 --- a/classes/class_lightmapgidata.rst +++ b/classes/class_lightmapgidata.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/LightmapGIData.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/LightmapGIData.xml. .. _class_LightmapGIData: diff --git a/classes/class_lightmapper.rst b/classes/class_lightmapper.rst index f1546f2aa..c87367826 100644 --- a/classes/class_lightmapper.rst +++ b/classes/class_lightmapper.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Lightmapper.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Lightmapper.xml. .. _class_Lightmapper: diff --git a/classes/class_lightmapperrd.rst b/classes/class_lightmapperrd.rst index 5ab0c9f71..ebb591eac 100644 --- a/classes/class_lightmapperrd.rst +++ b/classes/class_lightmapperrd.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/LightmapperRD.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/LightmapperRD.xml. .. _class_LightmapperRD: diff --git a/classes/class_lightmapprobe.rst b/classes/class_lightmapprobe.rst index f98dbad11..455bca391 100644 --- a/classes/class_lightmapprobe.rst +++ b/classes/class_lightmapprobe.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/LightmapProbe.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/LightmapProbe.xml. .. _class_LightmapProbe: diff --git a/classes/class_lightoccluder2d.rst b/classes/class_lightoccluder2d.rst index f325c8b2d..59807264c 100644 --- a/classes/class_lightoccluder2d.rst +++ b/classes/class_lightoccluder2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/LightOccluder2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/LightOccluder2D.xml. .. _class_LightOccluder2D: diff --git a/classes/class_line2d.rst b/classes/class_line2d.rst index f2c387186..ca6120052 100644 --- a/classes/class_line2d.rst +++ b/classes/class_line2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Line2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Line2D.xml. .. _class_Line2D: diff --git a/classes/class_lineedit.rst b/classes/class_lineedit.rst index 1988cc541..f7a8b470f 100644 --- a/classes/class_lineedit.rst +++ b/classes/class_lineedit.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/LineEdit.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/LineEdit.xml. .. _class_LineEdit: diff --git a/classes/class_linkbutton.rst b/classes/class_linkbutton.rst index ed3f64313..d0fdf45f5 100644 --- a/classes/class_linkbutton.rst +++ b/classes/class_linkbutton.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/LinkButton.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/LinkButton.xml. .. _class_LinkButton: diff --git a/classes/class_mainloop.rst b/classes/class_mainloop.rst index 0033b0939..29922b39f 100644 --- a/classes/class_mainloop.rst +++ b/classes/class_mainloop.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/MainLoop.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/MainLoop.xml. .. _class_MainLoop: @@ -23,7 +23,7 @@ Description **MainLoop** is the abstract base class for a Godot project's game loop. It is inherited by :ref:`SceneTree<class_SceneTree>`, which is the default game loop implementation used in Godot projects, though it is also possible to write and use one's own **MainLoop** subclass instead of the scene tree. -Upon the application start, a **MainLoop** implementation must be provided to the OS; otherwise, the application will exit. This happens automatically (and a :ref:`SceneTree<class_SceneTree>` is created) unless a **MainLoop** :ref:`Script<class_Script>` is provided from the command line (with e.g. ``godot -s my_loop.gd`` or the "Main Loop Type" project setting is overwritten. +Upon the application start, a **MainLoop** implementation must be provided to the OS; otherwise, the application will exit. This happens automatically (and a :ref:`SceneTree<class_SceneTree>` is created) unless a **MainLoop** :ref:`Script<class_Script>` is provided from the command line (with e.g. ``godot -s my_loop.gd``) or the "Main Loop Type" project setting is overwritten. Here is an example script implementing a simple **MainLoop**: @@ -54,6 +54,7 @@ Here is an example script implementing a simple **MainLoop**: using Godot; + [GlobalClass] public partial class CustomMainLoop : MainLoop { private double _timeElapsed = 0; diff --git a/classes/class_margincontainer.rst b/classes/class_margincontainer.rst index 0e7af52d8..da87cdf55 100644 --- a/classes/class_margincontainer.rst +++ b/classes/class_margincontainer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/MarginContainer.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/MarginContainer.xml. .. _class_MarginContainer: diff --git a/classes/class_marker2d.rst b/classes/class_marker2d.rst index 431cbc5d9..2e69a9c43 100644 --- a/classes/class_marker2d.rst +++ b/classes/class_marker2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Marker2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Marker2D.xml. .. _class_Marker2D: diff --git a/classes/class_marker3d.rst b/classes/class_marker3d.rst index cafdacc28..f79920676 100644 --- a/classes/class_marker3d.rst +++ b/classes/class_marker3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Marker3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Marker3D.xml. .. _class_Marker3D: diff --git a/classes/class_marshalls.rst b/classes/class_marshalls.rst index 6ca3b1434..43c014b7a 100644 --- a/classes/class_marshalls.rst +++ b/classes/class_marshalls.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Marshalls.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Marshalls.xml. .. _class_Marshalls: diff --git a/classes/class_material.rst b/classes/class_material.rst index a29ae9964..43ba90e63 100644 --- a/classes/class_material.rst +++ b/classes/class_material.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Material.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Material.xml. .. _class_Material: diff --git a/classes/class_menubar.rst b/classes/class_menubar.rst index 5bdfdcc13..890f6b706 100644 --- a/classes/class_menubar.rst +++ b/classes/class_menubar.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/MenuBar.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/MenuBar.xml. .. _class_MenuBar: diff --git a/classes/class_menubutton.rst b/classes/class_menubutton.rst index 2aa1f0ad7..e44eb554e 100644 --- a/classes/class_menubutton.rst +++ b/classes/class_menubutton.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/MenuButton.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/MenuButton.xml. .. _class_MenuButton: diff --git a/classes/class_mesh.rst b/classes/class_mesh.rst index a3b5b79d1..5aa69301e 100644 --- a/classes/class_mesh.rst +++ b/classes/class_mesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Mesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Mesh.xml. .. _class_Mesh: @@ -229,7 +229,7 @@ enum **ArrayType**: :ref:`ArrayType<enum_Mesh_ArrayType>` **ARRAY_CUSTOM0** = ``6`` -Contains custom color channel 0. :ref:`PackedByteArray<class_PackedByteArray>` if ``(format >> Mesh.ARRAY_FORMAT_CUSTOM0_SHIFT) & Mesh.ARRAY_FORMAT_CUSTOM_MASK`` is :ref:`ARRAY_CUSTOM_RGBA8_UNORM<class_Mesh_constant_ARRAY_CUSTOM_RGBA8_UNORM>`, :ref:`ARRAY_CUSTOM_RGBA8_UNORM<class_Mesh_constant_ARRAY_CUSTOM_RGBA8_UNORM>`, :ref:`ARRAY_CUSTOM_RG_HALF<class_Mesh_constant_ARRAY_CUSTOM_RG_HALF>` or :ref:`ARRAY_CUSTOM_RGBA_HALF<class_Mesh_constant_ARRAY_CUSTOM_RGBA_HALF>`. :ref:`PackedFloat32Array<class_PackedFloat32Array>` otherwise. +Contains custom color channel 0. :ref:`PackedByteArray<class_PackedByteArray>` if ``(format >> Mesh.ARRAY_FORMAT_CUSTOM0_SHIFT) & Mesh.ARRAY_FORMAT_CUSTOM_MASK`` is :ref:`ARRAY_CUSTOM_RGBA8_UNORM<class_Mesh_constant_ARRAY_CUSTOM_RGBA8_UNORM>`, :ref:`ARRAY_CUSTOM_RGBA8_SNORM<class_Mesh_constant_ARRAY_CUSTOM_RGBA8_SNORM>`, :ref:`ARRAY_CUSTOM_RG_HALF<class_Mesh_constant_ARRAY_CUSTOM_RG_HALF>`, or :ref:`ARRAY_CUSTOM_RGBA_HALF<class_Mesh_constant_ARRAY_CUSTOM_RGBA_HALF>`. :ref:`PackedFloat32Array<class_PackedFloat32Array>` otherwise. .. _class_Mesh_constant_ARRAY_CUSTOM1: @@ -237,7 +237,7 @@ Contains custom color channel 0. :ref:`PackedByteArray<class_PackedByteArray>` i :ref:`ArrayType<enum_Mesh_ArrayType>` **ARRAY_CUSTOM1** = ``7`` -Contains custom color channel 1. :ref:`PackedByteArray<class_PackedByteArray>` if ``(format >> Mesh.ARRAY_FORMAT_CUSTOM1_SHIFT) & Mesh.ARRAY_FORMAT_CUSTOM_MASK`` is :ref:`ARRAY_CUSTOM_RGBA8_UNORM<class_Mesh_constant_ARRAY_CUSTOM_RGBA8_UNORM>`, :ref:`ARRAY_CUSTOM_RGBA8_UNORM<class_Mesh_constant_ARRAY_CUSTOM_RGBA8_UNORM>`, :ref:`ARRAY_CUSTOM_RG_HALF<class_Mesh_constant_ARRAY_CUSTOM_RG_HALF>` or :ref:`ARRAY_CUSTOM_RGBA_HALF<class_Mesh_constant_ARRAY_CUSTOM_RGBA_HALF>`. :ref:`PackedFloat32Array<class_PackedFloat32Array>` otherwise. +Contains custom color channel 1. :ref:`PackedByteArray<class_PackedByteArray>` if ``(format >> Mesh.ARRAY_FORMAT_CUSTOM1_SHIFT) & Mesh.ARRAY_FORMAT_CUSTOM_MASK`` is :ref:`ARRAY_CUSTOM_RGBA8_UNORM<class_Mesh_constant_ARRAY_CUSTOM_RGBA8_UNORM>`, :ref:`ARRAY_CUSTOM_RGBA8_SNORM<class_Mesh_constant_ARRAY_CUSTOM_RGBA8_SNORM>`, :ref:`ARRAY_CUSTOM_RG_HALF<class_Mesh_constant_ARRAY_CUSTOM_RG_HALF>`, or :ref:`ARRAY_CUSTOM_RGBA_HALF<class_Mesh_constant_ARRAY_CUSTOM_RGBA_HALF>`. :ref:`PackedFloat32Array<class_PackedFloat32Array>` otherwise. .. _class_Mesh_constant_ARRAY_CUSTOM2: @@ -245,7 +245,7 @@ Contains custom color channel 1. :ref:`PackedByteArray<class_PackedByteArray>` i :ref:`ArrayType<enum_Mesh_ArrayType>` **ARRAY_CUSTOM2** = ``8`` -Contains custom color channel 2. :ref:`PackedByteArray<class_PackedByteArray>` if ``(format >> Mesh.ARRAY_FORMAT_CUSTOM2_SHIFT) & Mesh.ARRAY_FORMAT_CUSTOM_MASK`` is :ref:`ARRAY_CUSTOM_RGBA8_UNORM<class_Mesh_constant_ARRAY_CUSTOM_RGBA8_UNORM>`, :ref:`ARRAY_CUSTOM_RGBA8_UNORM<class_Mesh_constant_ARRAY_CUSTOM_RGBA8_UNORM>`, :ref:`ARRAY_CUSTOM_RG_HALF<class_Mesh_constant_ARRAY_CUSTOM_RG_HALF>` or :ref:`ARRAY_CUSTOM_RGBA_HALF<class_Mesh_constant_ARRAY_CUSTOM_RGBA_HALF>`. :ref:`PackedFloat32Array<class_PackedFloat32Array>` otherwise. +Contains custom color channel 2. :ref:`PackedByteArray<class_PackedByteArray>` if ``(format >> Mesh.ARRAY_FORMAT_CUSTOM2_SHIFT) & Mesh.ARRAY_FORMAT_CUSTOM_MASK`` is :ref:`ARRAY_CUSTOM_RGBA8_UNORM<class_Mesh_constant_ARRAY_CUSTOM_RGBA8_UNORM>`, :ref:`ARRAY_CUSTOM_RGBA8_SNORM<class_Mesh_constant_ARRAY_CUSTOM_RGBA8_SNORM>`, :ref:`ARRAY_CUSTOM_RG_HALF<class_Mesh_constant_ARRAY_CUSTOM_RG_HALF>`, or :ref:`ARRAY_CUSTOM_RGBA_HALF<class_Mesh_constant_ARRAY_CUSTOM_RGBA_HALF>`. :ref:`PackedFloat32Array<class_PackedFloat32Array>` otherwise. .. _class_Mesh_constant_ARRAY_CUSTOM3: @@ -253,7 +253,7 @@ Contains custom color channel 2. :ref:`PackedByteArray<class_PackedByteArray>` i :ref:`ArrayType<enum_Mesh_ArrayType>` **ARRAY_CUSTOM3** = ``9`` -Contains custom color channel 3. :ref:`PackedByteArray<class_PackedByteArray>` if ``(format >> Mesh.ARRAY_FORMAT_CUSTOM3_SHIFT) & Mesh.ARRAY_FORMAT_CUSTOM_MASK`` is :ref:`ARRAY_CUSTOM_RGBA8_UNORM<class_Mesh_constant_ARRAY_CUSTOM_RGBA8_UNORM>`, :ref:`ARRAY_CUSTOM_RGBA8_UNORM<class_Mesh_constant_ARRAY_CUSTOM_RGBA8_UNORM>`, :ref:`ARRAY_CUSTOM_RG_HALF<class_Mesh_constant_ARRAY_CUSTOM_RG_HALF>` or :ref:`ARRAY_CUSTOM_RGBA_HALF<class_Mesh_constant_ARRAY_CUSTOM_RGBA_HALF>`. :ref:`PackedFloat32Array<class_PackedFloat32Array>` otherwise. +Contains custom color channel 3. :ref:`PackedByteArray<class_PackedByteArray>` if ``(format >> Mesh.ARRAY_FORMAT_CUSTOM3_SHIFT) & Mesh.ARRAY_FORMAT_CUSTOM_MASK`` is :ref:`ARRAY_CUSTOM_RGBA8_UNORM<class_Mesh_constant_ARRAY_CUSTOM_RGBA8_UNORM>`, :ref:`ARRAY_CUSTOM_RGBA8_SNORM<class_Mesh_constant_ARRAY_CUSTOM_RGBA8_SNORM>`, :ref:`ARRAY_CUSTOM_RG_HALF<class_Mesh_constant_ARRAY_CUSTOM_RG_HALF>`, or :ref:`ARRAY_CUSTOM_RGBA_HALF<class_Mesh_constant_ARRAY_CUSTOM_RGBA_HALF>`. :ref:`PackedFloat32Array<class_PackedFloat32Array>` otherwise. .. _class_Mesh_constant_ARRAY_BONES: diff --git a/classes/class_meshconvexdecompositionsettings.rst b/classes/class_meshconvexdecompositionsettings.rst index c1c6ab045..32fe2fdd8 100644 --- a/classes/class_meshconvexdecompositionsettings.rst +++ b/classes/class_meshconvexdecompositionsettings.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/MeshConvexDecompositionSettings.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/MeshConvexDecompositionSettings.xml. .. _class_MeshConvexDecompositionSettings: diff --git a/classes/class_meshdatatool.rst b/classes/class_meshdatatool.rst index 57e131bee..2d87573e3 100644 --- a/classes/class_meshdatatool.rst +++ b/classes/class_meshdatatool.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/MeshDataTool.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/MeshDataTool.xml. .. _class_MeshDataTool: diff --git a/classes/class_meshinstance2d.rst b/classes/class_meshinstance2d.rst index 5cf3f8028..1f692b82c 100644 --- a/classes/class_meshinstance2d.rst +++ b/classes/class_meshinstance2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/MeshInstance2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/MeshInstance2D.xml. .. _class_MeshInstance2D: diff --git a/classes/class_meshinstance3d.rst b/classes/class_meshinstance3d.rst index 3b6b53db8..f2fbade50 100644 --- a/classes/class_meshinstance3d.rst +++ b/classes/class_meshinstance3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/MeshInstance3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/MeshInstance3D.xml. .. _class_MeshInstance3D: diff --git a/classes/class_meshlibrary.rst b/classes/class_meshlibrary.rst index 432fc444b..14b2773db 100644 --- a/classes/class_meshlibrary.rst +++ b/classes/class_meshlibrary.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/MeshLibrary.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/MeshLibrary.xml. .. _class_MeshLibrary: diff --git a/classes/class_meshtexture.rst b/classes/class_meshtexture.rst index dbfe9014f..f08fc71b5 100644 --- a/classes/class_meshtexture.rst +++ b/classes/class_meshtexture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/MeshTexture.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/MeshTexture.xml. .. _class_MeshTexture: diff --git a/classes/class_methodtweener.rst b/classes/class_methodtweener.rst index 9ddaff0c3..14596f424 100644 --- a/classes/class_methodtweener.rst +++ b/classes/class_methodtweener.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/MethodTweener.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/MethodTweener.xml. .. _class_MethodTweener: diff --git a/classes/class_missingnode.rst b/classes/class_missingnode.rst index f1a5d9a88..a022dbac0 100644 --- a/classes/class_missingnode.rst +++ b/classes/class_missingnode.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/MissingNode.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/MissingNode.xml. .. _class_MissingNode: diff --git a/classes/class_missingresource.rst b/classes/class_missingresource.rst index 3e3985041..0d9acb054 100644 --- a/classes/class_missingresource.rst +++ b/classes/class_missingresource.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/MissingResource.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/MissingResource.xml. .. _class_MissingResource: diff --git a/classes/class_mobilevrinterface.rst b/classes/class_mobilevrinterface.rst index b1324bbb5..1652125e0 100644 --- a/classes/class_mobilevrinterface.rst +++ b/classes/class_mobilevrinterface.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/mobile_vr/doc_classes/MobileVRInterface.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/mobile_vr/doc_classes/MobileVRInterface.xml. .. _class_MobileVRInterface: diff --git a/classes/class_moviewriter.rst b/classes/class_moviewriter.rst index 811480cc8..edeec94a4 100644 --- a/classes/class_moviewriter.rst +++ b/classes/class_moviewriter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/MovieWriter.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/MovieWriter.xml. .. _class_MovieWriter: diff --git a/classes/class_multimesh.rst b/classes/class_multimesh.rst index c8c78e7d8..2e9bc07a1 100644 --- a/classes/class_multimesh.rst +++ b/classes/class_multimesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/MultiMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/MultiMesh.xml. .. _class_MultiMesh: diff --git a/classes/class_multimeshinstance2d.rst b/classes/class_multimeshinstance2d.rst index e30a8c4cc..1d9318441 100644 --- a/classes/class_multimeshinstance2d.rst +++ b/classes/class_multimeshinstance2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/MultiMeshInstance2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/MultiMeshInstance2D.xml. .. _class_MultiMeshInstance2D: diff --git a/classes/class_multimeshinstance3d.rst b/classes/class_multimeshinstance3d.rst index 4fd271413..22a9d714f 100644 --- a/classes/class_multimeshinstance3d.rst +++ b/classes/class_multimeshinstance3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/MultiMeshInstance3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/MultiMeshInstance3D.xml. .. _class_MultiMeshInstance3D: diff --git a/classes/class_multiplayerapi.rst b/classes/class_multiplayerapi.rst index 850a9eba0..f3cd11942 100644 --- a/classes/class_multiplayerapi.rst +++ b/classes/class_multiplayerapi.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/MultiplayerAPI.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/MultiplayerAPI.xml. .. _class_MultiplayerAPI: diff --git a/classes/class_multiplayerapiextension.rst b/classes/class_multiplayerapiextension.rst index aabc97337..fdf2836ca 100644 --- a/classes/class_multiplayerapiextension.rst +++ b/classes/class_multiplayerapiextension.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/MultiplayerAPIExtension.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/MultiplayerAPIExtension.xml. .. _class_MultiplayerAPIExtension: diff --git a/classes/class_multiplayerpeer.rst b/classes/class_multiplayerpeer.rst index a526e6618..07ba00973 100644 --- a/classes/class_multiplayerpeer.rst +++ b/classes/class_multiplayerpeer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/MultiplayerPeer.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/MultiplayerPeer.xml. .. _class_MultiplayerPeer: diff --git a/classes/class_multiplayerpeerextension.rst b/classes/class_multiplayerpeerextension.rst index 2cbbcade0..8706c3530 100644 --- a/classes/class_multiplayerpeerextension.rst +++ b/classes/class_multiplayerpeerextension.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/MultiplayerPeerExtension.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/MultiplayerPeerExtension.xml. .. _class_MultiplayerPeerExtension: diff --git a/classes/class_multiplayerspawner.rst b/classes/class_multiplayerspawner.rst index d6696ebc5..507a13696 100644 --- a/classes/class_multiplayerspawner.rst +++ b/classes/class_multiplayerspawner.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/multiplayer/doc_classes/MultiplayerSpawner.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/multiplayer/doc_classes/MultiplayerSpawner.xml. .. _class_MultiplayerSpawner: diff --git a/classes/class_multiplayersynchronizer.rst b/classes/class_multiplayersynchronizer.rst index 4c0580999..86899fe71 100644 --- a/classes/class_multiplayersynchronizer.rst +++ b/classes/class_multiplayersynchronizer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/multiplayer/doc_classes/MultiplayerSynchronizer.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/multiplayer/doc_classes/MultiplayerSynchronizer.xml. .. _class_MultiplayerSynchronizer: diff --git a/classes/class_mutex.rst b/classes/class_mutex.rst index 869ae6097..e704602e2 100644 --- a/classes/class_mutex.rst +++ b/classes/class_mutex.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Mutex.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Mutex.xml. .. _class_Mutex: diff --git a/classes/class_navigationagent2d.rst b/classes/class_navigationagent2d.rst index c9dbd0af4..e5c2ca604 100644 --- a/classes/class_navigationagent2d.rst +++ b/classes/class_navigationagent2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/NavigationAgent2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/NavigationAgent2D.xml. .. _class_NavigationAgent2D: diff --git a/classes/class_navigationagent3d.rst b/classes/class_navigationagent3d.rst index abcba3bae..70b32c7b8 100644 --- a/classes/class_navigationagent3d.rst +++ b/classes/class_navigationagent3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/NavigationAgent3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/NavigationAgent3D.xml. .. _class_NavigationAgent3D: diff --git a/classes/class_navigationlink2d.rst b/classes/class_navigationlink2d.rst index d7da9c51b..f47c89b84 100644 --- a/classes/class_navigationlink2d.rst +++ b/classes/class_navigationlink2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/NavigationLink2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/NavigationLink2D.xml. .. _class_NavigationLink2D: @@ -67,6 +67,8 @@ Methods +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool<class_bool>` | :ref:`get_navigation_layer_value<class_NavigationLink2D_method_get_navigation_layer_value>` **(** :ref:`int<class_int>` layer_number **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID<class_RID>` | :ref:`get_rid<class_NavigationLink2D_method_get_rid>` **(** **)** |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_global_end_position<class_NavigationLink2D_method_set_global_end_position>` **(** :ref:`Vector2<class_Vector2>` position **)** | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_global_start_position<class_NavigationLink2D_method_set_global_start_position>` **(** :ref:`Vector2<class_Vector2>` position **)** | @@ -251,6 +253,18 @@ Returns whether or not the specified layer of the :ref:`navigation_layers<class_ ---- +.. _class_NavigationLink2D_method_get_rid: + +.. rst-class:: classref-method + +:ref:`RID<class_RID>` **get_rid** **(** **)** |const| + +Returns the :ref:`RID<class_RID>` of this link on the :ref:`NavigationServer2D<class_NavigationServer2D>`. + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationLink2D_method_set_global_end_position: .. rst-class:: classref-method diff --git a/classes/class_navigationlink3d.rst b/classes/class_navigationlink3d.rst index 9ed2fb436..c6ef6ea92 100644 --- a/classes/class_navigationlink3d.rst +++ b/classes/class_navigationlink3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/NavigationLink3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/NavigationLink3D.xml. .. _class_NavigationLink3D: @@ -67,6 +67,8 @@ Methods +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool<class_bool>` | :ref:`get_navigation_layer_value<class_NavigationLink3D_method_get_navigation_layer_value>` **(** :ref:`int<class_int>` layer_number **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID<class_RID>` | :ref:`get_rid<class_NavigationLink3D_method_get_rid>` **(** **)** |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_global_end_position<class_NavigationLink3D_method_set_global_end_position>` **(** :ref:`Vector3<class_Vector3>` position **)** | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_global_start_position<class_NavigationLink3D_method_set_global_start_position>` **(** :ref:`Vector3<class_Vector3>` position **)** | @@ -251,6 +253,18 @@ Returns whether or not the specified layer of the :ref:`navigation_layers<class_ ---- +.. _class_NavigationLink3D_method_get_rid: + +.. rst-class:: classref-method + +:ref:`RID<class_RID>` **get_rid** **(** **)** |const| + +Returns the :ref:`RID<class_RID>` of this link on the :ref:`NavigationServer3D<class_NavigationServer3D>`. + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationLink3D_method_set_global_end_position: .. rst-class:: classref-method diff --git a/classes/class_navigationmesh.rst b/classes/class_navigationmesh.rst index ba9bc496b..36999fcaf 100644 --- a/classes/class_navigationmesh.rst +++ b/classes/class_navigationmesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/NavigationMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/NavigationMesh.xml. .. _class_NavigationMesh: diff --git a/classes/class_navigationmeshgenerator.rst b/classes/class_navigationmeshgenerator.rst index 78966926d..025788636 100644 --- a/classes/class_navigationmeshgenerator.rst +++ b/classes/class_navigationmeshgenerator.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/NavigationMeshGenerator.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/NavigationMeshGenerator.xml. .. _class_NavigationMeshGenerator: diff --git a/classes/class_navigationmeshsourcegeometrydata2d.rst b/classes/class_navigationmeshsourcegeometrydata2d.rst index ea0e2c246..6a0497677 100644 --- a/classes/class_navigationmeshsourcegeometrydata2d.rst +++ b/classes/class_navigationmeshsourcegeometrydata2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/NavigationMeshSourceGeometryData2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/NavigationMeshSourceGeometryData2D.xml. .. _class_NavigationMeshSourceGeometryData2D: diff --git a/classes/class_navigationmeshsourcegeometrydata3d.rst b/classes/class_navigationmeshsourcegeometrydata3d.rst index 5bb0deb08..762a02169 100644 --- a/classes/class_navigationmeshsourcegeometrydata3d.rst +++ b/classes/class_navigationmeshsourcegeometrydata3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/NavigationMeshSourceGeometryData3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/NavigationMeshSourceGeometryData3D.xml. .. _class_NavigationMeshSourceGeometryData3D: diff --git a/classes/class_navigationobstacle2d.rst b/classes/class_navigationobstacle2d.rst index ed1e89c33..4144656d9 100644 --- a/classes/class_navigationobstacle2d.rst +++ b/classes/class_navigationobstacle2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/NavigationObstacle2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/NavigationObstacle2D.xml. .. _class_NavigationObstacle2D: diff --git a/classes/class_navigationobstacle3d.rst b/classes/class_navigationobstacle3d.rst index bd092645d..5dc6d46be 100644 --- a/classes/class_navigationobstacle3d.rst +++ b/classes/class_navigationobstacle3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/NavigationObstacle3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/NavigationObstacle3D.xml. .. _class_NavigationObstacle3D: diff --git a/classes/class_navigationpathqueryparameters2d.rst b/classes/class_navigationpathqueryparameters2d.rst index 9e53a5bde..6efd201c5 100644 --- a/classes/class_navigationpathqueryparameters2d.rst +++ b/classes/class_navigationpathqueryparameters2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/NavigationPathQueryParameters2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/NavigationPathQueryParameters2D.xml. .. _class_NavigationPathQueryParameters2D: diff --git a/classes/class_navigationpathqueryparameters3d.rst b/classes/class_navigationpathqueryparameters3d.rst index a83be6de5..06c0720d7 100644 --- a/classes/class_navigationpathqueryparameters3d.rst +++ b/classes/class_navigationpathqueryparameters3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/NavigationPathQueryParameters3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/NavigationPathQueryParameters3D.xml. .. _class_NavigationPathQueryParameters3D: diff --git a/classes/class_navigationpathqueryresult2d.rst b/classes/class_navigationpathqueryresult2d.rst index bce6999c3..cdf9a25ea 100644 --- a/classes/class_navigationpathqueryresult2d.rst +++ b/classes/class_navigationpathqueryresult2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/NavigationPathQueryResult2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/NavigationPathQueryResult2D.xml. .. _class_NavigationPathQueryResult2D: diff --git a/classes/class_navigationpathqueryresult3d.rst b/classes/class_navigationpathqueryresult3d.rst index 13067bad9..b91b082b8 100644 --- a/classes/class_navigationpathqueryresult3d.rst +++ b/classes/class_navigationpathqueryresult3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/NavigationPathQueryResult3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/NavigationPathQueryResult3D.xml. .. _class_NavigationPathQueryResult3D: diff --git a/classes/class_navigationpolygon.rst b/classes/class_navigationpolygon.rst index ccf7cce51..31e198110 100644 --- a/classes/class_navigationpolygon.rst +++ b/classes/class_navigationpolygon.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/NavigationPolygon.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/NavigationPolygon.xml. .. _class_NavigationPolygon: diff --git a/classes/class_navigationregion2d.rst b/classes/class_navigationregion2d.rst index 23624ff31..ec222bb93 100644 --- a/classes/class_navigationregion2d.rst +++ b/classes/class_navigationregion2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/NavigationRegion2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/NavigationRegion2D.xml. .. _class_NavigationRegion2D: @@ -85,6 +85,8 @@ Methods +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID<class_RID>` | :ref:`get_region_rid<class_NavigationRegion2D_method_get_region_rid>` **(** **)** |const| | +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID<class_RID>` | :ref:`get_rid<class_NavigationRegion2D_method_get_rid>` **(** **)** |const| | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_avoidance_layer_value<class_NavigationRegion2D_method_set_avoidance_layer_value>` **(** :ref:`int<class_int>` layer_number, :ref:`bool<class_bool>` value **)** | +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_navigation_layer_value<class_NavigationRegion2D_method_set_navigation_layer_value>` **(** :ref:`int<class_int>` layer_number, :ref:`bool<class_bool>` value **)** | @@ -327,6 +329,20 @@ Returns the current navigation map :ref:`RID<class_RID>` used by this region. :ref:`RID<class_RID>` **get_region_rid** **(** **)** |const| +Returns the :ref:`RID<class_RID>` of this region on the :ref:`NavigationServer2D<class_NavigationServer2D>`. + +\ *Deprecated.* Use :ref:`get_rid<class_NavigationRegion2D_method_get_rid>` instead. + +.. rst-class:: classref-item-separator + +---- + +.. _class_NavigationRegion2D_method_get_rid: + +.. rst-class:: classref-method + +:ref:`RID<class_RID>` **get_rid** **(** **)** |const| + Returns the :ref:`RID<class_RID>` of this region on the :ref:`NavigationServer2D<class_NavigationServer2D>`. Combined with :ref:`NavigationServer2D.map_get_closest_point_owner<class_NavigationServer2D_method_map_get_closest_point_owner>` can be used to identify the **NavigationRegion2D** closest to a point on the merged navigation map. .. rst-class:: classref-item-separator diff --git a/classes/class_navigationregion3d.rst b/classes/class_navigationregion3d.rst index d600a0f93..d71982dad 100644 --- a/classes/class_navigationregion3d.rst +++ b/classes/class_navigationregion3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/NavigationRegion3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/NavigationRegion3D.xml. .. _class_NavigationRegion3D: @@ -79,6 +79,8 @@ Methods +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID<class_RID>` | :ref:`get_region_rid<class_NavigationRegion3D_method_get_region_rid>` **(** **)** |const| | +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID<class_RID>` | :ref:`get_rid<class_NavigationRegion3D_method_get_rid>` **(** **)** |const| | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_navigation_layer_value<class_NavigationRegion3D_method_set_navigation_layer_value>` **(** :ref:`int<class_int>` layer_number, :ref:`bool<class_bool>` value **)** | +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_navigation_map<class_NavigationRegion3D_method_set_navigation_map>` **(** :ref:`RID<class_RID>` navigation_map **)** | @@ -271,6 +273,20 @@ Returns the current navigation map :ref:`RID<class_RID>` used by this region. :ref:`RID<class_RID>` **get_region_rid** **(** **)** |const| +Returns the :ref:`RID<class_RID>` of this region on the :ref:`NavigationServer3D<class_NavigationServer3D>`. + +\ *Deprecated.* Use :ref:`get_rid<class_NavigationRegion3D_method_get_rid>` instead. + +.. rst-class:: classref-item-separator + +---- + +.. _class_NavigationRegion3D_method_get_rid: + +.. rst-class:: classref-method + +:ref:`RID<class_RID>` **get_rid** **(** **)** |const| + Returns the :ref:`RID<class_RID>` of this region on the :ref:`NavigationServer3D<class_NavigationServer3D>`. Combined with :ref:`NavigationServer3D.map_get_closest_point_owner<class_NavigationServer3D_method_map_get_closest_point_owner>` can be used to identify the **NavigationRegion3D** closest to a point on the merged navigation map. .. rst-class:: classref-item-separator diff --git a/classes/class_navigationserver2d.rst b/classes/class_navigationserver2d.rst index 19efc01bb..d61a76677 100644 --- a/classes/class_navigationserver2d.rst +++ b/classes/class_navigationserver2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/NavigationServer2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/NavigationServer2D.xml. .. _class_NavigationServer2D: @@ -858,7 +858,7 @@ This function immediately forces synchronization of the specified navigation ``m Due to technical restrictions the current NavigationServer command queue will be flushed. This means all already queued update commands for this physics frame will be executed, even those intended for other maps, regions and agents not part of the specified map. The expensive computation of the navigation meshes and region connections of a map will only be done for the specified map. Other maps will receive the normal synchronization at the end of the physics frame. Should the specified map receive changes after the forced update it will update again as well when the other maps receive their update. -Avoidance processing and dispatch of the ``safe_velocity`` signals is untouched by this function and continues to happen for all maps and agents at the end of the physics frame. +Avoidance processing and dispatch of the ``safe_velocity`` signals is unaffected by this function and continues to happen for all maps and agents at the end of the physics frame. \ **Note:** With great power comes great responsibility. This function should only be used by users that really know what they are doing and have a good reason for it. Forcing an immediate update of a navigation map requires locking the NavigationServer and flushing the entire NavigationServer command queue. Not only can this severely impact the performance of a game but it can also introduce bugs if used inappropriately without much foresight. diff --git a/classes/class_navigationserver3d.rst b/classes/class_navigationserver3d.rst index 6f1338dff..ed18ca009 100644 --- a/classes/class_navigationserver3d.rst +++ b/classes/class_navigationserver3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/NavigationServer3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/NavigationServer3D.xml. .. _class_NavigationServer3D: @@ -685,7 +685,7 @@ void **agent_set_use_3d_avoidance** **(** :ref:`RID<class_RID>` agent, :ref:`boo Sets if the agent uses the 2D avoidance or the 3D avoidance while avoidance is enabled. -If ``true`` the agent calculates avoidance velocities in 3D for the xyz-axis, e.g. for games that take place in air, unterwater or space. The 3D using agent only avoids other 3D avoidance using agent's. The 3D using agent only reacts to radius based avoidance obstacles. The 3D using agent ignores any vertices based obstacles. The 3D using agent only avoids other 3D using agent's. +If ``true`` the agent calculates avoidance velocities in 3D for the xyz-axis, e.g. for games that take place in air, underwater or space. The 3D using agent only avoids other 3D avoidance using agent's. The 3D using agent only reacts to radius based avoidance obstacles. The 3D using agent ignores any vertices based obstacles. The 3D using agent only avoids other 3D using agent's. If ``false`` the agent calculates avoidance velocities in 2D along the xz-axis ignoring the y-axis. The 2D using agent only avoids other 2D avoidance using agent's. The 2D using agent reacts to radius avoidance obstacles. The 2D using agent reacts to vertices based avoidance obstacles. The 2D using agent only avoids other 2D using agent's. 2D using agents will ignore other 2D using agents or obstacles that are below their current position or above their current position including the agents height in 2D avoidance. @@ -1039,7 +1039,7 @@ This function immediately forces synchronization of the specified navigation ``m Due to technical restrictions the current NavigationServer command queue will be flushed. This means all already queued update commands for this physics frame will be executed, even those intended for other maps, regions and agents not part of the specified map. The expensive computation of the navigation meshes and region connections of a map will only be done for the specified map. Other maps will receive the normal synchronization at the end of the physics frame. Should the specified map receive changes after the forced update it will update again as well when the other maps receive their update. -Avoidance processing and dispatch of the ``safe_velocity`` signals is untouched by this function and continues to happen for all maps and agents at the end of the physics frame. +Avoidance processing and dispatch of the ``safe_velocity`` signals is unaffected by this function and continues to happen for all maps and agents at the end of the physics frame. \ **Note:** With great power comes great responsibility. This function should only be used by users that really know what they are doing and have a good reason for it. Forcing an immediate update of a navigation map requires locking the NavigationServer and flushing the entire NavigationServer command queue. Not only can this severely impact the performance of a game but it can also introduce bugs if used inappropriately without much foresight. diff --git a/classes/class_ninepatchrect.rst b/classes/class_ninepatchrect.rst index 14219a4a5..6c9507bd9 100644 --- a/classes/class_ninepatchrect.rst +++ b/classes/class_ninepatchrect.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/NinePatchRect.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/NinePatchRect.xml. .. _class_NinePatchRect: diff --git a/classes/class_node.rst b/classes/class_node.rst index e95fc85fe..0090c0bc6 100644 --- a/classes/class_node.rst +++ b/classes/class_node.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Node.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Node.xml. .. _class_Node: @@ -35,7 +35,7 @@ This means that when adding a node to the scene tree, the following order will b Nodes can also process input events. When present, the :ref:`_input<class_Node_private_method__input>` function will be called for each input that the program receives. In many cases, this can be overkill (unless used for simple projects), and the :ref:`_unhandled_input<class_Node_private_method__unhandled_input>` function might be preferred; it is called when the input event was not handled by anyone else (typically, GUI :ref:`Control<class_Control>` nodes), ensuring that the node only receives the events that were meant for it. -To keep track of the scene hierarchy (especially when instancing scenes into other scenes), an "owner" can be set for the node with the :ref:`owner<class_Node_property_owner>` property. This keeps track of who instantiated what. This is mostly useful when writing editors and tools, though. +To keep track of the scene hierarchy (especially when instantiating scenes into other scenes), an "owner" can be set for the node with the :ref:`owner<class_Node_property_owner>` property. This keeps track of who instantiated what. This is mostly useful when writing editors and tools, though. Finally, when a node is freed with :ref:`Object.free<class_Object_method_free>` or :ref:`queue_free<class_Node_method_queue_free>`, it will also free all its children. @@ -43,7 +43,7 @@ Finally, when a node is freed with :ref:`Object.free<class_Object_method_free>` \ **Networking with nodes:** After connecting to a server (or making one, see :ref:`ENetMultiplayerPeer<class_ENetMultiplayerPeer>`), it is possible to use the built-in RPC (remote procedure call) system to communicate over the network. By calling :ref:`rpc<class_Node_method_rpc>` with a method name, it will be called locally and in all connected peers (peers = clients and the server that accepts connections). To identify which node receives the RPC call, Godot will use its :ref:`NodePath<class_NodePath>` (make sure node names are the same on all peers). Also, take a look at the high-level networking tutorial and corresponding demos. -\ **Note:** The ``script`` property is part of the :ref:`Object<class_Object>` class, not **Node**. It isn't exposed like most properties but does have a setter and getter (``set_script()`` and ``get_script()``). +\ **Note:** The ``script`` property is part of the :ref:`Object<class_Object>` class, not **Node**. It isn't exposed like most properties but does have a setter and getter (see :ref:`Object.set_script<class_Object_method_set_script>` and :ref:`Object.get_script<class_Object_method_get_script>`). .. rst-class:: classref-introduction-group @@ -297,7 +297,7 @@ Signals **child_entered_tree** **(** :ref:`Node<class_Node>` node **)** -Emitted when a child node enters the scene tree, either because it entered on its own or because this node entered with it. +Emitted when the child ``node`` enters the :ref:`SceneTree<class_SceneTree>`, usually because this node entered the tree (see :ref:`tree_entered<class_Node_signal_tree_entered>`), or :ref:`add_child<class_Node_method_add_child>` has been called. This signal is emitted *after* the child node's own :ref:`NOTIFICATION_ENTER_TREE<class_Node_constant_NOTIFICATION_ENTER_TREE>` and :ref:`tree_entered<class_Node_signal_tree_entered>`. @@ -311,9 +311,9 @@ This signal is emitted *after* the child node's own :ref:`NOTIFICATION_ENTER_TRE **child_exiting_tree** **(** :ref:`Node<class_Node>` node **)** -Emitted when a child node is about to exit the scene tree, either because it is being removed or freed directly, or because this node is exiting the tree. +Emitted when the child ``node`` is about to exit the :ref:`SceneTree<class_SceneTree>`, usually because this node is exiting the tree (see :ref:`tree_exiting<class_Node_signal_tree_exiting>`), or because the child ``node`` is being removed or freed. -When this signal is received, the child ``node`` is still in the tree and valid. This signal is emitted *after* the child node's own :ref:`tree_exiting<class_Node_signal_tree_exiting>` and :ref:`NOTIFICATION_EXIT_TREE<class_Node_constant_NOTIFICATION_EXIT_TREE>`. +When this signal is received, the child ``node`` is still accessible inside the tree. This signal is emitted *after* the child node's own :ref:`tree_exiting<class_Node_signal_tree_exiting>` and :ref:`NOTIFICATION_EXIT_TREE<class_Node_constant_NOTIFICATION_EXIT_TREE>`. .. rst-class:: classref-item-separator @@ -337,7 +337,7 @@ Emitted when the list of children is changed. This happens when child nodes are **ready** **(** **)** -Emitted when the node is ready. Comes after :ref:`_ready<class_Node_private_method__ready>` callback and follows the same rules. +Emitted when the node is considered ready, after :ref:`_ready<class_Node_private_method__ready>` is called. .. rst-class:: classref-item-separator @@ -349,7 +349,7 @@ Emitted when the node is ready. Comes after :ref:`_ready<class_Node_private_meth **renamed** **(** **)** -Emitted when the node is renamed. +Emitted when the node's :ref:`name<class_Node_property_name>` is changed, if the node is inside the tree. .. rst-class:: classref-item-separator @@ -391,6 +391,8 @@ This signal is emitted *after* the related :ref:`NOTIFICATION_ENTER_TREE<class_N Emitted after the node exits the tree and is no longer active. +This signal is emitted *after* the related :ref:`NOTIFICATION_EXIT_TREE<class_Node_constant_NOTIFICATION_EXIT_TREE>` notification. + .. rst-class:: classref-item-separator ---- @@ -401,9 +403,9 @@ Emitted after the node exits the tree and is no longer active. **tree_exiting** **(** **)** -Emitted when the node is still active but about to exit the tree. This is the right place for de-initialization (or a "destructor", if you will). +Emitted when the node is just about to exit the tree. The node is still valid. As such, this is the right place for de-initialization (or a "destructor", if you will). -This signal is emitted *before* the related :ref:`NOTIFICATION_EXIT_TREE<class_Node_constant_NOTIFICATION_EXIT_TREE>` notification. +This signal is emitted *after* the node's :ref:`_exit_tree<class_Node_private_method__exit_tree>`, and *before* the related :ref:`NOTIFICATION_EXIT_TREE<class_Node_constant_NOTIFICATION_EXIT_TREE>`. .. rst-class:: classref-section-separator @@ -426,7 +428,7 @@ enum **ProcessMode**: :ref:`ProcessMode<enum_Node_ProcessMode>` **PROCESS_MODE_INHERIT** = ``0`` -Inherits process mode from the node's parent. For the root node, it is equivalent to :ref:`PROCESS_MODE_PAUSABLE<class_Node_constant_PROCESS_MODE_PAUSABLE>`. Default. +Inherits :ref:`process_mode<class_Node_property_process_mode>` from the node's parent. For the root node, it is equivalent to :ref:`PROCESS_MODE_PAUSABLE<class_Node_constant_PROCESS_MODE_PAUSABLE>`. This is the default for any newly created node. .. _class_Node_constant_PROCESS_MODE_PAUSABLE: @@ -434,7 +436,7 @@ Inherits process mode from the node's parent. For the root node, it is equivalen :ref:`ProcessMode<enum_Node_ProcessMode>` **PROCESS_MODE_PAUSABLE** = ``1`` -Stops processing when the :ref:`SceneTree<class_SceneTree>` is paused (process when unpaused). This is the inverse of :ref:`PROCESS_MODE_WHEN_PAUSED<class_Node_constant_PROCESS_MODE_WHEN_PAUSED>`. +Stops processing when :ref:`SceneTree.paused<class_SceneTree_property_paused>` is ``true``. This is the inverse of :ref:`PROCESS_MODE_WHEN_PAUSED<class_Node_constant_PROCESS_MODE_WHEN_PAUSED>`. .. _class_Node_constant_PROCESS_MODE_WHEN_PAUSED: @@ -442,7 +444,7 @@ Stops processing when the :ref:`SceneTree<class_SceneTree>` is paused (process w :ref:`ProcessMode<enum_Node_ProcessMode>` **PROCESS_MODE_WHEN_PAUSED** = ``2`` -Only process when the :ref:`SceneTree<class_SceneTree>` is paused (don't process when unpaused). This is the inverse of :ref:`PROCESS_MODE_PAUSABLE<class_Node_constant_PROCESS_MODE_PAUSABLE>`. +Process **only** when :ref:`SceneTree.paused<class_SceneTree_property_paused>` is ``true``. This is the inverse of :ref:`PROCESS_MODE_PAUSABLE<class_Node_constant_PROCESS_MODE_PAUSABLE>`. .. _class_Node_constant_PROCESS_MODE_ALWAYS: @@ -450,7 +452,7 @@ Only process when the :ref:`SceneTree<class_SceneTree>` is paused (don't process :ref:`ProcessMode<enum_Node_ProcessMode>` **PROCESS_MODE_ALWAYS** = ``3`` -Always process. Continue processing always, ignoring the :ref:`SceneTree<class_SceneTree>`'s paused property. This is the inverse of :ref:`PROCESS_MODE_DISABLED<class_Node_constant_PROCESS_MODE_DISABLED>`. +Always process. Keeps processing, ignoring :ref:`SceneTree.paused<class_SceneTree_property_paused>`. This is the inverse of :ref:`PROCESS_MODE_DISABLED<class_Node_constant_PROCESS_MODE_DISABLED>`. .. _class_Node_constant_PROCESS_MODE_DISABLED: @@ -458,7 +460,7 @@ Always process. Continue processing always, ignoring the :ref:`SceneTree<class_S :ref:`ProcessMode<enum_Node_ProcessMode>` **PROCESS_MODE_DISABLED** = ``4`` -Never process. Completely disables processing, ignoring the :ref:`SceneTree<class_SceneTree>`'s paused property. This is the inverse of :ref:`PROCESS_MODE_ALWAYS<class_Node_constant_PROCESS_MODE_ALWAYS>`. +Never process. Completely disables processing, ignoring :ref:`SceneTree.paused<class_SceneTree_property_paused>`. This is the inverse of :ref:`PROCESS_MODE_ALWAYS<class_Node_constant_PROCESS_MODE_ALWAYS>`. .. rst-class:: classref-item-separator @@ -476,7 +478,7 @@ enum **ProcessThreadGroup**: :ref:`ProcessThreadGroup<enum_Node_ProcessThreadGroup>` **PROCESS_THREAD_GROUP_INHERIT** = ``0`` -If the :ref:`process_thread_group<class_Node_property_process_thread_group>` property is sent to this, the node will belong to any parent (or grandparent) node that has a thread group mode that is not inherit. See :ref:`process_thread_group<class_Node_property_process_thread_group>` for more information. +Process this node based on the thread group mode of the first parent (or grandparent) node that has a thread group mode that is not inherit. See :ref:`process_thread_group<class_Node_property_process_thread_group>` for more information. .. _class_Node_constant_PROCESS_THREAD_GROUP_MAIN_THREAD: @@ -484,7 +486,7 @@ If the :ref:`process_thread_group<class_Node_property_process_thread_group>` pro :ref:`ProcessThreadGroup<enum_Node_ProcessThreadGroup>` **PROCESS_THREAD_GROUP_MAIN_THREAD** = ``1`` -Process this node (and children nodes set to inherit) on the main thread. See :ref:`process_thread_group<class_Node_property_process_thread_group>` for more information. +Process this node (and child nodes set to inherit) on the main thread. See :ref:`process_thread_group<class_Node_property_process_thread_group>` for more information. .. _class_Node_constant_PROCESS_THREAD_GROUP_SUB_THREAD: @@ -492,7 +494,7 @@ Process this node (and children nodes set to inherit) on the main thread. See :r :ref:`ProcessThreadGroup<enum_Node_ProcessThreadGroup>` **PROCESS_THREAD_GROUP_SUB_THREAD** = ``2`` -Process this node (and children nodes set to inherit) on a sub-thread. See :ref:`process_thread_group<class_Node_property_process_thread_group>` for more information. +Process this node (and child nodes set to inherit) on a sub-thread. See :ref:`process_thread_group<class_Node_property_process_thread_group>` for more information. .. rst-class:: classref-item-separator @@ -544,7 +546,7 @@ enum **DuplicateFlags**: :ref:`DuplicateFlags<enum_Node_DuplicateFlags>` **DUPLICATE_SIGNALS** = ``1`` -Duplicate the node's signals. +Duplicate the node's signal connections. .. _class_Node_constant_DUPLICATE_GROUPS: @@ -560,7 +562,7 @@ Duplicate the node's groups. :ref:`DuplicateFlags<enum_Node_DuplicateFlags>` **DUPLICATE_SCRIPTS** = ``4`` -Duplicate the node's scripts. +Duplicate the node's script (including the ancestor's script, if combined with :ref:`DUPLICATE_USE_INSTANTIATION<class_Node_constant_DUPLICATE_USE_INSTANTIATION>`). .. _class_Node_constant_DUPLICATE_USE_INSTANTIATION: @@ -568,9 +570,7 @@ Duplicate the node's scripts. :ref:`DuplicateFlags<enum_Node_DuplicateFlags>` **DUPLICATE_USE_INSTANTIATION** = ``8`` -Duplicate using instancing. - -An instance stays linked to the original so when the original changes, the instance changes too. +Duplicate using :ref:`PackedScene.instantiate<class_PackedScene_method_instantiate>`. If the node comes from a scene saved on disk, re-uses :ref:`PackedScene.instantiate<class_PackedScene_method_instantiate>` as the base for the duplicated node and its children. .. rst-class:: classref-item-separator @@ -588,7 +588,7 @@ enum **InternalMode**: :ref:`InternalMode<enum_Node_InternalMode>` **INTERNAL_MODE_DISABLED** = ``0`` -Node will not be internal. +The node will not be internal. .. _class_Node_constant_INTERNAL_MODE_FRONT: @@ -596,7 +596,7 @@ Node will not be internal. :ref:`InternalMode<enum_Node_InternalMode>` **INTERNAL_MODE_FRONT** = ``1`` -Node will be placed at the front of parent's node list, before any non-internal sibling. +The node will be placed at the beginning of the parent's children, before any non-internal sibling. .. _class_Node_constant_INTERNAL_MODE_BACK: @@ -604,7 +604,7 @@ Node will be placed at the front of parent's node list, before any non-internal :ref:`InternalMode<enum_Node_InternalMode>` **INTERNAL_MODE_BACK** = ``2`` -Node will be placed at the back of parent's node list, after any non-internal sibling. +The node will be placed at the end of the parent's children, after any non-internal sibling. .. rst-class:: classref-section-separator @@ -621,9 +621,9 @@ Constants **NOTIFICATION_ENTER_TREE** = ``10`` -Notification received when the node enters a :ref:`SceneTree<class_SceneTree>`. +Notification received when the node enters a :ref:`SceneTree<class_SceneTree>`. See :ref:`_enter_tree<class_Node_private_method__enter_tree>`. -This notification is emitted *before* the related :ref:`tree_entered<class_Node_signal_tree_entered>`. +This notification is received *before* the related :ref:`tree_entered<class_Node_signal_tree_entered>` signal. .. _class_Node_constant_NOTIFICATION_EXIT_TREE: @@ -631,9 +631,9 @@ This notification is emitted *before* the related :ref:`tree_entered<class_Node_ **NOTIFICATION_EXIT_TREE** = ``11`` -Notification received when the node is about to exit a :ref:`SceneTree<class_SceneTree>`. +Notification received when the node is about to exit a :ref:`SceneTree<class_SceneTree>`. See :ref:`_exit_tree<class_Node_private_method__exit_tree>`. -This notification is emitted *after* the related :ref:`tree_exiting<class_Node_signal_tree_exiting>`. +This notification is received *after* the related :ref:`tree_exiting<class_Node_signal_tree_exiting>` signal. .. _class_Node_constant_NOTIFICATION_MOVED_IN_PARENT: @@ -657,7 +657,7 @@ Notification received when the node is ready. See :ref:`_ready<class_Node_privat **NOTIFICATION_PAUSED** = ``14`` -Notification received when the node is paused. +Notification received when the node is paused. See :ref:`process_mode<class_Node_property_process_mode>`. .. _class_Node_constant_NOTIFICATION_UNPAUSED: @@ -665,7 +665,7 @@ Notification received when the node is paused. **NOTIFICATION_UNPAUSED** = ``15`` -Notification received when the node is unpaused. +Notification received when the node is unpaused. See :ref:`process_mode<class_Node_property_process_mode>`. .. _class_Node_constant_NOTIFICATION_PHYSICS_PROCESS: @@ -673,7 +673,7 @@ Notification received when the node is unpaused. **NOTIFICATION_PHYSICS_PROCESS** = ``16`` -Notification received every frame when the physics process flag is set (see :ref:`set_physics_process<class_Node_method_set_physics_process>`). +Notification received from the tree every physics frame when :ref:`is_physics_processing<class_Node_method_is_physics_processing>` returns ``true``. See :ref:`_physics_process<class_Node_private_method__physics_process>`. .. _class_Node_constant_NOTIFICATION_PROCESS: @@ -681,7 +681,7 @@ Notification received every frame when the physics process flag is set (see :ref **NOTIFICATION_PROCESS** = ``17`` -Notification received every frame when the process flag is set (see :ref:`set_process<class_Node_method_set_process>`). +Notification received from the tree every rendered frame when :ref:`is_processing<class_Node_method_is_processing>` returns ``true``. See :ref:`_process<class_Node_private_method__process>`. .. _class_Node_constant_NOTIFICATION_PARENTED: @@ -689,9 +689,9 @@ Notification received every frame when the process flag is set (see :ref:`set_pr **NOTIFICATION_PARENTED** = ``18`` -Notification received when a node is set as a child of another node. +Notification received when the node is set as a child of another node (see :ref:`add_child<class_Node_method_add_child>` and :ref:`add_sibling<class_Node_method_add_sibling>`). -\ **Note:** This doesn't mean that a node entered the :ref:`SceneTree<class_SceneTree>`. +\ **Note:** This does *not* mean that the node entered the :ref:`SceneTree<class_SceneTree>`. .. _class_Node_constant_NOTIFICATION_UNPARENTED: @@ -699,7 +699,9 @@ Notification received when a node is set as a child of another node. **NOTIFICATION_UNPARENTED** = ``19`` -Notification received when a node is unparented (parent removed it from the list of children). +Notification received when the parent node calls :ref:`remove_child<class_Node_method_remove_child>` on this node. + +\ **Note:** This does *not* mean that the node exited the :ref:`SceneTree<class_SceneTree>`. .. _class_Node_constant_NOTIFICATION_SCENE_INSTANTIATED: @@ -707,7 +709,7 @@ Notification received when a node is unparented (parent removed it from the list **NOTIFICATION_SCENE_INSTANTIATED** = ``20`` -Notification received by scene owner when its scene is instantiated. +Notification received *only* by the newly instantiated scene root node, when :ref:`PackedScene.instantiate<class_PackedScene_method_instantiate>` is completed. .. _class_Node_constant_NOTIFICATION_DRAG_BEGIN: @@ -737,7 +739,7 @@ Use :ref:`Viewport.gui_is_drag_successful<class_Viewport_method_gui_is_drag_succ **NOTIFICATION_PATH_RENAMED** = ``23`` -Notification received when the node's name or one of its parents' name is changed. This notification is *not* received when the node is removed from the scene tree to be added to another parent later on. +Notification received when the node's :ref:`name<class_Node_property_name>` or one of its ancestors' :ref:`name<class_Node_property_name>` is changed. This notification is *not* received when the node is removed from the :ref:`SceneTree<class_SceneTree>`. .. _class_Node_constant_NOTIFICATION_CHILD_ORDER_CHANGED: @@ -753,7 +755,7 @@ Notification received when the list of children is changed. This happens when ch **NOTIFICATION_INTERNAL_PROCESS** = ``25`` -Notification received every frame when the internal process flag is set (see :ref:`set_process_internal<class_Node_method_set_process_internal>`). +Notification received from the tree every rendered frame when :ref:`is_processing_internal<class_Node_method_is_processing_internal>` returns ``true``. .. _class_Node_constant_NOTIFICATION_INTERNAL_PHYSICS_PROCESS: @@ -761,7 +763,7 @@ Notification received every frame when the internal process flag is set (see :re **NOTIFICATION_INTERNAL_PHYSICS_PROCESS** = ``26`` -Notification received every frame when the internal physics process flag is set (see :ref:`set_physics_process_internal<class_Node_method_set_physics_process_internal>`). +Notification received from the tree every physics frame when :ref:`is_physics_processing_internal<class_Node_method_is_physics_processing_internal>` returns ``true``. .. _class_Node_constant_NOTIFICATION_POST_ENTER_TREE: @@ -769,7 +771,7 @@ Notification received every frame when the internal physics process flag is set **NOTIFICATION_POST_ENTER_TREE** = ``27`` -Notification received when the node is ready, just before :ref:`NOTIFICATION_READY<class_Node_constant_NOTIFICATION_READY>` is received. Unlike the latter, it's sent every time the node enters the tree, instead of only once. +Notification received when the node enters the tree, just before :ref:`NOTIFICATION_READY<class_Node_constant_NOTIFICATION_READY>` may be received. Unlike the latter, it is sent every time the node enters tree, not just once. .. _class_Node_constant_NOTIFICATION_DISABLED: @@ -829,7 +831,7 @@ Implemented for embedded windows and on desktop and web platforms. **NOTIFICATION_WM_WINDOW_FOCUS_IN** = ``1004`` -Notification received when the node's parent :ref:`Window<class_Window>` is focused. This may be a change of focus between two windows of the same engine instance, or from the OS desktop or a third-party application to a window of the game (in which case :ref:`NOTIFICATION_APPLICATION_FOCUS_IN<class_Node_constant_NOTIFICATION_APPLICATION_FOCUS_IN>` is also emitted). +Notification received from the OS when the node's :ref:`Window<class_Window>` ancestor is focused. This may be a change of focus between two windows of the same engine instance, or from the OS desktop or a third-party application to a window of the game (in which case :ref:`NOTIFICATION_APPLICATION_FOCUS_IN<class_Node_constant_NOTIFICATION_APPLICATION_FOCUS_IN>` is also received). A :ref:`Window<class_Window>` node receives this notification when it is focused. @@ -839,7 +841,7 @@ A :ref:`Window<class_Window>` node receives this notification when it is focused **NOTIFICATION_WM_WINDOW_FOCUS_OUT** = ``1005`` -Notification received when the node's parent :ref:`Window<class_Window>` is defocused. This may be a change of focus between two windows of the same engine instance, or from a window of the game to the OS desktop or a third-party application (in which case :ref:`NOTIFICATION_APPLICATION_FOCUS_OUT<class_Node_constant_NOTIFICATION_APPLICATION_FOCUS_OUT>` is also emitted). +Notification received from the OS when the node's :ref:`Window<class_Window>` ancestor is defocused. This may be a change of focus between two windows of the same engine instance, or from a window of the game to the OS desktop or a third-party application (in which case :ref:`NOTIFICATION_APPLICATION_FOCUS_OUT<class_Node_constant_NOTIFICATION_APPLICATION_FOCUS_OUT>` is also received). A :ref:`Window<class_Window>` node receives this notification when it is defocused. @@ -861,7 +863,7 @@ Implemented on desktop platforms. Notification received from the OS when a go back request is sent (e.g. pressing the "Back" button on Android). -Specific to the Android platform. +Implemented only on iOS. .. _class_Node_constant_NOTIFICATION_WM_SIZE_CHANGED: @@ -869,7 +871,9 @@ Specific to the Android platform. **NOTIFICATION_WM_SIZE_CHANGED** = ``1008`` -Notification received from the OS when the window is resized. +Notification received when the window is resized. + +\ **Note:** Only the resized :ref:`Window<class_Window>` node receives this notification, and it's not propagated to the child nodes. .. _class_Node_constant_NOTIFICATION_WM_DPI_CHANGE: @@ -877,7 +881,7 @@ Notification received from the OS when the window is resized. **NOTIFICATION_WM_DPI_CHANGE** = ``1009`` -Notification received from the OS when the screen's DPI has been changed. Only implemented on macOS. +Notification received from the OS when the screen's dots per inch (DPI) scale is changed. Only implemented on macOS. .. _class_Node_constant_NOTIFICATION_VP_MOUSE_ENTER: @@ -903,7 +907,7 @@ Notification received when the mouse cursor leaves the :ref:`Viewport<class_View Notification received from the OS when the application is exceeding its allocated memory. -Specific to the iOS platform. +Implemented only on iOS. .. _class_Node_constant_NOTIFICATION_TRANSLATION_CHANGED: @@ -921,7 +925,7 @@ Notification received when translations may have changed. Can be triggered by th Notification received from the OS when a request for "About" information is sent. -Specific to the macOS platform. +Implemented only on macOS. .. _class_Node_constant_NOTIFICATION_CRASH: @@ -931,7 +935,7 @@ Specific to the macOS platform. Notification received from Godot's crash handler when the engine is about to crash. -Implemented on desktop platforms if the crash handler is enabled. +Implemented on desktop platforms, if the crash handler is enabled. .. _class_Node_constant_NOTIFICATION_OS_IME_UPDATE: @@ -941,7 +945,7 @@ Implemented on desktop platforms if the crash handler is enabled. Notification received from the OS when an update of the Input Method Engine occurs (e.g. change of IME cursor position or composition string). -Specific to the macOS platform. +Implemented only on macOS. .. _class_Node_constant_NOTIFICATION_APPLICATION_RESUMED: @@ -951,7 +955,7 @@ Specific to the macOS platform. Notification received from the OS when the application is resumed. -Specific to the Android platform. +Implemented only on Android. .. _class_Node_constant_NOTIFICATION_APPLICATION_PAUSED: @@ -961,7 +965,7 @@ Specific to the Android platform. Notification received from the OS when the application is paused. -Specific to the Android platform. +Implemented only on Android. .. _class_Node_constant_NOTIFICATION_APPLICATION_FOCUS_IN: @@ -969,7 +973,7 @@ Specific to the Android platform. **NOTIFICATION_APPLICATION_FOCUS_IN** = ``2016`` -Notification received from the OS when the application is focused, i.e. when changing the focus from the OS desktop or a thirdparty application to any open window of the Godot instance. +Notification received from the OS when the application is focused, i.e. when changing the focus from the OS desktop or a third-party application to any open window of the Godot instance. Implemented on desktop platforms. @@ -979,7 +983,7 @@ Implemented on desktop platforms. **NOTIFICATION_APPLICATION_FOCUS_OUT** = ``2017`` -Notification received from the OS when the application is defocused, i.e. when changing the focus from any open window of the Godot instance to the OS desktop or a thirdparty application. +Notification received from the OS when the application is defocused, i.e. when changing the focus from any open window of the Godot instance to the OS desktop or a third-party application. Implemented on desktop platforms. @@ -989,7 +993,7 @@ Implemented on desktop platforms. **NOTIFICATION_TEXT_SERVER_CHANGED** = ``2018`` -Notification received when text server is changed. +Notification received when the :ref:`TextServer<class_TextServer>` is changed. .. rst-class:: classref-section-separator @@ -1011,7 +1015,7 @@ Property Descriptions - void **set_editor_description** **(** :ref:`String<class_String>` value **)** - :ref:`String<class_String>` **get_editor_description** **(** **)** -Add a custom description to a node. It will be displayed in a tooltip when hovered in editor's scene tree. +An optional description to the node. It will be displayed as a tooltip when hovering over the node in the editor's Scene dock. .. rst-class:: classref-item-separator @@ -1046,9 +1050,9 @@ The :ref:`MultiplayerAPI<class_MultiplayerAPI>` instance associated with this no - void **set_name** **(** :ref:`StringName<class_StringName>` value **)** - :ref:`StringName<class_StringName>` **get_name** **(** **)** -The name of the node. This name is unique among the siblings (other child nodes from the same parent). When set to an existing name, the node will be automatically renamed. +The name of the node. This name must be unique among the siblings (other child nodes from the same parent). When set to an existing sibling's name, the node is automatically renamed. -\ **Note:** Auto-generated names might include the ``@`` character, which is reserved for unique names when using :ref:`add_child<class_Node_method_add_child>`. When setting the name manually, any ``@`` will be removed. +\ **Note:** When changing the name, the following characters will be removed: (``.`` ``:`` ``@`` ``/`` ``"`` ``%``). In particular, the ``@`` character is reserved for auto-generated names. See also :ref:`String.validate_node_name<class_String_method_validate_node_name>`. .. rst-class:: classref-item-separator @@ -1065,9 +1069,9 @@ The name of the node. This name is unique among the siblings (other child nodes - void **set_owner** **(** :ref:`Node<class_Node>` value **)** - :ref:`Node<class_Node>` **get_owner** **(** **)** -The node owner. A node can have any ancestor node as owner (i.e. a parent, grandparent, etc. node ascending in the tree). This implies that :ref:`add_child<class_Node_method_add_child>` should be called before setting the owner, so that this relationship of parenting exists. When saving a node (using :ref:`PackedScene<class_PackedScene>`), all the nodes it owns will be saved with it. This allows for the creation of complex scene trees, with instancing and subinstancing. +The owner of this node. The owner must be an ancestor of this node. When packing the owner node in a :ref:`PackedScene<class_PackedScene>`, all the nodes it owns are also saved with it. -\ **Note:** If you want a child to be persisted to a :ref:`PackedScene<class_PackedScene>`, you must set :ref:`owner<class_Node_property_owner>` in addition to calling :ref:`add_child<class_Node_method_add_child>`. This is typically relevant for :doc:`tool scripts <../tutorials/plugins/running_code_in_the_editor>` and :doc:`editor plugins <../tutorials/plugins/editor/index>`. If a new node is added to the tree without setting its owner as an ancestor in that tree, it will be visible in the 2D/3D view, but not in the scene tree (and not persisted when packing or saving). +\ **Note:** In the editor, nodes not owned by the scene root are usually not displayed in the Scene dock, and will **not** be saved. To prevent this, remember to set the owner after calling :ref:`add_child<class_Node_method_add_child>`. See also (see :ref:`unique_name_in_owner<class_Node_property_unique_name_in_owner>`) .. rst-class:: classref-item-separator @@ -1084,7 +1088,7 @@ The node owner. A node can have any ancestor node as owner (i.e. a parent, grand - void **set_process_mode** **(** :ref:`ProcessMode<enum_Node_ProcessMode>` value **)** - :ref:`ProcessMode<enum_Node_ProcessMode>` **get_process_mode** **(** **)** -Can be used to pause or unpause the node, or make the node paused based on the :ref:`SceneTree<class_SceneTree>`, or make it inherit the process mode from its parent (default). +The node's processing behavior (see :ref:`ProcessMode<enum_Node_ProcessMode>`). To check if the node is able to process, with the current mode and :ref:`SceneTree.paused<class_SceneTree_property_paused>`, use :ref:`can_process<class_Node_method_can_process>`. .. rst-class:: classref-item-separator @@ -1118,7 +1122,7 @@ Similar to :ref:`process_priority<class_Node_property_process_priority>` but for - void **set_process_priority** **(** :ref:`int<class_int>` value **)** - :ref:`int<class_int>` **get_process_priority** **(** **)** -The node's priority in the execution order of the enabled processing callbacks (i.e. :ref:`NOTIFICATION_PROCESS<class_Node_constant_NOTIFICATION_PROCESS>`, :ref:`NOTIFICATION_PHYSICS_PROCESS<class_Node_constant_NOTIFICATION_PHYSICS_PROCESS>` and their internal counterparts). Nodes whose process priority value is *lower* will have their processing callbacks executed first. +The node's execution order of the process callbacks (:ref:`_process<class_Node_private_method__process>`, :ref:`_physics_process<class_Node_private_method__physics_process>`, and internal processing). Nodes whose priority value is *lower* call their process callbacks first, regardless of tree order. .. rst-class:: classref-item-separator @@ -1141,7 +1145,7 @@ By default, the thread group is :ref:`PROCESS_THREAD_GROUP_INHERIT<class_Node_co During processing in a sub-thread, accessing most functions in nodes outside the thread group is forbidden (and it will result in an error in debug mode). Use :ref:`Object.call_deferred<class_Object_method_call_deferred>`, :ref:`call_thread_safe<class_Node_method_call_thread_safe>`, :ref:`call_deferred_thread_group<class_Node_method_call_deferred_thread_group>` and the likes in order to communicate from the thread groups to the main thread (or to other thread groups). -To better understand process thread groups, the idea is that any node set to any other value than :ref:`PROCESS_THREAD_GROUP_INHERIT<class_Node_constant_PROCESS_THREAD_GROUP_INHERIT>` will include any children (and grandchildren) nodes set to inherit into its process thread group. this means that the processing of all the nodes in the group will happen together, at the same time as the node including them. +To better understand process thread groups, the idea is that any node set to any other value than :ref:`PROCESS_THREAD_GROUP_INHERIT<class_Node_constant_PROCESS_THREAD_GROUP_INHERIT>` will include any child (and grandchild) nodes set to inherit into its process thread group. This means that the processing of all the nodes in the group will happen together, at the same time as the node including them. .. rst-class:: classref-item-separator @@ -1192,7 +1196,7 @@ Set whether the current thread group will process messages (calls to :ref:`call_ - void **set_scene_file_path** **(** :ref:`String<class_String>` value **)** - :ref:`String<class_String>` **get_scene_file_path** **(** **)** -If a scene is instantiated from a file, its topmost node contains the absolute file path from which it was loaded in :ref:`scene_file_path<class_Node_property_scene_file_path>` (e.g. ``res://levels/1.tscn``). Otherwise, :ref:`scene_file_path<class_Node_property_scene_file_path>` is set to an empty string. +The original scene's file path, if the node has been instantiated from a :ref:`PackedScene<class_PackedScene>` file. Only scene root nodes contains this. .. rst-class:: classref-item-separator @@ -1209,9 +1213,9 @@ If a scene is instantiated from a file, its topmost node contains the absolute f - void **set_unique_name_in_owner** **(** :ref:`bool<class_bool>` value **)** - :ref:`bool<class_bool>` **is_unique_name_in_owner** **(** **)** -Sets this node's name as a unique name in its :ref:`owner<class_Node_property_owner>`. This allows the node to be accessed as ``%Name`` instead of the full path, from any node within that scene. +If ``true``, the node can be accessed from any node sharing the same :ref:`owner<class_Node_property_owner>` or from the :ref:`owner<class_Node_property_owner>` itself, with special ``%Name`` syntax in :ref:`get_node<class_Node_method_get_node>`. -If another node with the same owner already had that name declared as unique, that other node's name will no longer be set as having a unique name. +\ **Note:** If another node with the same :ref:`owner<class_Node_property_owner>` shares the same :ref:`name<class_Node_property_name>` as this node, the other node will no longer be accessible as unique. .. rst-class:: classref-section-separator @@ -1228,7 +1232,7 @@ Method Descriptions void **_enter_tree** **(** **)** |virtual| -Called when the node enters the :ref:`SceneTree<class_SceneTree>` (e.g. upon instancing, scene changing, or after calling :ref:`add_child<class_Node_method_add_child>` in a script). If the node has children, its :ref:`_enter_tree<class_Node_private_method__enter_tree>` callback will be called first, and then that of the children. +Called when the node enters the :ref:`SceneTree<class_SceneTree>` (e.g. upon instantiating, scene changing, or after calling :ref:`add_child<class_Node_method_add_child>` in a script). If the node has children, its :ref:`_enter_tree<class_Node_private_method__enter_tree>` callback will be called first, and then that of the children. Corresponds to the :ref:`NOTIFICATION_ENTER_TREE<class_Node_constant_NOTIFICATION_ENTER_TREE>` notification in :ref:`Object._notification<class_Object_private_method__notification>`. @@ -1347,7 +1351,7 @@ Corresponds to the :ref:`NOTIFICATION_READY<class_Node_constant_NOTIFICATION_REA Usually used for initialization. For even earlier initialization, :ref:`Object._init<class_Object_private_method__init>` may be used. See also :ref:`_enter_tree<class_Node_private_method__enter_tree>`. -\ **Note:** :ref:`_ready<class_Node_private_method__ready>` may be called only once for each node. After removing a node from the scene tree and adding it again, :ref:`_ready<class_Node_private_method__ready>` will not be called a second time. This can be bypassed by requesting another call with :ref:`request_ready<class_Node_method_request_ready>`, which may be called anywhere before adding the node again. +\ **Note:** This method may be called only once for each node. After removing a node from the scene tree and adding it again, :ref:`_ready<class_Node_private_method__ready>` will **not** be called a second time. This can be bypassed by requesting another call with :ref:`request_ready<class_Node_method_request_ready>`, which may be called anywhere before adding the node again. .. rst-class:: classref-item-separator @@ -1359,7 +1363,7 @@ Usually used for initialization. For even earlier initialization, :ref:`Object._ void **_shortcut_input** **(** :ref:`InputEvent<class_InputEvent>` event **)** |virtual| -Called when an :ref:`InputEventKey<class_InputEventKey>` or :ref:`InputEventShortcut<class_InputEventShortcut>` hasn't been consumed by :ref:`_input<class_Node_private_method__input>` or any GUI :ref:`Control<class_Control>` item. It is called before :ref:`_unhandled_key_input<class_Node_private_method__unhandled_key_input>` and :ref:`_unhandled_input<class_Node_private_method__unhandled_input>`. The input event propagates up through the node tree until a node consumes it. +Called when an :ref:`InputEventKey<class_InputEventKey>`, :ref:`InputEventShortcut<class_InputEventShortcut>`, or :ref:`InputEventJoypadButton<class_InputEventJoypadButton>` hasn't been consumed by :ref:`_input<class_Node_private_method__input>` or any GUI :ref:`Control<class_Control>` item. It is called before :ref:`_unhandled_key_input<class_Node_private_method__unhandled_key_input>` and :ref:`_unhandled_input<class_Node_private_method__unhandled_input>`. The input event propagates up through the node tree until a node consumes it. It is only called if shortcut processing is enabled, which is done automatically if this method is overridden, and can be toggled with :ref:`set_process_shortcut_input<class_Node_method_set_process_shortcut_input>`. @@ -1425,9 +1429,9 @@ Adds a child ``node``. Nodes can have any number of children, but every child mu If ``force_readable_name`` is ``true``, improves the readability of the added ``node``. If not named, the ``node`` is renamed to its type, and if it shares :ref:`name<class_Node_property_name>` with a sibling, a number is suffixed more appropriately. This operation is very slow. As such, it is recommended leaving this to ``false``, which assigns a dummy name featuring ``@`` in both situations. -If ``internal`` is different than :ref:`INTERNAL_MODE_DISABLED<class_Node_constant_INTERNAL_MODE_DISABLED>`, the child will be added as internal node. Such nodes are ignored by methods like :ref:`get_children<class_Node_method_get_children>`, unless their parameter ``include_internal`` is ``true``. The intended usage is to hide the internal nodes from the user, so the user won't accidentally delete or modify them. Used by some GUI nodes, e.g. :ref:`ColorPicker<class_ColorPicker>`. See :ref:`InternalMode<enum_Node_InternalMode>` for available modes. +If ``internal`` is different than :ref:`INTERNAL_MODE_DISABLED<class_Node_constant_INTERNAL_MODE_DISABLED>`, the child will be added as internal node. These nodes are ignored by methods like :ref:`get_children<class_Node_method_get_children>`, unless their parameter ``include_internal`` is ``true``. The intended usage is to hide the internal nodes from the user, so the user won't accidentally delete or modify them. Used by some GUI nodes, e.g. :ref:`ColorPicker<class_ColorPicker>`. See :ref:`InternalMode<enum_Node_InternalMode>` for available modes. -\ **Note:** If the child node already has a parent, the function will fail. Use :ref:`remove_child<class_Node_method_remove_child>` first to remove the node from its current parent. For example: +\ **Note:** If ``node`` already has a parent, this method will fail. Use :ref:`remove_child<class_Node_method_remove_child>` first to remove ``node`` from its current parent. For example: .. tabs:: @@ -1464,13 +1468,13 @@ If you need the child node to be added below a specific node in the list of chil void **add_sibling** **(** :ref:`Node<class_Node>` sibling, :ref:`bool<class_bool>` force_readable_name=false **)** -Adds a ``sibling`` node to current's node parent, at the same level as that node, right below it. +Adds a ``sibling`` node to this node's parent, and moves the added sibling right below this node. If ``force_readable_name`` is ``true``, improves the readability of the added ``sibling``. If not named, the ``sibling`` is renamed to its type, and if it shares :ref:`name<class_Node_property_name>` with a sibling, a number is suffixed more appropriately. This operation is very slow. As such, it is recommended leaving this to ``false``, which assigns a dummy name featuring ``@`` in both situations. Use :ref:`add_child<class_Node_method_add_child>` instead of this method if you don't need the child node to be added below a specific node in the list of children. -\ **Note:** If this node is internal, the new sibling will be internal too (see ``internal`` parameter in :ref:`add_child<class_Node_method_add_child>`). +\ **Note:** If this node is internal, the added sibling will be internal too (see :ref:`add_child<class_Node_method_add_child>`'s ``internal`` parameter). .. rst-class:: classref-item-separator @@ -1482,11 +1486,13 @@ Use :ref:`add_child<class_Node_method_add_child>` instead of this method if you void **add_to_group** **(** :ref:`StringName<class_StringName>` group, :ref:`bool<class_bool>` persistent=false **)** -Adds the node to a group. Groups are helpers to name and organize a subset of nodes, for example "enemies" or "collectables". A node can be in any number of groups. Nodes can be assigned a group at any time, but will not be added until they are inside the scene tree (see :ref:`is_inside_tree<class_Node_method_is_inside_tree>`). See notes in the description, and the group methods in :ref:`SceneTree<class_SceneTree>`. +Adds the node to the ``group``. Groups can be helpful to organize a subset of nodes, for example ``"enemies"`` or ``"collectables"``. See notes in the description, and the group methods in :ref:`SceneTree<class_SceneTree>`. -The ``persistent`` option is used when packing node to :ref:`PackedScene<class_PackedScene>` and saving to file. Non-persistent groups aren't stored. +If ``persistent`` is ``true``, the group will be stored when saved inside a :ref:`PackedScene<class_PackedScene>`. All groups created and displayed in the Node dock are persistent. -\ **Note:** For performance reasons, the order of node groups is *not* guaranteed. The order of node groups should not be relied upon as it can vary across project runs. +\ **Note:** To improve performance, the order of group names is *not* guaranteed and may vary between project runs. Therefore, do not rely on the group order. + +\ **Note:** :ref:`SceneTree<class_SceneTree>`'s group methods will *not* work on this node if not inside the tree (see :ref:`is_inside_tree<class_Node_method_is_inside_tree>`). .. rst-class:: classref-item-separator @@ -1522,7 +1528,7 @@ This function ensures that the calling of this function will succeed, no matter :ref:`bool<class_bool>` **can_process** **(** **)** |const| -Returns ``true`` if the node can process while the scene tree is paused (see :ref:`process_mode<class_Node_property_process_mode>`). Always returns ``true`` if the scene tree is not paused, and ``false`` if the node is not in the tree. +Returns ``true`` if the node can receive processing notifications and input callbacks (:ref:`NOTIFICATION_PROCESS<class_Node_constant_NOTIFICATION_PROCESS>`, :ref:`_input<class_Node_private_method__input>`, etc) from the :ref:`SceneTree<class_SceneTree>` and :ref:`Viewport<class_Viewport>`. The value depends on both the current :ref:`process_mode<class_Node_property_process_mode>` and :ref:`SceneTree.paused<class_SceneTree_property_paused>`. Returns ``false`` if the node is not inside the tree. .. rst-class:: classref-item-separator @@ -1534,7 +1540,9 @@ Returns ``true`` if the node can process while the scene tree is paused (see :re :ref:`Tween<class_Tween>` **create_tween** **(** **)** -Creates a new :ref:`Tween<class_Tween>` and binds it to this node. This is equivalent of doing: +Creates a new :ref:`Tween<class_Tween>` and binds it to this node. Fails if the node is not inside the tree. + +This is the equivalent of doing: .. tabs:: @@ -1561,11 +1569,9 @@ The Tween will start automatically on the next process frame or physics frame (d :ref:`Node<class_Node>` **duplicate** **(** :ref:`int<class_int>` flags=15 **)** |const| -Duplicates the node, returning a new node. +Duplicates the node, returning a new node with all of its properties, signals and groups copied from the original. The behavior can be tweaked through the ``flags`` (see :ref:`DuplicateFlags<enum_Node_DuplicateFlags>`). -You can fine-tune the behavior using the ``flags`` (see :ref:`DuplicateFlags<enum_Node_DuplicateFlags>`). - -\ **Note:** It will not work properly if the node contains a script with constructor arguments (i.e. needs to supply arguments to :ref:`Object._init<class_Object_private_method__init>` method). In that case, the node will be duplicated without a script. +\ **Note:** For nodes with a :ref:`Script<class_Script>` attached, if :ref:`Object._init<class_Object_private_method__init>` has been defined with required parameters, the duplicated node will not have a :ref:`Script<class_Script>`. .. rst-class:: classref-item-separator @@ -1577,17 +1583,13 @@ You can fine-tune the behavior using the ``flags`` (see :ref:`DuplicateFlags<enu :ref:`Node<class_Node>` **find_child** **(** :ref:`String<class_String>` pattern, :ref:`bool<class_bool>` recursive=true, :ref:`bool<class_bool>` owned=true **)** |const| -Finds the first descendant of this node whose name matches ``pattern`` as in :ref:`String.match<class_String_method_match>`. Internal children are also searched over (see ``internal`` parameter in :ref:`add_child<class_Node_method_add_child>`). +Finds the first descendant of this node whose :ref:`name<class_Node_property_name>` matches ``pattern``, returning ``null`` if no match is found. The matching is done against node names, *not* their paths, through :ref:`String.match<class_String_method_match>`. As such, it is case-sensitive, ``"*"`` matches zero or more characters, and ``"?"`` matches any single character. -\ ``pattern`` does not match against the full path, just against individual node names. It is case-sensitive, with ``"*"`` matching zero or more characters and ``"?"`` matching any single character except ``"."``). +If ``recursive`` is ``false``, only this node's direct children are checked. Nodes are checked in tree order, so this node's first direct child is checked first, then its own direct children, etc., before moving to the second direct child, and so on. Internal children are also included in the search (see ``internal`` parameter in :ref:`add_child<class_Node_method_add_child>`). -If ``recursive`` is ``true``, all child nodes are included, even if deeply nested. Nodes are checked in tree order, so this node's first direct child is checked first, then its own direct children, etc., before moving to the second direct child, and so on. If ``recursive`` is ``false``, only this node's direct children are matched. +If ``owned`` is ``true``, only descendants with a valid :ref:`owner<class_Node_property_owner>` node are checked. -If ``owned`` is ``true``, this method only finds nodes who have an assigned :ref:`owner<class_Node_property_owner>`. This is especially important for scenes instantiated through a script, because those scenes don't have an owner. - -Returns ``null`` if no matching **Node** is found. - -\ **Note:** As this method walks through all the descendants of the node, it is the slowest way to get a reference to another node. Whenever possible, consider using :ref:`get_node<class_Node_method_get_node>` with unique names instead (see :ref:`unique_name_in_owner<class_Node_property_unique_name_in_owner>`), or caching the node references into variable. +\ **Note:** This method can be very slow. Consider storing a reference to the found node in a variable. Alternatively, use :ref:`get_node<class_Node_method_get_node>` with unique names (see :ref:`unique_name_in_owner<class_Node_property_unique_name_in_owner>`). \ **Note:** To find all descendant nodes matching a pattern or a class type, see :ref:`find_children<class_Node_method_find_children>`. @@ -1601,21 +1603,17 @@ Returns ``null`` if no matching **Node** is found. :ref:`Node[]<class_Node>` **find_children** **(** :ref:`String<class_String>` pattern, :ref:`String<class_String>` type="", :ref:`bool<class_bool>` recursive=true, :ref:`bool<class_bool>` owned=true **)** |const| -Finds descendants of this node whose name matches ``pattern`` as in :ref:`String.match<class_String_method_match>`, and/or type matches ``type`` as in :ref:`Object.is_class<class_Object_method_is_class>`. Internal children are also searched over (see ``internal`` parameter in :ref:`add_child<class_Node_method_add_child>`). +Finds all descendants of this node whose names match ``pattern``, returning an empty :ref:`Array<class_Array>` if no match is found. The matching is done against node names, *not* their paths, through :ref:`String.match<class_String_method_match>`. As such, it is case-sensitive, ``"*"`` matches zero or more characters, and ``"?"`` matches any single character. -\ ``pattern`` does not match against the full path, just against individual node names. It is case-sensitive, with ``"*"`` matching zero or more characters and ``"?"`` matching any single character except ``"."``). +If ``type`` is not empty, only ancestors inheriting from ``type`` are included (see :ref:`Object.is_class<class_Object_method_is_class>`). -\ ``type`` will check equality or inheritance, and is case-sensitive. ``"Object"`` will match a node whose type is ``"Node"`` but not the other way around. +If ``recursive`` is ``false``, only this node's direct children are checked. Nodes are checked in tree order, so this node's first direct child is checked first, then its own direct children, etc., before moving to the second direct child, and so on. Internal children are also included in the search (see ``internal`` parameter in :ref:`add_child<class_Node_method_add_child>`). -If ``recursive`` is ``true``, all child nodes are included, even if deeply nested. Nodes are checked in tree order, so this node's first direct child is checked first, then its own direct children, etc., before moving to the second direct child, and so on. If ``recursive`` is ``false``, only this node's direct children are matched. +If ``owned`` is ``true``, only descendants with a valid :ref:`owner<class_Node_property_owner>` node are checked. -If ``owned`` is ``true``, this method only finds nodes who have an assigned :ref:`owner<class_Node_property_owner>`. This is especially important for scenes instantiated through a script, because those scenes don't have an owner. +\ **Note:** This method can be very slow. Consider storing references to the found nodes in a variable. -Returns an empty array if no matching nodes are found. - -\ **Note:** As this method walks through all the descendants of the node, it is the slowest way to get references to other nodes. Whenever possible, consider caching the node references into variables. - -\ **Note:** If you only want to find the first descendant node that matches a pattern, see :ref:`find_child<class_Node_method_find_child>`. +\ **Note:** To find a single descendant node matching a pattern, see :ref:`find_child<class_Node_method_find_child>`. .. rst-class:: classref-item-separator @@ -1627,11 +1625,9 @@ Returns an empty array if no matching nodes are found. :ref:`Node<class_Node>` **find_parent** **(** :ref:`String<class_String>` pattern **)** |const| -Finds the first parent of the current node whose name matches ``pattern`` as in :ref:`String.match<class_String_method_match>`. +Finds the first ancestor of this node whose :ref:`name<class_Node_property_name>` matches ``pattern``, returning ``null`` if no match is found. The matching is done through :ref:`String.match<class_String_method_match>`. As such, it is case-sensitive, ``"*"`` matches zero or more characters, and ``"?"`` matches any single character. See also :ref:`find_child<class_Node_method_find_child>` and :ref:`find_children<class_Node_method_find_children>`. -\ ``pattern`` does not match against the full path, just against individual node names. It is case-sensitive, with ``"*"`` matching zero or more characters and ``"?"`` matching any single character except ``"."``). - -\ **Note:** As this method walks upwards in the scene tree, it can be slow in large, deeply nested scene trees. Whenever possible, consider using :ref:`get_node<class_Node_method_get_node>` with unique names instead (see :ref:`unique_name_in_owner<class_Node_property_unique_name_in_owner>`), or caching the node references into variable. +\ **Note:** As this method walks upwards in the scene tree, it can be slow in large, deeply nested nodes. Consider storing a reference to the found node in a variable. Alternatively, use :ref:`get_node<class_Node_method_get_node>` with unique names (see :ref:`unique_name_in_owner<class_Node_property_unique_name_in_owner>`). .. rst-class:: classref-item-separator @@ -1643,13 +1639,21 @@ Finds the first parent of the current node whose name matches ``pattern`` as in :ref:`Node<class_Node>` **get_child** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` include_internal=false **)** |const| -Returns a child node by its index (see :ref:`get_child_count<class_Node_method_get_child_count>`). This method is often used for iterating all children of a node. +Fetches a child node by its index. Each child node has an index relative its siblings (see :ref:`get_index<class_Node_method_get_index>`). The first child is at index 0. Negative values can also be used to start from the end of the list. This method can be used in combination with :ref:`get_child_count<class_Node_method_get_child_count>` to iterate over this node's children. If no child exists at the given index, this method returns ``null`` and an error is generated. -Negative indices access the children from the last one. +If ``include_internal`` is ``false``, internal children are ignored (see :ref:`add_child<class_Node_method_add_child>`'s ``internal`` parameter). -If ``include_internal`` is ``false``, internal children are skipped (see ``internal`` parameter in :ref:`add_child<class_Node_method_add_child>`). +:: -To access a child node via its name, use :ref:`get_node<class_Node_method_get_node>`. + # Assuming the following are children of this node, in order: + # First, Middle, Last. + + var a = get_child(0).name # a is "First" + var b = get_child(1).name # b is "Middle" + var b = get_child(2).name # b is "Last" + var c = get_child(-1).name # c is "Last" + +\ **Note:** To fetch a node by :ref:`NodePath<class_NodePath>`, use :ref:`get_node<class_Node_method_get_node>`. .. rst-class:: classref-item-separator @@ -1661,9 +1665,9 @@ To access a child node via its name, use :ref:`get_node<class_Node_method_get_no :ref:`int<class_int>` **get_child_count** **(** :ref:`bool<class_bool>` include_internal=false **)** |const| -Returns the number of child nodes. +Returns the number of children of this node. -If ``include_internal`` is ``false``, internal children aren't counted (see ``internal`` parameter in :ref:`add_child<class_Node_method_add_child>`). +If ``include_internal`` is ``false``, internal children are not counted (see :ref:`add_child<class_Node_method_add_child>`'s ``internal`` parameter). .. rst-class:: classref-item-separator @@ -1675,9 +1679,9 @@ If ``include_internal`` is ``false``, internal children aren't counted (see ``in :ref:`Node[]<class_Node>` **get_children** **(** :ref:`bool<class_bool>` include_internal=false **)** |const| -Returns an array of references to node's children. +Returns all children of this node inside an :ref:`Array<class_Array>`. -If ``include_internal`` is ``false``, the returned array won't include internal children (see ``internal`` parameter in :ref:`add_child<class_Node_method_add_child>`). +If ``include_internal`` is ``false``, excludes internal children from the returned array (see :ref:`add_child<class_Node_method_add_child>`'s ``internal`` parameter). .. rst-class:: classref-item-separator @@ -1689,26 +1693,26 @@ If ``include_internal`` is ``false``, the returned array won't include internal :ref:`StringName[]<class_StringName>` **get_groups** **(** **)** |const| -Returns an array listing the groups that the node is a member of. +Returns an :ref:`Array<class_Array>` of group names that the node has been added to. -\ **Note:** For performance reasons, the order of node groups is *not* guaranteed. The order of node groups should not be relied upon as it can vary across project runs. +\ **Note:** To improve performance, the order of group names is *not* guaranteed and may vary between project runs. Therefore, do not rely on the group order. -\ **Note:** The engine uses some group names internally (all starting with an underscore). To avoid conflicts with internal groups, do not add custom groups whose name starts with an underscore. To exclude internal groups while looping over :ref:`get_groups<class_Node_method_get_groups>`, use the following snippet: +\ **Note:** This method may also return some group names starting with an underscore (``_``). These are internally used by the engine. To avoid conflicts, do not use custom groups starting with underscores. To exclude internal groups, see the following code snippet: .. tabs:: .. code-tab:: gdscript - # Stores the node's non-internal groups only (as an array of Strings). + # Stores the node's non-internal groups only (as an array of StringNames). var non_internal_groups = [] for group in get_groups(): - if not group.begins_with("_"): + if not str(group).begins_with("_"): non_internal_groups.push_back(group) .. code-tab:: csharp - // Stores the node's non-internal groups only (as a List of strings). + // Stores the node's non-internal groups only (as a List of StringNames). List<string> nonInternalGroups = new List<string>(); foreach (string group in GetGroups()) { @@ -1728,9 +1732,9 @@ Returns an array listing the groups that the node is a member of. :ref:`int<class_int>` **get_index** **(** :ref:`bool<class_bool>` include_internal=false **)** |const| -Returns the node's order in the scene tree branch. For example, if called on the first child node the position is ``0``. +Returns this node's order among its siblings. The first node's index is ``0``. See also :ref:`get_child<class_Node_method_get_child>`. -If ``include_internal`` is ``false``, the index won't take internal children into account, i.e. first non-internal child will have index of 0 (see ``internal`` parameter in :ref:`add_child<class_Node_method_add_child>`). +If ``include_internal`` is ``false``, returns the index ignoring internal children. The first, non-internal child will have an index of ``0`` (see :ref:`add_child<class_Node_method_add_child>`'s ``internal`` parameter). .. rst-class:: classref-item-separator @@ -1766,24 +1770,26 @@ Returns the peer ID of the multiplayer authority for this node. See :ref:`set_mu :ref:`Node<class_Node>` **get_node** **(** :ref:`NodePath<class_NodePath>` path **)** |const| -Fetches a node. The :ref:`NodePath<class_NodePath>` can be either a relative path (from the current node) or an absolute path (in the scene tree) to a node. If the path does not exist, ``null`` is returned and an error is logged. Attempts to access methods on the return value will result in an "Attempt to call <method> on a null instance." error. +Fetches a node. The :ref:`NodePath<class_NodePath>` can either be a relative path (from this node), or an absolute path (from the :ref:`SceneTree.root<class_SceneTree_property_root>`) to a node. If ``path`` does not point to a valid node, generates an error and returns ``null``. Attempts to access methods on the return value will result in an *"Attempt to call <method> on a null instance."* error. -\ **Note:** Fetching absolute paths only works when the node is inside the scene tree (see :ref:`is_inside_tree<class_Node_method_is_inside_tree>`). +\ **Note:** Fetching by absolute path only works when the node is inside the scene tree (see :ref:`is_inside_tree<class_Node_method_is_inside_tree>`). -\ **Example:** Assume your current node is Character and the following tree: +\ **Example:** Assume this method is called from the Character node, inside the following tree: :: - /root - /root/Character - /root/Character/Sword - /root/Character/Backpack/Dagger - /root/MyGame - /root/Swamp/Alligator - /root/Swamp/Mosquito - /root/Swamp/Goblin + ┖╴root + ┠╴Character (you are here!) + ┃ ┠╴Sword + ┃ ┖╴Backpack + ┃ ┖╴Dagger + ┠╴MyGame + ┖╴Swamp + ┠╴Alligator + ┠╴Mosquito + ┖╴Goblin -Possible paths are: +The following calls will return a valid node: .. tabs:: @@ -1814,26 +1820,52 @@ Possible paths are: :ref:`Array<class_Array>` **get_node_and_resource** **(** :ref:`NodePath<class_NodePath>` path **)** -Fetches a node and one of its resources as specified by the :ref:`NodePath<class_NodePath>`'s subname (e.g. ``Area2D/CollisionShape2D:shape``). If several nested resources are specified in the :ref:`NodePath<class_NodePath>`, the last one will be fetched. +Fetches a node and its most nested resource as specified by the :ref:`NodePath<class_NodePath>`'s subname. Returns an :ref:`Array<class_Array>` of size ``3`` where: -The return value is an array of size 3: the first index points to the **Node** (or ``null`` if not found), the second index points to the :ref:`Resource<class_Resource>` (or ``null`` if not found), and the third index is the remaining :ref:`NodePath<class_NodePath>`, if any. +- Element ``0`` is the **Node**, or ``null`` if not found; -For example, assuming that ``Area2D/CollisionShape2D`` is a valid node and that its ``shape`` property has been assigned a :ref:`RectangleShape2D<class_RectangleShape2D>` resource, one could have this kind of output: +- Element ``1`` is the subname's last nested :ref:`Resource<class_Resource>`, or ``null`` if not found; + +- Element ``2`` is the remaining :ref:`NodePath<class_NodePath>`, referring to an existing, non-:ref:`Resource<class_Resource>` property (see :ref:`Object.get_indexed<class_Object_method_get_indexed>`). + +\ **Example:** Assume that the child's :ref:`Sprite2D.texture<class_Sprite2D_property_texture>` has been assigned a :ref:`AtlasTexture<class_AtlasTexture>`: .. tabs:: .. code-tab:: gdscript - print(get_node_and_resource("Area2D/CollisionShape2D")) # [[CollisionShape2D:1161], Null, ] - print(get_node_and_resource("Area2D/CollisionShape2D:shape")) # [[CollisionShape2D:1161], [RectangleShape2D:1156], ] - print(get_node_and_resource("Area2D/CollisionShape2D:shape:extents")) # [[CollisionShape2D:1161], [RectangleShape2D:1156], :extents] + var a = get_node_and_resource("Area2D/Sprite2D") + print(a[0].name) # Prints Sprite2D + print(a[1]) # Prints <null> + print(a[2]) # Prints ^"" + + var b = get_node_and_resource("Area2D/Sprite2D:texture:atlas") + print(b[0].name) # Prints Sprite2D + print(b[1].get_class()) # Prints AtlasTexture + print(b[2]) # Prints ^"" + + var c = get_node_and_resource("Area2D/Sprite2D:texture:atlas:region") + print(c[0].name) # Prints Sprite2D + print(c[1].get_class()) # Prints AtlasTexture + print(c[2]) # Prints ^":region" .. code-tab:: csharp - GD.Print(GetNodeAndResource("Area2D/CollisionShape2D")); // [[CollisionShape2D:1161], Null, ] - GD.Print(GetNodeAndResource("Area2D/CollisionShape2D:shape")); // [[CollisionShape2D:1161], [RectangleShape2D:1156], ] - GD.Print(GetNodeAndResource("Area2D/CollisionShape2D:shape:extents")); // [[CollisionShape2D:1161], [RectangleShape2D:1156], :extents] + var a = GetNodeAndResource(NodePath("Area2D/Sprite2D")); + GD.Print(a[0].Name); // Prints Sprite2D + GD.Print(a[1]); // Prints <null> + GD.Print(a[2]); // Prints ^" + + var b = GetNodeAndResource(NodePath("Area2D/Sprite2D:texture:atlas")); + GD.Print(b[0].name); // Prints Sprite2D + GD.Print(b[1].get_class()); // Prints AtlasTexture + GD.Print(b[2]); // Prints ^"" + + var c = GetNodeAndResource(NodePath("Area2D/Sprite2D:texture:atlas:region")); + GD.Print(c[0].name); // Prints Sprite2D + GD.Print(c[1].get_class()); // Prints AtlasTexture + GD.Print(c[2]); // Prints ^":region" @@ -1847,7 +1879,7 @@ For example, assuming that ``Area2D/CollisionShape2D`` is a valid node and that :ref:`Node<class_Node>` **get_node_or_null** **(** :ref:`NodePath<class_NodePath>` path **)** |const| -Similar to :ref:`get_node<class_Node_method_get_node>`, but does not log an error if ``path`` does not point to a valid **Node**. +Fetches a node by :ref:`NodePath<class_NodePath>`. Similar to :ref:`get_node<class_Node_method_get_node>`, but does not generate an error if ``path`` does not point to a valid node. .. rst-class:: classref-item-separator @@ -1859,7 +1891,7 @@ Similar to :ref:`get_node<class_Node_method_get_node>`, but does not log an erro :ref:`Node<class_Node>` **get_parent** **(** **)** |const| -Returns the parent node of the current node, or ``null`` if the node lacks a parent. +Returns this node's parent node, or ``null`` if the node doesn't have a parent. .. rst-class:: classref-item-separator @@ -1871,7 +1903,7 @@ Returns the parent node of the current node, or ``null`` if the node lacks a par :ref:`NodePath<class_NodePath>` **get_path** **(** **)** |const| -Returns the absolute path of the current node. This only works if the current node is inside the scene tree (see :ref:`is_inside_tree<class_Node_method_is_inside_tree>`). +Returns the node's absolute path, relative to the :ref:`SceneTree.root<class_SceneTree_property_root>`. If the node is not inside the scene tree, this method fails and returns an empty :ref:`NodePath<class_NodePath>`. .. rst-class:: classref-item-separator @@ -1883,11 +1915,11 @@ Returns the absolute path of the current node. This only works if the current no :ref:`NodePath<class_NodePath>` **get_path_to** **(** :ref:`Node<class_Node>` node, :ref:`bool<class_bool>` use_unique_path=false **)** |const| -Returns the relative :ref:`NodePath<class_NodePath>` from this node to the specified ``node``. Both nodes must be in the same scene or the function will fail. +Returns the relative :ref:`NodePath<class_NodePath>` from this node to the specified ``node``. Both nodes must be in the same :ref:`SceneTree<class_SceneTree>`, otherwise this method fails and returns an empty :ref:`NodePath<class_NodePath>`. -If ``use_unique_path`` is ``true``, returns the shortest path considering unique node. +If ``use_unique_path`` is ``true``, returns the shortest path accounting for this node's unique name (see :ref:`unique_name_in_owner<class_Node_property_unique_name_in_owner>`). -\ **Note:** If you get a relative path which starts from a unique node, the path may be longer than a normal relative path due to the addition of the unique node's name. +\ **Note:** If you get a relative path which starts from a unique node, the path may be longer than a normal relative path, due to the addition of the unique node's name. .. rst-class:: classref-item-separator @@ -1899,7 +1931,7 @@ If ``use_unique_path`` is ``true``, returns the shortest path considering unique :ref:`float<class_float>` **get_physics_process_delta_time** **(** **)** |const| -Returns the time elapsed (in seconds) since the last physics-bound frame (see :ref:`_physics_process<class_Node_private_method__physics_process>`). This is always a constant value in physics processing unless the frames per second is changed via :ref:`Engine.physics_ticks_per_second<class_Engine_property_physics_ticks_per_second>`. +Returns the time elapsed (in seconds) since the last physics callback. This value is identical to :ref:`_physics_process<class_Node_private_method__physics_process>`'s ``delta`` parameter, and is often consistent at run-time, unless :ref:`Engine.physics_ticks_per_second<class_Engine_property_physics_ticks_per_second>` is changed. See also :ref:`NOTIFICATION_PHYSICS_PROCESS<class_Node_constant_NOTIFICATION_PHYSICS_PROCESS>`. .. rst-class:: classref-item-separator @@ -1911,7 +1943,7 @@ Returns the time elapsed (in seconds) since the last physics-bound frame (see :r :ref:`float<class_float>` **get_process_delta_time** **(** **)** |const| -Returns the time elapsed (in seconds) since the last process callback. This value may vary from frame to frame. +Returns the time elapsed (in seconds) since the last process callback. This value is identical to :ref:`_process<class_Node_private_method__process>`'s ``delta`` parameter, and may vary from frame to frame. See also :ref:`NOTIFICATION_PROCESS<class_Node_constant_NOTIFICATION_PROCESS>`. .. rst-class:: classref-item-separator @@ -1923,7 +1955,7 @@ Returns the time elapsed (in seconds) since the last process callback. This valu :ref:`bool<class_bool>` **get_scene_instance_load_placeholder** **(** **)** |const| -Returns ``true`` if this is an instance load placeholder. See :ref:`InstancePlaceholder<class_InstancePlaceholder>`. +Returns ``true`` if this node is an instance load placeholder. See :ref:`InstancePlaceholder<class_InstancePlaceholder>` and :ref:`set_scene_instance_load_placeholder<class_Node_method_set_scene_instance_load_placeholder>`. .. rst-class:: classref-item-separator @@ -1935,7 +1967,7 @@ Returns ``true`` if this is an instance load placeholder. See :ref:`InstancePlac :ref:`SceneTree<class_SceneTree>` **get_tree** **(** **)** |const| -Returns the :ref:`SceneTree<class_SceneTree>` that contains this node. Returns ``null`` and prints an error if this node is not inside the scene tree. See also :ref:`is_inside_tree<class_Node_method_is_inside_tree>`. +Returns the :ref:`SceneTree<class_SceneTree>` that contains this node. If this node is not inside the tree, generates an error and returns ``null``. See also :ref:`is_inside_tree<class_Node_method_is_inside_tree>`. .. rst-class:: classref-item-separator @@ -1993,7 +2025,7 @@ Similar to :ref:`get_tree_string<class_Node_method_get_tree_string>`, this retur :ref:`Viewport<class_Viewport>` **get_viewport** **(** **)** |const| -Returns the node's :ref:`Viewport<class_Viewport>`. +Returns the node's closest :ref:`Viewport<class_Viewport>` ancestor, if the node is inside the tree. Otherwise, returns ``null``. .. rst-class:: classref-item-separator @@ -2017,7 +2049,7 @@ Returns the :ref:`Window<class_Window>` that contains this node. If the node is :ref:`bool<class_bool>` **has_node** **(** :ref:`NodePath<class_NodePath>` path **)** |const| -Returns ``true`` if the node that the :ref:`NodePath<class_NodePath>` points to exists. +Returns ``true`` if the ``path`` points to a valid node. See also :ref:`get_node<class_Node_method_get_node>`. .. rst-class:: classref-item-separator @@ -2029,7 +2061,7 @@ Returns ``true`` if the node that the :ref:`NodePath<class_NodePath>` points to :ref:`bool<class_bool>` **has_node_and_resource** **(** :ref:`NodePath<class_NodePath>` path **)** |const| -Returns ``true`` if the :ref:`NodePath<class_NodePath>` points to a valid node and its subname points to a valid resource, e.g. ``Area2D/CollisionShape2D:shape``. Properties with a non-:ref:`Resource<class_Resource>` type (e.g. nodes or primitive math types) are not considered resources. +Returns ``true`` if ``path`` points to a valid node and its subnames point to a valid :ref:`Resource<class_Resource>`, e.g. ``Area2D/CollisionShape2D:shape``. Properties that are not :ref:`Resource<class_Resource>` types (such as nodes or other :ref:`Variant<class_Variant>` types) are not considered. See also :ref:`get_node_and_resource<class_Node_method_get_node_and_resource>`. .. rst-class:: classref-item-separator @@ -2041,7 +2073,7 @@ Returns ``true`` if the :ref:`NodePath<class_NodePath>` points to a valid node a :ref:`bool<class_bool>` **is_ancestor_of** **(** :ref:`Node<class_Node>` node **)** |const| -Returns ``true`` if the given node is a direct or indirect child of the current node. +Returns ``true`` if the given ``node`` is a direct or indirect child of this node. .. rst-class:: classref-item-separator @@ -2053,7 +2085,7 @@ Returns ``true`` if the given node is a direct or indirect child of the current :ref:`bool<class_bool>` **is_displayed_folded** **(** **)** |const| -Returns ``true`` if the node is folded (collapsed) in the Scene dock. This method is only intended for use with editor tooling. +Returns ``true`` if the node is folded (collapsed) in the Scene dock. This method is intended to be used in editor plugins and tools. See also :ref:`set_display_folded<class_Node_method_set_display_folded>`. .. rst-class:: classref-item-separator @@ -2065,7 +2097,7 @@ Returns ``true`` if the node is folded (collapsed) in the Scene dock. This metho :ref:`bool<class_bool>` **is_editable_instance** **(** :ref:`Node<class_Node>` node **)** |const| -Returns ``true`` if ``node`` has editable children enabled relative to this node. This method is only intended for use with editor tooling. +Returns ``true`` if ``node`` has editable children enabled relative to this node. This method is intended to be used in editor plugins and tools. See also :ref:`set_editable_instance<class_Node_method_set_editable_instance>`. .. rst-class:: classref-item-separator @@ -2077,7 +2109,7 @@ Returns ``true`` if ``node`` has editable children enabled relative to this node :ref:`bool<class_bool>` **is_greater_than** **(** :ref:`Node<class_Node>` node **)** |const| -Returns ``true`` if the given node occurs later in the scene hierarchy than the current node. +Returns ``true`` if the given ``node`` occurs later in the scene hierarchy than this node. A node occurring later is usually processed last. .. rst-class:: classref-item-separator @@ -2089,7 +2121,7 @@ Returns ``true`` if the given node occurs later in the scene hierarchy than the :ref:`bool<class_bool>` **is_in_group** **(** :ref:`StringName<class_StringName>` group **)** |const| -Returns ``true`` if this node is in the specified group. See notes in the description, and the group methods in :ref:`SceneTree<class_SceneTree>`. +Returns ``true`` if this node has been added to the given ``group``. See :ref:`add_to_group<class_Node_method_add_to_group>` and :ref:`remove_from_group<class_Node_method_remove_from_group>`. See also notes in the description, and the :ref:`SceneTree<class_SceneTree>`'s group methods. .. rst-class:: classref-item-separator @@ -2101,7 +2133,7 @@ Returns ``true`` if this node is in the specified group. See notes in the descri :ref:`bool<class_bool>` **is_inside_tree** **(** **)** |const| -Returns ``true`` if this node is currently inside a :ref:`SceneTree<class_SceneTree>`. +Returns ``true`` if this node is currently inside a :ref:`SceneTree<class_SceneTree>`. See also :ref:`get_tree<class_Node_method_get_tree>`. .. rst-class:: classref-item-separator @@ -2235,9 +2267,9 @@ Returns ``true`` if the node is processing unhandled key input (see :ref:`set_pr void **move_child** **(** :ref:`Node<class_Node>` child_node, :ref:`int<class_int>` to_index **)** -Moves a child node to a different index (order) among the other children. Since calls, signals, etc. are performed by tree order, changing the order of children nodes may be useful. If ``to_index`` is negative, the index will be counted from the end. +Moves ``child_node`` to the given index. A node's index is the order among its siblings. If ``to_index`` is negative, the index is counted from the end of the list. See also :ref:`get_child<class_Node_method_get_child>` and :ref:`get_index<class_Node_method_get_index>`. -\ **Note:** Internal children can only be moved within their expected "internal range" (see ``internal`` parameter in :ref:`add_child<class_Node_method_add_child>`). +\ **Note:** The processing order of several engine callbacks (:ref:`_ready<class_Node_private_method__ready>`, :ref:`_process<class_Node_private_method__process>`, etc.) and notifications sent through :ref:`propagate_notification<class_Node_method_propagate_notification>` is affected by tree order. :ref:`CanvasItem<class_CanvasItem>` nodes are also rendered in tree order. See also :ref:`process_priority<class_Node_property_process_priority>`. .. rst-class:: classref-item-separator @@ -2273,9 +2305,9 @@ Similar to :ref:`call_thread_safe<class_Node_method_call_thread_safe>`, but for void **print_orphan_nodes** **(** **)** |static| -Prints all orphan nodes (nodes outside the :ref:`SceneTree<class_SceneTree>`). Used for debugging. +Prints all orphan nodes (nodes outside the :ref:`SceneTree<class_SceneTree>`). Useful for debugging. -\ **Note:** :ref:`print_orphan_nodes<class_Node_method_print_orphan_nodes>` only works in debug builds. When called in a project exported in release mode, :ref:`print_orphan_nodes<class_Node_method_print_orphan_nodes>` will not print anything. +\ **Note:** This method only works in debug builds. Does nothing in a project exported in release mode. .. rst-class:: classref-item-separator @@ -2287,18 +2319,18 @@ Prints all orphan nodes (nodes outside the :ref:`SceneTree<class_SceneTree>`). U void **print_tree** **(** **)** -Prints the tree to stdout. Used mainly for debugging purposes. This version displays the path relative to the current node, and is good for copy/pasting into the :ref:`get_node<class_Node_method_get_node>` function. +Prints the node and its children to the console, recursively. The node does not have to be inside the tree. This method outputs :ref:`NodePath<class_NodePath>`\ s relative to this node, and is good for copy/pasting into :ref:`get_node<class_Node_method_get_node>`. See also :ref:`print_tree_pretty<class_Node_method_print_tree_pretty>`. \ **Example output:**\ :: - TheGame - TheGame/Menu - TheGame/Menu/Label - TheGame/Menu/Camera2D - TheGame/SplashScreen - TheGame/SplashScreen/Camera2D + . + Menu + Menu/Label + Menu/Camera2D + SplashScreen + SplashScreen/Camera2D .. rst-class:: classref-item-separator @@ -2310,7 +2342,7 @@ Prints the tree to stdout. Used mainly for debugging purposes. This version disp void **print_tree_pretty** **(** **)** -Similar to :ref:`print_tree<class_Node_method_print_tree>`, this prints the tree to stdout. This version displays a more graphical representation similar to what is displayed in the Scene Dock. It is useful for inspecting larger trees. +Prints the node and its children to the console, recursively. The node does not have to be inside the tree. Similar to :ref:`print_tree<class_Node_method_print_tree>`, but the graphical representation looks like what is displayed in the editor's Scene dock. It is useful for inspecting larger trees. \ **Example output:**\ @@ -2333,7 +2365,9 @@ Similar to :ref:`print_tree<class_Node_method_print_tree>`, this prints the tree void **propagate_call** **(** :ref:`StringName<class_StringName>` method, :ref:`Array<class_Array>` args=[], :ref:`bool<class_bool>` parent_first=false **)** -Calls the given method (if present) with the arguments given in ``args`` on this node and recursively on all its children. If the ``parent_first`` argument is ``true``, the method will be called on the current node first, then on all its children. If ``parent_first`` is ``false``, the children will be called first. +Calls the given ``method`` name, passing ``args`` as arguments, on this node and all of its children, recursively. + +If ``parent_first`` is ``true``, the method is called on this node first, then on all of its children. If ``false``, the children's methods are called first. .. rst-class:: classref-item-separator @@ -2345,7 +2379,7 @@ Calls the given method (if present) with the arguments given in ``args`` on this void **propagate_notification** **(** :ref:`int<class_int>` what **)** -Notifies the current node and all its children recursively by calling :ref:`Object.notification<class_Object_method_notification>` on all of them. +Calls :ref:`Object.notification<class_Object_method_notification>` with ``what`` on this node and all of its children, recursively. .. rst-class:: classref-item-separator @@ -2357,11 +2391,11 @@ Notifies the current node and all its children recursively by calling :ref:`Obje void **queue_free** **(** **)** -Queues a node for deletion at the end of the current frame. When deleted, all of its child nodes will be deleted as well, and all references to the node and its children will become invalid, see :ref:`Object.free<class_Object_method_free>`. +Queues this node to be deleted at the end of the current frame. When deleted, all of its children are deleted as well, and all references to the node and its children become invalid. -It is safe to call :ref:`queue_free<class_Node_method_queue_free>` multiple times per frame on a node, and to :ref:`Object.free<class_Object_method_free>` a node that is currently queued for deletion. Use :ref:`Object.is_queued_for_deletion<class_Object_method_is_queued_for_deletion>` to check whether a node will be deleted at the end of the frame. +Unlike with :ref:`Object.free<class_Object_method_free>`, the node is not deleted instantly, and it can still be accessed before deletion. It is also safe to call :ref:`queue_free<class_Node_method_queue_free>` multiple times. Use :ref:`Object.is_queued_for_deletion<class_Object_method_is_queued_for_deletion>` to check if the node will be deleted at the end of the frame. -The node will only be freed after all other deferred calls are finished, so using :ref:`queue_free<class_Node_method_queue_free>` is not always the same as calling :ref:`Object.free<class_Object_method_free>` through :ref:`Object.call_deferred<class_Object_method_call_deferred>`. +\ **Note:** The node will only be freed after all other deferred calls are finished. Using this method is not always the same as calling :ref:`Object.free<class_Object_method_free>` through :ref:`Object.call_deferred<class_Object_method_call_deferred>`. .. rst-class:: classref-item-separator @@ -2373,9 +2407,9 @@ The node will only be freed after all other deferred calls are finished, so usin void **remove_child** **(** :ref:`Node<class_Node>` node **)** -Removes a child node. The node is NOT deleted and must be deleted manually. +Removes a child ``node``. The ``node``, along with its children, are **not** deleted. To delete a node, see :ref:`queue_free<class_Node_method_queue_free>`. -\ **Note:** This function may set the :ref:`owner<class_Node_property_owner>` of the removed Node (or its descendants) to be ``null``, if that :ref:`owner<class_Node_property_owner>` is no longer a parent or ancestor. +\ **Note:** When this node is inside the tree, this method sets the :ref:`owner<class_Node_property_owner>` of the removed ``node`` (or its descendants) to ``null``, if their :ref:`owner<class_Node_property_owner>` is no longer an ancestor (see :ref:`is_ancestor_of<class_Node_method_is_ancestor_of>`). .. rst-class:: classref-item-separator @@ -2387,7 +2421,7 @@ Removes a child node. The node is NOT deleted and must be deleted manually. void **remove_from_group** **(** :ref:`StringName<class_StringName>` group **)** -Removes a node from the ``group``. Does nothing if the node is not in the ``group``. See notes in the description, and the group methods in :ref:`SceneTree<class_SceneTree>`. +Removes the node from the given ``group``. Does nothing if the node is not in the ``group``. See also notes in the description, and the :ref:`SceneTree<class_SceneTree>`'s group methods. .. rst-class:: classref-item-separator @@ -2413,13 +2447,11 @@ If ``keep_global_transform`` is ``true``, the node's global transform will be pr void **replace_by** **(** :ref:`Node<class_Node>` node, :ref:`bool<class_bool>` keep_groups=false **)** -Replaces a node in a scene by the given one. Subscriptions that pass through this node will be lost. +Replaces this node by the given ``node``. All children of this node are moved to ``node``. -If ``keep_groups`` is ``true``, the ``node`` is added to the same groups that the replaced node is in. +If ``keep_groups`` is ``true``, the ``node`` is added to the same groups that the replaced node is in (see :ref:`add_to_group<class_Node_method_add_to_group>`). -\ **Note:** The given node will become the new parent of any child nodes that the replaced node had. - -\ **Note:** The replaced node is not automatically freed, so you either need to keep it in a variable for later use or free it using :ref:`Object.free<class_Object_method_free>`. +\ **Warning:** The replaced node is removed from the tree, but it is **not** deleted. To prevent memory leaks, store a reference to the node in a variable, or use :ref:`Object.free<class_Object_method_free>`. .. rst-class:: classref-item-separator @@ -2431,7 +2463,9 @@ If ``keep_groups`` is ``true``, the ``node`` is added to the same groups that th void **request_ready** **(** **)** -Requests that :ref:`_ready<class_Node_private_method__ready>` be called again. Note that the method won't be called immediately, but is scheduled for when the node is added to the scene tree again. :ref:`_ready<class_Node_private_method__ready>` is called only for the node which requested it, which means that you need to request ready for each child if you want them to call :ref:`_ready<class_Node_private_method__ready>` too (in which case, :ref:`_ready<class_Node_private_method__ready>` will be called in the same order as it would normally). +Requests :ref:`_ready<class_Node_private_method__ready>` to be called again the next time the node enters the tree. Does **not** immediately call :ref:`_ready<class_Node_private_method__ready>`. + +\ **Note:** This method only affects the current node. If the node's children also need to request ready, this method needs to be called for each one of them. When the node and its children enter the tree again, the order of :ref:`_ready<class_Node_private_method__ready>` callbacks will be the same as normal. .. rst-class:: classref-item-separator @@ -2443,9 +2477,11 @@ Requests that :ref:`_ready<class_Node_private_method__ready>` be called again. N :ref:`Error<enum_@GlobalScope_Error>` **rpc** **(** :ref:`StringName<class_StringName>` method, ... **)** |vararg| -Sends a remote procedure call request for the given ``method`` to peers on the network (and locally), optionally sending all additional arguments as arguments to the method called by the RPC. The call request will only be received by nodes with the same :ref:`NodePath<class_NodePath>`, including the exact same node name. Behavior depends on the RPC configuration for the given method, see :ref:`rpc_config<class_Node_method_rpc_config>` and :ref:`@GDScript.@rpc<class_@GDScript_annotation_@rpc>`. Methods are not exposed to RPCs by default. Returns ``null``. +Sends a remote procedure call request for the given ``method`` to peers on the network (and locally), sending additional arguments to the method called by the RPC. The call request will only be received by nodes with the same :ref:`NodePath<class_NodePath>`, including the exact same :ref:`name<class_Node_property_name>`. Behavior depends on the RPC configuration for the given ``method`` (see :ref:`rpc_config<class_Node_method_rpc_config>` and :ref:`@GDScript.@rpc<class_@GDScript_annotation_@rpc>`). By default, methods are not exposed to RPCs. -\ **Note:** You can only safely use RPCs on clients after you received the ``connected_to_server`` signal from the :ref:`MultiplayerAPI<class_MultiplayerAPI>`. You also need to keep track of the connection state, either by the :ref:`MultiplayerAPI<class_MultiplayerAPI>` signals like ``server_disconnected`` or by checking ``get_multiplayer().peer.get_connection_status() == CONNECTION_CONNECTED``. +May return :ref:`@GlobalScope.OK<class_@GlobalScope_constant_OK>` if the call is successful, :ref:`@GlobalScope.ERR_INVALID_PARAMETER<class_@GlobalScope_constant_ERR_INVALID_PARAMETER>` if the arguments passed in the ``method`` do not match, :ref:`@GlobalScope.ERR_UNCONFIGURED<class_@GlobalScope_constant_ERR_UNCONFIGURED>` if the node's :ref:`multiplayer<class_Node_property_multiplayer>` cannot be fetched (such as when the node is not inside the tree), :ref:`@GlobalScope.ERR_CONNECTION_ERROR<class_@GlobalScope_constant_ERR_CONNECTION_ERROR>` if :ref:`multiplayer<class_Node_property_multiplayer>`'s connection is not available. + +\ **Note:** You can only safely use RPCs on clients after you received the :ref:`MultiplayerAPI.connected_to_server<class_MultiplayerAPI_signal_connected_to_server>` signal from the :ref:`MultiplayerAPI<class_MultiplayerAPI>`. You also need to keep track of the connection state, either by the :ref:`MultiplayerAPI<class_MultiplayerAPI>` signals like :ref:`MultiplayerAPI.server_disconnected<class_MultiplayerAPI_signal_server_disconnected>` or by checking (``get_multiplayer().peer.get_connection_status() == CONNECTION_CONNECTED``). .. rst-class:: classref-item-separator @@ -2457,18 +2493,17 @@ Sends a remote procedure call request for the given ``method`` to peers on the n void **rpc_config** **(** :ref:`StringName<class_StringName>` method, :ref:`Variant<class_Variant>` config **)** -Changes the RPC mode for the given ``method`` with the given ``config`` which should be ``null`` (to disable) or a :ref:`Dictionary<class_Dictionary>` in the form: +Changes the RPC configuration for the given ``method``. ``config`` should either be ``null`` to disable the feature (as by default), or a :ref:`Dictionary<class_Dictionary>` containing the following entries: -:: +- ``rpc_mode``: see :ref:`RPCMode<enum_MultiplayerAPI_RPCMode>`; - { - rpc_mode = MultiplayerAPI.RPCMode, - transfer_mode = MultiplayerPeer.TransferMode, - call_local = false, - channel = 0, - } +- ``transfer_mode``: see :ref:`TransferMode<enum_MultiplayerPeer_TransferMode>`; -See :ref:`RPCMode<enum_MultiplayerAPI_RPCMode>` and :ref:`TransferMode<enum_MultiplayerPeer_TransferMode>`. An alternative is annotating methods and properties with the corresponding :ref:`@GDScript.@rpc<class_@GDScript_annotation_@rpc>` annotation (``@rpc("any_peer")``, ``@rpc("authority")``). By default, methods are not exposed to networking (and RPCs). +- ``call_local``: if ``true``, the method will also be called locally; + +- ``channel``: an :ref:`int<class_int>` representing the channel to send the RPC on. + +\ **Note:** In GDScript, this method corresponds to the :ref:`@GDScript.@rpc<class_@GDScript_annotation_@rpc>` annotation, with various parameters passed (``@rpc(any)``, ``@rpc(authority)``...). See also the :doc:`high-level multiplayer <../tutorials/networking/high_level_multiplayer>` tutorial. .. rst-class:: classref-item-separator @@ -2480,7 +2515,9 @@ See :ref:`RPCMode<enum_MultiplayerAPI_RPCMode>` and :ref:`TransferMode<enum_Mult :ref:`Error<enum_@GlobalScope_Error>` **rpc_id** **(** :ref:`int<class_int>` peer_id, :ref:`StringName<class_StringName>` method, ... **)** |vararg| -Sends a :ref:`rpc<class_Node_method_rpc>` to a specific peer identified by ``peer_id`` (see :ref:`MultiplayerPeer.set_target_peer<class_MultiplayerPeer_method_set_target_peer>`). Returns ``null``. +Sends a :ref:`rpc<class_Node_method_rpc>` to a specific peer identified by ``peer_id`` (see :ref:`MultiplayerPeer.set_target_peer<class_MultiplayerPeer_method_set_target_peer>`). + +May return :ref:`@GlobalScope.OK<class_@GlobalScope_constant_OK>` if the call is successful, :ref:`@GlobalScope.ERR_INVALID_PARAMETER<class_@GlobalScope_constant_ERR_INVALID_PARAMETER>` if the arguments passed in the ``method`` do not match, :ref:`@GlobalScope.ERR_UNCONFIGURED<class_@GlobalScope_constant_ERR_UNCONFIGURED>` if the node's :ref:`multiplayer<class_Node_property_multiplayer>` cannot be fetched (such as when the node is not inside the tree), :ref:`@GlobalScope.ERR_CONNECTION_ERROR<class_@GlobalScope_constant_ERR_CONNECTION_ERROR>` if :ref:`multiplayer<class_Node_property_multiplayer>`'s connection is not available. .. rst-class:: classref-item-separator @@ -2504,7 +2541,7 @@ Similar to :ref:`call_deferred_thread_group<class_Node_method_call_deferred_thre void **set_display_folded** **(** :ref:`bool<class_bool>` fold **)** -Sets the folded state of the node in the Scene dock. This method is only intended for use with editor tooling. +If set to ``true``, the node appears folded in the Scene dock. As a result, all of its children are hidden. This method is intended to be used in editor plugins and tools, but it also works in release builds. See also :ref:`is_displayed_folded<class_Node_method_is_displayed_folded>`. .. rst-class:: classref-item-separator @@ -2516,7 +2553,7 @@ Sets the folded state of the node in the Scene dock. This method is only intende void **set_editable_instance** **(** :ref:`Node<class_Node>` node, :ref:`bool<class_bool>` is_editable **)** -Sets the editable children state of ``node`` relative to this node. This method is only intended for use with editor tooling. +Set to ``true`` to allow all nodes owned by ``node`` to be available, and editable, in the Scene dock, even if their :ref:`owner<class_Node_property_owner>` is not the scene root. This method is intended to be used in editor plugins and tools, but it also works in release builds. See also :ref:`is_editable_instance<class_Node_method_is_editable_instance>`. .. rst-class:: classref-item-separator @@ -2528,9 +2565,11 @@ Sets the editable children state of ``node`` relative to this node. This method void **set_multiplayer_authority** **(** :ref:`int<class_int>` id, :ref:`bool<class_bool>` recursive=true **)** -Sets the node's multiplayer authority to the peer with the given peer ID. The multiplayer authority is the peer that has authority over the node on the network. Useful in conjunction with :ref:`rpc_config<class_Node_method_rpc_config>` and the :ref:`MultiplayerAPI<class_MultiplayerAPI>`. Defaults to peer ID 1 (the server). If ``recursive``, the given peer is recursively set as the authority for all children of this node. +Sets the node's multiplayer authority to the peer with the given peer ``id``. The multiplayer authority is the peer that has authority over the node on the network. Defaults to peer ID 1 (the server). Useful in conjunction with :ref:`rpc_config<class_Node_method_rpc_config>` and the :ref:`MultiplayerAPI<class_MultiplayerAPI>`. -\ **Warning:** This does **not** automatically replicate the new authority to other peers. It is developer's responsibility to do so. You can propagate the information about the new authority using :ref:`MultiplayerSpawner.spawn_function<class_MultiplayerSpawner_property_spawn_function>`, an RPC, or using a :ref:`MultiplayerSynchronizer<class_MultiplayerSynchronizer>`. Also, the parent's authority does **not** propagate to newly added children. +If ``recursive`` is ``true``, the given peer is recursively set as the authority for all children of this node. + +\ **Warning:** This does **not** automatically replicate the new authority to other peers. It is the developer's responsibility to do so. You may replicate the new authority's information using :ref:`MultiplayerSpawner.spawn_function<class_MultiplayerSpawner_property_spawn_function>`, an RPC, or a :ref:`MultiplayerSynchronizer<class_MultiplayerSynchronizer>`. Furthermore, the parent's authority does **not** propagate to newly added children. .. rst-class:: classref-item-separator @@ -2542,7 +2581,7 @@ Sets the node's multiplayer authority to the peer with the given peer ID. The mu void **set_physics_process** **(** :ref:`bool<class_bool>` enable **)** -Enables or disables physics (i.e. fixed framerate) processing. When a node is being processed, it will receive a :ref:`NOTIFICATION_PHYSICS_PROCESS<class_Node_constant_NOTIFICATION_PHYSICS_PROCESS>` at a fixed (usually 60 FPS, see :ref:`Engine.physics_ticks_per_second<class_Engine_property_physics_ticks_per_second>` to change) interval (and the :ref:`_physics_process<class_Node_private_method__physics_process>` callback will be called if exists). Enabled automatically if :ref:`_physics_process<class_Node_private_method__physics_process>` is overridden. Any calls to this before :ref:`_ready<class_Node_private_method__ready>` will be ignored. +If set to ``true``, enables physics (fixed framerate) processing. When a node is being processed, it will receive a :ref:`NOTIFICATION_PHYSICS_PROCESS<class_Node_constant_NOTIFICATION_PHYSICS_PROCESS>` at a fixed (usually 60 FPS, see :ref:`Engine.physics_ticks_per_second<class_Engine_property_physics_ticks_per_second>` to change) interval (and the :ref:`_physics_process<class_Node_private_method__physics_process>` callback will be called if exists). Enabled automatically if :ref:`_physics_process<class_Node_private_method__physics_process>` is overridden. .. rst-class:: classref-item-separator @@ -2554,9 +2593,9 @@ Enables or disables physics (i.e. fixed framerate) processing. When a node is be void **set_physics_process_internal** **(** :ref:`bool<class_bool>` enable **)** -Enables or disables internal physics for this node. Internal physics processing happens in isolation from the normal :ref:`_physics_process<class_Node_private_method__physics_process>` calls and is used by some nodes internally to guarantee proper functioning even if the node is paused or physics processing is disabled for scripting (:ref:`set_physics_process<class_Node_method_set_physics_process>`). Only useful for advanced uses to manipulate built-in nodes' behavior. +If set to ``true``, enables internal physics for this node. Internal physics processing happens in isolation from the normal :ref:`_physics_process<class_Node_private_method__physics_process>` calls and is used by some nodes internally to guarantee proper functioning even if the node is paused or physics processing is disabled for scripting (:ref:`set_physics_process<class_Node_method_set_physics_process>`). -\ **Warning:** Built-in Nodes rely on the internal processing for their own logic, so changing this value from your code may lead to unexpected behavior. Script access to this internal logic is provided for specific advanced uses, but is unsafe and not supported. +\ **Warning:** Built-in nodes rely on internal processing for their internal logic. Disabling it is unsafe and may lead to unexpected behavior. Use this method if you know what you are doing. .. rst-class:: classref-item-separator @@ -2568,7 +2607,7 @@ Enables or disables internal physics for this node. Internal physics processing void **set_process** **(** :ref:`bool<class_bool>` enable **)** -Enables or disables processing. When a node is being processed, it will receive a :ref:`NOTIFICATION_PROCESS<class_Node_constant_NOTIFICATION_PROCESS>` on every drawn frame (and the :ref:`_process<class_Node_private_method__process>` callback will be called if exists). Enabled automatically if :ref:`_process<class_Node_private_method__process>` is overridden. Any calls to this before :ref:`_ready<class_Node_private_method__ready>` will be ignored. +If set to ``true``, enables processing. When a node is being processed, it will receive a :ref:`NOTIFICATION_PROCESS<class_Node_constant_NOTIFICATION_PROCESS>` on every drawn frame (and the :ref:`_process<class_Node_private_method__process>` callback will be called if exists). Enabled automatically if :ref:`_process<class_Node_private_method__process>` is overridden. .. rst-class:: classref-item-separator @@ -2580,7 +2619,7 @@ Enables or disables processing. When a node is being processed, it will receive void **set_process_input** **(** :ref:`bool<class_bool>` enable **)** -Enables or disables input processing. This is not required for GUI controls! Enabled automatically if :ref:`_input<class_Node_private_method__input>` is overridden. Any calls to this before :ref:`_ready<class_Node_private_method__ready>` will be ignored. +If set to ``true``, enables input processing. This is not required for GUI controls! Enabled automatically if :ref:`_input<class_Node_private_method__input>` is overridden. .. rst-class:: classref-item-separator @@ -2592,9 +2631,9 @@ Enables or disables input processing. This is not required for GUI controls! Ena void **set_process_internal** **(** :ref:`bool<class_bool>` enable **)** -Enables or disabled internal processing for this node. Internal processing happens in isolation from the normal :ref:`_process<class_Node_private_method__process>` calls and is used by some nodes internally to guarantee proper functioning even if the node is paused or processing is disabled for scripting (:ref:`set_process<class_Node_method_set_process>`). Only useful for advanced uses to manipulate built-in nodes' behavior. +If set to ``true``, enables internal processing for this node. Internal processing happens in isolation from the normal :ref:`_process<class_Node_private_method__process>` calls and is used by some nodes internally to guarantee proper functioning even if the node is paused or processing is disabled for scripting (:ref:`set_process<class_Node_method_set_process>`). -\ **Warning:** Built-in Nodes rely on the internal processing for their own logic, so changing this value from your code may lead to unexpected behavior. Script access to this internal logic is provided for specific advanced uses, but is unsafe and not supported. +\ **Warning:** Built-in nodes rely on internal processing for their internal logic. Disabling it is unsafe and may lead to unexpected behavior. Use this method if you know what you are doing. .. rst-class:: classref-item-separator @@ -2606,7 +2645,7 @@ Enables or disabled internal processing for this node. Internal processing happe void **set_process_shortcut_input** **(** :ref:`bool<class_bool>` enable **)** -Enables shortcut processing. Enabled automatically if :ref:`_shortcut_input<class_Node_private_method__shortcut_input>` is overridden. Any calls to this before :ref:`_ready<class_Node_private_method__ready>` will be ignored. +If set to ``true``, enables shortcut processing for this node. Enabled automatically if :ref:`_shortcut_input<class_Node_private_method__shortcut_input>` is overridden. .. rst-class:: classref-item-separator @@ -2618,7 +2657,7 @@ Enables shortcut processing. Enabled automatically if :ref:`_shortcut_input<clas void **set_process_unhandled_input** **(** :ref:`bool<class_bool>` enable **)** -Enables unhandled input processing. This is not required for GUI controls! It enables the node to receive all input that was not previously handled (usually by a :ref:`Control<class_Control>`). Enabled automatically if :ref:`_unhandled_input<class_Node_private_method__unhandled_input>` is overridden. Any calls to this before :ref:`_ready<class_Node_private_method__ready>` will be ignored. +If set to ``true``, enables unhandled input processing. This is not required for GUI controls! It enables the node to receive all input that was not previously handled (usually by a :ref:`Control<class_Control>`). Enabled automatically if :ref:`_unhandled_input<class_Node_private_method__unhandled_input>` is overridden. .. rst-class:: classref-item-separator @@ -2630,7 +2669,7 @@ Enables unhandled input processing. This is not required for GUI controls! It en void **set_process_unhandled_key_input** **(** :ref:`bool<class_bool>` enable **)** -Enables unhandled key input processing. Enabled automatically if :ref:`_unhandled_key_input<class_Node_private_method__unhandled_key_input>` is overridden. Any calls to this before :ref:`_ready<class_Node_private_method__ready>` will be ignored. +If set to ``true``, enables unhandled key input processing. Enabled automatically if :ref:`_unhandled_key_input<class_Node_private_method__unhandled_key_input>` is overridden. .. rst-class:: classref-item-separator @@ -2642,7 +2681,7 @@ Enables unhandled key input processing. Enabled automatically if :ref:`_unhandle void **set_scene_instance_load_placeholder** **(** :ref:`bool<class_bool>` load_placeholder **)** -Sets whether this is an instance load placeholder. See :ref:`InstancePlaceholder<class_InstancePlaceholder>`. +If set to ``true``, the node becomes a :ref:`InstancePlaceholder<class_InstancePlaceholder>` when packed and instantiated from a :ref:`PackedScene<class_PackedScene>`. See also :ref:`get_scene_instance_load_placeholder<class_Node_method_get_scene_instance_load_placeholder>`. .. rst-class:: classref-item-separator @@ -2666,9 +2705,7 @@ Similar to :ref:`call_thread_safe<class_Node_method_call_thread_safe>`, but for void **update_configuration_warnings** **(** **)** -Updates the warning displayed for this node in the Scene Dock. - -Use :ref:`_get_configuration_warnings<class_Node_private_method__get_configuration_warnings>` to setup the warning message to display. +Refreshes the warnings displayed for this node in the Scene dock. Use :ref:`_get_configuration_warnings<class_Node_private_method__get_configuration_warnings>` to customize the warning messages to display. .. |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_node2d.rst b/classes/class_node2d.rst index 79b9f50f2..f0455adc9 100644 --- a/classes/class_node2d.rst +++ b/classes/class_node2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Node2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Node2D.xml. .. _class_Node2D: diff --git a/classes/class_node3d.rst b/classes/class_node3d.rst index 4b973f471..16cfea57e 100644 --- a/classes/class_node3d.rst +++ b/classes/class_node3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Node3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Node3D.xml. .. _class_Node3D: @@ -654,7 +654,9 @@ Returns all the gizmos attached to this **Node3D**. :ref:`Node3D<class_Node3D>` **get_parent_node_3d** **(** **)** |const| -Returns the parent **Node3D**, or an empty :ref:`Object<class_Object>` if no parent exists or parent is not of type **Node3D**. +Returns the parent **Node3D**, or ``null`` if no parent exists, the parent is not of type **Node3D**, or :ref:`top_level<class_Node3D_property_top_level>` is ``true``. + +\ **Note:** Calling this method is not equivalent to ``get_parent() as Node3D``, which does not take :ref:`top_level<class_Node3D_property_top_level>` into account. .. rst-class:: classref-item-separator diff --git a/classes/class_node3dgizmo.rst b/classes/class_node3dgizmo.rst index 5577bb969..0699c4d6b 100644 --- a/classes/class_node3dgizmo.rst +++ b/classes/class_node3dgizmo.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Node3DGizmo.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Node3DGizmo.xml. .. _class_Node3DGizmo: diff --git a/classes/class_nodepath.rst b/classes/class_nodepath.rst index af615acf2..d49abfa44 100644 --- a/classes/class_nodepath.rst +++ b/classes/class_nodepath.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/NodePath.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/NodePath.xml. .. _class_NodePath: diff --git a/classes/class_noise.rst b/classes/class_noise.rst index b1b093270..fb3133225 100644 --- a/classes/class_noise.rst +++ b/classes/class_noise.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/noise/doc_classes/Noise.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/noise/doc_classes/Noise.xml. .. _class_Noise: diff --git a/classes/class_noisetexture2d.rst b/classes/class_noisetexture2d.rst index 9c43eb5cb..6b7627104 100644 --- a/classes/class_noisetexture2d.rst +++ b/classes/class_noisetexture2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/noise/doc_classes/NoiseTexture2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/noise/doc_classes/NoiseTexture2D.xml. .. _class_NoiseTexture2D: diff --git a/classes/class_noisetexture3d.rst b/classes/class_noisetexture3d.rst index e0d128333..1e5819716 100644 --- a/classes/class_noisetexture3d.rst +++ b/classes/class_noisetexture3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/noise/doc_classes/NoiseTexture3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/noise/doc_classes/NoiseTexture3D.xml. .. _class_NoiseTexture3D: diff --git a/classes/class_object.rst b/classes/class_object.rst index d5db6d919..6676397b0 100644 --- a/classes/class_object.rst +++ b/classes/class_object.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Object.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Object.xml. .. _class_Object: @@ -281,6 +281,14 @@ Notification received when the object is initialized, before its script is attac Notification received when the object is about to be deleted. Can act as the deconstructor of some programming languages. +.. _class_Object_constant_NOTIFICATION_EXTENSION_RELOADED: + +.. rst-class:: classref-constant + +**NOTIFICATION_EXTENSION_RELOADED** = ``2`` + +Notification received when the object finishes hot reloading. This notification is only sent for extensions classes and derived. + .. rst-class:: classref-section-separator ---- @@ -655,7 +663,7 @@ Override this method to customize existing properties. Every property info goes { if (property["name"].AsStringName() == PropertyName.Number && IsNumberEditable) { - var usage = property["usage"].As>PropertyUsageFlags<() | PropertyUsageFlags.ReadOnly; + var usage = property["usage"].As<PropertyUsageFlags>() | PropertyUsageFlags.ReadOnly; property["usage"] = (int)usage; } } @@ -744,7 +752,7 @@ Calls the ``method`` on the object and returns the result. This method supports Calls the ``method`` on the object during idle time. Always returns null, **not** the method's result. -Idle time happens mainly at the end of process and physics frames. In it, deferred calls will be run until there are none left, which means you can defer calls from other deferred calls and they'll still be run in the current idle time cycle. If not done carefully, this can result in infinite recursion without causing a stack overflow, which will hang the game similarly to an infinite loop. +Idle time happens mainly at the end of process and physics frames. In it, deferred calls will be run until there are none left, which means you can defer calls from other deferred calls and they'll still be run in the current idle time cycle. This means you should not call a method deferred from itself (or from a method called by it), as this causes infinite recursion the same way as if you had called the method directly. This method supports a variable number of arguments, so parameters can be passed as a comma separated list. @@ -1073,7 +1081,7 @@ Returns the :ref:`Variant<class_Variant>` value of the given ``property``. If th var node = new Node2D(); node.Rotation = 1.5f; - var a = node.Get("rotation"); // a is 1.5 + var a = node.Get(Node2D.PropertyName.Rotation); // a is 1.5 @@ -1532,7 +1540,7 @@ Assigns ``value`` to the given ``property``. If the property does not exist or t .. code-tab:: csharp var node = new Node2D(); - node.Set("global_scale", new Vector2(8, 2.5)); + node.Set(Node2D.PropertyName.GlobalScale, new Vector2(8, 2.5)); GD.Print(node.GlobalScale); // Prints Vector2(8, 2.5) @@ -1571,22 +1579,22 @@ Assigns ``value`` to the given ``property``, at the end of the current frame. Th var node = Node2D.new() add_child(node) - node.rotation = 45.0 - node.set_deferred("rotation", 90.0) - print(node.rotation) # Prints 45.0 + node.rotation = 1.5 + node.set_deferred("rotation", 3.0) + print(node.rotation) # Prints 1.5 await get_tree().process_frame - print(node.rotation) # Prints 90.0 + print(node.rotation) # Prints 3.0 .. code-tab:: csharp var node = new Node2D(); - node.Rotation = 45f; - node.SetDeferred("rotation", 90f); - GD.Print(node.Rotation); // Prints 45.0 + node.Rotation = 1.5f; + node.SetDeferred(Node2D.PropertyName.Rotation, 3f); + GD.Print(node.Rotation); // Prints 1.5 await ToSignal(GetTree(), SceneTree.SignalName.ProcessFrame); - GD.Print(node.Rotation); // Prints 90.0 + GD.Print(node.Rotation); // Prints 3.0 diff --git a/classes/class_occluder3d.rst b/classes/class_occluder3d.rst index 1a38021ad..29abf23b7 100644 --- a/classes/class_occluder3d.rst +++ b/classes/class_occluder3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Occluder3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Occluder3D.xml. .. _class_Occluder3D: diff --git a/classes/class_occluderinstance3d.rst b/classes/class_occluderinstance3d.rst index d8323a204..0d9e412d5 100644 --- a/classes/class_occluderinstance3d.rst +++ b/classes/class_occluderinstance3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/OccluderInstance3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/OccluderInstance3D.xml. .. _class_OccluderInstance3D: diff --git a/classes/class_occluderpolygon2d.rst b/classes/class_occluderpolygon2d.rst index cf390932c..d68b738e5 100644 --- a/classes/class_occluderpolygon2d.rst +++ b/classes/class_occluderpolygon2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/OccluderPolygon2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/OccluderPolygon2D.xml. .. _class_OccluderPolygon2D: diff --git a/classes/class_offlinemultiplayerpeer.rst b/classes/class_offlinemultiplayerpeer.rst index 1aa7b2c72..f10fc5fdb 100644 --- a/classes/class_offlinemultiplayerpeer.rst +++ b/classes/class_offlinemultiplayerpeer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/OfflineMultiplayerPeer.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/OfflineMultiplayerPeer.xml. .. _class_OfflineMultiplayerPeer: diff --git a/classes/class_oggpacketsequence.rst b/classes/class_oggpacketsequence.rst index 0daafa575..a9f81eae2 100644 --- a/classes/class_oggpacketsequence.rst +++ b/classes/class_oggpacketsequence.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/ogg/doc_classes/OggPacketSequence.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/ogg/doc_classes/OggPacketSequence.xml. .. _class_OggPacketSequence: diff --git a/classes/class_oggpacketsequenceplayback.rst b/classes/class_oggpacketsequenceplayback.rst index 2c8b750f5..f0f810522 100644 --- a/classes/class_oggpacketsequenceplayback.rst +++ b/classes/class_oggpacketsequenceplayback.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/ogg/doc_classes/OggPacketSequencePlayback.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/ogg/doc_classes/OggPacketSequencePlayback.xml. .. _class_OggPacketSequencePlayback: diff --git a/classes/class_omnilight3d.rst b/classes/class_omnilight3d.rst index 9b9705288..23656600e 100644 --- a/classes/class_omnilight3d.rst +++ b/classes/class_omnilight3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/OmniLight3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/OmniLight3D.xml. .. _class_OmniLight3D: diff --git a/classes/class_openxraction.rst b/classes/class_openxraction.rst index 13ca5faf0..292a338d3 100644 --- a/classes/class_openxraction.rst +++ b/classes/class_openxraction.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/openxr/doc_classes/OpenXRAction.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/openxr/doc_classes/OpenXRAction.xml. .. _class_OpenXRAction: diff --git a/classes/class_openxractionmap.rst b/classes/class_openxractionmap.rst index 94d3b968e..b264772e9 100644 --- a/classes/class_openxractionmap.rst +++ b/classes/class_openxractionmap.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/openxr/doc_classes/OpenXRActionMap.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/openxr/doc_classes/OpenXRActionMap.xml. .. _class_OpenXRActionMap: diff --git a/classes/class_openxractionset.rst b/classes/class_openxractionset.rst index 8e2855979..5a3de80bc 100644 --- a/classes/class_openxractionset.rst +++ b/classes/class_openxractionset.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/openxr/doc_classes/OpenXRActionSet.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/openxr/doc_classes/OpenXRActionSet.xml. .. _class_OpenXRActionSet: diff --git a/classes/class_openxrapiextension.rst b/classes/class_openxrapiextension.rst index c64796c96..a9dba2293 100644 --- a/classes/class_openxrapiextension.rst +++ b/classes/class_openxrapiextension.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/openxr/doc_classes/OpenXRAPIExtension.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/openxr/doc_classes/OpenXRAPIExtension.xml. .. _class_OpenXRAPIExtension: diff --git a/classes/class_openxrextensionwrapperextension.rst b/classes/class_openxrextensionwrapperextension.rst index 4fea0976f..1dca4daa7 100644 --- a/classes/class_openxrextensionwrapperextension.rst +++ b/classes/class_openxrextensionwrapperextension.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/openxr/doc_classes/OpenXRExtensionWrapperExtension.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/openxr/doc_classes/OpenXRExtensionWrapperExtension.xml. .. _class_OpenXRExtensionWrapperExtension: diff --git a/classes/class_openxrhand.rst b/classes/class_openxrhand.rst index 3c06b4f09..1ebf4f9ee 100644 --- a/classes/class_openxrhand.rst +++ b/classes/class_openxrhand.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/openxr/doc_classes/OpenXRHand.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/openxr/doc_classes/OpenXRHand.xml. .. _class_OpenXRHand: diff --git a/classes/class_openxrinteractionprofile.rst b/classes/class_openxrinteractionprofile.rst index d2673643e..f24f36fbc 100644 --- a/classes/class_openxrinteractionprofile.rst +++ b/classes/class_openxrinteractionprofile.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/openxr/doc_classes/OpenXRInteractionProfile.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/openxr/doc_classes/OpenXRInteractionProfile.xml. .. _class_OpenXRInteractionProfile: diff --git a/classes/class_openxrinteractionprofilemetadata.rst b/classes/class_openxrinteractionprofilemetadata.rst index 8d8897c54..974827385 100644 --- a/classes/class_openxrinteractionprofilemetadata.rst +++ b/classes/class_openxrinteractionprofilemetadata.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/openxr/doc_classes/OpenXRInteractionProfileMetadata.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/openxr/doc_classes/OpenXRInteractionProfileMetadata.xml. .. _class_OpenXRInteractionProfileMetadata: diff --git a/classes/class_openxrinterface.rst b/classes/class_openxrinterface.rst index d9284235c..8230163ca 100644 --- a/classes/class_openxrinterface.rst +++ b/classes/class_openxrinterface.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/openxr/doc_classes/OpenXRInterface.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/openxr/doc_classes/OpenXRInterface.xml. .. _class_OpenXRInterface: diff --git a/classes/class_openxripbinding.rst b/classes/class_openxripbinding.rst index 1a1385fb1..0b5d11686 100644 --- a/classes/class_openxripbinding.rst +++ b/classes/class_openxripbinding.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/openxr/doc_classes/OpenXRIPBinding.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/openxr/doc_classes/OpenXRIPBinding.xml. .. _class_OpenXRIPBinding: diff --git a/classes/class_optimizedtranslation.rst b/classes/class_optimizedtranslation.rst index e404d60ac..675110e6f 100644 --- a/classes/class_optimizedtranslation.rst +++ b/classes/class_optimizedtranslation.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/OptimizedTranslation.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/OptimizedTranslation.xml. .. _class_OptimizedTranslation: diff --git a/classes/class_optionbutton.rst b/classes/class_optionbutton.rst index c1b1fe2d4..938fabff7 100644 --- a/classes/class_optionbutton.rst +++ b/classes/class_optionbutton.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/OptionButton.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/OptionButton.xml. .. _class_OptionButton: diff --git a/classes/class_ormmaterial3d.rst b/classes/class_ormmaterial3d.rst index d4d90b5ba..9e69574cc 100644 --- a/classes/class_ormmaterial3d.rst +++ b/classes/class_ormmaterial3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ORMMaterial3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ORMMaterial3D.xml. .. _class_ORMMaterial3D: diff --git a/classes/class_os.rst b/classes/class_os.rst index dd1a56e74..6b2957f65 100644 --- a/classes/class_os.rst +++ b/classes/class_os.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/OS.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/OS.xml. .. _class_OS: @@ -535,6 +535,8 @@ If you wish to access a shell built-in or execute a composite command, a platfor \ **Note:** On macOS, sandboxed applications are limited to run only embedded helper executables, specified during export. +\ **Note:** On Android, system commands such as ``dumpsys`` can only be run on a rooted device. + .. rst-class:: classref-item-separator ---- @@ -634,9 +636,11 @@ For example, in the command line below, ``--fullscreen`` will not be returned in :: - godot --fullscreen -- --level 1 - # Or: - godot --fullscreen ++ --level 1 + # Godot has been executed with the following command: + # godot --fullscreen -- --level=2 --hardcore + + OS.get_cmdline_args() # Returns ["--fullscreen", "--level=2", "--hardcore"] + OS.get_cmdline_user_args() # Returns ["--level=2", "--hardcore"] .. rst-class:: classref-item-separator diff --git a/classes/class_packedbytearray.rst b/classes/class_packedbytearray.rst index ef3301ba4..85ca254e9 100644 --- a/classes/class_packedbytearray.rst +++ b/classes/class_packedbytearray.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PackedByteArray.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PackedByteArray.xml. .. _class_PackedByteArray: @@ -471,6 +471,8 @@ Decodes a size of a :ref:`Variant<class_Variant>` from the bytes starting at ``b Returns a new **PackedByteArray** with the data decompressed. Set ``buffer_size`` to the size of the uncompressed data. Set the compression mode using one of :ref:`CompressionMode<enum_FileAccess_CompressionMode>`'s constants. +\ **Note:** Decompression is not guaranteed to work with data not compressed by Godot, for example if data compressed with the deflate compression mode lacks a checksum or header. + .. rst-class:: classref-item-separator ---- @@ -487,6 +489,8 @@ This method is potentially slower than :ref:`decompress<class_PackedByteArray_me GZIP has a maximal compression ratio of 1032:1, meaning it's very possible for a small compressed payload to decompress to a potentially very large output. To guard against this, you may provide a maximum size this function is allowed to allocate in bytes via ``max_output_size``. Passing -1 will allow for unbounded output. If any positive value is passed, and the decompression exceeds that amount in bytes, then an error will be returned. +\ **Note:** Decompression is not guaranteed to work with data not compressed by Godot, for example if data compressed with the deflate compression mode lacks a checksum or header. + .. rst-class:: classref-item-separator ---- @@ -836,7 +840,7 @@ Removes an element from the array by index. :ref:`int<class_int>` **resize** **(** :ref:`int<class_int>` new_size **)** -Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. +Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. Calling :ref:`resize<class_PackedByteArray_method_resize>` once and assigning the new values is faster than adding new elements one by one. .. rst-class:: classref-item-separator diff --git a/classes/class_packedcolorarray.rst b/classes/class_packedcolorarray.rst index 4f44ff772..3244f7c1f 100644 --- a/classes/class_packedcolorarray.rst +++ b/classes/class_packedcolorarray.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PackedColorArray.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PackedColorArray.xml. .. _class_PackedColorArray: @@ -325,7 +325,7 @@ Removes an element from the array by index. :ref:`int<class_int>` **resize** **(** :ref:`int<class_int>` new_size **)** -Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. +Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. Calling :ref:`resize<class_PackedColorArray_method_resize>` once and assigning the new values is faster than adding new elements one by one. .. rst-class:: classref-item-separator diff --git a/classes/class_packeddatacontainer.rst b/classes/class_packeddatacontainer.rst index 01c94c606..66dbaec6b 100644 --- a/classes/class_packeddatacontainer.rst +++ b/classes/class_packeddatacontainer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PackedDataContainer.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PackedDataContainer.xml. .. _class_PackedDataContainer: diff --git a/classes/class_packeddatacontainerref.rst b/classes/class_packeddatacontainerref.rst index 13d73b0ee..e0de80798 100644 --- a/classes/class_packeddatacontainerref.rst +++ b/classes/class_packeddatacontainerref.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PackedDataContainerRef.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PackedDataContainerRef.xml. .. _class_PackedDataContainerRef: diff --git a/classes/class_packedfloat32array.rst b/classes/class_packedfloat32array.rst index 624448538..bc7bc793f 100644 --- a/classes/class_packedfloat32array.rst +++ b/classes/class_packedfloat32array.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PackedFloat32Array.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PackedFloat32Array.xml. .. _class_PackedFloat32Array: @@ -329,7 +329,7 @@ Removes an element from the array by index. :ref:`int<class_int>` **resize** **(** :ref:`int<class_int>` new_size **)** -Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. +Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. Calling :ref:`resize<class_PackedFloat32Array_method_resize>` once and assigning the new values is faster than adding new elements one by one. .. rst-class:: classref-item-separator diff --git a/classes/class_packedfloat64array.rst b/classes/class_packedfloat64array.rst index 4020f7a7b..a4037c099 100644 --- a/classes/class_packedfloat64array.rst +++ b/classes/class_packedfloat64array.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PackedFloat64Array.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PackedFloat64Array.xml. .. _class_PackedFloat64Array: @@ -329,7 +329,7 @@ Removes an element from the array by index. :ref:`int<class_int>` **resize** **(** :ref:`int<class_int>` new_size **)** -Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. +Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. Calling :ref:`resize<class_PackedFloat64Array_method_resize>` once and assigning the new values is faster than adding new elements one by one. .. rst-class:: classref-item-separator diff --git a/classes/class_packedint32array.rst b/classes/class_packedint32array.rst index e5e4dfa23..429419104 100644 --- a/classes/class_packedint32array.rst +++ b/classes/class_packedint32array.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PackedInt32Array.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PackedInt32Array.xml. .. _class_PackedInt32Array: @@ -321,7 +321,7 @@ Removes an element from the array by index. :ref:`int<class_int>` **resize** **(** :ref:`int<class_int>` new_size **)** -Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. +Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. Calling :ref:`resize<class_PackedInt32Array_method_resize>` once and assigning the new values is faster than adding new elements one by one. .. rst-class:: classref-item-separator diff --git a/classes/class_packedint64array.rst b/classes/class_packedint64array.rst index 8b710ef90..24cec932b 100644 --- a/classes/class_packedint64array.rst +++ b/classes/class_packedint64array.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PackedInt64Array.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PackedInt64Array.xml. .. _class_PackedInt64Array: @@ -321,7 +321,7 @@ Removes an element from the array by index. :ref:`int<class_int>` **resize** **(** :ref:`int<class_int>` new_size **)** -Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. +Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. Calling :ref:`resize<class_PackedInt64Array_method_resize>` once and assigning the new values is faster than adding new elements one by one. .. rst-class:: classref-item-separator diff --git a/classes/class_packedscene.rst b/classes/class_packedscene.rst index be4503e48..34c63eaee 100644 --- a/classes/class_packedscene.rst +++ b/classes/class_packedscene.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PackedScene.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PackedScene.xml. .. _class_PackedScene: @@ -208,7 +208,7 @@ Property Descriptions A dictionary representation of the scene contents. -Available keys include "rnames" and "variants" for resources, "node_count", "nodes", "node_paths" for nodes, "editable_instances" for base scene children overrides, "conn_count" and "conns" for signal connections, and "version" for the format style of the PackedScene. +Available keys include "rnames" and "variants" for resources, "node_count", "nodes", "node_paths" for nodes, "editable_instances" for paths to overridden nodes, "conn_count" and "conns" for signal connections, and "version" for the format style of the PackedScene. .. rst-class:: classref-section-separator diff --git a/classes/class_packedstringarray.rst b/classes/class_packedstringarray.rst index b623f3e9e..f27d1c8b1 100644 --- a/classes/class_packedstringarray.rst +++ b/classes/class_packedstringarray.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PackedStringArray.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PackedStringArray.xml. .. _class_PackedStringArray: @@ -334,7 +334,7 @@ Removes an element from the array by index. :ref:`int<class_int>` **resize** **(** :ref:`int<class_int>` new_size **)** -Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. +Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. Calling :ref:`resize<class_PackedStringArray_method_resize>` once and assigning the new values is faster than adding new elements one by one. .. rst-class:: classref-item-separator diff --git a/classes/class_packedvector2array.rst b/classes/class_packedvector2array.rst index d41288c9d..3acc1fcf6 100644 --- a/classes/class_packedvector2array.rst +++ b/classes/class_packedvector2array.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PackedVector2Array.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PackedVector2Array.xml. .. _class_PackedVector2Array: @@ -342,7 +342,7 @@ Removes an element from the array by index. :ref:`int<class_int>` **resize** **(** :ref:`int<class_int>` new_size **)** -Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. +Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. Calling :ref:`resize<class_PackedVector2Array_method_resize>` once and assigning the new values is faster than adding new elements one by one. .. rst-class:: classref-item-separator diff --git a/classes/class_packedvector3array.rst b/classes/class_packedvector3array.rst index 98bc0ead1..e0a127a5f 100644 --- a/classes/class_packedvector3array.rst +++ b/classes/class_packedvector3array.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PackedVector3Array.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PackedVector3Array.xml. .. _class_PackedVector3Array: @@ -335,7 +335,7 @@ Removes an element from the array by index. :ref:`int<class_int>` **resize** **(** :ref:`int<class_int>` new_size **)** -Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. +Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. Calling :ref:`resize<class_PackedVector3Array_method_resize>` once and assigning the new values is faster than adding new elements one by one. .. rst-class:: classref-item-separator diff --git a/classes/class_packetpeer.rst b/classes/class_packetpeer.rst index e929aa53a..4fe441d7a 100644 --- a/classes/class_packetpeer.rst +++ b/classes/class_packetpeer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PacketPeer.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PacketPeer.xml. .. _class_PacketPeer: diff --git a/classes/class_packetpeerdtls.rst b/classes/class_packetpeerdtls.rst index b9551d353..18c80d5f3 100644 --- a/classes/class_packetpeerdtls.rst +++ b/classes/class_packetpeerdtls.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PacketPeerDTLS.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PacketPeerDTLS.xml. .. _class_PacketPeerDTLS: diff --git a/classes/class_packetpeerextension.rst b/classes/class_packetpeerextension.rst index c2d14d123..b4b454b54 100644 --- a/classes/class_packetpeerextension.rst +++ b/classes/class_packetpeerextension.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PacketPeerExtension.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PacketPeerExtension.xml. .. _class_PacketPeerExtension: diff --git a/classes/class_packetpeerstream.rst b/classes/class_packetpeerstream.rst index 1de903a9c..d481f8901 100644 --- a/classes/class_packetpeerstream.rst +++ b/classes/class_packetpeerstream.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PacketPeerStream.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PacketPeerStream.xml. .. _class_PacketPeerStream: diff --git a/classes/class_packetpeerudp.rst b/classes/class_packetpeerudp.rst index 08595acba..0651dcc49 100644 --- a/classes/class_packetpeerudp.rst +++ b/classes/class_packetpeerudp.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PacketPeerUDP.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PacketPeerUDP.xml. .. _class_PacketPeerUDP: @@ -256,7 +256,7 @@ Waits for a packet to arrive on the bound address. See :ref:`bind<class_PacketPe .. code-tab:: csharp - var socket = new PacketPeerUDP(); + var socket = new PacketPeerUdp(); // Server socket.SetDestAddress("127.0.0.1", 789); socket.PutPacket("Time to stop".ToAsciiBuffer()); diff --git a/classes/class_panel.rst b/classes/class_panel.rst index b66a115c2..b77be5a90 100644 --- a/classes/class_panel.rst +++ b/classes/class_panel.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Panel.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Panel.xml. .. _class_Panel: diff --git a/classes/class_panelcontainer.rst b/classes/class_panelcontainer.rst index 67886a98c..e4945368f 100644 --- a/classes/class_panelcontainer.rst +++ b/classes/class_panelcontainer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PanelContainer.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PanelContainer.xml. .. _class_PanelContainer: diff --git a/classes/class_panoramaskymaterial.rst b/classes/class_panoramaskymaterial.rst index d12080735..ff6f44107 100644 --- a/classes/class_panoramaskymaterial.rst +++ b/classes/class_panoramaskymaterial.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PanoramaSkyMaterial.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PanoramaSkyMaterial.xml. .. _class_PanoramaSkyMaterial: diff --git a/classes/class_parallaxbackground.rst b/classes/class_parallaxbackground.rst index fcab0d205..2a014112b 100644 --- a/classes/class_parallaxbackground.rst +++ b/classes/class_parallaxbackground.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ParallaxBackground.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ParallaxBackground.xml. .. _class_ParallaxBackground: diff --git a/classes/class_parallaxlayer.rst b/classes/class_parallaxlayer.rst index a6eb8324d..5d5d3e5fc 100644 --- a/classes/class_parallaxlayer.rst +++ b/classes/class_parallaxlayer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ParallaxLayer.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ParallaxLayer.xml. .. _class_ParallaxLayer: @@ -61,11 +61,13 @@ Property Descriptions - void **set_mirroring** **(** :ref:`Vector2<class_Vector2>` value **)** - :ref:`Vector2<class_Vector2>` **get_mirroring** **(** **)** -The ParallaxLayer's :ref:`Texture2D<class_Texture2D>` repeating. Useful for creating an infinite scrolling background. If an axis is set to ``0``, the :ref:`Texture2D<class_Texture2D>` will not be repeated. +The interval, in pixels, at which the **ParallaxLayer** is drawn repeatedly. Useful for creating an infinitely scrolling background. If an axis is set to ``0``, the **ParallaxLayer** will be drawn only once along that direction. -If the length of the viewport axis is bigger than twice the repeated axis size, it will not repeat infinitely, as the parallax layer only draws 2 instances of the texture at any given time. +\ **Note:** If you want the repetition to pixel-perfect match a :ref:`Texture2D<class_Texture2D>` displayed by a child node, you should account for any scale applied to the texture when defining this interval. For example, if you use a child :ref:`Sprite2D<class_Sprite2D>` scaled to ``0.5`` to display a 600x600 texture, and want this sprite to be repeated continuously horizontally, you should set the mirroring to ``Vector2(300, 0)``. -\ **Note:** Despite its name, the texture will not be mirrored, it will simply be repeated. +\ **Note:** If the length of the viewport axis is bigger than twice the repeated axis size, it will not repeat infinitely, as the parallax layer only draws 2 instances of the layer at any given time. The visibility window is calculated from the parent :ref:`ParallaxBackground<class_ParallaxBackground>`'s position, not the layer's own position. So, if you use mirroring, **do not** change the **ParallaxLayer** position relative to its parent. Instead, if you need to adjust the background's position, set the :ref:`CanvasLayer.offset<class_CanvasLayer_property_offset>` property in the parent :ref:`ParallaxBackground<class_ParallaxBackground>`. + +\ **Note:** Despite the name, the layer will not be mirrored, it will only be repeated. .. rst-class:: classref-item-separator diff --git a/classes/class_particleprocessmaterial.rst b/classes/class_particleprocessmaterial.rst index 388999bff..854953b0f 100644 --- a/classes/class_particleprocessmaterial.rst +++ b/classes/class_particleprocessmaterial.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ParticleProcessMaterial.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ParticleProcessMaterial.xml. .. _class_ParticleProcessMaterial: diff --git a/classes/class_path2d.rst b/classes/class_path2d.rst index d6c027fb6..f489d69a6 100644 --- a/classes/class_path2d.rst +++ b/classes/class_path2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Path2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Path2D.xml. .. _class_Path2D: diff --git a/classes/class_path3d.rst b/classes/class_path3d.rst index dd9b3e1e5..7ac5e05aa 100644 --- a/classes/class_path3d.rst +++ b/classes/class_path3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Path3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Path3D.xml. .. _class_Path3D: diff --git a/classes/class_pathfollow2d.rst b/classes/class_pathfollow2d.rst index c6de58a0b..457addc5d 100644 --- a/classes/class_pathfollow2d.rst +++ b/classes/class_pathfollow2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PathFollow2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PathFollow2D.xml. .. _class_PathFollow2D: diff --git a/classes/class_pathfollow3d.rst b/classes/class_pathfollow3d.rst index 2b8455ddf..e3f69dd7e 100644 --- a/classes/class_pathfollow3d.rst +++ b/classes/class_pathfollow3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PathFollow3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PathFollow3D.xml. .. _class_PathFollow3D: diff --git a/classes/class_pckpacker.rst b/classes/class_pckpacker.rst index 0b78762ad..221ccf32c 100644 --- a/classes/class_pckpacker.rst +++ b/classes/class_pckpacker.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PCKPacker.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PCKPacker.xml. .. _class_PCKPacker: @@ -33,7 +33,7 @@ The **PCKPacker** is used to create packages that can be loaded into a running p .. code-tab:: csharp - var packer = new PCKPacker(); + var packer = new PckPacker(); packer.PckStart("test.pck"); packer.AddFile("res://text.txt", "text.txt"); packer.Flush(); diff --git a/classes/class_performance.rst b/classes/class_performance.rst index 2edaf727c..a9a186da0 100644 --- a/classes/class_performance.rst +++ b/classes/class_performance.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Performance.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Performance.xml. .. _class_Performance: diff --git a/classes/class_physicalbone2d.rst b/classes/class_physicalbone2d.rst index 4464986d4..ecdc15bfc 100644 --- a/classes/class_physicalbone2d.rst +++ b/classes/class_physicalbone2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicalBone2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PhysicalBone2D.xml. .. _class_PhysicalBone2D: diff --git a/classes/class_physicalbone3d.rst b/classes/class_physicalbone3d.rst index e7508b9c4..add23d8f6 100644 --- a/classes/class_physicalbone3d.rst +++ b/classes/class_physicalbone3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicalBone3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PhysicalBone3D.xml. .. _class_PhysicalBone3D: @@ -266,6 +266,8 @@ Sets the body's transform. The body's bounciness. Values range from ``0`` (no bounce) to ``1`` (full bounciness). +\ **Note:** Even with :ref:`bounce<class_PhysicalBone3D_property_bounce>` set to ``1.0``, some energy will be lost over time due to linear and angular damping. To have a **PhysicalBone3D** that preserves all its energy over time, set :ref:`bounce<class_PhysicalBone3D_property_bounce>` to ``1.0``, :ref:`linear_damp_mode<class_PhysicalBone3D_property_linear_damp_mode>` to :ref:`DAMP_MODE_REPLACE<class_PhysicalBone3D_constant_DAMP_MODE_REPLACE>`, :ref:`linear_damp<class_PhysicalBone3D_property_linear_damp>` to ``0.0``, :ref:`angular_damp_mode<class_PhysicalBone3D_property_angular_damp_mode>` to :ref:`DAMP_MODE_REPLACE<class_PhysicalBone3D_constant_DAMP_MODE_REPLACE>`, and :ref:`angular_damp<class_PhysicalBone3D_property_angular_damp>` to ``0.0``. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_physicalskymaterial.rst b/classes/class_physicalskymaterial.rst index ca537a470..8780ea046 100644 --- a/classes/class_physicalskymaterial.rst +++ b/classes/class_physicalskymaterial.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicalSkyMaterial.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PhysicalSkyMaterial.xml. .. _class_PhysicalSkyMaterial: diff --git a/classes/class_physicsbody2d.rst b/classes/class_physicsbody2d.rst index f174fdb08..099166e16 100644 --- a/classes/class_physicsbody2d.rst +++ b/classes/class_physicsbody2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsBody2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PhysicsBody2D.xml. .. _class_PhysicsBody2D: diff --git a/classes/class_physicsbody3d.rst b/classes/class_physicsbody3d.rst index fcba201d7..2746759df 100644 --- a/classes/class_physicsbody3d.rst +++ b/classes/class_physicsbody3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsBody3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PhysicsBody3D.xml. .. _class_PhysicsBody3D: diff --git a/classes/class_physicsdirectbodystate2d.rst b/classes/class_physicsdirectbodystate2d.rst index 6c8f678bf..2726f3be7 100644 --- a/classes/class_physicsdirectbodystate2d.rst +++ b/classes/class_physicsdirectbodystate2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsDirectBodyState2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PhysicsDirectBodyState2D.xml. .. _class_PhysicsDirectBodyState2D: diff --git a/classes/class_physicsdirectbodystate2dextension.rst b/classes/class_physicsdirectbodystate2dextension.rst index e379048c2..4c7ea7504 100644 --- a/classes/class_physicsdirectbodystate2dextension.rst +++ b/classes/class_physicsdirectbodystate2dextension.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsDirectBodyState2DExtension.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PhysicsDirectBodyState2DExtension.xml. .. _class_PhysicsDirectBodyState2DExtension: @@ -136,9 +136,7 @@ Method Descriptions void **_add_constant_central_force** **(** :ref:`Vector2<class_Vector2>` force **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsDirectBodyState2D.add_constant_central_force<class_PhysicsDirectBodyState2D_method_add_constant_central_force>`. .. rst-class:: classref-item-separator @@ -150,9 +148,7 @@ void **_add_constant_central_force** **(** :ref:`Vector2<class_Vector2>` force * void **_add_constant_force** **(** :ref:`Vector2<class_Vector2>` force, :ref:`Vector2<class_Vector2>` position **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsDirectBodyState2D.add_constant_force<class_PhysicsDirectBodyState2D_method_add_constant_force>`. .. rst-class:: classref-item-separator @@ -164,9 +160,7 @@ void **_add_constant_force** **(** :ref:`Vector2<class_Vector2>` force, :ref:`Ve void **_add_constant_torque** **(** :ref:`float<class_float>` torque **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsDirectBodyState2D.add_constant_torque<class_PhysicsDirectBodyState2D_method_add_constant_torque>`. .. rst-class:: classref-item-separator @@ -178,9 +172,7 @@ void **_add_constant_torque** **(** :ref:`float<class_float>` torque **)** |virt void **_apply_central_force** **(** :ref:`Vector2<class_Vector2>` force **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsDirectBodyState2D.apply_central_force<class_PhysicsDirectBodyState2D_method_apply_central_force>`. .. rst-class:: classref-item-separator @@ -192,9 +184,7 @@ void **_apply_central_force** **(** :ref:`Vector2<class_Vector2>` force **)** |v void **_apply_central_impulse** **(** :ref:`Vector2<class_Vector2>` impulse **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsDirectBodyState2D.apply_central_impulse<class_PhysicsDirectBodyState2D_method_apply_central_impulse>`. .. rst-class:: classref-item-separator @@ -206,9 +196,7 @@ void **_apply_central_impulse** **(** :ref:`Vector2<class_Vector2>` impulse **)* void **_apply_force** **(** :ref:`Vector2<class_Vector2>` force, :ref:`Vector2<class_Vector2>` position **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsDirectBodyState2D.apply_force<class_PhysicsDirectBodyState2D_method_apply_force>`. .. rst-class:: classref-item-separator @@ -220,9 +208,7 @@ void **_apply_force** **(** :ref:`Vector2<class_Vector2>` force, :ref:`Vector2<c void **_apply_impulse** **(** :ref:`Vector2<class_Vector2>` impulse, :ref:`Vector2<class_Vector2>` position **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsDirectBodyState2D.apply_impulse<class_PhysicsDirectBodyState2D_method_apply_impulse>`. .. rst-class:: classref-item-separator @@ -234,9 +220,7 @@ void **_apply_impulse** **(** :ref:`Vector2<class_Vector2>` impulse, :ref:`Vecto void **_apply_torque** **(** :ref:`float<class_float>` torque **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsDirectBodyState2D.apply_torque<class_PhysicsDirectBodyState2D_method_apply_torque>`. .. rst-class:: classref-item-separator @@ -248,9 +232,7 @@ void **_apply_torque** **(** :ref:`float<class_float>` torque **)** |virtual| void **_apply_torque_impulse** **(** :ref:`float<class_float>` impulse **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsDirectBodyState2D.apply_torque_impulse<class_PhysicsDirectBodyState2D_method_apply_torque_impulse>`. .. rst-class:: classref-item-separator @@ -262,9 +244,7 @@ void **_apply_torque_impulse** **(** :ref:`float<class_float>` impulse **)** |vi :ref:`float<class_float>` **_get_angular_velocity** **(** **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.angular_velocity<class_PhysicsDirectBodyState2D_property_angular_velocity>` and its respective getter. .. rst-class:: classref-item-separator @@ -276,9 +256,7 @@ void **_apply_torque_impulse** **(** :ref:`float<class_float>` impulse **)** |vi :ref:`Vector2<class_Vector2>` **_get_center_of_mass** **(** **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.center_of_mass<class_PhysicsDirectBodyState2D_property_center_of_mass>` and its respective getter. .. rst-class:: classref-item-separator @@ -290,9 +268,7 @@ void **_apply_torque_impulse** **(** :ref:`float<class_float>` impulse **)** |vi :ref:`Vector2<class_Vector2>` **_get_center_of_mass_local** **(** **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.center_of_mass_local<class_PhysicsDirectBodyState2D_property_center_of_mass_local>` and its respective getter. .. rst-class:: classref-item-separator @@ -304,9 +280,7 @@ void **_apply_torque_impulse** **(** :ref:`float<class_float>` impulse **)** |vi :ref:`Vector2<class_Vector2>` **_get_constant_force** **(** **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsDirectBodyState2D.get_constant_force<class_PhysicsDirectBodyState2D_method_get_constant_force>`. .. rst-class:: classref-item-separator @@ -318,9 +292,7 @@ void **_apply_torque_impulse** **(** :ref:`float<class_float>` impulse **)** |vi :ref:`float<class_float>` **_get_constant_torque** **(** **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsDirectBodyState2D.get_constant_torque<class_PhysicsDirectBodyState2D_method_get_constant_torque>`. .. rst-class:: classref-item-separator @@ -332,9 +304,7 @@ void **_apply_torque_impulse** **(** :ref:`float<class_float>` impulse **)** |vi :ref:`RID<class_RID>` **_get_contact_collider** **(** :ref:`int<class_int>` contact_idx **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsDirectBodyState2D.get_contact_collider<class_PhysicsDirectBodyState2D_method_get_contact_collider>`. .. rst-class:: classref-item-separator @@ -346,9 +316,7 @@ void **_apply_torque_impulse** **(** :ref:`float<class_float>` impulse **)** |vi :ref:`int<class_int>` **_get_contact_collider_id** **(** :ref:`int<class_int>` contact_idx **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsDirectBodyState2D.get_contact_collider_id<class_PhysicsDirectBodyState2D_method_get_contact_collider_id>`. .. rst-class:: classref-item-separator @@ -360,9 +328,7 @@ void **_apply_torque_impulse** **(** :ref:`float<class_float>` impulse **)** |vi :ref:`Object<class_Object>` **_get_contact_collider_object** **(** :ref:`int<class_int>` contact_idx **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsDirectBodyState2D.get_contact_collider_object<class_PhysicsDirectBodyState2D_method_get_contact_collider_object>`. .. rst-class:: classref-item-separator @@ -374,9 +340,7 @@ void **_apply_torque_impulse** **(** :ref:`float<class_float>` impulse **)** |vi :ref:`Vector2<class_Vector2>` **_get_contact_collider_position** **(** :ref:`int<class_int>` contact_idx **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsDirectBodyState2D.get_contact_collider_position<class_PhysicsDirectBodyState2D_method_get_contact_collider_position>`. .. rst-class:: classref-item-separator @@ -388,9 +352,7 @@ void **_apply_torque_impulse** **(** :ref:`float<class_float>` impulse **)** |vi :ref:`int<class_int>` **_get_contact_collider_shape** **(** :ref:`int<class_int>` contact_idx **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsDirectBodyState2D.get_contact_collider_shape<class_PhysicsDirectBodyState2D_method_get_contact_collider_shape>`. .. rst-class:: classref-item-separator @@ -402,9 +364,7 @@ void **_apply_torque_impulse** **(** :ref:`float<class_float>` impulse **)** |vi :ref:`Vector2<class_Vector2>` **_get_contact_collider_velocity_at_position** **(** :ref:`int<class_int>` contact_idx **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsDirectBodyState2D.get_contact_collider_velocity_at_position<class_PhysicsDirectBodyState2D_method_get_contact_collider_velocity_at_position>`. .. rst-class:: classref-item-separator @@ -416,9 +376,7 @@ void **_apply_torque_impulse** **(** :ref:`float<class_float>` impulse **)** |vi :ref:`int<class_int>` **_get_contact_count** **(** **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsDirectBodyState2D.get_contact_count<class_PhysicsDirectBodyState2D_method_get_contact_count>`. .. rst-class:: classref-item-separator @@ -430,9 +388,7 @@ void **_apply_torque_impulse** **(** :ref:`float<class_float>` impulse **)** |vi :ref:`Vector2<class_Vector2>` **_get_contact_impulse** **(** :ref:`int<class_int>` contact_idx **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsDirectBodyState2D.get_contact_impulse<class_PhysicsDirectBodyState2D_method_get_contact_impulse>`. .. rst-class:: classref-item-separator @@ -444,9 +400,7 @@ void **_apply_torque_impulse** **(** :ref:`float<class_float>` impulse **)** |vi :ref:`Vector2<class_Vector2>` **_get_contact_local_normal** **(** :ref:`int<class_int>` contact_idx **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsDirectBodyState2D.get_contact_local_normal<class_PhysicsDirectBodyState2D_method_get_contact_local_normal>`. .. rst-class:: classref-item-separator @@ -458,9 +412,7 @@ void **_apply_torque_impulse** **(** :ref:`float<class_float>` impulse **)** |vi :ref:`Vector2<class_Vector2>` **_get_contact_local_position** **(** :ref:`int<class_int>` contact_idx **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsDirectBodyState2D.get_contact_local_position<class_PhysicsDirectBodyState2D_method_get_contact_local_position>`. .. rst-class:: classref-item-separator @@ -472,9 +424,7 @@ void **_apply_torque_impulse** **(** :ref:`float<class_float>` impulse **)** |vi :ref:`int<class_int>` **_get_contact_local_shape** **(** :ref:`int<class_int>` contact_idx **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsDirectBodyState2D.get_contact_local_shape<class_PhysicsDirectBodyState2D_method_get_contact_local_shape>`. .. rst-class:: classref-item-separator @@ -486,9 +436,7 @@ void **_apply_torque_impulse** **(** :ref:`float<class_float>` impulse **)** |vi :ref:`Vector2<class_Vector2>` **_get_contact_local_velocity_at_position** **(** :ref:`int<class_int>` contact_idx **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsDirectBodyState2D.get_contact_local_velocity_at_position<class_PhysicsDirectBodyState2D_method_get_contact_local_velocity_at_position>`. .. rst-class:: classref-item-separator @@ -500,9 +448,7 @@ void **_apply_torque_impulse** **(** :ref:`float<class_float>` impulse **)** |vi :ref:`float<class_float>` **_get_inverse_inertia** **(** **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.inverse_inertia<class_PhysicsDirectBodyState2D_property_inverse_inertia>` and its respective getter. .. rst-class:: classref-item-separator @@ -514,9 +460,7 @@ void **_apply_torque_impulse** **(** :ref:`float<class_float>` impulse **)** |vi :ref:`float<class_float>` **_get_inverse_mass** **(** **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.inverse_mass<class_PhysicsDirectBodyState2D_property_inverse_mass>` and its respective getter. .. rst-class:: classref-item-separator @@ -528,9 +472,7 @@ void **_apply_torque_impulse** **(** :ref:`float<class_float>` impulse **)** |vi :ref:`Vector2<class_Vector2>` **_get_linear_velocity** **(** **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.linear_velocity<class_PhysicsDirectBodyState2D_property_linear_velocity>` and its respective getter. .. rst-class:: classref-item-separator @@ -542,9 +484,7 @@ void **_apply_torque_impulse** **(** :ref:`float<class_float>` impulse **)** |vi :ref:`PhysicsDirectSpaceState2D<class_PhysicsDirectSpaceState2D>` **_get_space_state** **(** **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsDirectBodyState2D.get_space_state<class_PhysicsDirectBodyState2D_method_get_space_state>`. .. rst-class:: classref-item-separator @@ -556,9 +496,7 @@ void **_apply_torque_impulse** **(** :ref:`float<class_float>` impulse **)** |vi :ref:`float<class_float>` **_get_step** **(** **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.step<class_PhysicsDirectBodyState2D_property_step>` and its respective getter. .. rst-class:: classref-item-separator @@ -570,9 +508,7 @@ void **_apply_torque_impulse** **(** :ref:`float<class_float>` impulse **)** |vi :ref:`float<class_float>` **_get_total_angular_damp** **(** **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.total_angular_damp<class_PhysicsDirectBodyState2D_property_total_angular_damp>` and its respective getter. .. rst-class:: classref-item-separator @@ -584,9 +520,7 @@ void **_apply_torque_impulse** **(** :ref:`float<class_float>` impulse **)** |vi :ref:`Vector2<class_Vector2>` **_get_total_gravity** **(** **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.total_gravity<class_PhysicsDirectBodyState2D_property_total_gravity>` and its respective getter. .. rst-class:: classref-item-separator @@ -598,9 +532,7 @@ void **_apply_torque_impulse** **(** :ref:`float<class_float>` impulse **)** |vi :ref:`float<class_float>` **_get_total_linear_damp** **(** **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.total_linear_damp<class_PhysicsDirectBodyState2D_property_total_linear_damp>` and its respective getter. .. rst-class:: classref-item-separator @@ -612,9 +544,7 @@ void **_apply_torque_impulse** **(** :ref:`float<class_float>` impulse **)** |vi :ref:`Transform2D<class_Transform2D>` **_get_transform** **(** **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.transform<class_PhysicsDirectBodyState2D_property_transform>` and its respective getter. .. rst-class:: classref-item-separator @@ -626,9 +556,7 @@ void **_apply_torque_impulse** **(** :ref:`float<class_float>` impulse **)** |vi :ref:`Vector2<class_Vector2>` **_get_velocity_at_local_position** **(** :ref:`Vector2<class_Vector2>` local_position **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsDirectBodyState2D.get_velocity_at_local_position<class_PhysicsDirectBodyState2D_method_get_velocity_at_local_position>`. .. rst-class:: classref-item-separator @@ -640,9 +568,7 @@ void **_apply_torque_impulse** **(** :ref:`float<class_float>` impulse **)** |vi void **_integrate_forces** **(** **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsDirectBodyState2D.integrate_forces<class_PhysicsDirectBodyState2D_method_integrate_forces>`. .. rst-class:: classref-item-separator @@ -654,9 +580,7 @@ void **_integrate_forces** **(** **)** |virtual| :ref:`bool<class_bool>` **_is_sleeping** **(** **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.sleeping<class_PhysicsDirectBodyState2D_property_sleeping>` and its respective getter. .. rst-class:: classref-item-separator @@ -668,9 +592,7 @@ void **_integrate_forces** **(** **)** |virtual| void **_set_angular_velocity** **(** :ref:`float<class_float>` velocity **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.angular_velocity<class_PhysicsDirectBodyState2D_property_angular_velocity>` and its respective setter. .. rst-class:: classref-item-separator @@ -682,9 +604,7 @@ void **_set_angular_velocity** **(** :ref:`float<class_float>` velocity **)** |v void **_set_constant_force** **(** :ref:`Vector2<class_Vector2>` force **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsDirectBodyState2D.set_constant_force<class_PhysicsDirectBodyState2D_method_set_constant_force>`. .. rst-class:: classref-item-separator @@ -696,9 +616,7 @@ void **_set_constant_force** **(** :ref:`Vector2<class_Vector2>` force **)** |vi void **_set_constant_torque** **(** :ref:`float<class_float>` torque **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsDirectBodyState2D.set_constant_torque<class_PhysicsDirectBodyState2D_method_set_constant_torque>`. .. rst-class:: classref-item-separator @@ -710,9 +628,7 @@ void **_set_constant_torque** **(** :ref:`float<class_float>` torque **)** |virt void **_set_linear_velocity** **(** :ref:`Vector2<class_Vector2>` velocity **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.linear_velocity<class_PhysicsDirectBodyState2D_property_linear_velocity>` and its respective setter. .. rst-class:: classref-item-separator @@ -724,9 +640,7 @@ void **_set_linear_velocity** **(** :ref:`Vector2<class_Vector2>` velocity **)** void **_set_sleep_state** **(** :ref:`bool<class_bool>` enabled **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.sleeping<class_PhysicsDirectBodyState2D_property_sleeping>` and its respective setter. .. rst-class:: classref-item-separator @@ -738,9 +652,7 @@ void **_set_sleep_state** **(** :ref:`bool<class_bool>` enabled **)** |virtual| void **_set_transform** **(** :ref:`Transform2D<class_Transform2D>` transform **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.transform<class_PhysicsDirectBodyState2D_property_transform>` and its respective setter. .. |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_physicsdirectbodystate3d.rst b/classes/class_physicsdirectbodystate3d.rst index 703731a4e..4eb21d6fa 100644 --- a/classes/class_physicsdirectbodystate3d.rst +++ b/classes/class_physicsdirectbodystate3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsDirectBodyState3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PhysicsDirectBodyState3D.xml. .. _class_PhysicsDirectBodyState3D: diff --git a/classes/class_physicsdirectbodystate3dextension.rst b/classes/class_physicsdirectbodystate3dextension.rst index c4a84f607..a29fa62b1 100644 --- a/classes/class_physicsdirectbodystate3dextension.rst +++ b/classes/class_physicsdirectbodystate3dextension.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsDirectBodyState3DExtension.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PhysicsDirectBodyState3DExtension.xml. .. _class_PhysicsDirectBodyState3DExtension: diff --git a/classes/class_physicsdirectspacestate2d.rst b/classes/class_physicsdirectspacestate2d.rst index 25f7b87d0..5f6cbf6c5 100644 --- a/classes/class_physicsdirectspacestate2d.rst +++ b/classes/class_physicsdirectspacestate2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsDirectSpaceState2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PhysicsDirectSpaceState2D.xml. .. _class_PhysicsDirectSpaceState2D: diff --git a/classes/class_physicsdirectspacestate2dextension.rst b/classes/class_physicsdirectspacestate2dextension.rst index 6f97168f7..b54da6208 100644 --- a/classes/class_physicsdirectspacestate2dextension.rst +++ b/classes/class_physicsdirectspacestate2dextension.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsDirectSpaceState2DExtension.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PhysicsDirectSpaceState2DExtension.xml. .. _class_PhysicsDirectSpaceState2DExtension: diff --git a/classes/class_physicsdirectspacestate3d.rst b/classes/class_physicsdirectspacestate3d.rst index 6bf2c855e..bf7f3edd7 100644 --- a/classes/class_physicsdirectspacestate3d.rst +++ b/classes/class_physicsdirectspacestate3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsDirectSpaceState3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PhysicsDirectSpaceState3D.xml. .. _class_PhysicsDirectSpaceState3D: diff --git a/classes/class_physicsdirectspacestate3dextension.rst b/classes/class_physicsdirectspacestate3dextension.rst index ca1db8457..84856c8de 100644 --- a/classes/class_physicsdirectspacestate3dextension.rst +++ b/classes/class_physicsdirectspacestate3dextension.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsDirectSpaceState3DExtension.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PhysicsDirectSpaceState3DExtension.xml. .. _class_PhysicsDirectSpaceState3DExtension: diff --git a/classes/class_physicsmaterial.rst b/classes/class_physicsmaterial.rst index 9a13ede9d..5152176c0 100644 --- a/classes/class_physicsmaterial.rst +++ b/classes/class_physicsmaterial.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsMaterial.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PhysicsMaterial.xml. .. _class_PhysicsMaterial: @@ -78,6 +78,8 @@ If ``true``, subtracts the bounciness from the colliding object's bounciness ins The body's bounciness. Values range from ``0`` (no bounce) to ``1`` (full bounciness). +\ **Note:** Even with :ref:`bounce<class_PhysicsMaterial_property_bounce>` set to ``1.0``, some energy will be lost over time due to linear and angular damping. To have a :ref:`PhysicsBody3D<class_PhysicsBody3D>` that preserves all its energy over time, set :ref:`bounce<class_PhysicsMaterial_property_bounce>` to ``1.0``, the body's linear damp mode to **Replace** (if applicable), its linear damp to ``0.0``, its angular damp mode to **Replace** (if applicable), and its angular damp to ``0.0``. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_physicspointqueryparameters2d.rst b/classes/class_physicspointqueryparameters2d.rst index c3376a8bf..48b75b517 100644 --- a/classes/class_physicspointqueryparameters2d.rst +++ b/classes/class_physicspointqueryparameters2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsPointQueryParameters2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PhysicsPointQueryParameters2D.xml. .. _class_PhysicsPointQueryParameters2D: diff --git a/classes/class_physicspointqueryparameters3d.rst b/classes/class_physicspointqueryparameters3d.rst index 13aa056a9..7f5d8c571 100644 --- a/classes/class_physicspointqueryparameters3d.rst +++ b/classes/class_physicspointqueryparameters3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsPointQueryParameters3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PhysicsPointQueryParameters3D.xml. .. _class_PhysicsPointQueryParameters3D: diff --git a/classes/class_physicsrayqueryparameters2d.rst b/classes/class_physicsrayqueryparameters2d.rst index 25bcc0d6a..3bb8c75f0 100644 --- a/classes/class_physicsrayqueryparameters2d.rst +++ b/classes/class_physicsrayqueryparameters2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsRayQueryParameters2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PhysicsRayQueryParameters2D.xml. .. _class_PhysicsRayQueryParameters2D: diff --git a/classes/class_physicsrayqueryparameters3d.rst b/classes/class_physicsrayqueryparameters3d.rst index 7699e26c0..8dd216c4e 100644 --- a/classes/class_physicsrayqueryparameters3d.rst +++ b/classes/class_physicsrayqueryparameters3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsRayQueryParameters3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PhysicsRayQueryParameters3D.xml. .. _class_PhysicsRayQueryParameters3D: diff --git a/classes/class_physicsserver2d.rst b/classes/class_physicsserver2d.rst index 4999e439a..4ba2c2b27 100644 --- a/classes/class_physicsserver2d.rst +++ b/classes/class_physicsserver2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsServer2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PhysicsServer2D.xml. .. _class_PhysicsServer2D: diff --git a/classes/class_physicsserver2dextension.rst b/classes/class_physicsserver2dextension.rst index 1287a45b8..10e7bba90 100644 --- a/classes/class_physicsserver2dextension.rst +++ b/classes/class_physicsserver2dextension.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsServer2DExtension.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PhysicsServer2DExtension.xml. .. _class_PhysicsServer2DExtension: @@ -328,9 +328,7 @@ Method Descriptions void **_area_add_shape** **(** :ref:`RID<class_RID>` area, :ref:`RID<class_RID>` shape, :ref:`Transform2D<class_Transform2D>` transform, :ref:`bool<class_bool>` disabled **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.area_add_shape<class_PhysicsServer2D_method_area_add_shape>`. .. rst-class:: classref-item-separator @@ -342,9 +340,7 @@ void **_area_add_shape** **(** :ref:`RID<class_RID>` area, :ref:`RID<class_RID>` void **_area_attach_canvas_instance_id** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` id **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.area_attach_canvas_instance_id<class_PhysicsServer2D_method_area_attach_canvas_instance_id>`. .. rst-class:: classref-item-separator @@ -356,9 +352,7 @@ void **_area_attach_canvas_instance_id** **(** :ref:`RID<class_RID>` area, :ref: void **_area_attach_object_instance_id** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` id **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.area_attach_object_instance_id<class_PhysicsServer2D_method_area_attach_object_instance_id>`. .. rst-class:: classref-item-separator @@ -370,9 +364,7 @@ void **_area_attach_object_instance_id** **(** :ref:`RID<class_RID>` area, :ref: void **_area_clear_shapes** **(** :ref:`RID<class_RID>` area **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.area_clear_shapes<class_PhysicsServer2D_method_area_clear_shapes>`. .. rst-class:: classref-item-separator @@ -384,9 +376,7 @@ void **_area_clear_shapes** **(** :ref:`RID<class_RID>` area **)** |virtual| :ref:`RID<class_RID>` **_area_create** **(** **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.area_create<class_PhysicsServer2D_method_area_create>`. .. rst-class:: classref-item-separator @@ -398,9 +388,7 @@ void **_area_clear_shapes** **(** :ref:`RID<class_RID>` area **)** |virtual| :ref:`int<class_int>` **_area_get_canvas_instance_id** **(** :ref:`RID<class_RID>` area **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.area_get_canvas_instance_id<class_PhysicsServer2D_method_area_get_canvas_instance_id>`. .. rst-class:: classref-item-separator @@ -412,9 +400,7 @@ void **_area_clear_shapes** **(** :ref:`RID<class_RID>` area **)** |virtual| :ref:`int<class_int>` **_area_get_collision_layer** **(** :ref:`RID<class_RID>` area **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.area_get_collision_layer<class_PhysicsServer2D_method_area_get_collision_layer>`. .. rst-class:: classref-item-separator @@ -426,9 +412,7 @@ void **_area_clear_shapes** **(** :ref:`RID<class_RID>` area **)** |virtual| :ref:`int<class_int>` **_area_get_collision_mask** **(** :ref:`RID<class_RID>` area **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.area_get_collision_mask<class_PhysicsServer2D_method_area_get_collision_mask>`. .. rst-class:: classref-item-separator @@ -440,9 +424,7 @@ void **_area_clear_shapes** **(** :ref:`RID<class_RID>` area **)** |virtual| :ref:`int<class_int>` **_area_get_object_instance_id** **(** :ref:`RID<class_RID>` area **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.area_get_object_instance_id<class_PhysicsServer2D_method_area_get_object_instance_id>`. .. rst-class:: classref-item-separator @@ -454,9 +436,7 @@ void **_area_clear_shapes** **(** :ref:`RID<class_RID>` area **)** |virtual| :ref:`Variant<class_Variant>` **_area_get_param** **(** :ref:`RID<class_RID>` area, :ref:`AreaParameter<enum_PhysicsServer2D_AreaParameter>` param **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.area_get_param<class_PhysicsServer2D_method_area_get_param>`. .. rst-class:: classref-item-separator @@ -468,9 +448,7 @@ void **_area_clear_shapes** **(** :ref:`RID<class_RID>` area **)** |virtual| :ref:`RID<class_RID>` **_area_get_shape** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.area_get_shape<class_PhysicsServer2D_method_area_get_shape>`. .. rst-class:: classref-item-separator @@ -482,9 +460,7 @@ void **_area_clear_shapes** **(** :ref:`RID<class_RID>` area **)** |virtual| :ref:`int<class_int>` **_area_get_shape_count** **(** :ref:`RID<class_RID>` area **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.area_get_shape_count<class_PhysicsServer2D_method_area_get_shape_count>`. .. rst-class:: classref-item-separator @@ -496,9 +472,7 @@ void **_area_clear_shapes** **(** :ref:`RID<class_RID>` area **)** |virtual| :ref:`Transform2D<class_Transform2D>` **_area_get_shape_transform** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.area_get_shape_transform<class_PhysicsServer2D_method_area_get_shape_transform>`. .. rst-class:: classref-item-separator @@ -510,9 +484,7 @@ void **_area_clear_shapes** **(** :ref:`RID<class_RID>` area **)** |virtual| :ref:`RID<class_RID>` **_area_get_space** **(** :ref:`RID<class_RID>` area **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.area_get_space<class_PhysicsServer2D_method_area_get_space>`. .. rst-class:: classref-item-separator @@ -524,9 +496,7 @@ void **_area_clear_shapes** **(** :ref:`RID<class_RID>` area **)** |virtual| :ref:`Transform2D<class_Transform2D>` **_area_get_transform** **(** :ref:`RID<class_RID>` area **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.area_get_transform<class_PhysicsServer2D_method_area_get_transform>`. .. rst-class:: classref-item-separator @@ -538,9 +508,7 @@ void **_area_clear_shapes** **(** :ref:`RID<class_RID>` area **)** |virtual| void **_area_remove_shape** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.area_remove_shape<class_PhysicsServer2D_method_area_remove_shape>`. .. rst-class:: classref-item-separator @@ -552,9 +520,7 @@ void **_area_remove_shape** **(** :ref:`RID<class_RID>` area, :ref:`int<class_in void **_area_set_area_monitor_callback** **(** :ref:`RID<class_RID>` area, :ref:`Callable<class_Callable>` callback **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.area_set_area_monitor_callback<class_PhysicsServer2D_method_area_set_area_monitor_callback>`. .. rst-class:: classref-item-separator @@ -566,9 +532,7 @@ void **_area_set_area_monitor_callback** **(** :ref:`RID<class_RID>` area, :ref: void **_area_set_collision_layer** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` layer **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.area_set_collision_layer<class_PhysicsServer2D_method_area_set_collision_layer>`. .. rst-class:: classref-item-separator @@ -580,9 +544,7 @@ void **_area_set_collision_layer** **(** :ref:`RID<class_RID>` area, :ref:`int<c void **_area_set_collision_mask** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` mask **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.area_set_collision_mask<class_PhysicsServer2D_method_area_set_collision_mask>`. .. rst-class:: classref-item-separator @@ -594,9 +556,7 @@ void **_area_set_collision_mask** **(** :ref:`RID<class_RID>` area, :ref:`int<cl void **_area_set_monitor_callback** **(** :ref:`RID<class_RID>` area, :ref:`Callable<class_Callable>` callback **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.area_set_monitor_callback<class_PhysicsServer2D_method_area_set_monitor_callback>`. .. rst-class:: classref-item-separator @@ -608,9 +568,7 @@ void **_area_set_monitor_callback** **(** :ref:`RID<class_RID>` area, :ref:`Call void **_area_set_monitorable** **(** :ref:`RID<class_RID>` area, :ref:`bool<class_bool>` monitorable **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.area_set_monitorable<class_PhysicsServer2D_method_area_set_monitorable>`. .. rst-class:: classref-item-separator @@ -622,9 +580,7 @@ void **_area_set_monitorable** **(** :ref:`RID<class_RID>` area, :ref:`bool<clas void **_area_set_param** **(** :ref:`RID<class_RID>` area, :ref:`AreaParameter<enum_PhysicsServer2D_AreaParameter>` param, :ref:`Variant<class_Variant>` value **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.area_set_param<class_PhysicsServer2D_method_area_set_param>`. .. rst-class:: classref-item-separator @@ -636,9 +592,9 @@ void **_area_set_param** **(** :ref:`RID<class_RID>` area, :ref:`AreaParameter<e void **_area_set_pickable** **(** :ref:`RID<class_RID>` area, :ref:`bool<class_bool>` pickable **)** |virtual| -.. container:: contribute +If set to ``true``, allows the area with the given :ref:`RID<class_RID>` to detect mouse inputs when the mouse cursor is hovering on it. - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D<class_PhysicsServer2D>`'s internal ``area_set_pickable`` method. Corresponds to :ref:`PhysicsBody2D.input_pickable<class_PhysicsBody2D_property_input_pickable>`. .. rst-class:: classref-item-separator @@ -650,9 +606,7 @@ void **_area_set_pickable** **(** :ref:`RID<class_RID>` area, :ref:`bool<class_b void **_area_set_shape** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx, :ref:`RID<class_RID>` shape **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.area_set_shape<class_PhysicsServer2D_method_area_set_shape>`. .. rst-class:: classref-item-separator @@ -664,9 +618,7 @@ void **_area_set_shape** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` void **_area_set_shape_disabled** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx, :ref:`bool<class_bool>` disabled **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.area_set_shape_disabled<class_PhysicsServer2D_method_area_set_shape_disabled>`. .. rst-class:: classref-item-separator @@ -678,9 +630,7 @@ void **_area_set_shape_disabled** **(** :ref:`RID<class_RID>` area, :ref:`int<cl void **_area_set_shape_transform** **(** :ref:`RID<class_RID>` area, :ref:`int<class_int>` shape_idx, :ref:`Transform2D<class_Transform2D>` transform **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.area_set_shape_transform<class_PhysicsServer2D_method_area_set_shape_transform>`. .. rst-class:: classref-item-separator @@ -692,9 +642,7 @@ void **_area_set_shape_transform** **(** :ref:`RID<class_RID>` area, :ref:`int<c void **_area_set_space** **(** :ref:`RID<class_RID>` area, :ref:`RID<class_RID>` space **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.area_set_space<class_PhysicsServer2D_method_area_set_space>`. .. rst-class:: classref-item-separator @@ -706,9 +654,7 @@ void **_area_set_space** **(** :ref:`RID<class_RID>` area, :ref:`RID<class_RID>` void **_area_set_transform** **(** :ref:`RID<class_RID>` area, :ref:`Transform2D<class_Transform2D>` transform **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.area_set_transform<class_PhysicsServer2D_method_area_set_transform>`. .. rst-class:: classref-item-separator @@ -720,9 +666,7 @@ void **_area_set_transform** **(** :ref:`RID<class_RID>` area, :ref:`Transform2D void **_body_add_collision_exception** **(** :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` excepted_body **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_add_collision_exception<class_PhysicsServer2D_method_body_add_collision_exception>`. .. rst-class:: classref-item-separator @@ -734,9 +678,7 @@ void **_body_add_collision_exception** **(** :ref:`RID<class_RID>` body, :ref:`R void **_body_add_constant_central_force** **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` force **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_add_constant_central_force<class_PhysicsServer2D_method_body_add_constant_central_force>`. .. rst-class:: classref-item-separator @@ -748,9 +690,7 @@ void **_body_add_constant_central_force** **(** :ref:`RID<class_RID>` body, :ref void **_body_add_constant_force** **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` force, :ref:`Vector2<class_Vector2>` position **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_add_constant_force<class_PhysicsServer2D_method_body_add_constant_force>`. .. rst-class:: classref-item-separator @@ -762,9 +702,7 @@ void **_body_add_constant_force** **(** :ref:`RID<class_RID>` body, :ref:`Vector void **_body_add_constant_torque** **(** :ref:`RID<class_RID>` body, :ref:`float<class_float>` torque **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_add_constant_torque<class_PhysicsServer2D_method_body_add_constant_torque>`. .. rst-class:: classref-item-separator @@ -776,9 +714,7 @@ void **_body_add_constant_torque** **(** :ref:`RID<class_RID>` body, :ref:`float void **_body_add_shape** **(** :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` shape, :ref:`Transform2D<class_Transform2D>` transform, :ref:`bool<class_bool>` disabled **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_add_shape<class_PhysicsServer2D_method_body_add_shape>`. .. rst-class:: classref-item-separator @@ -790,9 +726,7 @@ void **_body_add_shape** **(** :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` void **_body_apply_central_force** **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` force **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_apply_central_force<class_PhysicsServer2D_method_body_apply_central_force>`. .. rst-class:: classref-item-separator @@ -804,9 +738,7 @@ void **_body_apply_central_force** **(** :ref:`RID<class_RID>` body, :ref:`Vecto void **_body_apply_central_impulse** **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` impulse **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_apply_central_impulse<class_PhysicsServer2D_method_body_apply_central_impulse>`. .. rst-class:: classref-item-separator @@ -818,9 +750,7 @@ void **_body_apply_central_impulse** **(** :ref:`RID<class_RID>` body, :ref:`Vec void **_body_apply_force** **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` force, :ref:`Vector2<class_Vector2>` position **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_apply_force<class_PhysicsServer2D_method_body_apply_force>`. .. rst-class:: classref-item-separator @@ -832,9 +762,7 @@ void **_body_apply_force** **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class void **_body_apply_impulse** **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` impulse, :ref:`Vector2<class_Vector2>` position **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_apply_impulse<class_PhysicsServer2D_method_body_apply_impulse>`. .. rst-class:: classref-item-separator @@ -846,9 +774,7 @@ void **_body_apply_impulse** **(** :ref:`RID<class_RID>` body, :ref:`Vector2<cla void **_body_apply_torque** **(** :ref:`RID<class_RID>` body, :ref:`float<class_float>` torque **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_apply_torque<class_PhysicsServer2D_method_body_apply_torque>`. .. rst-class:: classref-item-separator @@ -860,9 +786,7 @@ void **_body_apply_torque** **(** :ref:`RID<class_RID>` body, :ref:`float<class_ void **_body_apply_torque_impulse** **(** :ref:`RID<class_RID>` body, :ref:`float<class_float>` impulse **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_apply_torque_impulse<class_PhysicsServer2D_method_body_apply_torque_impulse>`. .. rst-class:: classref-item-separator @@ -874,9 +798,7 @@ void **_body_apply_torque_impulse** **(** :ref:`RID<class_RID>` body, :ref:`floa void **_body_attach_canvas_instance_id** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` id **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_attach_canvas_instance_id<class_PhysicsServer2D_method_body_attach_canvas_instance_id>`. .. rst-class:: classref-item-separator @@ -888,9 +810,7 @@ void **_body_attach_canvas_instance_id** **(** :ref:`RID<class_RID>` body, :ref: void **_body_attach_object_instance_id** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` id **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_attach_object_instance_id<class_PhysicsServer2D_method_body_attach_object_instance_id>`. .. rst-class:: classref-item-separator @@ -902,9 +822,7 @@ void **_body_attach_object_instance_id** **(** :ref:`RID<class_RID>` body, :ref: void **_body_clear_shapes** **(** :ref:`RID<class_RID>` body **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_clear_shapes<class_PhysicsServer2D_method_body_clear_shapes>`. .. rst-class:: classref-item-separator @@ -916,9 +834,9 @@ void **_body_clear_shapes** **(** :ref:`RID<class_RID>` body **)** |virtual| :ref:`bool<class_bool>` **_body_collide_shape** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` body_shape, :ref:`RID<class_RID>` shape, :ref:`Transform2D<class_Transform2D>` shape_xform, :ref:`Vector2<class_Vector2>` motion, void* results, :ref:`int<class_int>` result_max, int32_t* result_count **)** |virtual| -.. container:: contribute +Given a ``body``, a ``shape``, and their respective parameters, this method should return ``true`` if a collision between the two would occur, with additional details passed in ``results``. - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D<class_PhysicsServer2D>`'s internal ``shape_collide`` method. Corresponds to :ref:`PhysicsDirectSpaceState2D.collide_shape<class_PhysicsDirectSpaceState2D_method_collide_shape>`. .. rst-class:: classref-item-separator @@ -930,9 +848,7 @@ void **_body_clear_shapes** **(** :ref:`RID<class_RID>` body **)** |virtual| :ref:`RID<class_RID>` **_body_create** **(** **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_create<class_PhysicsServer2D_method_body_create>`. .. rst-class:: classref-item-separator @@ -944,9 +860,7 @@ void **_body_clear_shapes** **(** :ref:`RID<class_RID>` body **)** |virtual| :ref:`int<class_int>` **_body_get_canvas_instance_id** **(** :ref:`RID<class_RID>` body **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_get_canvas_instance_id<class_PhysicsServer2D_method_body_get_canvas_instance_id>`. .. rst-class:: classref-item-separator @@ -958,9 +872,9 @@ void **_body_clear_shapes** **(** :ref:`RID<class_RID>` body **)** |virtual| :ref:`RID[]<class_RID>` **_body_get_collision_exceptions** **(** :ref:`RID<class_RID>` body **)** |virtual| |const| -.. container:: contribute +Returns the :ref:`RID<class_RID>`\ s of all bodies added as collision exceptions for the given ``body``. See also :ref:`_body_add_collision_exception<class_PhysicsServer2DExtension_private_method__body_add_collision_exception>` and :ref:`_body_remove_collision_exception<class_PhysicsServer2DExtension_private_method__body_remove_collision_exception>`. - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D<class_PhysicsServer2D>`'s internal ``body_get_collision_exceptions`` method. Corresponds to :ref:`PhysicsBody2D.get_collision_exceptions<class_PhysicsBody2D_method_get_collision_exceptions>`. .. rst-class:: classref-item-separator @@ -972,9 +886,7 @@ void **_body_clear_shapes** **(** :ref:`RID<class_RID>` body **)** |virtual| :ref:`int<class_int>` **_body_get_collision_layer** **(** :ref:`RID<class_RID>` body **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_get_collision_layer<class_PhysicsServer2D_method_body_get_collision_layer>`. .. rst-class:: classref-item-separator @@ -986,9 +898,7 @@ void **_body_clear_shapes** **(** :ref:`RID<class_RID>` body **)** |virtual| :ref:`int<class_int>` **_body_get_collision_mask** **(** :ref:`RID<class_RID>` body **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_get_collision_mask<class_PhysicsServer2D_method_body_get_collision_mask>`. .. rst-class:: classref-item-separator @@ -1000,9 +910,7 @@ void **_body_clear_shapes** **(** :ref:`RID<class_RID>` body **)** |virtual| :ref:`float<class_float>` **_body_get_collision_priority** **(** :ref:`RID<class_RID>` body **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_get_collision_priority<class_PhysicsServer2D_method_body_get_collision_priority>`. .. rst-class:: classref-item-separator @@ -1014,9 +922,7 @@ void **_body_clear_shapes** **(** :ref:`RID<class_RID>` body **)** |virtual| :ref:`Vector2<class_Vector2>` **_body_get_constant_force** **(** :ref:`RID<class_RID>` body **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_get_constant_force<class_PhysicsServer2D_method_body_get_constant_force>`. .. rst-class:: classref-item-separator @@ -1028,9 +934,7 @@ void **_body_clear_shapes** **(** :ref:`RID<class_RID>` body **)** |virtual| :ref:`float<class_float>` **_body_get_constant_torque** **(** :ref:`RID<class_RID>` body **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_get_constant_torque<class_PhysicsServer2D_method_body_get_constant_torque>`. .. rst-class:: classref-item-separator @@ -1042,9 +946,9 @@ void **_body_clear_shapes** **(** :ref:`RID<class_RID>` body **)** |virtual| :ref:`float<class_float>` **_body_get_contacts_reported_depth_threshold** **(** :ref:`RID<class_RID>` body **)** |virtual| |const| -.. container:: contribute +Overridable version of :ref:`PhysicsServer2D<class_PhysicsServer2D>`'s internal ``body_get_contacts_reported_depth_threshold`` method. - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +\ **Note:** This method is currently unused by Godot's default physics implementation. .. rst-class:: classref-item-separator @@ -1056,9 +960,7 @@ void **_body_clear_shapes** **(** :ref:`RID<class_RID>` body **)** |virtual| :ref:`CCDMode<enum_PhysicsServer2D_CCDMode>` **_body_get_continuous_collision_detection_mode** **(** :ref:`RID<class_RID>` body **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_get_continuous_collision_detection_mode<class_PhysicsServer2D_method_body_get_continuous_collision_detection_mode>`. .. rst-class:: classref-item-separator @@ -1070,9 +972,7 @@ void **_body_clear_shapes** **(** :ref:`RID<class_RID>` body **)** |virtual| :ref:`PhysicsDirectBodyState2D<class_PhysicsDirectBodyState2D>` **_body_get_direct_state** **(** :ref:`RID<class_RID>` body **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_get_direct_state<class_PhysicsServer2D_method_body_get_direct_state>`. .. rst-class:: classref-item-separator @@ -1084,9 +984,7 @@ void **_body_clear_shapes** **(** :ref:`RID<class_RID>` body **)** |virtual| :ref:`int<class_int>` **_body_get_max_contacts_reported** **(** :ref:`RID<class_RID>` body **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_get_max_contacts_reported<class_PhysicsServer2D_method_body_get_max_contacts_reported>`. .. rst-class:: classref-item-separator @@ -1098,9 +996,7 @@ void **_body_clear_shapes** **(** :ref:`RID<class_RID>` body **)** |virtual| :ref:`BodyMode<enum_PhysicsServer2D_BodyMode>` **_body_get_mode** **(** :ref:`RID<class_RID>` body **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_get_mode<class_PhysicsServer2D_method_body_get_mode>`. .. rst-class:: classref-item-separator @@ -1112,9 +1008,7 @@ void **_body_clear_shapes** **(** :ref:`RID<class_RID>` body **)** |virtual| :ref:`int<class_int>` **_body_get_object_instance_id** **(** :ref:`RID<class_RID>` body **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_get_object_instance_id<class_PhysicsServer2D_method_body_get_object_instance_id>`. .. rst-class:: classref-item-separator @@ -1126,9 +1020,7 @@ void **_body_clear_shapes** **(** :ref:`RID<class_RID>` body **)** |virtual| :ref:`Variant<class_Variant>` **_body_get_param** **(** :ref:`RID<class_RID>` body, :ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` param **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_get_param<class_PhysicsServer2D_method_body_get_param>`. .. rst-class:: classref-item-separator @@ -1140,9 +1032,7 @@ void **_body_clear_shapes** **(** :ref:`RID<class_RID>` body **)** |virtual| :ref:`RID<class_RID>` **_body_get_shape** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_get_shape<class_PhysicsServer2D_method_body_get_shape>`. .. rst-class:: classref-item-separator @@ -1154,9 +1044,7 @@ void **_body_clear_shapes** **(** :ref:`RID<class_RID>` body **)** |virtual| :ref:`int<class_int>` **_body_get_shape_count** **(** :ref:`RID<class_RID>` body **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_get_shape_count<class_PhysicsServer2D_method_body_get_shape_count>`. .. rst-class:: classref-item-separator @@ -1168,9 +1056,7 @@ void **_body_clear_shapes** **(** :ref:`RID<class_RID>` body **)** |virtual| :ref:`Transform2D<class_Transform2D>` **_body_get_shape_transform** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_get_shape_transform<class_PhysicsServer2D_method_body_get_shape_transform>`. .. rst-class:: classref-item-separator @@ -1182,9 +1068,7 @@ void **_body_clear_shapes** **(** :ref:`RID<class_RID>` body **)** |virtual| :ref:`RID<class_RID>` **_body_get_space** **(** :ref:`RID<class_RID>` body **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_get_space<class_PhysicsServer2D_method_body_get_space>`. .. rst-class:: classref-item-separator @@ -1196,9 +1080,7 @@ void **_body_clear_shapes** **(** :ref:`RID<class_RID>` body **)** |virtual| :ref:`Variant<class_Variant>` **_body_get_state** **(** :ref:`RID<class_RID>` body, :ref:`BodyState<enum_PhysicsServer2D_BodyState>` state **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_get_state<class_PhysicsServer2D_method_body_get_state>`. .. rst-class:: classref-item-separator @@ -1210,9 +1092,7 @@ void **_body_clear_shapes** **(** :ref:`RID<class_RID>` body **)** |virtual| :ref:`bool<class_bool>` **_body_is_omitting_force_integration** **(** :ref:`RID<class_RID>` body **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_is_omitting_force_integration<class_PhysicsServer2D_method_body_is_omitting_force_integration>`. .. rst-class:: classref-item-separator @@ -1224,9 +1104,7 @@ void **_body_clear_shapes** **(** :ref:`RID<class_RID>` body **)** |virtual| void **_body_remove_collision_exception** **(** :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` excepted_body **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_remove_collision_exception<class_PhysicsServer2D_method_body_remove_collision_exception>`. .. rst-class:: classref-item-separator @@ -1238,9 +1116,7 @@ void **_body_remove_collision_exception** **(** :ref:`RID<class_RID>` body, :ref void **_body_remove_shape** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_remove_shape<class_PhysicsServer2D_method_body_remove_shape>`. .. rst-class:: classref-item-separator @@ -1252,9 +1128,7 @@ void **_body_remove_shape** **(** :ref:`RID<class_RID>` body, :ref:`int<class_in void **_body_reset_mass_properties** **(** :ref:`RID<class_RID>` body **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_reset_mass_properties<class_PhysicsServer2D_method_body_reset_mass_properties>`. .. rst-class:: classref-item-separator @@ -1266,9 +1140,7 @@ void **_body_reset_mass_properties** **(** :ref:`RID<class_RID>` body **)** |vir void **_body_set_axis_velocity** **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` axis_velocity **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_set_axis_velocity<class_PhysicsServer2D_method_body_set_axis_velocity>`. .. rst-class:: classref-item-separator @@ -1280,9 +1152,7 @@ void **_body_set_axis_velocity** **(** :ref:`RID<class_RID>` body, :ref:`Vector2 void **_body_set_collision_layer** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` layer **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_set_collision_layer<class_PhysicsServer2D_method_body_set_collision_layer>`. .. rst-class:: classref-item-separator @@ -1294,9 +1164,7 @@ void **_body_set_collision_layer** **(** :ref:`RID<class_RID>` body, :ref:`int<c void **_body_set_collision_mask** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` mask **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_set_collision_mask<class_PhysicsServer2D_method_body_set_collision_mask>`. .. rst-class:: classref-item-separator @@ -1308,9 +1176,7 @@ void **_body_set_collision_mask** **(** :ref:`RID<class_RID>` body, :ref:`int<cl void **_body_set_collision_priority** **(** :ref:`RID<class_RID>` body, :ref:`float<class_float>` priority **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_set_collision_priority<class_PhysicsServer2D_method_body_set_collision_priority>`. .. rst-class:: classref-item-separator @@ -1322,9 +1188,7 @@ void **_body_set_collision_priority** **(** :ref:`RID<class_RID>` body, :ref:`fl void **_body_set_constant_force** **(** :ref:`RID<class_RID>` body, :ref:`Vector2<class_Vector2>` force **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_set_constant_force<class_PhysicsServer2D_method_body_set_constant_force>`. .. rst-class:: classref-item-separator @@ -1336,9 +1200,7 @@ void **_body_set_constant_force** **(** :ref:`RID<class_RID>` body, :ref:`Vector void **_body_set_constant_torque** **(** :ref:`RID<class_RID>` body, :ref:`float<class_float>` torque **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_set_constant_torque<class_PhysicsServer2D_method_body_set_constant_torque>`. .. rst-class:: classref-item-separator @@ -1350,9 +1212,9 @@ void **_body_set_constant_torque** **(** :ref:`RID<class_RID>` body, :ref:`float void **_body_set_contacts_reported_depth_threshold** **(** :ref:`RID<class_RID>` body, :ref:`float<class_float>` threshold **)** |virtual| -.. container:: contribute +Overridable version of :ref:`PhysicsServer2D<class_PhysicsServer2D>`'s internal ``body_set_contacts_reported_depth_threshold`` method. - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +\ **Note:** This method is currently unused by Godot's default physics implementation. .. rst-class:: classref-item-separator @@ -1364,9 +1226,7 @@ void **_body_set_contacts_reported_depth_threshold** **(** :ref:`RID<class_RID>` void **_body_set_continuous_collision_detection_mode** **(** :ref:`RID<class_RID>` body, :ref:`CCDMode<enum_PhysicsServer2D_CCDMode>` mode **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_set_continuous_collision_detection_mode<class_PhysicsServer2D_method_body_set_continuous_collision_detection_mode>`. .. rst-class:: classref-item-separator @@ -1378,9 +1238,7 @@ void **_body_set_continuous_collision_detection_mode** **(** :ref:`RID<class_RID void **_body_set_force_integration_callback** **(** :ref:`RID<class_RID>` body, :ref:`Callable<class_Callable>` callable, :ref:`Variant<class_Variant>` userdata **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_set_force_integration_callback<class_PhysicsServer2D_method_body_set_force_integration_callback>`. .. rst-class:: classref-item-separator @@ -1392,9 +1250,7 @@ void **_body_set_force_integration_callback** **(** :ref:`RID<class_RID>` body, void **_body_set_max_contacts_reported** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` amount **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_set_max_contacts_reported<class_PhysicsServer2D_method_body_set_max_contacts_reported>`. .. rst-class:: classref-item-separator @@ -1406,9 +1262,7 @@ void **_body_set_max_contacts_reported** **(** :ref:`RID<class_RID>` body, :ref: void **_body_set_mode** **(** :ref:`RID<class_RID>` body, :ref:`BodyMode<enum_PhysicsServer2D_BodyMode>` mode **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_set_mode<class_PhysicsServer2D_method_body_set_mode>`. .. rst-class:: classref-item-separator @@ -1420,9 +1274,7 @@ void **_body_set_mode** **(** :ref:`RID<class_RID>` body, :ref:`BodyMode<enum_Ph void **_body_set_omit_force_integration** **(** :ref:`RID<class_RID>` body, :ref:`bool<class_bool>` enable **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_set_omit_force_integration<class_PhysicsServer2D_method_body_set_omit_force_integration>`. .. rst-class:: classref-item-separator @@ -1434,9 +1286,7 @@ void **_body_set_omit_force_integration** **(** :ref:`RID<class_RID>` body, :ref void **_body_set_param** **(** :ref:`RID<class_RID>` body, :ref:`BodyParameter<enum_PhysicsServer2D_BodyParameter>` param, :ref:`Variant<class_Variant>` value **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_set_param<class_PhysicsServer2D_method_body_set_param>`. .. rst-class:: classref-item-separator @@ -1448,9 +1298,9 @@ void **_body_set_param** **(** :ref:`RID<class_RID>` body, :ref:`BodyParameter<e void **_body_set_pickable** **(** :ref:`RID<class_RID>` body, :ref:`bool<class_bool>` pickable **)** |virtual| -.. container:: contribute +If set to ``true``, allows the body with the given :ref:`RID<class_RID>` to detect mouse inputs when the mouse cursor is hovering on it. - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D<class_PhysicsServer2D>`'s internal ``body_set_pickable`` method. Corresponds to :ref:`PhysicsBody2D.input_pickable<class_PhysicsBody2D_property_input_pickable>`. .. rst-class:: classref-item-separator @@ -1462,9 +1312,7 @@ void **_body_set_pickable** **(** :ref:`RID<class_RID>` body, :ref:`bool<class_b void **_body_set_shape** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx, :ref:`RID<class_RID>` shape **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_set_shape<class_PhysicsServer2D_method_body_set_shape>`. .. rst-class:: classref-item-separator @@ -1476,9 +1324,7 @@ void **_body_set_shape** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` void **_body_set_shape_as_one_way_collision** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx, :ref:`bool<class_bool>` enable, :ref:`float<class_float>` margin **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_set_shape_as_one_way_collision<class_PhysicsServer2D_method_body_set_shape_as_one_way_collision>`. .. rst-class:: classref-item-separator @@ -1490,9 +1336,7 @@ void **_body_set_shape_as_one_way_collision** **(** :ref:`RID<class_RID>` body, void **_body_set_shape_disabled** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx, :ref:`bool<class_bool>` disabled **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_set_shape_disabled<class_PhysicsServer2D_method_body_set_shape_disabled>`. .. rst-class:: classref-item-separator @@ -1504,9 +1348,7 @@ void **_body_set_shape_disabled** **(** :ref:`RID<class_RID>` body, :ref:`int<cl void **_body_set_shape_transform** **(** :ref:`RID<class_RID>` body, :ref:`int<class_int>` shape_idx, :ref:`Transform2D<class_Transform2D>` transform **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_set_shape_transform<class_PhysicsServer2D_method_body_set_shape_transform>`. .. rst-class:: classref-item-separator @@ -1518,9 +1360,7 @@ void **_body_set_shape_transform** **(** :ref:`RID<class_RID>` body, :ref:`int<c void **_body_set_space** **(** :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` space **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_set_space<class_PhysicsServer2D_method_body_set_space>`. .. rst-class:: classref-item-separator @@ -1532,9 +1372,7 @@ void **_body_set_space** **(** :ref:`RID<class_RID>` body, :ref:`RID<class_RID>` void **_body_set_state** **(** :ref:`RID<class_RID>` body, :ref:`BodyState<enum_PhysicsServer2D_BodyState>` state, :ref:`Variant<class_Variant>` value **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_set_state<class_PhysicsServer2D_method_body_set_state>`. .. rst-class:: classref-item-separator @@ -1546,9 +1384,9 @@ void **_body_set_state** **(** :ref:`RID<class_RID>` body, :ref:`BodyState<enum_ void **_body_set_state_sync_callback** **(** :ref:`RID<class_RID>` body, :ref:`Callable<class_Callable>` callable **)** |virtual| -.. container:: contribute +Assigns the ``body`` to call the given ``callable`` during the synchronization phase of the loop, before :ref:`_step<class_PhysicsServer2DExtension_private_method__step>` is called. See also :ref:`_sync<class_PhysicsServer2DExtension_private_method__sync>`. - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D<class_PhysicsServer2D>`'s internal ``body_set_state_sync_callback`` method. .. rst-class:: classref-item-separator @@ -1560,9 +1398,7 @@ void **_body_set_state_sync_callback** **(** :ref:`RID<class_RID>` body, :ref:`C :ref:`bool<class_bool>` **_body_test_motion** **(** :ref:`RID<class_RID>` body, :ref:`Transform2D<class_Transform2D>` from, :ref:`Vector2<class_Vector2>` motion, :ref:`float<class_float>` margin, :ref:`bool<class_bool>` collide_separation_ray, :ref:`bool<class_bool>` recovery_as_collision, PhysicsServer2DExtensionMotionResult* result **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.body_test_motion<class_PhysicsServer2D_method_body_test_motion>`. Unlike the exposed implementation, this method does not receive all of the arguments inside a :ref:`PhysicsTestMotionParameters2D<class_PhysicsTestMotionParameters2D>`. .. rst-class:: classref-item-separator @@ -1574,9 +1410,7 @@ void **_body_set_state_sync_callback** **(** :ref:`RID<class_RID>` body, :ref:`C :ref:`RID<class_RID>` **_capsule_shape_create** **(** **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.capsule_shape_create<class_PhysicsServer2D_method_capsule_shape_create>`. .. rst-class:: classref-item-separator @@ -1588,9 +1422,7 @@ void **_body_set_state_sync_callback** **(** :ref:`RID<class_RID>` body, :ref:`C :ref:`RID<class_RID>` **_circle_shape_create** **(** **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.circle_shape_create<class_PhysicsServer2D_method_circle_shape_create>`. .. rst-class:: classref-item-separator @@ -1602,9 +1434,7 @@ void **_body_set_state_sync_callback** **(** :ref:`RID<class_RID>` body, :ref:`C :ref:`RID<class_RID>` **_concave_polygon_shape_create** **(** **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.concave_polygon_shape_create<class_PhysicsServer2D_method_concave_polygon_shape_create>`. .. rst-class:: classref-item-separator @@ -1616,9 +1446,7 @@ void **_body_set_state_sync_callback** **(** :ref:`RID<class_RID>` body, :ref:`C :ref:`RID<class_RID>` **_convex_polygon_shape_create** **(** **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.convex_polygon_shape_create<class_PhysicsServer2D_method_convex_polygon_shape_create>`. .. rst-class:: classref-item-separator @@ -1630,9 +1458,7 @@ void **_body_set_state_sync_callback** **(** :ref:`RID<class_RID>` body, :ref:`C :ref:`float<class_float>` **_damped_spring_joint_get_param** **(** :ref:`RID<class_RID>` joint, :ref:`DampedSpringParam<enum_PhysicsServer2D_DampedSpringParam>` param **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.damped_spring_joint_get_param<class_PhysicsServer2D_method_damped_spring_joint_get_param>`. .. rst-class:: classref-item-separator @@ -1644,9 +1470,7 @@ void **_body_set_state_sync_callback** **(** :ref:`RID<class_RID>` body, :ref:`C void **_damped_spring_joint_set_param** **(** :ref:`RID<class_RID>` joint, :ref:`DampedSpringParam<enum_PhysicsServer2D_DampedSpringParam>` param, :ref:`float<class_float>` value **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.damped_spring_joint_set_param<class_PhysicsServer2D_method_damped_spring_joint_set_param>`. .. rst-class:: classref-item-separator @@ -1658,9 +1482,9 @@ void **_damped_spring_joint_set_param** **(** :ref:`RID<class_RID>` joint, :ref: void **_end_sync** **(** **)** |virtual| -.. container:: contribute +Called to indicate that the physics server has stopped synchronizing. It is in the loop's iteration/physics phase, and can access physics objects even if running on a separate thread. See also :ref:`_sync<class_PhysicsServer2DExtension_private_method__sync>`. - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D<class_PhysicsServer2D>`'s internal ``end_sync`` method. .. rst-class:: classref-item-separator @@ -1672,9 +1496,9 @@ void **_end_sync** **(** **)** |virtual| void **_finish** **(** **)** |virtual| -.. container:: contribute +Called when the main loop finalizes to shut down the physics server. See also :ref:`MainLoop._finalize<class_MainLoop_private_method__finalize>` and :ref:`_init<class_PhysicsServer2DExtension_private_method__init>`. - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D<class_PhysicsServer2D>`'s internal ``finish`` method. .. rst-class:: classref-item-separator @@ -1686,9 +1510,9 @@ void **_finish** **(** **)** |virtual| void **_flush_queries** **(** **)** |virtual| -.. container:: contribute +Called every physics step before :ref:`_step<class_PhysicsServer2DExtension_private_method__step>` to process all remaining queries. - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D<class_PhysicsServer2D>`'s internal ``flush_queries`` method. .. rst-class:: classref-item-separator @@ -1700,9 +1524,7 @@ void **_flush_queries** **(** **)** |virtual| void **_free_rid** **(** :ref:`RID<class_RID>` rid **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.free_rid<class_PhysicsServer2D_method_free_rid>`. .. rst-class:: classref-item-separator @@ -1714,9 +1536,7 @@ void **_free_rid** **(** :ref:`RID<class_RID>` rid **)** |virtual| :ref:`int<class_int>` **_get_process_info** **(** :ref:`ProcessInfo<enum_PhysicsServer2D_ProcessInfo>` process_info **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.get_process_info<class_PhysicsServer2D_method_get_process_info>`. .. rst-class:: classref-item-separator @@ -1728,9 +1548,9 @@ void **_free_rid** **(** :ref:`RID<class_RID>` rid **)** |virtual| void **_init** **(** **)** |virtual| -.. container:: contribute +Called when the main loop is initialized and creates a new instance of this physics server. See also :ref:`MainLoop._initialize<class_MainLoop_private_method__initialize>` and :ref:`_finish<class_PhysicsServer2DExtension_private_method__finish>`. - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D<class_PhysicsServer2D>`'s internal ``init`` method. .. rst-class:: classref-item-separator @@ -1742,9 +1562,9 @@ void **_init** **(** **)** |virtual| :ref:`bool<class_bool>` **_is_flushing_queries** **(** **)** |virtual| |const| -.. container:: contribute +Overridable method that should return ``true`` when the physics server is processing queries. See also :ref:`_flush_queries<class_PhysicsServer2DExtension_private_method__flush_queries>`. - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D<class_PhysicsServer2D>`'s internal ``is_flushing_queries`` method. .. rst-class:: classref-item-separator @@ -1756,9 +1576,7 @@ void **_init** **(** **)** |virtual| void **_joint_clear** **(** :ref:`RID<class_RID>` joint **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.joint_clear<class_PhysicsServer2D_method_joint_clear>`. .. rst-class:: classref-item-separator @@ -1770,9 +1588,7 @@ void **_joint_clear** **(** :ref:`RID<class_RID>` joint **)** |virtual| :ref:`RID<class_RID>` **_joint_create** **(** **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.joint_create<class_PhysicsServer2D_method_joint_create>`. .. rst-class:: classref-item-separator @@ -1784,9 +1600,7 @@ void **_joint_clear** **(** :ref:`RID<class_RID>` joint **)** |virtual| void **_joint_disable_collisions_between_bodies** **(** :ref:`RID<class_RID>` joint, :ref:`bool<class_bool>` disable **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.joint_disable_collisions_between_bodies<class_PhysicsServer2D_method_joint_disable_collisions_between_bodies>`. .. rst-class:: classref-item-separator @@ -1798,9 +1612,7 @@ void **_joint_disable_collisions_between_bodies** **(** :ref:`RID<class_RID>` jo :ref:`float<class_float>` **_joint_get_param** **(** :ref:`RID<class_RID>` joint, :ref:`JointParam<enum_PhysicsServer2D_JointParam>` param **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.joint_get_param<class_PhysicsServer2D_method_joint_get_param>`. .. rst-class:: classref-item-separator @@ -1812,9 +1624,7 @@ void **_joint_disable_collisions_between_bodies** **(** :ref:`RID<class_RID>` jo :ref:`JointType<enum_PhysicsServer2D_JointType>` **_joint_get_type** **(** :ref:`RID<class_RID>` joint **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.joint_get_type<class_PhysicsServer2D_method_joint_get_type>`. .. rst-class:: classref-item-separator @@ -1826,9 +1636,7 @@ void **_joint_disable_collisions_between_bodies** **(** :ref:`RID<class_RID>` jo :ref:`bool<class_bool>` **_joint_is_disabled_collisions_between_bodies** **(** :ref:`RID<class_RID>` joint **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.joint_is_disabled_collisions_between_bodies<class_PhysicsServer2D_method_joint_is_disabled_collisions_between_bodies>`. .. rst-class:: classref-item-separator @@ -1840,9 +1648,7 @@ void **_joint_disable_collisions_between_bodies** **(** :ref:`RID<class_RID>` jo void **_joint_make_damped_spring** **(** :ref:`RID<class_RID>` joint, :ref:`Vector2<class_Vector2>` anchor_a, :ref:`Vector2<class_Vector2>` anchor_b, :ref:`RID<class_RID>` body_a, :ref:`RID<class_RID>` body_b **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.joint_make_damped_spring<class_PhysicsServer2D_method_joint_make_damped_spring>`. .. rst-class:: classref-item-separator @@ -1854,9 +1660,7 @@ void **_joint_make_damped_spring** **(** :ref:`RID<class_RID>` joint, :ref:`Vect void **_joint_make_groove** **(** :ref:`RID<class_RID>` joint, :ref:`Vector2<class_Vector2>` a_groove1, :ref:`Vector2<class_Vector2>` a_groove2, :ref:`Vector2<class_Vector2>` b_anchor, :ref:`RID<class_RID>` body_a, :ref:`RID<class_RID>` body_b **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.joint_make_groove<class_PhysicsServer2D_method_joint_make_groove>`. .. rst-class:: classref-item-separator @@ -1868,9 +1672,7 @@ void **_joint_make_groove** **(** :ref:`RID<class_RID>` joint, :ref:`Vector2<cla void **_joint_make_pin** **(** :ref:`RID<class_RID>` joint, :ref:`Vector2<class_Vector2>` anchor, :ref:`RID<class_RID>` body_a, :ref:`RID<class_RID>` body_b **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.joint_make_pin<class_PhysicsServer2D_method_joint_make_pin>`. .. rst-class:: classref-item-separator @@ -1882,9 +1684,7 @@ void **_joint_make_pin** **(** :ref:`RID<class_RID>` joint, :ref:`Vector2<class_ void **_joint_set_param** **(** :ref:`RID<class_RID>` joint, :ref:`JointParam<enum_PhysicsServer2D_JointParam>` param, :ref:`float<class_float>` value **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.joint_set_param<class_PhysicsServer2D_method_joint_set_param>`. .. rst-class:: classref-item-separator @@ -1896,9 +1696,7 @@ void **_joint_set_param** **(** :ref:`RID<class_RID>` joint, :ref:`JointParam<en :ref:`bool<class_bool>` **_pin_joint_get_flag** **(** :ref:`RID<class_RID>` joint, :ref:`PinJointFlag<enum_PhysicsServer2D_PinJointFlag>` flag **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.pin_joint_get_flag<class_PhysicsServer2D_method_pin_joint_get_flag>`. .. rst-class:: classref-item-separator @@ -1910,9 +1708,7 @@ void **_joint_set_param** **(** :ref:`RID<class_RID>` joint, :ref:`JointParam<en :ref:`float<class_float>` **_pin_joint_get_param** **(** :ref:`RID<class_RID>` joint, :ref:`PinJointParam<enum_PhysicsServer2D_PinJointParam>` param **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.pin_joint_get_param<class_PhysicsServer2D_method_pin_joint_get_param>`. .. rst-class:: classref-item-separator @@ -1924,9 +1720,7 @@ void **_joint_set_param** **(** :ref:`RID<class_RID>` joint, :ref:`JointParam<en void **_pin_joint_set_flag** **(** :ref:`RID<class_RID>` joint, :ref:`PinJointFlag<enum_PhysicsServer2D_PinJointFlag>` flag, :ref:`bool<class_bool>` enabled **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.pin_joint_set_flag<class_PhysicsServer2D_method_pin_joint_set_flag>`. .. rst-class:: classref-item-separator @@ -1938,9 +1732,7 @@ void **_pin_joint_set_flag** **(** :ref:`RID<class_RID>` joint, :ref:`PinJointFl void **_pin_joint_set_param** **(** :ref:`RID<class_RID>` joint, :ref:`PinJointParam<enum_PhysicsServer2D_PinJointParam>` param, :ref:`float<class_float>` value **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.pin_joint_set_param<class_PhysicsServer2D_method_pin_joint_set_param>`. .. rst-class:: classref-item-separator @@ -1952,9 +1744,7 @@ void **_pin_joint_set_param** **(** :ref:`RID<class_RID>` joint, :ref:`PinJointP :ref:`RID<class_RID>` **_rectangle_shape_create** **(** **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.rectangle_shape_create<class_PhysicsServer2D_method_rectangle_shape_create>`. .. rst-class:: classref-item-separator @@ -1966,9 +1756,7 @@ void **_pin_joint_set_param** **(** :ref:`RID<class_RID>` joint, :ref:`PinJointP :ref:`RID<class_RID>` **_segment_shape_create** **(** **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.segment_shape_create<class_PhysicsServer2D_method_segment_shape_create>`. .. rst-class:: classref-item-separator @@ -1980,9 +1768,7 @@ void **_pin_joint_set_param** **(** :ref:`RID<class_RID>` joint, :ref:`PinJointP :ref:`RID<class_RID>` **_separation_ray_shape_create** **(** **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.separation_ray_shape_create<class_PhysicsServer2D_method_separation_ray_shape_create>`. .. rst-class:: classref-item-separator @@ -1994,9 +1780,7 @@ void **_pin_joint_set_param** **(** :ref:`RID<class_RID>` joint, :ref:`PinJointP void **_set_active** **(** :ref:`bool<class_bool>` active **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.set_active<class_PhysicsServer2D_method_set_active>`. .. rst-class:: classref-item-separator @@ -2008,9 +1792,9 @@ void **_set_active** **(** :ref:`bool<class_bool>` active **)** |virtual| :ref:`bool<class_bool>` **_shape_collide** **(** :ref:`RID<class_RID>` shape_A, :ref:`Transform2D<class_Transform2D>` xform_A, :ref:`Vector2<class_Vector2>` motion_A, :ref:`RID<class_RID>` shape_B, :ref:`Transform2D<class_Transform2D>` xform_B, :ref:`Vector2<class_Vector2>` motion_B, void* results, :ref:`int<class_int>` result_max, int32_t* result_count **)** |virtual| -.. container:: contribute +Given two shapes and their parameters, should return ``true`` if a collision between the two would occur, with additional details passed in ``results``. - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D<class_PhysicsServer2D>`'s internal ``shape_collide`` method. Corresponds to :ref:`PhysicsDirectSpaceState2D.collide_shape<class_PhysicsDirectSpaceState2D_method_collide_shape>`. .. rst-class:: classref-item-separator @@ -2022,9 +1806,9 @@ void **_set_active** **(** :ref:`bool<class_bool>` active **)** |virtual| :ref:`float<class_float>` **_shape_get_custom_solver_bias** **(** :ref:`RID<class_RID>` shape **)** |virtual| |const| -.. container:: contribute +Should return the custom solver bias of the given ``shape``, which defines how much bodies are forced to separate on contact when this shape is involved. - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D<class_PhysicsServer2D>`'s internal ``shape_get_custom_solver_bias`` method. Corresponds to :ref:`Shape2D.custom_solver_bias<class_Shape2D_property_custom_solver_bias>`. .. rst-class:: classref-item-separator @@ -2036,9 +1820,7 @@ void **_set_active** **(** :ref:`bool<class_bool>` active **)** |virtual| :ref:`Variant<class_Variant>` **_shape_get_data** **(** :ref:`RID<class_RID>` shape **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.shape_get_data<class_PhysicsServer2D_method_shape_get_data>`. .. rst-class:: classref-item-separator @@ -2050,9 +1832,7 @@ void **_set_active** **(** :ref:`bool<class_bool>` active **)** |virtual| :ref:`ShapeType<enum_PhysicsServer2D_ShapeType>` **_shape_get_type** **(** :ref:`RID<class_RID>` shape **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.shape_get_type<class_PhysicsServer2D_method_shape_get_type>`. .. rst-class:: classref-item-separator @@ -2064,9 +1844,9 @@ void **_set_active** **(** :ref:`bool<class_bool>` active **)** |virtual| void **_shape_set_custom_solver_bias** **(** :ref:`RID<class_RID>` shape, :ref:`float<class_float>` bias **)** |virtual| -.. container:: contribute +Should set the custom solver bias for the given ``shape``. It defines how much bodies are forced to separate on contact. - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D<class_PhysicsServer2D>`'s internal ``shape_get_custom_solver_bias`` method. Corresponds to :ref:`Shape2D.custom_solver_bias<class_Shape2D_property_custom_solver_bias>`. .. rst-class:: classref-item-separator @@ -2078,9 +1858,7 @@ void **_shape_set_custom_solver_bias** **(** :ref:`RID<class_RID>` shape, :ref:` void **_shape_set_data** **(** :ref:`RID<class_RID>` shape, :ref:`Variant<class_Variant>` data **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.shape_set_data<class_PhysicsServer2D_method_shape_set_data>`. .. rst-class:: classref-item-separator @@ -2092,9 +1870,7 @@ void **_shape_set_data** **(** :ref:`RID<class_RID>` shape, :ref:`Variant<class_ :ref:`RID<class_RID>` **_space_create** **(** **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.space_create<class_PhysicsServer2D_method_space_create>`. .. rst-class:: classref-item-separator @@ -2106,9 +1882,9 @@ void **_shape_set_data** **(** :ref:`RID<class_RID>` shape, :ref:`Variant<class_ :ref:`int<class_int>` **_space_get_contact_count** **(** :ref:`RID<class_RID>` space **)** |virtual| |const| -.. container:: contribute +Should return how many contacts have occurred during the last physics step in the given ``space``. See also :ref:`_space_get_contacts<class_PhysicsServer2DExtension_private_method__space_get_contacts>` and :ref:`_space_set_debug_contacts<class_PhysicsServer2DExtension_private_method__space_set_debug_contacts>`. - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D<class_PhysicsServer2D>`'s internal ``space_get_contact_count`` method. .. rst-class:: classref-item-separator @@ -2120,9 +1896,9 @@ void **_shape_set_data** **(** :ref:`RID<class_RID>` shape, :ref:`Variant<class_ :ref:`PackedVector2Array<class_PackedVector2Array>` **_space_get_contacts** **(** :ref:`RID<class_RID>` space **)** |virtual| |const| -.. container:: contribute +Should return the positions of all contacts that have occurred during the last physics step in the given ``space``. See also :ref:`_space_get_contact_count<class_PhysicsServer2DExtension_private_method__space_get_contact_count>` and :ref:`_space_set_debug_contacts<class_PhysicsServer2DExtension_private_method__space_set_debug_contacts>`. - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D<class_PhysicsServer2D>`'s internal ``space_get_contacts`` method. .. rst-class:: classref-item-separator @@ -2134,9 +1910,7 @@ void **_shape_set_data** **(** :ref:`RID<class_RID>` shape, :ref:`Variant<class_ :ref:`PhysicsDirectSpaceState2D<class_PhysicsDirectSpaceState2D>` **_space_get_direct_state** **(** :ref:`RID<class_RID>` space **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.space_get_direct_state<class_PhysicsServer2D_method_space_get_direct_state>`. .. rst-class:: classref-item-separator @@ -2148,9 +1922,7 @@ void **_shape_set_data** **(** :ref:`RID<class_RID>` shape, :ref:`Variant<class_ :ref:`float<class_float>` **_space_get_param** **(** :ref:`RID<class_RID>` space, :ref:`SpaceParameter<enum_PhysicsServer2D_SpaceParameter>` param **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.space_get_param<class_PhysicsServer2D_method_space_get_param>`. .. rst-class:: classref-item-separator @@ -2162,9 +1934,7 @@ void **_shape_set_data** **(** :ref:`RID<class_RID>` shape, :ref:`Variant<class_ :ref:`bool<class_bool>` **_space_is_active** **(** :ref:`RID<class_RID>` space **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.space_is_active<class_PhysicsServer2D_method_space_is_active>`. .. rst-class:: classref-item-separator @@ -2176,9 +1946,7 @@ void **_shape_set_data** **(** :ref:`RID<class_RID>` shape, :ref:`Variant<class_ void **_space_set_active** **(** :ref:`RID<class_RID>` space, :ref:`bool<class_bool>` active **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.space_set_active<class_PhysicsServer2D_method_space_set_active>`. .. rst-class:: classref-item-separator @@ -2190,9 +1958,9 @@ void **_space_set_active** **(** :ref:`RID<class_RID>` space, :ref:`bool<class_b void **_space_set_debug_contacts** **(** :ref:`RID<class_RID>` space, :ref:`int<class_int>` max_contacts **)** |virtual| -.. container:: contribute +Used internally to allow the given ``space`` to store contact points, up to ``max_contacts``. This is automatically set for the main :ref:`World2D<class_World2D>`'s space when :ref:`SceneTree.debug_collisions_hint<class_SceneTree_property_debug_collisions_hint>` is ``true``, or by checking "Visible Collision Shapes" in the editor. Only works in debug builds. - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D<class_PhysicsServer2D>`'s internal ``space_set_debug_contacts`` method. .. rst-class:: classref-item-separator @@ -2204,9 +1972,7 @@ void **_space_set_debug_contacts** **(** :ref:`RID<class_RID>` space, :ref:`int< void **_space_set_param** **(** :ref:`RID<class_RID>` space, :ref:`SpaceParameter<enum_PhysicsServer2D_SpaceParameter>` param, :ref:`float<class_float>` value **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.space_set_param<class_PhysicsServer2D_method_space_set_param>`. .. rst-class:: classref-item-separator @@ -2218,9 +1984,9 @@ void **_space_set_param** **(** :ref:`RID<class_RID>` space, :ref:`SpaceParamete void **_step** **(** :ref:`float<class_float>` step **)** |virtual| -.. container:: contribute +Called every physics step to process the physics simulation. ``step`` is the time elapsed since the last physics step, in seconds. It is usually the same as :ref:`Node.get_physics_process_delta_time<class_Node_method_get_physics_process_delta_time>`. - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D<class_PhysicsServer2D>`'s internal ``step`` method. .. rst-class:: classref-item-separator @@ -2232,9 +1998,9 @@ void **_step** **(** :ref:`float<class_float>` step **)** |virtual| void **_sync** **(** **)** |virtual| -.. container:: contribute +Called to indicate that the physics server is synchronizing and cannot access physics states if running on a separate thread. See also :ref:`_end_sync<class_PhysicsServer2DExtension_private_method__end_sync>`. - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D<class_PhysicsServer2D>`'s internal ``sync`` method. .. rst-class:: classref-item-separator @@ -2246,9 +2012,7 @@ void **_sync** **(** **)** |virtual| :ref:`RID<class_RID>` **_world_boundary_shape_create** **(** **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Overridable version of :ref:`PhysicsServer2D.world_boundary_shape_create<class_PhysicsServer2D_method_world_boundary_shape_create>`. .. rst-class:: classref-item-separator @@ -2260,9 +2024,7 @@ void **_sync** **(** **)** |virtual| :ref:`bool<class_bool>` **body_test_motion_is_excluding_body** **(** :ref:`RID<class_RID>` body **)** |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Returns ``true`` if the body with the given :ref:`RID<class_RID>` is being excluded from :ref:`_body_test_motion<class_PhysicsServer2DExtension_private_method__body_test_motion>`. See also :ref:`Object.get_instance_id<class_Object_method_get_instance_id>`. .. rst-class:: classref-item-separator @@ -2274,9 +2036,7 @@ void **_sync** **(** **)** |virtual| :ref:`bool<class_bool>` **body_test_motion_is_excluding_object** **(** :ref:`int<class_int>` object **)** |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Returns ``true`` if the object with the given instance ID is being excluded from :ref:`_body_test_motion<class_PhysicsServer2DExtension_private_method__body_test_motion>`. See also :ref:`Object.get_instance_id<class_Object_method_get_instance_id>`. .. |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_physicsserver2dmanager.rst b/classes/class_physicsserver2dmanager.rst index 2e640ef9e..f3a3b94f1 100644 --- a/classes/class_physicsserver2dmanager.rst +++ b/classes/class_physicsserver2dmanager.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsServer2DManager.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PhysicsServer2DManager.xml. .. _class_PhysicsServer2DManager: diff --git a/classes/class_physicsserver3d.rst b/classes/class_physicsserver3d.rst index b1f658bd0..c9744ebd3 100644 --- a/classes/class_physicsserver3d.rst +++ b/classes/class_physicsserver3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsServer3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PhysicsServer3D.xml. .. _class_PhysicsServer3D: diff --git a/classes/class_physicsserver3dextension.rst b/classes/class_physicsserver3dextension.rst index 8fa9d1087..4a2628ecf 100644 --- a/classes/class_physicsserver3dextension.rst +++ b/classes/class_physicsserver3dextension.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsServer3DExtension.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PhysicsServer3DExtension.xml. .. _class_PhysicsServer3DExtension: diff --git a/classes/class_physicsserver3dmanager.rst b/classes/class_physicsserver3dmanager.rst index 5f8e76585..8496c0c66 100644 --- a/classes/class_physicsserver3dmanager.rst +++ b/classes/class_physicsserver3dmanager.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsServer3DManager.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PhysicsServer3DManager.xml. .. _class_PhysicsServer3DManager: diff --git a/classes/class_physicsserver3drenderingserverhandler.rst b/classes/class_physicsserver3drenderingserverhandler.rst index 16b352f7f..b9616cf63 100644 --- a/classes/class_physicsserver3drenderingserverhandler.rst +++ b/classes/class_physicsserver3drenderingserverhandler.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsServer3DRenderingServerHandler.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PhysicsServer3DRenderingServerHandler.xml. .. _class_PhysicsServer3DRenderingServerHandler: diff --git a/classes/class_physicsshapequeryparameters2d.rst b/classes/class_physicsshapequeryparameters2d.rst index 1b146102c..4c845f8a2 100644 --- a/classes/class_physicsshapequeryparameters2d.rst +++ b/classes/class_physicsshapequeryparameters2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsShapeQueryParameters2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PhysicsShapeQueryParameters2D.xml. .. _class_PhysicsShapeQueryParameters2D: diff --git a/classes/class_physicsshapequeryparameters3d.rst b/classes/class_physicsshapequeryparameters3d.rst index e78180dc9..9a6b19ca6 100644 --- a/classes/class_physicsshapequeryparameters3d.rst +++ b/classes/class_physicsshapequeryparameters3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsShapeQueryParameters3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PhysicsShapeQueryParameters3D.xml. .. _class_PhysicsShapeQueryParameters3D: diff --git a/classes/class_physicstestmotionparameters2d.rst b/classes/class_physicstestmotionparameters2d.rst index be979a5cc..402f4d657 100644 --- a/classes/class_physicstestmotionparameters2d.rst +++ b/classes/class_physicstestmotionparameters2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsTestMotionParameters2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PhysicsTestMotionParameters2D.xml. .. _class_PhysicsTestMotionParameters2D: diff --git a/classes/class_physicstestmotionparameters3d.rst b/classes/class_physicstestmotionparameters3d.rst index f3387458d..726260b13 100644 --- a/classes/class_physicstestmotionparameters3d.rst +++ b/classes/class_physicstestmotionparameters3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsTestMotionParameters3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PhysicsTestMotionParameters3D.xml. .. _class_PhysicsTestMotionParameters3D: diff --git a/classes/class_physicstestmotionresult2d.rst b/classes/class_physicstestmotionresult2d.rst index aa08bf5e5..edce69140 100644 --- a/classes/class_physicstestmotionresult2d.rst +++ b/classes/class_physicstestmotionresult2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsTestMotionResult2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PhysicsTestMotionResult2D.xml. .. _class_PhysicsTestMotionResult2D: diff --git a/classes/class_physicstestmotionresult3d.rst b/classes/class_physicstestmotionresult3d.rst index ff85e51df..96c681a5a 100644 --- a/classes/class_physicstestmotionresult3d.rst +++ b/classes/class_physicstestmotionresult3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsTestMotionResult3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PhysicsTestMotionResult3D.xml. .. _class_PhysicsTestMotionResult3D: diff --git a/classes/class_pinjoint2d.rst b/classes/class_pinjoint2d.rst index fd07b8f4c..c5cf27f94 100644 --- a/classes/class_pinjoint2d.rst +++ b/classes/class_pinjoint2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PinJoint2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PinJoint2D.xml. .. _class_PinJoint2D: diff --git a/classes/class_pinjoint3d.rst b/classes/class_pinjoint3d.rst index 27c8bc9d2..595fc3a32 100644 --- a/classes/class_pinjoint3d.rst +++ b/classes/class_pinjoint3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PinJoint3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PinJoint3D.xml. .. _class_PinJoint3D: diff --git a/classes/class_placeholdercubemap.rst b/classes/class_placeholdercubemap.rst index 416c9c163..6de6f112d 100644 --- a/classes/class_placeholdercubemap.rst +++ b/classes/class_placeholdercubemap.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PlaceholderCubemap.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PlaceholderCubemap.xml. .. _class_PlaceholderCubemap: diff --git a/classes/class_placeholdercubemaparray.rst b/classes/class_placeholdercubemaparray.rst index 1b19ec51d..49b986a2c 100644 --- a/classes/class_placeholdercubemaparray.rst +++ b/classes/class_placeholdercubemaparray.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PlaceholderCubemapArray.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PlaceholderCubemapArray.xml. .. _class_PlaceholderCubemapArray: diff --git a/classes/class_placeholdermaterial.rst b/classes/class_placeholdermaterial.rst index fa650d409..bf27bce1a 100644 --- a/classes/class_placeholdermaterial.rst +++ b/classes/class_placeholdermaterial.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PlaceholderMaterial.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PlaceholderMaterial.xml. .. _class_PlaceholderMaterial: diff --git a/classes/class_placeholdermesh.rst b/classes/class_placeholdermesh.rst index c79e3e366..a3f488c3c 100644 --- a/classes/class_placeholdermesh.rst +++ b/classes/class_placeholdermesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PlaceholderMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PlaceholderMesh.xml. .. _class_PlaceholderMesh: diff --git a/classes/class_placeholdertexture2d.rst b/classes/class_placeholdertexture2d.rst index 0a6200b5e..e379087bf 100644 --- a/classes/class_placeholdertexture2d.rst +++ b/classes/class_placeholdertexture2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PlaceholderTexture2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PlaceholderTexture2D.xml. .. _class_PlaceholderTexture2D: diff --git a/classes/class_placeholdertexture2darray.rst b/classes/class_placeholdertexture2darray.rst index b4a208922..4b2d9c01e 100644 --- a/classes/class_placeholdertexture2darray.rst +++ b/classes/class_placeholdertexture2darray.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PlaceholderTexture2DArray.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PlaceholderTexture2DArray.xml. .. _class_PlaceholderTexture2DArray: diff --git a/classes/class_placeholdertexture3d.rst b/classes/class_placeholdertexture3d.rst index 84ca5baae..9eef563f9 100644 --- a/classes/class_placeholdertexture3d.rst +++ b/classes/class_placeholdertexture3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PlaceholderTexture3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PlaceholderTexture3D.xml. .. _class_PlaceholderTexture3D: diff --git a/classes/class_placeholdertexturelayered.rst b/classes/class_placeholdertexturelayered.rst index af4141b60..2a5a661e3 100644 --- a/classes/class_placeholdertexturelayered.rst +++ b/classes/class_placeholdertexturelayered.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PlaceholderTextureLayered.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PlaceholderTextureLayered.xml. .. _class_PlaceholderTextureLayered: diff --git a/classes/class_plane.rst b/classes/class_plane.rst index 30c2675f7..6f85d852a 100644 --- a/classes/class_plane.rst +++ b/classes/class_plane.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Plane.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Plane.xml. .. _class_Plane: diff --git a/classes/class_planemesh.rst b/classes/class_planemesh.rst index d03789737..61fa36a8e 100644 --- a/classes/class_planemesh.rst +++ b/classes/class_planemesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PlaneMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PlaneMesh.xml. .. _class_PlaneMesh: diff --git a/classes/class_pointlight2d.rst b/classes/class_pointlight2d.rst index 023768730..6b57640f5 100644 --- a/classes/class_pointlight2d.rst +++ b/classes/class_pointlight2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PointLight2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PointLight2D.xml. .. _class_PointLight2D: diff --git a/classes/class_pointmesh.rst b/classes/class_pointmesh.rst index c49ce21d1..e5d13e685 100644 --- a/classes/class_pointmesh.rst +++ b/classes/class_pointmesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PointMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PointMesh.xml. .. _class_PointMesh: diff --git a/classes/class_polygon2d.rst b/classes/class_polygon2d.rst index 1ee8e73bf..f19fbe8fd 100644 --- a/classes/class_polygon2d.rst +++ b/classes/class_polygon2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Polygon2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Polygon2D.xml. .. _class_Polygon2D: diff --git a/classes/class_polygonoccluder3d.rst b/classes/class_polygonoccluder3d.rst index a3882a80d..3d950d68c 100644 --- a/classes/class_polygonoccluder3d.rst +++ b/classes/class_polygonoccluder3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PolygonOccluder3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PolygonOccluder3D.xml. .. _class_PolygonOccluder3D: diff --git a/classes/class_polygonpathfinder.rst b/classes/class_polygonpathfinder.rst index 950989059..88ffba946 100644 --- a/classes/class_polygonpathfinder.rst +++ b/classes/class_polygonpathfinder.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PolygonPathFinder.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PolygonPathFinder.xml. .. _class_PolygonPathFinder: diff --git a/classes/class_popup.rst b/classes/class_popup.rst index 3b567318e..1359dff3b 100644 --- a/classes/class_popup.rst +++ b/classes/class_popup.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Popup.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Popup.xml. .. _class_Popup: diff --git a/classes/class_popupmenu.rst b/classes/class_popupmenu.rst index ae8b6dfcd..9add9e01d 100644 --- a/classes/class_popupmenu.rst +++ b/classes/class_popupmenu.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PopupMenu.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PopupMenu.xml. .. _class_PopupMenu: diff --git a/classes/class_popuppanel.rst b/classes/class_popuppanel.rst index 3e413c1a9..fc5f45769 100644 --- a/classes/class_popuppanel.rst +++ b/classes/class_popuppanel.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PopupPanel.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PopupPanel.xml. .. _class_PopupPanel: diff --git a/classes/class_portablecompressedtexture2d.rst b/classes/class_portablecompressedtexture2d.rst index 95c9b903c..3e6cc5c0e 100644 --- a/classes/class_portablecompressedtexture2d.rst +++ b/classes/class_portablecompressedtexture2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PortableCompressedTexture2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PortableCompressedTexture2D.xml. .. _class_PortableCompressedTexture2D: diff --git a/classes/class_primitivemesh.rst b/classes/class_primitivemesh.rst index b53ef004e..ad11ccd7f 100644 --- a/classes/class_primitivemesh.rst +++ b/classes/class_primitivemesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PrimitiveMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PrimitiveMesh.xml. .. _class_PrimitiveMesh: @@ -166,9 +166,7 @@ Method Descriptions :ref:`Array<class_Array>` **_create_mesh_array** **(** **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Override this method to customize how this primitive mesh should be generated. Should return an :ref:`Array<class_Array>` where each element is another Array of values required for the mesh (see the :ref:`ArrayType<enum_Mesh_ArrayType>` constants). .. rst-class:: classref-item-separator diff --git a/classes/class_prismmesh.rst b/classes/class_prismmesh.rst index c1a8f2f27..83e6c5f2d 100644 --- a/classes/class_prismmesh.rst +++ b/classes/class_prismmesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PrismMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PrismMesh.xml. .. _class_PrismMesh: diff --git a/classes/class_proceduralskymaterial.rst b/classes/class_proceduralskymaterial.rst index 33002aeb0..995b2b6c5 100644 --- a/classes/class_proceduralskymaterial.rst +++ b/classes/class_proceduralskymaterial.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ProceduralSkyMaterial.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ProceduralSkyMaterial.xml. .. _class_ProceduralSkyMaterial: @@ -23,7 +23,7 @@ Description \ **ProceduralSkyMaterial** supports up to 4 suns, using the color, and energy, direction, and angular distance of the first four :ref:`DirectionalLight3D<class_DirectionalLight3D>` nodes in the scene. This means that the suns are defined individually by the properties of their corresponding :ref:`DirectionalLight3D<class_DirectionalLight3D>`\ s and globally by :ref:`sun_angle_max<class_ProceduralSkyMaterial_property_sun_angle_max>` and :ref:`sun_curve<class_ProceduralSkyMaterial_property_sun_curve>`. -\ **ProceduralSkyMaterial** uses a lightweight shader to draw the sky and is therefore suited for real time updates. This makes it a great option for a sky that is simple and computationally cheap, but unrealistic. If you need a more realistic procedural option, use :ref:`PhysicalSkyMaterial<class_PhysicalSkyMaterial>`. +\ **ProceduralSkyMaterial** uses a lightweight shader to draw the sky and is therefore suited for real-time updates. This makes it a great option for a sky that is simple and computationally cheap, but unrealistic. If you need a more realistic procedural option, use :ref:`PhysicalSkyMaterial<class_PhysicalSkyMaterial>`. .. rst-class:: classref-reftable-group diff --git a/classes/class_progressbar.rst b/classes/class_progressbar.rst index 2af8e5211..58894033e 100644 --- a/classes/class_progressbar.rst +++ b/classes/class_progressbar.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ProgressBar.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ProgressBar.xml. .. _class_ProgressBar: diff --git a/classes/class_projection.rst b/classes/class_projection.rst index 95077427a..ff5c68fb8 100644 --- a/classes/class_projection.rst +++ b/classes/class_projection.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Projection.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Projection.xml. .. _class_Projection: diff --git a/classes/class_projectsettings.rst b/classes/class_projectsettings.rst index 6236f903f..97b17b604 100644 --- a/classes/class_projectsettings.rst +++ b/classes/class_projectsettings.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ProjectSettings.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ProjectSettings.xml. .. _class_ProjectSettings: @@ -429,6 +429,8 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool<class_bool>` | :ref:`editor/export/convert_text_resources_to_binary<class_ProjectSettings_property_editor/export/convert_text_resources_to_binary>` | ``true`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int<class_int>` | :ref:`editor/import/atlas_max_width<class_ProjectSettings_property_editor/import/atlas_max_width>` | ``2048`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool<class_bool>` | :ref:`editor/import/reimport_missing_imported_files<class_ProjectSettings_property_editor/import/reimport_missing_imported_files>` | ``true`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool<class_bool>` | :ref:`editor/import/use_multiple_threads<class_ProjectSettings_property_editor/import/use_multiple_threads>` | ``true`` | @@ -2240,7 +2242,7 @@ If ``true``, text-to-speech support is enabled, see :ref:`DisplayServer.tts_get_ :ref:`int<class_int>` **audio/video/video_delay_compensation_ms** = ``0`` -Setting to hardcode audio delay when playing video. Best to leave this untouched unless you know what you are doing. +Setting to hardcode audio delay when playing video. Best to leave this unchanged unless you know what you are doing. .. rst-class:: classref-item-separator @@ -3770,6 +3772,8 @@ Main window content is expanded to the full size of the window. Unlike a borderl Main window initial position (in virtual desktop coordinates), this setting is used only if :ref:`display/window/size/initial_position_type<class_ProjectSettings_property_display/window/size/initial_position_type>` is set to "Absolute" (``0``). +\ **Note:** This setting only affects the exported project, or when the project is run from the command line. In the editor, the value of :ref:`EditorSettings.run/window_placement/rect_custom_position<class_EditorSettings_property_run/window_placement/rect_custom_position>` is used instead. + .. rst-class:: classref-item-separator ---- @@ -3788,6 +3792,8 @@ Main window initial position. \ ``2`` - "Other Screen Center", :ref:`display/window/size/initial_screen<class_ProjectSettings_property_display/window/size/initial_screen>` is used to set the screen. +\ **Note:** This setting only affects the exported project, or when the project is run from the command line. In the editor, the value of :ref:`EditorSettings.run/window_placement/rect<class_EditorSettings_property_run/window_placement/rect>` is used instead. + .. rst-class:: classref-item-separator ---- @@ -3800,6 +3806,8 @@ Main window initial position. Main window initial screen, this setting is used only if :ref:`display/window/size/initial_position_type<class_ProjectSettings_property_display/window/size/initial_position_type>` is set to "Other Screen Center" (``2``). +\ **Note:** This setting only affects the exported project, or when the project is run from the command line. In the editor, the value of :ref:`EditorSettings.run/window_placement/screen<class_EditorSettings_property_run/window_placement/screen>` is used instead. + .. rst-class:: classref-item-separator ---- @@ -3834,7 +3842,11 @@ Main window can't be focused. No-focus window will ignore all input, except mous :ref:`bool<class_bool>` **display/window/size/resizable** = ``true`` -Allows the window to be resizable by default. +If ``true``, allows the window to be resizable by default. + +\ **Note:** This property is only read when the project starts. To change whether the window is resizable at runtime, set :ref:`Window.unresizable<class_Window_property_unresizable>` instead on the root Window, which can be retrieved using ``get_viewport().get_window()``. :ref:`Window.unresizable<class_Window_property_unresizable>` takes the opposite value of this setting. + +\ **Note:** Certain window managers can be configured to ignore the non-resizable status of a window. Do not rely on this setting as a guarantee that the window will *never* be resizable. \ **Note:** This setting is ignored on iOS. @@ -4056,6 +4068,18 @@ If ``true``, text resources are converted to a binary format on export. This dec ---- +.. _class_ProjectSettings_property_editor/import/atlas_max_width: + +.. rst-class:: classref-property + +:ref:`int<class_int>` **editor/import/atlas_max_width** = ``2048`` + +The maximum width to use when importing textures as an atlas. The value will be rounded to the nearest power of two when used. Use this to prevent imported textures from growing too large in the other direction. + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_editor/import/reimport_missing_imported_files: .. rst-class:: classref-property @@ -4928,7 +4952,7 @@ Default :ref:`InputEventAction<class_InputEventAction>` to select an item in a : :ref:`Dictionary<class_Dictionary>` **input/ui_swap_input_direction** -Default :ref:`InputEventAction<class_InputEventAction>` to swap input direction, i.e. change between left-to-right to right-to-left modes. Affects text-editting controls (:ref:`LineEdit<class_LineEdit>`, :ref:`TextEdit<class_TextEdit>`). +Default :ref:`InputEventAction<class_InputEventAction>` to swap input direction, i.e. change between left-to-right to right-to-left modes. Affects text-editing controls (:ref:`LineEdit<class_LineEdit>`, :ref:`TextEdit<class_TextEdit>`). .. rst-class:: classref-item-separator @@ -5330,7 +5354,7 @@ In case there's more than one caret active, removes the secondary carets and cle :ref:`Dictionary<class_Dictionary>` **input/ui_text_completion_accept** -Default :ref:`InputEventAction<class_InputEventAction>` to accept an autocompetion hint. +Default :ref:`InputEventAction<class_InputEventAction>` to accept an autocompletion hint. \ **Note:** Default ``ui_*`` actions cannot be removed as they are necessary for the internal logic of several :ref:`Control<class_Control>`\ s. The events assigned to the action can however be modified. @@ -5344,7 +5368,7 @@ Default :ref:`InputEventAction<class_InputEventAction>` to accept an autocompeti :ref:`Dictionary<class_Dictionary>` **input/ui_text_completion_query** -Default :ref:`InputEventAction<class_InputEventAction>` to request autocompetion. +Default :ref:`InputEventAction<class_InputEventAction>` to request autocompletion. \ **Note:** Default ``ui_*`` actions cannot be removed as they are necessary for the internal logic of several :ref:`Control<class_Control>`\ s. The events assigned to the action can however be modified. @@ -5358,7 +5382,7 @@ Default :ref:`InputEventAction<class_InputEventAction>` to request autocompetion :ref:`Dictionary<class_Dictionary>` **input/ui_text_completion_replace** -Default :ref:`InputEventAction<class_InputEventAction>` to accept an autocompetion hint, replacing existing text. +Default :ref:`InputEventAction<class_InputEventAction>` to accept an autocompletion hint, replacing existing text. \ **Note:** Default ``ui_*`` actions cannot be removed as they are necessary for the internal logic of several :ref:`Control<class_Control>`\ s. The events assigned to the action can however be modified. @@ -9106,7 +9130,7 @@ Controls the maximum number of physics steps that can be simulated each rendered :ref:`float<class_float>` **physics/common/physics_jitter_fix** = ``0.5`` -Controls how much physics ticks are synchronized with real time. For 0 or less, the ticks are synchronized. Such values are recommended for network games, where clock synchronization matters. Higher values cause higher deviation of in-game clock and real clock, but allows smoothing out framerate jitters. The default value of 0.5 should be fine for most; values above 2 could cause the game to react to dropped frames with a noticeable delay and are not recommended. +Controls how much physics ticks are synchronized with real time. For 0 or less, the ticks are synchronized. Such values are recommended for network games, where clock synchronization matters. Higher values cause higher deviation of in-game clock and real clock, but allows smoothing out framerate jitters. The default value of 0.5 should be good enough for most; values above 2 could cause the game to react to dropped frames with a noticeable delay and are not recommended. \ **Note:** For best results, when using a custom physics interpolation solution, the physics jitter fix should be disabled by setting :ref:`physics/common/physics_jitter_fix<class_ProjectSettings_property_physics/common/physics_jitter_fix>` to ``0``. @@ -10382,9 +10406,7 @@ Max number of positional lights renderable in a frame. If more lights than this :ref:`int<class_int>` **rendering/limits/spatial_indexer/threaded_cull_minimum_instances** = ``1000`` -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +The minimum number of instances that must be present in a scene to enable culling computations on multiple threads. If a scene has fewer instances than this number, culling is done on a single thread. .. rst-class:: classref-item-separator diff --git a/classes/class_propertytweener.rst b/classes/class_propertytweener.rst index 6c81c07ce..784c5c046 100644 --- a/classes/class_propertytweener.rst +++ b/classes/class_propertytweener.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PropertyTweener.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PropertyTweener.xml. .. _class_PropertyTweener: diff --git a/classes/class_quadmesh.rst b/classes/class_quadmesh.rst index 54b88aec6..9aabd62fe 100644 --- a/classes/class_quadmesh.rst +++ b/classes/class_quadmesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/QuadMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/QuadMesh.xml. .. _class_QuadMesh: diff --git a/classes/class_quadoccluder3d.rst b/classes/class_quadoccluder3d.rst index 3c8d2d0d1..274e98252 100644 --- a/classes/class_quadoccluder3d.rst +++ b/classes/class_quadoccluder3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/QuadOccluder3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/QuadOccluder3D.xml. .. _class_QuadOccluder3D: diff --git a/classes/class_quaternion.rst b/classes/class_quaternion.rst index 699179921..07decaa4e 100644 --- a/classes/class_quaternion.rst +++ b/classes/class_quaternion.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Quaternion.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Quaternion.xml. .. _class_Quaternion: @@ -17,11 +17,15 @@ A unit quaternion used for representing 3D rotations. Description ----------- -Quaternions are similar to :ref:`Basis<class_Basis>`, which implements the matrix representation of rotations. Unlike :ref:`Basis<class_Basis>`, which stores rotation, scale, and shearing, quaternions only store rotation. +The **Quaternion** built-in :ref:`Variant<class_Variant>` type is a 4D data structure that represents rotation in the form of a `Hamilton convention quaternion <https://en.wikipedia.org/wiki/Quaternions_and_spatial_rotation>`__. Compared to the :ref:`Basis<class_Basis>` type which can store both rotation and scale, quaternions can *only* store rotation. -Quaternions can be parametrized using both an axis-angle pair or Euler angles. Due to their compactness and the way they are stored in memory, certain operations (obtaining axis-angle and performing SLERP, in particular) are more efficient and robust against floating-point errors. +A **Quaternion** is composed by 4 floating-point components: :ref:`w<class_Quaternion_property_w>`, :ref:`x<class_Quaternion_property_x>`, :ref:`y<class_Quaternion_property_y>`, and :ref:`z<class_Quaternion_property_z>`. These components are very compact in memory, and because of this some operations are more efficient and less likely to cause floating-point errors. Methods such as :ref:`get_angle<class_Quaternion_method_get_angle>`, :ref:`get_axis<class_Quaternion_method_get_axis>`, and :ref:`slerp<class_Quaternion_method_slerp>` are faster than their :ref:`Basis<class_Basis>` counterparts. -\ **Note:** Quaternions need to be normalized before being used for rotation. +For a great introduction to quaternions, see `this video by 3Blue1Brown <https://www.youtube.com/watch?v=d4EgbgTm0Bg>`__. You do not need to know the math behind quaternions, as Godot provides several helper methods that handle it for you. These include :ref:`slerp<class_Quaternion_method_slerp>` and :ref:`spherical_cubic_interpolate<class_Quaternion_method_spherical_cubic_interpolate>`, as well as the ``*`` operator. + +\ **Note:** Quaternions must be normalized before being used for rotation (see :ref:`normalized<class_Quaternion_method_normalized>`). + +\ **Note:** Similarly to :ref:`Vector2<class_Vector2>` and :ref:`Vector3<class_Vector3>`, the components of a quaternion use 32-bit precision by default, unlike :ref:`float<class_float>` which is always 64-bit. If double precision is needed, compile the engine with the option ``precision=double``. .. note:: @@ -32,10 +36,16 @@ Quaternions can be parametrized using both an axis-angle pair or Euler angles. D Tutorials --------- +- `3Blue1Brown's video on Quaternions <https://www.youtube.com/watch?v=d4EgbgTm0Bg>`__ + +- `Online Quaternion Visualization <https://quaternions.online/>`__ + - `Using 3D transforms <../tutorials/3d/using_transforms.html#interpolating-with-quaternions>`__ - `Third Person Shooter Demo <https://godotengine.org/asset-library/asset/678>`__ +- `Advanced Quaternion Visualization <https://iwatake2222.github.io/rotation_master/rotation_master.html>`__ + .. rst-class:: classref-reftable-group Properties @@ -175,7 +185,9 @@ Constants **IDENTITY** = ``Quaternion(0, 0, 0, 1)`` -The identity quaternion, representing no rotation. Equivalent to an identity :ref:`Basis<class_Basis>` matrix. If a vector is transformed by an identity quaternion, it will not change. +The identity quaternion, representing no rotation. This has the same rotation as :ref:`Basis.IDENTITY<class_Basis_constant_IDENTITY>`. + +If a :ref:`Vector3<class_Vector3>` is rotated (multiplied) by this quaternion, it does not change. .. rst-class:: classref-section-separator @@ -192,9 +204,9 @@ Property Descriptions :ref:`float<class_float>` **w** = ``1.0`` -W component of the quaternion (real part). +W component of the quaternion. This is the "real" part. -Quaternion components should usually not be manipulated directly. +\ **Note:** Quaternion components should usually not be manipulated directly. .. rst-class:: classref-item-separator @@ -206,9 +218,9 @@ Quaternion components should usually not be manipulated directly. :ref:`float<class_float>` **x** = ``0.0`` -X component of the quaternion (imaginary ``i`` axis part). +X component of the quaternion. This is the value along the "imaginary" ``i`` axis. -Quaternion components should usually not be manipulated directly. +\ **Note:** Quaternion components should usually not be manipulated directly. .. rst-class:: classref-item-separator @@ -220,9 +232,9 @@ Quaternion components should usually not be manipulated directly. :ref:`float<class_float>` **y** = ``0.0`` -Y component of the quaternion (imaginary ``j`` axis part). +Y component of the quaternion. This is the value along the "imaginary" ``j`` axis. -Quaternion components should usually not be manipulated directly. +\ **Note:** Quaternion components should usually not be manipulated directly. .. rst-class:: classref-item-separator @@ -234,9 +246,9 @@ Quaternion components should usually not be manipulated directly. :ref:`float<class_float>` **z** = ``0.0`` -Z component of the quaternion (imaginary ``k`` axis part). +Z component of the quaternion. This is the value along the "imaginary" ``k`` axis. -Quaternion components should usually not be manipulated directly. +\ **Note:** Quaternion components should usually not be manipulated directly. .. rst-class:: classref-section-separator @@ -253,7 +265,7 @@ Constructor Descriptions :ref:`Quaternion<class_Quaternion>` **Quaternion** **(** **)** -Constructs a default-initialized quaternion with all components set to ``0``. +Constructs a **Quaternion** identical to the :ref:`IDENTITY<class_Quaternion_constant_IDENTITY>`. .. rst-class:: classref-item-separator @@ -273,7 +285,7 @@ Constructs a **Quaternion** as a copy of the given **Quaternion**. :ref:`Quaternion<class_Quaternion>` **Quaternion** **(** :ref:`Vector3<class_Vector3>` arc_from, :ref:`Vector3<class_Vector3>` arc_to **)** -Constructs a quaternion representing the shortest arc between two points on the surface of a sphere with a radius of ``1.0``. +Constructs a **Quaternion** representing the shortest arc between ``arc_from`` and ``arc_to``. These can be imagined as two points intersecting a sphere's surface, with a radius of ``1.0``. .. rst-class:: classref-item-separator @@ -283,7 +295,7 @@ Constructs a quaternion representing the shortest arc between two points on the :ref:`Quaternion<class_Quaternion>` **Quaternion** **(** :ref:`Vector3<class_Vector3>` axis, :ref:`float<class_float>` angle **)** -Constructs a quaternion that will rotate around the given axis by the specified angle. The axis must be a normalized vector. +Constructs a **Quaternion** representing rotation around the ``axis`` by the given ``angle``, in radians. The axis must be a normalized vector. .. rst-class:: classref-item-separator @@ -293,7 +305,9 @@ Constructs a quaternion that will rotate around the given axis by the specified :ref:`Quaternion<class_Quaternion>` **Quaternion** **(** :ref:`Basis<class_Basis>` from **)** -Constructs a quaternion from the given :ref:`Basis<class_Basis>`. +Constructs a **Quaternion** from the given rotation :ref:`Basis<class_Basis>`. + +This constructor is faster than :ref:`Basis.get_rotation_quaternion<class_Basis_method_get_rotation_quaternion>`, but the given basis must be *orthonormalized* (see :ref:`Basis.orthonormalized<class_Basis_method_orthonormalized>`). Otherwise, the constructor fails and returns :ref:`IDENTITY<class_Quaternion_constant_IDENTITY>`. .. rst-class:: classref-item-separator @@ -303,7 +317,9 @@ Constructs a quaternion from the given :ref:`Basis<class_Basis>`. :ref:`Quaternion<class_Quaternion>` **Quaternion** **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y, :ref:`float<class_float>` z, :ref:`float<class_float>` w **)** -Constructs a quaternion defined by the given values. +Constructs a **Quaternion** defined by the given values. + +\ **Note:** Only normalized quaternions represent rotation; if these values are not normalized, the new **Quaternion** will not be a valid rotation. .. rst-class:: classref-section-separator @@ -334,7 +350,9 @@ Returns the angle between this quaternion and ``to``. This is the magnitude of t :ref:`float<class_float>` **dot** **(** :ref:`Quaternion<class_Quaternion>` with **)** |const| -Returns the dot product of two quaternions. +Returns the dot product between this quaternion and ``with``. + +This is equivalent to ``(quat.x * with.x) + (quat.y * with.y) + (quat.z * with.z) + (quat.w * with.w)``. .. rst-class:: classref-item-separator @@ -346,9 +364,7 @@ Returns the dot product of two quaternions. :ref:`Quaternion<class_Quaternion>` **exp** **(** **)** |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Returns the exponential of this quaternion. The rotation axis of the result is the normalized rotation axis of this quaternion, the angle of the result is the length of the vector part of this quaternion. .. rst-class:: classref-item-separator @@ -360,7 +376,7 @@ Returns the dot product of two quaternions. :ref:`Quaternion<class_Quaternion>` **from_euler** **(** :ref:`Vector3<class_Vector3>` euler **)** |static| -Constructs a Quaternion from Euler angles in YXZ rotation order. +Constructs a new **Quaternion** from the given :ref:`Vector3<class_Vector3>` of `Euler angles <https://en.wikipedia.org/wiki/Euler_angles>`__, in radians. This method always uses the YXZ convention (:ref:`@GlobalScope.EULER_ORDER_YXZ<class_@GlobalScope_constant_EULER_ORDER_YXZ>`). .. rst-class:: classref-item-separator @@ -372,9 +388,9 @@ Constructs a Quaternion from Euler angles in YXZ rotation order. :ref:`float<class_float>` **get_angle** **(** **)** |const| -.. container:: contribute +Returns the angle of the rotation represented by this quaternion. - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +\ **Note:** The quaternion must be normalized. .. rst-class:: classref-item-separator @@ -386,9 +402,7 @@ Constructs a Quaternion from Euler angles in YXZ rotation order. :ref:`Vector3<class_Vector3>` **get_axis** **(** **)** |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Returns the rotation axis of the rotation represented by this quaternion. .. rst-class:: classref-item-separator @@ -400,7 +414,9 @@ Constructs a Quaternion from Euler angles in YXZ rotation order. :ref:`Vector3<class_Vector3>` **get_euler** **(** :ref:`int<class_int>` order=2 **)** |const| -Returns the quaternion's rotation in the form of Euler angles. The Euler order depends on the ``order`` parameter, for example using the YXZ convention: since this method decomposes, first Z, then X, and Y last. See the :ref:`EulerOrder<enum_@GlobalScope_EulerOrder>` enum for possible values. The returned vector contains the rotation angles in the format (X angle, Y angle, Z angle). +Returns this quaternion's rotation as a :ref:`Vector3<class_Vector3>` of `Euler angles <https://en.wikipedia.org/wiki/Euler_angles>`__, in radians. + +The order of each consecutive rotation can be changed with ``order`` (see :ref:`EulerOrder<enum_@GlobalScope_EulerOrder>` constants). By default, the YXZ convention is used (:ref:`@GlobalScope.EULER_ORDER_YXZ<class_@GlobalScope_constant_EULER_ORDER_YXZ>`): Z (roll) is calculated first, then X (pitch), and lastly Y (yaw). When using the opposite method :ref:`from_euler<class_Quaternion_method_from_euler>`, this order is reversed. .. rst-class:: classref-item-separator @@ -412,7 +428,7 @@ Returns the quaternion's rotation in the form of Euler angles. The Euler order d :ref:`Quaternion<class_Quaternion>` **inverse** **(** **)** |const| -Returns the inverse of the quaternion. +Returns the inverse version of this quaternion, inverting the sign of every component except :ref:`w<class_Quaternion_property_w>`. .. rst-class:: classref-item-separator @@ -448,7 +464,7 @@ Returns ``true`` if this quaternion is finite, by calling :ref:`@GlobalScope.is_ :ref:`bool<class_bool>` **is_normalized** **(** **)** |const| -Returns whether the quaternion is normalized or not. +Returns ``true`` if this quaternion is normalized. See also :ref:`normalized<class_Quaternion_method_normalized>`. .. rst-class:: classref-item-separator @@ -460,7 +476,7 @@ Returns whether the quaternion is normalized or not. :ref:`float<class_float>` **length** **(** **)** |const| -Returns the length of the quaternion. +Returns this quaternion's length, also called magnitude. .. rst-class:: classref-item-separator @@ -472,7 +488,9 @@ Returns the length of the quaternion. :ref:`float<class_float>` **length_squared** **(** **)** |const| -Returns the length of the quaternion, squared. +Returns this quaternion's length, squared. + +\ **Note:** This method is faster than :ref:`length<class_Quaternion_method_length>`, so prefer it if you only need to compare quaternion lengths. .. rst-class:: classref-item-separator @@ -484,9 +502,7 @@ Returns the length of the quaternion, squared. :ref:`Quaternion<class_Quaternion>` **log** **(** **)** |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Returns the logarithm of this quaternion. Multiplies this quaternion's rotation axis by its rotation angle, and stores the result in the returned quaternion's vector part (:ref:`x<class_Quaternion_property_x>`, :ref:`y<class_Quaternion_property_y>`, and :ref:`z<class_Quaternion_property_z>`). The returned quaternion's real part (:ref:`w<class_Quaternion_property_w>`) is always ``0.0``. .. rst-class:: classref-item-separator @@ -498,7 +514,7 @@ Returns the length of the quaternion, squared. :ref:`Quaternion<class_Quaternion>` **normalized** **(** **)** |const| -Returns a copy of the quaternion, normalized to unit length. +Returns a copy of this quaternion, normalized so that its length is ``1.0``. See also :ref:`is_normalized<class_Quaternion_method_is_normalized>`. .. rst-class:: classref-item-separator @@ -510,9 +526,7 @@ Returns a copy of the quaternion, normalized to unit length. :ref:`Quaternion<class_Quaternion>` **slerp** **(** :ref:`Quaternion<class_Quaternion>` to, :ref:`float<class_float>` weight **)** |const| -Returns the result of the spherical linear interpolation between this quaternion and ``to`` by amount ``weight``. - -\ **Note:** Both quaternions must be normalized. +Performs a spherical-linear interpolation with the ``to`` quaternion, given a ``weight`` and returns the result. Both this quaternion and ``to`` must be normalized. .. rst-class:: classref-item-separator @@ -524,7 +538,7 @@ Returns the result of the spherical linear interpolation between this quaternion :ref:`Quaternion<class_Quaternion>` **slerpni** **(** :ref:`Quaternion<class_Quaternion>` to, :ref:`float<class_float>` weight **)** |const| -Returns the result of the spherical linear interpolation between this quaternion and ``to`` by amount ``weight``, but without checking if the rotation path is not bigger than 90 degrees. +Performs a spherical-linear interpolation with the ``to`` quaternion, given a ``weight`` and returns the result. Unlike :ref:`slerp<class_Quaternion_method_slerp>`, this method does not check if the rotation path is smaller than 90 degrees. Both this quaternion and ``to`` must be normalized. .. rst-class:: classref-item-separator @@ -567,7 +581,7 @@ Operator Descriptions :ref:`bool<class_bool>` **operator !=** **(** :ref:`Quaternion<class_Quaternion>` right **)** -Returns ``true`` if the quaternions are not equal. +Returns ``true`` if the components of both quaternions are not exactly equal. \ **Note:** Due to floating-point precision errors, consider using :ref:`is_equal_approx<class_Quaternion_method_is_equal_approx>` instead, which is more reliable. @@ -581,7 +595,7 @@ Returns ``true`` if the quaternions are not equal. :ref:`Quaternion<class_Quaternion>` **operator *** **(** :ref:`Quaternion<class_Quaternion>` right **)** -Composes these two quaternions by multiplying them together. This has the effect of rotating the second quaternion (the child) by the first quaternion (the parent). +Composes (multiplies) two quaternions. This rotates the ``right`` quaternion (the child) by this quaternion (the parent). .. rst-class:: classref-item-separator @@ -593,7 +607,7 @@ Composes these two quaternions by multiplying them together. This has the effect :ref:`Vector3<class_Vector3>` **operator *** **(** :ref:`Vector3<class_Vector3>` right **)** -Rotates (multiplies) the :ref:`Vector3<class_Vector3>` by the given **Quaternion**. +Rotates (multiplies) the ``right`` vector by this quaternion, returning a :ref:`Vector3<class_Vector3>`. .. rst-class:: classref-item-separator @@ -605,7 +619,9 @@ Rotates (multiplies) the :ref:`Vector3<class_Vector3>` by the given **Quaternion :ref:`Quaternion<class_Quaternion>` **operator *** **(** :ref:`float<class_float>` right **)** -Multiplies each component of the **Quaternion** by the given value. This operation is not meaningful on its own, but it can be used as a part of a larger expression. +Multiplies each component of the **Quaternion** by the right :ref:`float<class_float>` value. + +This operation is not meaningful on its own, but it can be used as a part of a larger expression. .. rst-class:: classref-item-separator @@ -617,7 +633,9 @@ Multiplies each component of the **Quaternion** by the given value. This operati :ref:`Quaternion<class_Quaternion>` **operator *** **(** :ref:`int<class_int>` right **)** -Multiplies each component of the **Quaternion** by the given value. This operation is not meaningful on its own, but it can be used as a part of a larger expression. +Multiplies each component of the **Quaternion** by the right :ref:`int<class_int>` value. + +This operation is not meaningful on its own, but it can be used as a part of a larger expression. .. rst-class:: classref-item-separator @@ -629,7 +647,9 @@ Multiplies each component of the **Quaternion** by the given value. This operati :ref:`Quaternion<class_Quaternion>` **operator +** **(** :ref:`Quaternion<class_Quaternion>` right **)** -Adds each component of the left **Quaternion** to the right **Quaternion**. This operation is not meaningful on its own, but it can be used as a part of a larger expression, such as approximating an intermediate rotation between two nearby rotations. +Adds each component of the left **Quaternion** to the right **Quaternion**. + +This operation is not meaningful on its own, but it can be used as a part of a larger expression, such as approximating an intermediate rotation between two nearby rotations. .. rst-class:: classref-item-separator @@ -641,7 +661,9 @@ Adds each component of the left **Quaternion** to the right **Quaternion**. This :ref:`Quaternion<class_Quaternion>` **operator -** **(** :ref:`Quaternion<class_Quaternion>` right **)** -Subtracts each component of the left **Quaternion** by the right **Quaternion**. This operation is not meaningful on its own, but it can be used as a part of a larger expression. +Subtracts each component of the left **Quaternion** by the right **Quaternion**. + +This operation is not meaningful on its own, but it can be used as a part of a larger expression. .. rst-class:: classref-item-separator @@ -653,7 +675,9 @@ Subtracts each component of the left **Quaternion** by the right **Quaternion**. :ref:`Quaternion<class_Quaternion>` **operator /** **(** :ref:`float<class_float>` right **)** -Divides each component of the **Quaternion** by the given value. This operation is not meaningful on its own, but it can be used as a part of a larger expression. +Divides each component of the **Quaternion** by the right :ref:`float<class_float>` value. + +This operation is not meaningful on its own, but it can be used as a part of a larger expression. .. rst-class:: classref-item-separator @@ -665,7 +689,9 @@ Divides each component of the **Quaternion** by the given value. This operation :ref:`Quaternion<class_Quaternion>` **operator /** **(** :ref:`int<class_int>` right **)** -Divides each component of the **Quaternion** by the given value. This operation is not meaningful on its own, but it can be used as a part of a larger expression. +Divides each component of the **Quaternion** by the right :ref:`int<class_int>` value. + +This operation is not meaningful on its own, but it can be used as a part of a larger expression. .. rst-class:: classref-item-separator @@ -677,7 +703,7 @@ Divides each component of the **Quaternion** by the given value. This operation :ref:`bool<class_bool>` **operator ==** **(** :ref:`Quaternion<class_Quaternion>` right **)** -Returns ``true`` if the quaternions are exactly equal. +Returns ``true`` if the components of both quaternions are exactly equal. \ **Note:** Due to floating-point precision errors, consider using :ref:`is_equal_approx<class_Quaternion_method_is_equal_approx>` instead, which is more reliable. @@ -691,7 +717,9 @@ Returns ``true`` if the quaternions are exactly equal. :ref:`float<class_float>` **operator []** **(** :ref:`int<class_int>` index **)** -Access quaternion components using their index. ``q[0]`` is equivalent to ``q.x``, ``q[1]`` is equivalent to ``q.y``, ``q[2]`` is equivalent to ``q.z``, and ``q[3]`` is equivalent to ``q.w``. +Accesses each component of this quaternion by their index. + +Index ``0`` is the same as :ref:`x<class_Quaternion_property_x>`, index ``1`` is the same as :ref:`y<class_Quaternion_property_y>`, index ``2`` is the same as :ref:`z<class_Quaternion_property_z>`, and index ``3`` is the same as :ref:`w<class_Quaternion_property_w>`. .. rst-class:: classref-item-separator @@ -715,7 +743,7 @@ Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, :ref:`Quaternion<class_Quaternion>` **operator unary-** **(** **)** -Returns the negative value of the **Quaternion**. This is the same as writing ``Quaternion(-q.x, -q.y, -q.z, -q.w)``. This operation results in a quaternion that represents the same rotation. +Returns the negative value of the **Quaternion**. This is the same as multiplying all components by ``-1``. This operation results in a quaternion that represents the same rotation. .. |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_randomnumbergenerator.rst b/classes/class_randomnumbergenerator.rst index ee5a5c9be..2e891875e 100644 --- a/classes/class_randomnumbergenerator.rst +++ b/classes/class_randomnumbergenerator.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RandomNumberGenerator.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/RandomNumberGenerator.xml. .. _class_RandomNumberGenerator: @@ -23,7 +23,7 @@ RandomNumberGenerator is a class for generating pseudo-random numbers. It curren \ **Note:** The underlying algorithm is an implementation detail and should not be depended upon. -To generate a random float number (within a given range) based on a time-dependant seed: +To generate a random float number (within a given range) based on a time-dependent seed: :: diff --git a/classes/class_range.rst b/classes/class_range.rst index 77eedd214..61709fd49 100644 --- a/classes/class_range.rst +++ b/classes/class_range.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Range.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Range.xml. .. _class_Range: diff --git a/classes/class_raycast2d.rst b/classes/class_raycast2d.rst index 0a4d7b38b..26a393e88 100644 --- a/classes/class_raycast2d.rst +++ b/classes/class_raycast2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RayCast2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/RayCast2D.xml. .. _class_RayCast2D: @@ -311,6 +311,27 @@ Returns the :ref:`RID<class_RID>` of the first object that the ray intersects, o Returns the shape ID of the first object that the ray intersects, or ``0`` if no object is intersecting the ray (i.e. :ref:`is_colliding<class_RayCast2D_method_is_colliding>` returns ``false``). +To get the intersected shape node, for a :ref:`CollisionObject2D<class_CollisionObject2D>` target, use: + + +.. tabs:: + + .. code-tab:: gdscript + + var target = get_collider() # A CollisionObject2D. + var shape_id = get_collider_shape() # The shape index in the collider. + var owner_id = target.shape_find_owner(shape_id) # The owner ID in the collider. + var shape = target.shape_owner_get_owner(owner_id) + + .. code-tab:: csharp + + var target = (CollisionObject2D)GetCollider(); // A CollisionObject2D. + var shapeId = GetColliderShape(); // The shape index in the collider. + var ownerId = target.ShapeFindOwner(shapeId); // The owner ID in the collider. + var shape = target.ShapeOwnerGetOwner(ownerId); + + + .. rst-class:: classref-item-separator ---- @@ -345,7 +366,7 @@ Returns the normal of the intersecting object's shape at the collision point, or :ref:`Vector2<class_Vector2>` **get_collision_point** **(** **)** |const| -Returns the collision point at which the ray intersects the closest object. +Returns the collision point at which the ray intersects the closest object. If :ref:`hit_from_inside<class_RayCast2D_property_hit_from_inside>` is ``true`` and the ray starts inside of a collision shape, this function will return the origin point of the ray. \ **Note:** This point is in the **global** coordinate system. diff --git a/classes/class_raycast3d.rst b/classes/class_raycast3d.rst index 664d381a8..cc1a97a13 100644 --- a/classes/class_raycast3d.rst +++ b/classes/class_raycast3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RayCast3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/RayCast3D.xml. .. _class_RayCast3D: @@ -374,6 +374,27 @@ Returns the :ref:`RID<class_RID>` of the first object that the ray intersects, o Returns the shape ID of the first object that the ray intersects, or ``0`` if no object is intersecting the ray (i.e. :ref:`is_colliding<class_RayCast3D_method_is_colliding>` returns ``false``). +To get the intersected shape node, for a :ref:`CollisionObject3D<class_CollisionObject3D>` target, use: + + +.. tabs:: + + .. code-tab:: gdscript + + var target = get_collider() # A CollisionObject3D. + var shape_id = get_collider_shape() # The shape index in the collider. + var owner_id = target.shape_find_owner(shape_id) # The owner ID in the collider. + var shape = target.shape_owner_get_owner(owner_id) + + .. code-tab:: csharp + + var target = (CollisionObject3D)GetCollider(); // A CollisionObject3D. + var shapeId = GetColliderShape(); // The shape index in the collider. + var ownerId = target.ShapeFindOwner(shapeId); // The owner ID in the collider. + var shape = target.ShapeOwnerGetOwner(ownerId); + + + .. rst-class:: classref-item-separator ---- @@ -420,7 +441,7 @@ Returns the normal of the intersecting object's shape at the collision point, or :ref:`Vector3<class_Vector3>` **get_collision_point** **(** **)** |const| -Returns the collision point at which the ray intersects the closest object. +Returns the collision point at which the ray intersects the closest object. If :ref:`hit_from_inside<class_RayCast3D_property_hit_from_inside>` is ``true`` and the ray starts inside of a collision shape, this function will return the origin point of the ray. \ **Note:** This point is in the **global** coordinate system. diff --git a/classes/class_rdattachmentformat.rst b/classes/class_rdattachmentformat.rst index 6b734ce01..511709997 100644 --- a/classes/class_rdattachmentformat.rst +++ b/classes/class_rdattachmentformat.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RDAttachmentFormat.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/RDAttachmentFormat.xml. .. _class_RDAttachmentFormat: diff --git a/classes/class_rdframebufferpass.rst b/classes/class_rdframebufferpass.rst index 0ee84fb37..97c18a109 100644 --- a/classes/class_rdframebufferpass.rst +++ b/classes/class_rdframebufferpass.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RDFramebufferPass.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/RDFramebufferPass.xml. .. _class_RDFramebufferPass: diff --git a/classes/class_rdpipelinecolorblendstate.rst b/classes/class_rdpipelinecolorblendstate.rst index eba406bed..81033462f 100644 --- a/classes/class_rdpipelinecolorblendstate.rst +++ b/classes/class_rdpipelinecolorblendstate.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RDPipelineColorBlendState.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/RDPipelineColorBlendState.xml. .. _class_RDPipelineColorBlendState: diff --git a/classes/class_rdpipelinecolorblendstateattachment.rst b/classes/class_rdpipelinecolorblendstateattachment.rst index 7bcda5d0d..a4f56bcc5 100644 --- a/classes/class_rdpipelinecolorblendstateattachment.rst +++ b/classes/class_rdpipelinecolorblendstateattachment.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RDPipelineColorBlendStateAttachment.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/RDPipelineColorBlendStateAttachment.xml. .. _class_RDPipelineColorBlendStateAttachment: diff --git a/classes/class_rdpipelinedepthstencilstate.rst b/classes/class_rdpipelinedepthstencilstate.rst index 1a4aa0107..2f60bea8e 100644 --- a/classes/class_rdpipelinedepthstencilstate.rst +++ b/classes/class_rdpipelinedepthstencilstate.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RDPipelineDepthStencilState.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/RDPipelineDepthStencilState.xml. .. _class_RDPipelineDepthStencilState: @@ -93,9 +93,7 @@ Property Descriptions - void **set_back_op_compare** **(** :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>` value **)** - :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>` **get_back_op_compare** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +The method used for comparing the previous back stencil value and :ref:`back_op_reference<class_RDPipelineDepthStencilState_property_back_op_reference>`. .. rst-class:: classref-item-separator @@ -112,9 +110,7 @@ Property Descriptions - void **set_back_op_compare_mask** **(** :ref:`int<class_int>` value **)** - :ref:`int<class_int>` **get_back_op_compare_mask** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Selects which bits from the back stencil value will be compared. .. rst-class:: classref-item-separator @@ -131,9 +127,7 @@ Property Descriptions - void **set_back_op_depth_fail** **(** :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` value **)** - :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **get_back_op_depth_fail** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +The operation to perform on the stencil buffer for back pixels that pass the stencil test but fail the depth test. .. rst-class:: classref-item-separator @@ -150,9 +144,7 @@ Property Descriptions - void **set_back_op_fail** **(** :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` value **)** - :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **get_back_op_fail** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +The operation to perform on the stencil buffer for back pixels that fail the stencil test .. rst-class:: classref-item-separator @@ -169,9 +161,7 @@ Property Descriptions - void **set_back_op_pass** **(** :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` value **)** - :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **get_back_op_pass** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +The operation to perform on the stencil buffer for back pixels that pass the stencil test. .. rst-class:: classref-item-separator @@ -188,9 +178,7 @@ Property Descriptions - void **set_back_op_reference** **(** :ref:`int<class_int>` value **)** - :ref:`int<class_int>` **get_back_op_reference** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +The value the previous back stencil value will be compared to. .. rst-class:: classref-item-separator @@ -207,9 +195,7 @@ Property Descriptions - void **set_back_op_write_mask** **(** :ref:`int<class_int>` value **)** - :ref:`int<class_int>` **get_back_op_write_mask** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Selects which bits from the back stencil value will be changed. .. rst-class:: classref-item-separator @@ -226,9 +212,7 @@ Property Descriptions - void **set_depth_compare_operator** **(** :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>` value **)** - :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>` **get_depth_compare_operator** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +The method used for comparing the previous and current depth values. .. rst-class:: classref-item-separator @@ -245,9 +229,7 @@ Property Descriptions - void **set_depth_range_max** **(** :ref:`float<class_float>` value **)** - :ref:`float<class_float>` **get_depth_range_max** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +The maximum depth that returns true for :ref:`enable_depth_range<class_RDPipelineDepthStencilState_property_enable_depth_range>`. .. rst-class:: classref-item-separator @@ -264,9 +246,7 @@ Property Descriptions - void **set_depth_range_min** **(** :ref:`float<class_float>` value **)** - :ref:`float<class_float>` **get_depth_range_min** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +The minimum depth that returns true for :ref:`enable_depth_range<class_RDPipelineDepthStencilState_property_enable_depth_range>`. .. rst-class:: classref-item-separator @@ -283,9 +263,7 @@ Property Descriptions - void **set_enable_depth_range** **(** :ref:`bool<class_bool>` value **)** - :ref:`bool<class_bool>` **get_enable_depth_range** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +If ``true``, each depth value will be tested to see if it is between :ref:`depth_range_min<class_RDPipelineDepthStencilState_property_depth_range_min>` and :ref:`depth_range_max<class_RDPipelineDepthStencilState_property_depth_range_max>`. If it is outside of these values, it is discarded. .. rst-class:: classref-item-separator @@ -319,9 +297,7 @@ If ``true``, enables depth testing which allows objects to be automatically occl - void **set_enable_depth_write** **(** :ref:`bool<class_bool>` value **)** - :ref:`bool<class_bool>` **get_enable_depth_write** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +If ``true``, writes to the depth buffer whenever the depth test returns true. Only works when enable_depth_test is also true. .. rst-class:: classref-item-separator @@ -338,9 +314,7 @@ If ``true``, enables depth testing which allows objects to be automatically occl - void **set_enable_stencil** **(** :ref:`bool<class_bool>` value **)** - :ref:`bool<class_bool>` **get_enable_stencil** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +If ``true``, enables stencil testing. There are separate stencil buffers for front-facing triangles and back-facing triangles. See properties that begin with "front_op" and properties with "back_op" for each. .. rst-class:: classref-item-separator @@ -357,9 +331,7 @@ If ``true``, enables depth testing which allows objects to be automatically occl - void **set_front_op_compare** **(** :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>` value **)** - :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>` **get_front_op_compare** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +The method used for comparing the previous front stencil value and :ref:`front_op_reference<class_RDPipelineDepthStencilState_property_front_op_reference>`. .. rst-class:: classref-item-separator @@ -376,9 +348,7 @@ If ``true``, enables depth testing which allows objects to be automatically occl - void **set_front_op_compare_mask** **(** :ref:`int<class_int>` value **)** - :ref:`int<class_int>` **get_front_op_compare_mask** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Selects which bits from the front stencil value will be compared. .. rst-class:: classref-item-separator @@ -395,9 +365,7 @@ If ``true``, enables depth testing which allows objects to be automatically occl - void **set_front_op_depth_fail** **(** :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` value **)** - :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **get_front_op_depth_fail** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +The operation to perform on the stencil buffer for front pixels that pass the stencil test but fail the depth test. .. rst-class:: classref-item-separator @@ -414,9 +382,7 @@ If ``true``, enables depth testing which allows objects to be automatically occl - void **set_front_op_fail** **(** :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` value **)** - :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **get_front_op_fail** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +The operation to perform on the stencil buffer for front pixels that fail the stencil test. .. rst-class:: classref-item-separator @@ -433,9 +399,7 @@ If ``true``, enables depth testing which allows objects to be automatically occl - void **set_front_op_pass** **(** :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` value **)** - :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **get_front_op_pass** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +The operation to perform on the stencil buffer for front pixels that pass the stencil test. .. rst-class:: classref-item-separator @@ -452,9 +416,7 @@ If ``true``, enables depth testing which allows objects to be automatically occl - void **set_front_op_reference** **(** :ref:`int<class_int>` value **)** - :ref:`int<class_int>` **get_front_op_reference** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +The value the previous front stencil value will be compared to. .. rst-class:: classref-item-separator @@ -471,9 +433,7 @@ If ``true``, enables depth testing which allows objects to be automatically occl - void **set_front_op_write_mask** **(** :ref:`int<class_int>` value **)** - :ref:`int<class_int>` **get_front_op_write_mask** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Selects which bits from the front stencil value will be changed. .. |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_rdpipelinemultisamplestate.rst b/classes/class_rdpipelinemultisamplestate.rst index f0cf83eeb..fce3eca17 100644 --- a/classes/class_rdpipelinemultisamplestate.rst +++ b/classes/class_rdpipelinemultisamplestate.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RDPipelineMultisampleState.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/RDPipelineMultisampleState.xml. .. _class_RDPipelineMultisampleState: diff --git a/classes/class_rdpipelinerasterizationstate.rst b/classes/class_rdpipelinerasterizationstate.rst index 05db640ca..11b6bdaa7 100644 --- a/classes/class_rdpipelinerasterizationstate.rst +++ b/classes/class_rdpipelinerasterizationstate.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RDPipelineRasterizationState.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/RDPipelineRasterizationState.xml. .. _class_RDPipelineRasterizationState: diff --git a/classes/class_rdpipelinespecializationconstant.rst b/classes/class_rdpipelinespecializationconstant.rst index ad23de808..293e4fd55 100644 --- a/classes/class_rdpipelinespecializationconstant.rst +++ b/classes/class_rdpipelinespecializationconstant.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RDPipelineSpecializationConstant.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/RDPipelineSpecializationConstant.xml. .. _class_RDPipelineSpecializationConstant: diff --git a/classes/class_rdsamplerstate.rst b/classes/class_rdsamplerstate.rst index 859590e02..ed9a20f1f 100644 --- a/classes/class_rdsamplerstate.rst +++ b/classes/class_rdsamplerstate.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RDSamplerState.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/RDSamplerState.xml. .. _class_RDSamplerState: diff --git a/classes/class_rdshaderfile.rst b/classes/class_rdshaderfile.rst index c486c0b74..6722a923e 100644 --- a/classes/class_rdshaderfile.rst +++ b/classes/class_rdshaderfile.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RDShaderFile.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/RDShaderFile.xml. .. _class_RDShaderFile: diff --git a/classes/class_rdshadersource.rst b/classes/class_rdshadersource.rst index 49fb66a88..62cfdc64c 100644 --- a/classes/class_rdshadersource.rst +++ b/classes/class_rdshadersource.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RDShaderSource.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/RDShaderSource.xml. .. _class_RDShaderSource: diff --git a/classes/class_rdshaderspirv.rst b/classes/class_rdshaderspirv.rst index 0c37fd58e..caf0c2e73 100644 --- a/classes/class_rdshaderspirv.rst +++ b/classes/class_rdshaderspirv.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RDShaderSPIRV.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/RDShaderSPIRV.xml. .. _class_RDShaderSPIRV: diff --git a/classes/class_rdtextureformat.rst b/classes/class_rdtextureformat.rst index 7ded5665a..139bd4aa4 100644 --- a/classes/class_rdtextureformat.rst +++ b/classes/class_rdtextureformat.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RDTextureFormat.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/RDTextureFormat.xml. .. _class_RDTextureFormat: diff --git a/classes/class_rdtextureview.rst b/classes/class_rdtextureview.rst index 0f7bda357..0e83b8ad8 100644 --- a/classes/class_rdtextureview.rst +++ b/classes/class_rdtextureview.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RDTextureView.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/RDTextureView.xml. .. _class_RDTextureView: diff --git a/classes/class_rduniform.rst b/classes/class_rduniform.rst index 8d55f14a3..34db351d6 100644 --- a/classes/class_rduniform.rst +++ b/classes/class_rduniform.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RDUniform.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/RDUniform.xml. .. _class_RDUniform: diff --git a/classes/class_rdvertexattribute.rst b/classes/class_rdvertexattribute.rst index ec5f895ee..817997fd9 100644 --- a/classes/class_rdvertexattribute.rst +++ b/classes/class_rdvertexattribute.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RDVertexAttribute.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/RDVertexAttribute.xml. .. _class_RDVertexAttribute: diff --git a/classes/class_rect2.rst b/classes/class_rect2.rst index 82e576031..b0ae3937b 100644 --- a/classes/class_rect2.rst +++ b/classes/class_rect2.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Rect2.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Rect2.xml. .. _class_Rect2: diff --git a/classes/class_rect2i.rst b/classes/class_rect2i.rst index fa0c4558a..a35ed0178 100644 --- a/classes/class_rect2i.rst +++ b/classes/class_rect2i.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Rect2i.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Rect2i.xml. .. _class_Rect2i: diff --git a/classes/class_rectangleshape2d.rst b/classes/class_rectangleshape2d.rst index 0cd2a575b..e0ce50a97 100644 --- a/classes/class_rectangleshape2d.rst +++ b/classes/class_rectangleshape2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RectangleShape2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/RectangleShape2D.xml. .. _class_RectangleShape2D: diff --git a/classes/class_refcounted.rst b/classes/class_refcounted.rst index ff22d1cb0..9ff4aeac0 100644 --- a/classes/class_refcounted.rst +++ b/classes/class_refcounted.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RefCounted.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/RefCounted.xml. .. _class_RefCounted: diff --git a/classes/class_referencerect.rst b/classes/class_referencerect.rst index 87391532a..9430f1ac1 100644 --- a/classes/class_referencerect.rst +++ b/classes/class_referencerect.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ReferenceRect.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ReferenceRect.xml. .. _class_ReferenceRect: diff --git a/classes/class_reflectionprobe.rst b/classes/class_reflectionprobe.rst index 78e9391ca..2b5b24cc3 100644 --- a/classes/class_reflectionprobe.rst +++ b/classes/class_reflectionprobe.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ReflectionProbe.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ReflectionProbe.xml. .. _class_ReflectionProbe: diff --git a/classes/class_regex.rst b/classes/class_regex.rst index 833ca1976..8678c50b9 100644 --- a/classes/class_regex.rst +++ b/classes/class_regex.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/regex/doc_classes/RegEx.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/regex/doc_classes/RegEx.xml. .. _class_RegEx: diff --git a/classes/class_regexmatch.rst b/classes/class_regexmatch.rst index 50ac6471a..77b480ade 100644 --- a/classes/class_regexmatch.rst +++ b/classes/class_regexmatch.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/regex/doc_classes/RegExMatch.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/regex/doc_classes/RegExMatch.xml. .. _class_RegExMatch: diff --git a/classes/class_remotetransform2d.rst b/classes/class_remotetransform2d.rst index 447d03017..6aed1e38e 100644 --- a/classes/class_remotetransform2d.rst +++ b/classes/class_remotetransform2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RemoteTransform2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/RemoteTransform2D.xml. .. _class_RemoteTransform2D: diff --git a/classes/class_remotetransform3d.rst b/classes/class_remotetransform3d.rst index 99e84d52e..07f55cfb2 100644 --- a/classes/class_remotetransform3d.rst +++ b/classes/class_remotetransform3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RemoteTransform3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/RemoteTransform3D.xml. .. _class_RemoteTransform3D: diff --git a/classes/class_renderingdevice.rst b/classes/class_renderingdevice.rst index f55afd4f8..87fe97b7b 100644 --- a/classes/class_renderingdevice.rst +++ b/classes/class_renderingdevice.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RenderingDevice.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/RenderingDevice.xml. .. _class_RenderingDevice: @@ -4602,7 +4602,7 @@ A simple drawing operation might look like this (code is not a complete example) :: var rd = RenderingDevice.new() - var clear_colors = PackedColorArray([Color(0, 0, 0, 0), Color(0, 0, 0, 0), Color(0, 0, 0, 0)] + var clear_colors = PackedColorArray([Color(0, 0, 0, 0), Color(0, 0, 0, 0), Color(0, 0, 0, 0)]) var draw_list = rd.draw_list_begin(framebuffers[i], RenderingDevice.INITIAL_ACTION_CLEAR, RenderingDevice.FINAL_ACTION_READ, RenderingDevice.INITIAL_ACTION_CLEAR, RenderingDevice.FINAL_ACTION_DISCARD, clear_colors) # Draw opaque. diff --git a/classes/class_renderingserver.rst b/classes/class_renderingserver.rst index dbe725f0e..f61f60ff3 100644 --- a/classes/class_renderingserver.rst +++ b/classes/class_renderingserver.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RenderingServer.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/RenderingServer.xml. .. _class_RenderingServer: @@ -267,6 +267,8 @@ Methods +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RenderingDevice<class_RenderingDevice>` | :ref:`create_local_rendering_device<class_RenderingServer_method_create_local_rendering_device>` **(** **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2<class_Rect2>` | :ref:`debug_canvas_item_get_rect<class_RenderingServer_method_debug_canvas_item_get_rect>` **(** :ref:`RID<class_RID>` item **)** | + +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID<class_RID>` | :ref:`decal_create<class_RenderingServer_method_decal_create>` **(** **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`decal_set_albedo_mix<class_RenderingServer_method_decal_set_albedo_mix>` **(** :ref:`RID<class_RID>` decal, :ref:`float<class_float>` albedo_mix **)** | @@ -4630,7 +4632,7 @@ Uses the default filter mode for this :ref:`Viewport<class_Viewport>`. :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_NEAREST** = ``1`` -The texture filter reads from the nearest pixel only. The simplest and fastest method of filtering, but the texture will look pixelized. +The texture filter reads from the nearest pixel only. This makes the texture look pixelated from up close, and grainy from a distance (due to mipmaps not being sampled). .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_LINEAR: @@ -4638,7 +4640,7 @@ The texture filter reads from the nearest pixel only. The simplest and fastest m :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_LINEAR** = ``2`` -The texture filter blends between the nearest 4 pixels. Use this when you want to avoid a pixelated style, but do not want mipmaps. +The texture filter blends between the nearest 4 pixels. This makes the texture look smooth from up close, and grainy from a distance (due to mipmaps not being sampled). .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS: @@ -4646,7 +4648,9 @@ The texture filter blends between the nearest 4 pixels. Use this when you want t :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS** = ``3`` -The texture filter reads from the nearest pixel in the nearest mipmap. The fastest way to read from textures with mipmaps. +The texture filter reads from the nearest pixel and blends between the nearest 2 mipmaps (or uses the nearest mipmap if :ref:`ProjectSettings.rendering/textures/default_filters/use_nearest_mipmap_filter<class_ProjectSettings_property_rendering/textures/default_filters/use_nearest_mipmap_filter>` is ``true``). This makes the texture look pixelated from up close, and smooth from a distance. + +Use this for non-pixel art textures that may be viewed at a low scale (e.g. due to :ref:`Camera2D<class_Camera2D>` zoom or sprite scaling), as mipmaps are important to smooth out pixels that are smaller than on-screen pixels. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS: @@ -4654,7 +4658,9 @@ The texture filter reads from the nearest pixel in the nearest mipmap. The faste :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS** = ``4`` -The texture filter blends between the nearest 4 pixels and between the nearest 2 mipmaps. +The texture filter blends between the nearest 4 pixels and between the nearest 2 mipmaps (or uses the nearest mipmap if :ref:`ProjectSettings.rendering/textures/default_filters/use_nearest_mipmap_filter<class_ProjectSettings_property_rendering/textures/default_filters/use_nearest_mipmap_filter>` is ``true``). This makes the texture look smooth from up close, and smooth from a distance. + +Use this for non-pixel art textures that may be viewed at a low scale (e.g. due to :ref:`Camera2D<class_Camera2D>` zoom or sprite scaling), as mipmaps are important to smooth out pixels that are smaller than on-screen pixels. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC: @@ -4662,7 +4668,9 @@ The texture filter blends between the nearest 4 pixels and between the nearest 2 :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC** = ``5`` -The texture filter reads from the nearest pixel, but selects a mipmap based on the angle between the surface and the camera view. This reduces artifacts on surfaces that are almost in line with the camera. +The texture filter reads from the nearest pixel and blends between 2 mipmaps (or uses the nearest mipmap if :ref:`ProjectSettings.rendering/textures/default_filters/use_nearest_mipmap_filter<class_ProjectSettings_property_rendering/textures/default_filters/use_nearest_mipmap_filter>` is ``true``) based on the angle between the surface and the camera view. This makes the texture look pixelated from up close, and smooth from a distance. Anisotropic filtering improves texture quality on surfaces that are almost in line with the camera, but is slightly slower. The anisotropic filtering level can be changed by adjusting :ref:`ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level<class_ProjectSettings_property_rendering/textures/default_filters/anisotropic_filtering_level>`. + +\ **Note:** This texture filter is rarely useful in 2D projects. :ref:`CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS<class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS>` is usually more appropriate in this case. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC: @@ -4670,7 +4678,9 @@ The texture filter reads from the nearest pixel, but selects a mipmap based on t :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC** = ``6`` -The texture filter blends between the nearest 4 pixels and selects a mipmap based on the angle between the surface and the camera view. This reduces artifacts on surfaces that are almost in line with the camera. This is the slowest of the filtering options, but results in the highest quality texturing. +The texture filter blends between the nearest 4 pixels and blends between 2 mipmaps (or uses the nearest mipmap if :ref:`ProjectSettings.rendering/textures/default_filters/use_nearest_mipmap_filter<class_ProjectSettings_property_rendering/textures/default_filters/use_nearest_mipmap_filter>` is ``true``) based on the angle between the surface and the camera view. This makes the texture look smooth from up close, and smooth from a distance. Anisotropic filtering improves texture quality on surfaces that are almost in line with the camera, but is slightly slower. The anisotropic filtering level can be changed by adjusting :ref:`ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level<class_ProjectSettings_property_rendering/textures/default_filters/anisotropic_filtering_level>`. + +\ **Note:** This texture filter is rarely useful in 2D projects. :ref:`CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS<class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS>` is usually more appropriate in this case. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_MAX: @@ -6666,6 +6676,20 @@ Creates a RenderingDevice that can be used to do draw and compute operations on ---- +.. _class_RenderingServer_method_debug_canvas_item_get_rect: + +.. rst-class:: classref-method + +:ref:`Rect2<class_Rect2>` **debug_canvas_item_get_rect** **(** :ref:`RID<class_RID>` item **)** + +Returns the bounding rectangle for a canvas item in local space, as calculated by the renderer. This bound is used internally for culling. + +\ **Warning:** This function is intended for debugging in the editor, and will pass through and return a zero :ref:`Rect2<class_Rect2>` in exported projects. + +.. rst-class:: classref-item-separator + +---- + .. _class_RenderingServer_method_decal_create: .. rst-class:: classref-method @@ -7238,7 +7262,7 @@ Sets the size of the fog volume when shape is :ref:`FOG_VOLUME_SHAPE_ELLIPSOID<c void **force_draw** **(** :ref:`bool<class_bool>` swap_buffers=true, :ref:`float<class_float>` frame_step=0.0 **)** -Forces redrawing of all viewports at once. +Forces redrawing of all viewports at once. Must be called from the main thread. .. rst-class:: classref-item-separator @@ -7914,7 +7938,7 @@ Sets the override material of a specific surface. Equivalent to :ref:`MeshInstan void **instance_set_transform** **(** :ref:`RID<class_RID>` instance, :ref:`Transform3D<class_Transform3D>` transform **)** -Sets the world space transform of the instance. Equivalent to :ref:`Node3D.transform<class_Node3D_property_transform>`. +Sets the world space transform of the instance. Equivalent to :ref:`Node3D.global_transform<class_Node3D_property_global_transform>`. .. rst-class:: classref-item-separator diff --git a/classes/class_renderscenebuffers.rst b/classes/class_renderscenebuffers.rst index c72d1ccc7..2fb5e4f54 100644 --- a/classes/class_renderscenebuffers.rst +++ b/classes/class_renderscenebuffers.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RenderSceneBuffers.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/RenderSceneBuffers.xml. .. _class_RenderSceneBuffers: diff --git a/classes/class_renderscenebuffersconfiguration.rst b/classes/class_renderscenebuffersconfiguration.rst index e445a3ddd..70f4f8338 100644 --- a/classes/class_renderscenebuffersconfiguration.rst +++ b/classes/class_renderscenebuffersconfiguration.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RenderSceneBuffersConfiguration.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/RenderSceneBuffersConfiguration.xml. .. _class_RenderSceneBuffersConfiguration: diff --git a/classes/class_renderscenebuffersextension.rst b/classes/class_renderscenebuffersextension.rst index 383b6ae16..cf9c60cdb 100644 --- a/classes/class_renderscenebuffersextension.rst +++ b/classes/class_renderscenebuffersextension.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RenderSceneBuffersExtension.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/RenderSceneBuffersExtension.xml. .. _class_RenderSceneBuffersExtension: diff --git a/classes/class_renderscenebuffersrd.rst b/classes/class_renderscenebuffersrd.rst index 6ed9bd560..96706d160 100644 --- a/classes/class_renderscenebuffersrd.rst +++ b/classes/class_renderscenebuffersrd.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RenderSceneBuffersRD.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/RenderSceneBuffersRD.xml. .. _class_RenderSceneBuffersRD: diff --git a/classes/class_resource.rst b/classes/class_resource.rst index d0c4350ea..d485d3cdb 100644 --- a/classes/class_resource.rst +++ b/classes/class_resource.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Resource.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Resource.xml. .. _class_Resource: diff --git a/classes/class_resourceformatloader.rst b/classes/class_resourceformatloader.rst index 40019ba46..30d7c7d4e 100644 --- a/classes/class_resourceformatloader.rst +++ b/classes/class_resourceformatloader.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ResourceFormatLoader.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ResourceFormatLoader.xml. .. _class_ResourceFormatLoader: diff --git a/classes/class_resourceformatsaver.rst b/classes/class_resourceformatsaver.rst index 36bd22dbb..e54f130b6 100644 --- a/classes/class_resourceformatsaver.rst +++ b/classes/class_resourceformatsaver.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ResourceFormatSaver.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ResourceFormatSaver.xml. .. _class_ResourceFormatSaver: diff --git a/classes/class_resourceimporter.rst b/classes/class_resourceimporter.rst index f896ace57..28a0302cd 100644 --- a/classes/class_resourceimporter.rst +++ b/classes/class_resourceimporter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ResourceImporter.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ResourceImporter.xml. .. _class_ResourceImporter: diff --git a/classes/class_resourceimporterbitmap.rst b/classes/class_resourceimporterbitmap.rst index 6f697bdb8..21b74a10e 100644 --- a/classes/class_resourceimporterbitmap.rst +++ b/classes/class_resourceimporterbitmap.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ResourceImporterBitMap.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ResourceImporterBitMap.xml. .. _class_ResourceImporterBitMap: diff --git a/classes/class_resourceimporterbmfont.rst b/classes/class_resourceimporterbmfont.rst index b9d610173..67b00b072 100644 --- a/classes/class_resourceimporterbmfont.rst +++ b/classes/class_resourceimporterbmfont.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ResourceImporterBMFont.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ResourceImporterBMFont.xml. .. _class_ResourceImporterBMFont: diff --git a/classes/class_resourceimportercsvtranslation.rst b/classes/class_resourceimportercsvtranslation.rst index bc8964211..a752256b7 100644 --- a/classes/class_resourceimportercsvtranslation.rst +++ b/classes/class_resourceimportercsvtranslation.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ResourceImporterCSVTranslation.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ResourceImporterCSVTranslation.xml. .. _class_ResourceImporterCSVTranslation: diff --git a/classes/class_resourceimporterdynamicfont.rst b/classes/class_resourceimporterdynamicfont.rst index 9e4cca200..f3f7718be 100644 --- a/classes/class_resourceimporterdynamicfont.rst +++ b/classes/class_resourceimporterdynamicfont.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ResourceImporterDynamicFont.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ResourceImporterDynamicFont.xml. .. _class_ResourceImporterDynamicFont: diff --git a/classes/class_resourceimporterimage.rst b/classes/class_resourceimporterimage.rst index 4b5015167..598a86867 100644 --- a/classes/class_resourceimporterimage.rst +++ b/classes/class_resourceimporterimage.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ResourceImporterImage.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ResourceImporterImage.xml. .. _class_ResourceImporterImage: diff --git a/classes/class_resourceimporterimagefont.rst b/classes/class_resourceimporterimagefont.rst index dc159bf44..a56ff0d36 100644 --- a/classes/class_resourceimporterimagefont.rst +++ b/classes/class_resourceimporterimagefont.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ResourceImporterImageFont.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ResourceImporterImageFont.xml. .. _class_ResourceImporterImageFont: diff --git a/classes/class_resourceimporterlayeredtexture.rst b/classes/class_resourceimporterlayeredtexture.rst index a49516add..881804f6d 100644 --- a/classes/class_resourceimporterlayeredtexture.rst +++ b/classes/class_resourceimporterlayeredtexture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ResourceImporterLayeredTexture.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ResourceImporterLayeredTexture.xml. .. _class_ResourceImporterLayeredTexture: diff --git a/classes/class_resourceimportermp3.rst b/classes/class_resourceimportermp3.rst index 274bdd6b5..245a30cc6 100644 --- a/classes/class_resourceimportermp3.rst +++ b/classes/class_resourceimportermp3.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/minimp3/doc_classes/ResourceImporterMP3.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/minimp3/doc_classes/ResourceImporterMP3.xml. .. _class_ResourceImporterMP3: diff --git a/classes/class_resourceimporterobj.rst b/classes/class_resourceimporterobj.rst index c202703d8..760a1dccd 100644 --- a/classes/class_resourceimporterobj.rst +++ b/classes/class_resourceimporterobj.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ResourceImporterOBJ.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ResourceImporterOBJ.xml. .. _class_ResourceImporterOBJ: @@ -12,7 +12,7 @@ ResourceImporterOBJ **Inherits:** :ref:`ResourceImporter<class_ResourceImporter>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>` -Imports an OBJ 3D model as a standalone :ref:`Mesh<class_Mesh>` or scene. +Imports an OBJ 3D model as an independent :ref:`Mesh<class_Mesh>` or scene. .. rst-class:: classref-introduction-group diff --git a/classes/class_resourceimporteroggvorbis.rst b/classes/class_resourceimporteroggvorbis.rst index 5bd3f9b96..b491047b5 100644 --- a/classes/class_resourceimporteroggvorbis.rst +++ b/classes/class_resourceimporteroggvorbis.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/vorbis/doc_classes/ResourceImporterOggVorbis.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/vorbis/doc_classes/ResourceImporterOggVorbis.xml. .. _class_ResourceImporterOggVorbis: diff --git a/classes/class_resourceimporterscene.rst b/classes/class_resourceimporterscene.rst index 5501d9772..362c1bf3b 100644 --- a/classes/class_resourceimporterscene.rst +++ b/classes/class_resourceimporterscene.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ResourceImporterScene.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ResourceImporterScene.xml. .. _class_ResourceImporterScene: @@ -19,7 +19,7 @@ Imports a glTF, FBX, Collada or Blender 3D scene. Description ----------- -See also :ref:`ResourceImporterOBJ<class_ResourceImporterOBJ>`, which is used for OBJ models that can be imported as a standalone :ref:`Mesh<class_Mesh>` or a scene. +See also :ref:`ResourceImporterOBJ<class_ResourceImporterOBJ>`, which is used for OBJ models that can be imported as an independent :ref:`Mesh<class_Mesh>` or a scene. Additional options (such as extracting individual meshes or materials to files) are available in the **Advanced Import Settings** dialog. This dialog can be accessed by double-clicking a 3D scene in the FileSystem dock or by selecting a 3D scene in the FileSystem dock, going to the Import dock and choosing **Advanced**. diff --git a/classes/class_resourceimportershaderfile.rst b/classes/class_resourceimportershaderfile.rst index 23329719d..5618e7fac 100644 --- a/classes/class_resourceimportershaderfile.rst +++ b/classes/class_resourceimportershaderfile.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ResourceImporterShaderFile.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ResourceImporterShaderFile.xml. .. _class_ResourceImporterShaderFile: diff --git a/classes/class_resourceimportertexture.rst b/classes/class_resourceimportertexture.rst index 4393e3ea0..0557ac5db 100644 --- a/classes/class_resourceimportertexture.rst +++ b/classes/class_resourceimportertexture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ResourceImporterTexture.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ResourceImporterTexture.xml. .. _class_ResourceImporterTexture: diff --git a/classes/class_resourceimportertextureatlas.rst b/classes/class_resourceimportertextureatlas.rst index 528538f38..4339ad210 100644 --- a/classes/class_resourceimportertextureatlas.rst +++ b/classes/class_resourceimportertextureatlas.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ResourceImporterTextureAtlas.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ResourceImporterTextureAtlas.xml. .. _class_ResourceImporterTextureAtlas: diff --git a/classes/class_resourceimporterwav.rst b/classes/class_resourceimporterwav.rst index bab6f682e..0c72d2028 100644 --- a/classes/class_resourceimporterwav.rst +++ b/classes/class_resourceimporterwav.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ResourceImporterWAV.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ResourceImporterWAV.xml. .. _class_ResourceImporterWAV: diff --git a/classes/class_resourceloader.rst b/classes/class_resourceloader.rst index 10f8ffba7..912268cc9 100644 --- a/classes/class_resourceloader.rst +++ b/classes/class_resourceloader.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ResourceLoader.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ResourceLoader.xml. .. _class_ResourceLoader: @@ -262,6 +262,8 @@ GDScript has a simplified :ref:`@GDScript.load<class_@GDScript_method_load>` bui \ **Note:** If :ref:`ProjectSettings.editor/export/convert_text_resources_to_binary<class_ProjectSettings_property_editor/export/convert_text_resources_to_binary>` is ``true``, :ref:`@GDScript.load<class_@GDScript_method_load>` will not be able to read converted files in an exported project. If you rely on run-time loading of files present within the PCK, set :ref:`ProjectSettings.editor/export/convert_text_resources_to_binary<class_ProjectSettings_property_editor/export/convert_text_resources_to_binary>` to ``false``. +\ **Note:** Relative paths will be prefixed with ``"res://"`` before loading, to avoid unexpected results make sure your paths are absolute. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_resourcepreloader.rst b/classes/class_resourcepreloader.rst index f81515537..8f12cf752 100644 --- a/classes/class_resourcepreloader.rst +++ b/classes/class_resourcepreloader.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ResourcePreloader.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ResourcePreloader.xml. .. _class_ResourcePreloader: diff --git a/classes/class_resourcesaver.rst b/classes/class_resourcesaver.rst index 66db2e385..78820b684 100644 --- a/classes/class_resourcesaver.rst +++ b/classes/class_resourcesaver.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ResourceSaver.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ResourceSaver.xml. .. _class_ResourceSaver: diff --git a/classes/class_resourceuid.rst b/classes/class_resourceuid.rst index 992407c10..36372d3ad 100644 --- a/classes/class_resourceuid.rst +++ b/classes/class_resourceuid.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ResourceUID.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ResourceUID.xml. .. _class_ResourceUID: diff --git a/classes/class_ribbontrailmesh.rst b/classes/class_ribbontrailmesh.rst index f4a375179..77f622d2e 100644 --- a/classes/class_ribbontrailmesh.rst +++ b/classes/class_ribbontrailmesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RibbonTrailMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/RibbonTrailMesh.xml. .. _class_RibbonTrailMesh: diff --git a/classes/class_richtexteffect.rst b/classes/class_richtexteffect.rst index 2d9380776..9e2d4de36 100644 --- a/classes/class_richtexteffect.rst +++ b/classes/class_richtexteffect.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RichTextEffect.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/RichTextEffect.xml. .. _class_RichTextEffect: @@ -19,7 +19,7 @@ A custom effect for a :ref:`RichTextLabel<class_RichTextLabel>`. Description ----------- -A custom effect for a :ref:`RichTextLabel<class_RichTextLabel>`. +A custom effect for a :ref:`RichTextLabel<class_RichTextLabel>`, which can be loaded in the :ref:`RichTextLabel<class_RichTextLabel>` inspector or using :ref:`RichTextLabel.install_effect<class_RichTextLabel_method_install_effect>`. \ **Note:** For a **RichTextEffect** to be usable, a BBCode tag must be defined as a member variable called ``bbcode`` in the script. diff --git a/classes/class_richtextlabel.rst b/classes/class_richtextlabel.rst index 62c8b0cb5..c3411c0e8 100644 --- a/classes/class_richtextlabel.rst +++ b/classes/class_richtextlabel.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RichTextLabel.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/RichTextLabel.xml. .. _class_RichTextLabel: @@ -341,7 +341,22 @@ Triggered when the document is fully loaded. **meta_clicked** **(** :ref:`Variant<class_Variant>` meta **)** -Triggered when the user clicks on content between meta tags. If the meta is defined in text, e.g. ``[url={"data"="hi"}]hi[/url]``, then the parameter for this signal will be a :ref:`String<class_String>` type. If a particular type or an object is desired, the :ref:`push_meta<class_RichTextLabel_method_push_meta>` method must be used to manually insert the data into the tag stack. +Triggered when the user clicks on content between meta (URL) tags. If the meta is defined in BBCode, e.g. ``[url={"key": "value"}]Text[/url]``, then the parameter for this signal will always be a :ref:`String<class_String>` type. If a particular type or an object is desired, the :ref:`push_meta<class_RichTextLabel_method_push_meta>` method must be used to manually insert the data into the tag stack. Alternatively, you can convert the :ref:`String<class_String>` input to the desired type based on its contents (such as calling :ref:`JSON.parse<class_JSON_method_parse>` on it). + +For example, the following method can be connected to :ref:`meta_clicked<class_RichTextLabel_signal_meta_clicked>` to open clicked URLs using the user's default web browser: + + +.. tabs:: + + .. code-tab:: gdscript + + # This assumes RichTextLabel's `meta_clicked` signal was connected to + # the function below using the signal connection dialog. + func _richtextlabel_on_meta_clicked(meta): + # `meta` is of Variant type, so convert it to a String to avoid script errors at run-time. + OS.shell_open(str(meta)) + + .. rst-class:: classref-item-separator @@ -697,7 +712,7 @@ Language code used for line-breaking and text shaping algorithms, if left empty - void **set_meta_underline** **(** :ref:`bool<class_bool>` value **)** - :ref:`bool<class_bool>` **is_meta_underlined** **(** **)** -If ``true``, the label underlines meta tags such as ``[url]{text}[/url]``. +If ``true``, the label underlines meta tags such as ``[url]{text}[/url]``. These tags can call a function when clicked if :ref:`meta_clicked<class_RichTextLabel_signal_meta_clicked>` is connected to a function. .. rst-class:: classref-item-separator @@ -1034,7 +1049,7 @@ Clears the current selection. :ref:`int<class_int>` **get_character_line** **(** :ref:`int<class_int>` character **)** -Returns the line number of the character position provided. +Returns the line number of the character position provided. Line and character numbers are both zero-indexed. \ **Note:** If :ref:`threaded<class_RichTextLabel_property_threaded>` is enabled, this method returns a value for the loaded part of the document. Use :ref:`is_ready<class_RichTextLabel_method_is_ready>` or :ref:`finished<class_RichTextLabel_signal_finished>` to determine whether document is fully loaded. @@ -1048,7 +1063,7 @@ Returns the line number of the character position provided. :ref:`int<class_int>` **get_character_paragraph** **(** :ref:`int<class_int>` character **)** -Returns the paragraph number of the character position provided. +Returns the paragraph number of the character position provided. Paragraph and character numbers are both zero-indexed. \ **Note:** If :ref:`threaded<class_RichTextLabel_property_threaded>` is enabled, this method returns a value for the loaded part of the document. Use :ref:`is_ready<class_RichTextLabel_method_is_ready>` or :ref:`finished<class_RichTextLabel_signal_finished>` to determine whether document is fully loaded. @@ -1305,7 +1320,32 @@ Returns the number of visible paragraphs. A paragraph is considered visible if a void **install_effect** **(** :ref:`Variant<class_Variant>` effect **)** -Installs a custom effect. ``effect`` should be a valid :ref:`RichTextEffect<class_RichTextEffect>`. +Installs a custom effect. This can also be done in the RichTextLabel inspector using the :ref:`custom_effects<class_RichTextLabel_property_custom_effects>` property. ``effect`` should be a valid :ref:`RichTextEffect<class_RichTextEffect>`. + +Example RichTextEffect: + +:: + + # effect.gd + class_name MyCustomEffect + extends RichTextEffect + + var bbcode = "my_custom_effect" + + # ... + +Registering the above effect in RichTextLabel from script: + +:: + + # rich_text_label.gd + extends RichTextLabel + + func _ready(): + install_effect(MyCustomEffect.new()) + + # Alternatively, if not using `class_name` in the script that extends RichTextEffect: + install_effect(preload("res://effect.gd").new()) .. rst-class:: classref-item-separator @@ -1621,6 +1661,8 @@ void **push_meta** **(** :ref:`Variant<class_Variant>` data **)** Adds a meta tag to the tag stack. Similar to the BBCode ``[url=something]{text}[/url]``, but supports non-:ref:`String<class_String>` metadata types. +\ **Note:** Meta tags do nothing by default when clicked. To assign behavior when clicked, connect :ref:`meta_clicked<class_RichTextLabel_signal_meta_clicked>` to a function that is called when the meta tag is clicked. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_rid.rst b/classes/class_rid.rst index 070bc918c..ba20b3af1 100644 --- a/classes/class_rid.rst +++ b/classes/class_rid.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RID.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/RID.xml. .. _class_RID: diff --git a/classes/class_rigidbody2d.rst b/classes/class_rigidbody2d.rst index 80966cf56..c1ad461d2 100644 --- a/classes/class_rigidbody2d.rst +++ b/classes/class_rigidbody2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RigidBody2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/RigidBody2D.xml. .. _class_RigidBody2D: diff --git a/classes/class_rigidbody3d.rst b/classes/class_rigidbody3d.rst index 15aff1a29..0e8e1b2e2 100644 --- a/classes/class_rigidbody3d.rst +++ b/classes/class_rigidbody3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RigidBody3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/RigidBody3D.xml. .. _class_RigidBody3D: diff --git a/classes/class_rootmotionview.rst b/classes/class_rootmotionview.rst index acdb3af1b..ddc8a5460 100644 --- a/classes/class_rootmotionview.rst +++ b/classes/class_rootmotionview.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RootMotionView.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/RootMotionView.xml. .. _class_RootMotionView: diff --git a/classes/class_scenemultiplayer.rst b/classes/class_scenemultiplayer.rst index 053fa5902..c089d8746 100644 --- a/classes/class_scenemultiplayer.rst +++ b/classes/class_scenemultiplayer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/multiplayer/doc_classes/SceneMultiplayer.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/multiplayer/doc_classes/SceneMultiplayer.xml. .. _class_SceneMultiplayer: diff --git a/classes/class_scenereplicationconfig.rst b/classes/class_scenereplicationconfig.rst index 06769d84b..65f20f3d0 100644 --- a/classes/class_scenereplicationconfig.rst +++ b/classes/class_scenereplicationconfig.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/multiplayer/doc_classes/SceneReplicationConfig.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/multiplayer/doc_classes/SceneReplicationConfig.xml. .. _class_SceneReplicationConfig: diff --git a/classes/class_scenestate.rst b/classes/class_scenestate.rst index ca2aa9622..4d5cf519f 100644 --- a/classes/class_scenestate.rst +++ b/classes/class_scenestate.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SceneState.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/SceneState.xml. .. _class_SceneState: diff --git a/classes/class_scenetree.rst b/classes/class_scenetree.rst index aaab54c31..654a67658 100644 --- a/classes/class_scenetree.rst +++ b/classes/class_scenetree.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SceneTree.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/SceneTree.xml. .. _class_SceneTree: diff --git a/classes/class_scenetreetimer.rst b/classes/class_scenetreetimer.rst index 714386c5e..f99b88de3 100644 --- a/classes/class_scenetreetimer.rst +++ b/classes/class_scenetreetimer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SceneTreeTimer.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/SceneTreeTimer.xml. .. _class_SceneTreeTimer: diff --git a/classes/class_script.rst b/classes/class_script.rst index bfb139f48..85ff36c9b 100644 --- a/classes/class_script.rst +++ b/classes/class_script.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Script.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Script.xml. .. _class_Script: diff --git a/classes/class_scriptcreatedialog.rst b/classes/class_scriptcreatedialog.rst index 68880c39d..51b430870 100644 --- a/classes/class_scriptcreatedialog.rst +++ b/classes/class_scriptcreatedialog.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ScriptCreateDialog.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ScriptCreateDialog.xml. .. _class_ScriptCreateDialog: diff --git a/classes/class_scripteditor.rst b/classes/class_scripteditor.rst index 164f44009..3e8cbeaef 100644 --- a/classes/class_scripteditor.rst +++ b/classes/class_scripteditor.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ScriptEditor.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ScriptEditor.xml. .. _class_ScriptEditor: diff --git a/classes/class_scripteditorbase.rst b/classes/class_scripteditorbase.rst index e9d2508dd..3b6a646d9 100644 --- a/classes/class_scripteditorbase.rst +++ b/classes/class_scripteditorbase.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ScriptEditorBase.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ScriptEditorBase.xml. .. _class_ScriptEditorBase: diff --git a/classes/class_scriptextension.rst b/classes/class_scriptextension.rst index fdfbc2cab..f0adb109f 100644 --- a/classes/class_scriptextension.rst +++ b/classes/class_scriptextension.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ScriptExtension.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ScriptExtension.xml. .. _class_ScriptExtension: diff --git a/classes/class_scriptlanguage.rst b/classes/class_scriptlanguage.rst index ba55ef0bf..5519dc4eb 100644 --- a/classes/class_scriptlanguage.rst +++ b/classes/class_scriptlanguage.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ScriptLanguage.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ScriptLanguage.xml. .. _class_ScriptLanguage: diff --git a/classes/class_scriptlanguageextension.rst b/classes/class_scriptlanguageextension.rst index 3b7cdd84e..c25fe5a51 100644 --- a/classes/class_scriptlanguageextension.rst +++ b/classes/class_scriptlanguageextension.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ScriptLanguageExtension.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ScriptLanguageExtension.xml. .. _class_ScriptLanguageExtension: diff --git a/classes/class_scrollbar.rst b/classes/class_scrollbar.rst index 30acc393f..8d24a1de7 100644 --- a/classes/class_scrollbar.rst +++ b/classes/class_scrollbar.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ScrollBar.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ScrollBar.xml. .. _class_ScrollBar: diff --git a/classes/class_scrollcontainer.rst b/classes/class_scrollcontainer.rst index c84ee6e6a..90e7a4558 100644 --- a/classes/class_scrollcontainer.rst +++ b/classes/class_scrollcontainer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ScrollContainer.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ScrollContainer.xml. .. _class_ScrollContainer: diff --git a/classes/class_segmentshape2d.rst b/classes/class_segmentshape2d.rst index 43f4f76a0..b8f402f2f 100644 --- a/classes/class_segmentshape2d.rst +++ b/classes/class_segmentshape2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SegmentShape2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/SegmentShape2D.xml. .. _class_SegmentShape2D: diff --git a/classes/class_semaphore.rst b/classes/class_semaphore.rst index 58a7cd0f5..37c7d68f4 100644 --- a/classes/class_semaphore.rst +++ b/classes/class_semaphore.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Semaphore.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Semaphore.xml. .. _class_Semaphore: diff --git a/classes/class_separationrayshape2d.rst b/classes/class_separationrayshape2d.rst index 195e63fe8..9f0ce4bb7 100644 --- a/classes/class_separationrayshape2d.rst +++ b/classes/class_separationrayshape2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SeparationRayShape2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/SeparationRayShape2D.xml. .. _class_SeparationRayShape2D: diff --git a/classes/class_separationrayshape3d.rst b/classes/class_separationrayshape3d.rst index a951f748f..b9cb790d2 100644 --- a/classes/class_separationrayshape3d.rst +++ b/classes/class_separationrayshape3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SeparationRayShape3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/SeparationRayShape3D.xml. .. _class_SeparationRayShape3D: diff --git a/classes/class_separator.rst b/classes/class_separator.rst index ae73f68e7..4c622bd44 100644 --- a/classes/class_separator.rst +++ b/classes/class_separator.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Separator.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Separator.xml. .. _class_Separator: diff --git a/classes/class_shader.rst b/classes/class_shader.rst index 5fe28caff..fff454673 100644 --- a/classes/class_shader.rst +++ b/classes/class_shader.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Shader.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Shader.xml. .. _class_Shader: diff --git a/classes/class_shaderglobalsoverride.rst b/classes/class_shaderglobalsoverride.rst index bdb325568..2ba2d86c0 100644 --- a/classes/class_shaderglobalsoverride.rst +++ b/classes/class_shaderglobalsoverride.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ShaderGlobalsOverride.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ShaderGlobalsOverride.xml. .. _class_ShaderGlobalsOverride: diff --git a/classes/class_shaderinclude.rst b/classes/class_shaderinclude.rst index 476aa7fba..0e1694af9 100644 --- a/classes/class_shaderinclude.rst +++ b/classes/class_shaderinclude.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ShaderInclude.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ShaderInclude.xml. .. _class_ShaderInclude: diff --git a/classes/class_shadermaterial.rst b/classes/class_shadermaterial.rst index f8486d315..4993a2c27 100644 --- a/classes/class_shadermaterial.rst +++ b/classes/class_shadermaterial.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ShaderMaterial.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ShaderMaterial.xml. .. _class_ShaderMaterial: diff --git a/classes/class_shape2d.rst b/classes/class_shape2d.rst index c0c9c2c37..f7c87ef75 100644 --- a/classes/class_shape2d.rst +++ b/classes/class_shape2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Shape2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Shape2D.xml. .. _class_Shape2D: diff --git a/classes/class_shape3d.rst b/classes/class_shape3d.rst index eaad3974c..8a97e1437 100644 --- a/classes/class_shape3d.rst +++ b/classes/class_shape3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Shape3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Shape3D.xml. .. _class_Shape3D: diff --git a/classes/class_shapecast2d.rst b/classes/class_shapecast2d.rst index 5e25c1871..099231863 100644 --- a/classes/class_shapecast2d.rst +++ b/classes/class_shapecast2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ShapeCast2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ShapeCast2D.xml. .. _class_ShapeCast2D: diff --git a/classes/class_shapecast3d.rst b/classes/class_shapecast3d.rst index 74e7d2320..4b9a49c67 100644 --- a/classes/class_shapecast3d.rst +++ b/classes/class_shapecast3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ShapeCast3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ShapeCast3D.xml. .. _class_ShapeCast3D: diff --git a/classes/class_shortcut.rst b/classes/class_shortcut.rst index 2b6275b6b..0d7944f21 100644 --- a/classes/class_shortcut.rst +++ b/classes/class_shortcut.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Shortcut.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Shortcut.xml. .. _class_Shortcut: diff --git a/classes/class_signal.rst b/classes/class_signal.rst index 8a9823cc4..d72b2ee63 100644 --- a/classes/class_signal.rst +++ b/classes/class_signal.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Signal.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Signal.xml. .. _class_Signal: diff --git a/classes/class_skeleton2d.rst b/classes/class_skeleton2d.rst index 10ba21be7..85809b66a 100644 --- a/classes/class_skeleton2d.rst +++ b/classes/class_skeleton2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Skeleton2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Skeleton2D.xml. .. _class_Skeleton2D: diff --git a/classes/class_skeleton3d.rst b/classes/class_skeleton3d.rst index 0b49aa2bb..ec23820fa 100644 --- a/classes/class_skeleton3d.rst +++ b/classes/class_skeleton3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Skeleton3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Skeleton3D.xml. .. _class_Skeleton3D: @@ -25,8 +25,6 @@ The overall transform of a bone with respect to the skeleton is determined by bo Note that "global pose" below refers to the overall transform of the bone with respect to skeleton, so it is not the actual global/world transform of the bone. -To setup different types of inverse kinematics, consider using :ref:`SkeletonIK3D<class_SkeletonIK3D>`, or add a custom IK implementation in :ref:`Node._process<class_Node_private_method__process>` as a child node. - .. rst-class:: classref-introduction-group Tutorials @@ -157,9 +155,7 @@ Signals **bone_enabled_changed** **(** :ref:`int<class_int>` bone_idx **)** -.. container:: contribute - - There is currently no description for this signal. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Emitted when the bone at ``bone_idx`` is toggled with :ref:`set_bone_enabled<class_Skeleton3D_method_set_bone_enabled>`. Use :ref:`is_bone_enabled<class_Skeleton3D_method_is_bone_enabled>` to check the new value. .. rst-class:: classref-item-separator @@ -183,9 +179,7 @@ This signal is emitted when one of the bones in the Skeleton3D node have changed **pose_updated** **(** **)** -.. container:: contribute - - There is currently no description for this signal. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Emitted when the pose is updated, after :ref:`NOTIFICATION_UPDATE_SKELETON<class_Skeleton3D_constant_NOTIFICATION_UPDATE_SKELETON>` is received. .. rst-class:: classref-item-separator @@ -197,9 +191,7 @@ This signal is emitted when one of the bones in the Skeleton3D node have changed **show_rest_only_changed** **(** **)** -.. container:: contribute - - There is currently no description for this signal. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Emitted when the value of :ref:`show_rest_only<class_Skeleton3D_property_show_rest_only>` changes. .. rst-class:: classref-section-separator @@ -216,7 +208,9 @@ Constants **NOTIFICATION_UPDATE_SKELETON** = ``50`` +Notification received when this skeleton's pose needs to be updated. +This notification is received *before* the related :ref:`pose_updated<class_Skeleton3D_signal_pose_updated>` signal. .. rst-class:: classref-section-separator @@ -276,9 +270,7 @@ Multiplies the 3D position track animation. - void **set_show_rest_only** **(** :ref:`bool<class_bool>` value **)** - :ref:`bool<class_bool>` **is_show_rest_only** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +If ``true``, forces the bones in their default rest pose, regardless of their values. In the editor, this also prevents the bones from being edited. .. rst-class:: classref-section-separator @@ -383,7 +375,7 @@ Force updates the bone transform for the bone at ``bone_idx`` and all of its chi :ref:`PackedInt32Array<class_PackedInt32Array>` **get_bone_children** **(** :ref:`int<class_int>` bone_idx **)** |const| -Returns an array containing the bone indexes of all the children node of the passed in bone, ``bone_idx``. +Returns an array containing the bone indexes of all the child node of the passed in bone, ``bone_idx``. .. rst-class:: classref-item-separator diff --git a/classes/class_skeletonik3d.rst b/classes/class_skeletonik3d.rst index 1f4643383..21ed86cfc 100644 --- a/classes/class_skeletonik3d.rst +++ b/classes/class_skeletonik3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SkeletonIK3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/SkeletonIK3D.xml. .. _class_SkeletonIK3D: diff --git a/classes/class_skeletonmodification2d.rst b/classes/class_skeletonmodification2d.rst index 825e62655..4f20876bb 100644 --- a/classes/class_skeletonmodification2d.rst +++ b/classes/class_skeletonmodification2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SkeletonModification2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/SkeletonModification2D.xml. .. _class_SkeletonModification2D: diff --git a/classes/class_skeletonmodification2dccdik.rst b/classes/class_skeletonmodification2dccdik.rst index 4e1d3983a..3352c0b4f 100644 --- a/classes/class_skeletonmodification2dccdik.rst +++ b/classes/class_skeletonmodification2dccdik.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SkeletonModification2DCCDIK.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/SkeletonModification2DCCDIK.xml. .. _class_SkeletonModification2DCCDIK: diff --git a/classes/class_skeletonmodification2dfabrik.rst b/classes/class_skeletonmodification2dfabrik.rst index 2279b8139..2f1a0e662 100644 --- a/classes/class_skeletonmodification2dfabrik.rst +++ b/classes/class_skeletonmodification2dfabrik.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SkeletonModification2DFABRIK.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/SkeletonModification2DFABRIK.xml. .. _class_SkeletonModification2DFABRIK: diff --git a/classes/class_skeletonmodification2djiggle.rst b/classes/class_skeletonmodification2djiggle.rst index 3f999f4dc..7bd125daf 100644 --- a/classes/class_skeletonmodification2djiggle.rst +++ b/classes/class_skeletonmodification2djiggle.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SkeletonModification2DJiggle.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/SkeletonModification2DJiggle.xml. .. _class_SkeletonModification2DJiggle: diff --git a/classes/class_skeletonmodification2dlookat.rst b/classes/class_skeletonmodification2dlookat.rst index ca2c20e3b..b5eb43940 100644 --- a/classes/class_skeletonmodification2dlookat.rst +++ b/classes/class_skeletonmodification2dlookat.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SkeletonModification2DLookAt.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/SkeletonModification2DLookAt.xml. .. _class_SkeletonModification2DLookAt: diff --git a/classes/class_skeletonmodification2dphysicalbones.rst b/classes/class_skeletonmodification2dphysicalbones.rst index 107df698e..3968c989f 100644 --- a/classes/class_skeletonmodification2dphysicalbones.rst +++ b/classes/class_skeletonmodification2dphysicalbones.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SkeletonModification2DPhysicalBones.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/SkeletonModification2DPhysicalBones.xml. .. _class_SkeletonModification2DPhysicalBones: diff --git a/classes/class_skeletonmodification2dstackholder.rst b/classes/class_skeletonmodification2dstackholder.rst index bdf131882..3001d527e 100644 --- a/classes/class_skeletonmodification2dstackholder.rst +++ b/classes/class_skeletonmodification2dstackholder.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SkeletonModification2DStackHolder.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/SkeletonModification2DStackHolder.xml. .. _class_SkeletonModification2DStackHolder: diff --git a/classes/class_skeletonmodification2dtwoboneik.rst b/classes/class_skeletonmodification2dtwoboneik.rst index c9be46b68..769e05a8f 100644 --- a/classes/class_skeletonmodification2dtwoboneik.rst +++ b/classes/class_skeletonmodification2dtwoboneik.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SkeletonModification2DTwoBoneIK.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/SkeletonModification2DTwoBoneIK.xml. .. _class_SkeletonModification2DTwoBoneIK: diff --git a/classes/class_skeletonmodificationstack2d.rst b/classes/class_skeletonmodificationstack2d.rst index 9c1d84d74..04d64fbd9 100644 --- a/classes/class_skeletonmodificationstack2d.rst +++ b/classes/class_skeletonmodificationstack2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SkeletonModificationStack2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/SkeletonModificationStack2D.xml. .. _class_SkeletonModificationStack2D: diff --git a/classes/class_skeletonprofile.rst b/classes/class_skeletonprofile.rst index 0080d0a15..b38559052 100644 --- a/classes/class_skeletonprofile.rst +++ b/classes/class_skeletonprofile.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SkeletonProfile.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/SkeletonProfile.xml. .. _class_SkeletonProfile: diff --git a/classes/class_skeletonprofilehumanoid.rst b/classes/class_skeletonprofilehumanoid.rst index eb65d0cc9..962a4b723 100644 --- a/classes/class_skeletonprofilehumanoid.rst +++ b/classes/class_skeletonprofilehumanoid.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SkeletonProfileHumanoid.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/SkeletonProfileHumanoid.xml. .. _class_SkeletonProfileHumanoid: diff --git a/classes/class_skin.rst b/classes/class_skin.rst index 298fa7e6b..4039966ad 100644 --- a/classes/class_skin.rst +++ b/classes/class_skin.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Skin.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Skin.xml. .. _class_Skin: diff --git a/classes/class_skinreference.rst b/classes/class_skinreference.rst index d6b8440ab..1f8b45914 100644 --- a/classes/class_skinreference.rst +++ b/classes/class_skinreference.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SkinReference.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/SkinReference.xml. .. _class_SkinReference: diff --git a/classes/class_sky.rst b/classes/class_sky.rst index 07ed0d219..b8035a20b 100644 --- a/classes/class_sky.rst +++ b/classes/class_sky.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Sky.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Sky.xml. .. _class_Sky: diff --git a/classes/class_slider.rst b/classes/class_slider.rst index 883712716..4b9cc1fdf 100644 --- a/classes/class_slider.rst +++ b/classes/class_slider.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Slider.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Slider.xml. .. _class_Slider: diff --git a/classes/class_sliderjoint3d.rst b/classes/class_sliderjoint3d.rst index 942cd6fc1..5a78cbc48 100644 --- a/classes/class_sliderjoint3d.rst +++ b/classes/class_sliderjoint3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SliderJoint3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/SliderJoint3D.xml. .. _class_SliderJoint3D: diff --git a/classes/class_softbody3d.rst b/classes/class_softbody3d.rst index 9a984906e..62af2593b 100644 --- a/classes/class_softbody3d.rst +++ b/classes/class_softbody3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SoftBody3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/SoftBody3D.xml. .. _class_SoftBody3D: @@ -185,9 +185,7 @@ The physics layers this SoftBody3D **scans**. Collision objects can scan one or - void **set_damping_coefficient** **(** :ref:`float<class_float>` value **)** - :ref:`float<class_float>` **get_damping_coefficient** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +The body's damping coefficient. Higher values will slow down the body more noticeably when forces are applied. .. rst-class:: classref-item-separator @@ -221,9 +219,9 @@ Defines the behavior in physics when :ref:`Node.process_mode<class_Node_property - void **set_drag_coefficient** **(** :ref:`float<class_float>` value **)** - :ref:`float<class_float>` **get_drag_coefficient** **(** **)** -.. container:: contribute +The body's drag coefficient. Higher values increase this body's air resistance. - There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +\ **Note:** This value is currently unused by Godot's default physics implementation. .. rst-class:: classref-item-separator @@ -274,9 +272,7 @@ Higher values will result in a stiffer body, while lower values will increase th - void **set_pressure_coefficient** **(** :ref:`float<class_float>` value **)** - :ref:`float<class_float>` **get_pressure_coefficient** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +The pressure coefficient of this soft body. Simulate pressure build-up from inside this body. Higher values increase the strength of this effect. .. rst-class:: classref-item-separator @@ -392,9 +388,7 @@ Returns whether or not the specified layer of the :ref:`collision_mask<class_Sof :ref:`RID<class_RID>` **get_physics_rid** **(** **)** |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`! +Returns the internal :ref:`RID<class_RID>` used by the :ref:`PhysicsServer3D<class_PhysicsServer3D>` for this body. .. rst-class:: classref-item-separator diff --git a/classes/class_spheremesh.rst b/classes/class_spheremesh.rst index c64636372..9c9307d7b 100644 --- a/classes/class_spheremesh.rst +++ b/classes/class_spheremesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SphereMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/SphereMesh.xml. .. _class_SphereMesh: diff --git a/classes/class_sphereoccluder3d.rst b/classes/class_sphereoccluder3d.rst index a387d2f59..c94688141 100644 --- a/classes/class_sphereoccluder3d.rst +++ b/classes/class_sphereoccluder3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SphereOccluder3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/SphereOccluder3D.xml. .. _class_SphereOccluder3D: diff --git a/classes/class_sphereshape3d.rst b/classes/class_sphereshape3d.rst index 4a1b4c874..426b8ef8b 100644 --- a/classes/class_sphereshape3d.rst +++ b/classes/class_sphereshape3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SphereShape3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/SphereShape3D.xml. .. _class_SphereShape3D: diff --git a/classes/class_spinbox.rst b/classes/class_spinbox.rst index 889e47da0..1d4cafb9d 100644 --- a/classes/class_spinbox.rst +++ b/classes/class_spinbox.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SpinBox.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/SpinBox.xml. .. _class_SpinBox: diff --git a/classes/class_splitcontainer.rst b/classes/class_splitcontainer.rst index 0c5189832..f7d612c67 100644 --- a/classes/class_splitcontainer.rst +++ b/classes/class_splitcontainer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SplitContainer.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/SplitContainer.xml. .. _class_SplitContainer: diff --git a/classes/class_spotlight3d.rst b/classes/class_spotlight3d.rst index 96dee0bab..6f3ab84b4 100644 --- a/classes/class_spotlight3d.rst +++ b/classes/class_spotlight3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SpotLight3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/SpotLight3D.xml. .. _class_SpotLight3D: diff --git a/classes/class_springarm3d.rst b/classes/class_springarm3d.rst index 221147efd..0c462d10e 100644 --- a/classes/class_springarm3d.rst +++ b/classes/class_springarm3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SpringArm3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/SpringArm3D.xml. .. _class_SpringArm3D: diff --git a/classes/class_sprite2d.rst b/classes/class_sprite2d.rst index 51bced633..23a424843 100644 --- a/classes/class_sprite2d.rst +++ b/classes/class_sprite2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Sprite2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Sprite2D.xml. .. _class_Sprite2D: @@ -176,7 +176,7 @@ If ``true``, texture is flipped vertically. - void **set_frame** **(** :ref:`int<class_int>` value **)** - :ref:`int<class_int>` **get_frame** **(** **)** -Current frame to display from sprite sheet. :ref:`hframes<class_Sprite2D_property_hframes>` or :ref:`vframes<class_Sprite2D_property_vframes>` must be greater than 1. +Current frame to display from sprite sheet. :ref:`hframes<class_Sprite2D_property_hframes>` or :ref:`vframes<class_Sprite2D_property_vframes>` must be greater than 1. This property is automatically adjusted when :ref:`hframes<class_Sprite2D_property_hframes>` or :ref:`vframes<class_Sprite2D_property_vframes>` are changed to keep pointing to the same visual frame (same column and row). If that's impossible, this value is reset to ``0``. .. rst-class:: classref-item-separator @@ -210,7 +210,7 @@ Coordinates of the frame to display from sprite sheet. This is as an alias for t - void **set_hframes** **(** :ref:`int<class_int>` value **)** - :ref:`int<class_int>` **get_hframes** **(** **)** -The number of columns in the sprite sheet. +The number of columns in the sprite sheet. When this property is changed, :ref:`frame<class_Sprite2D_property_frame>` is adjusted so that the same visual frame is maintained (same row and column). If that's impossible, :ref:`frame<class_Sprite2D_property_frame>` is reset to ``0``. .. rst-class:: classref-item-separator @@ -312,7 +312,7 @@ The region of the atlas texture to display. :ref:`region_enabled<class_Sprite2D_ - void **set_vframes** **(** :ref:`int<class_int>` value **)** - :ref:`int<class_int>` **get_vframes** **(** **)** -The number of rows in the sprite sheet. +The number of rows in the sprite sheet. When this property is changed, :ref:`frame<class_Sprite2D_property_frame>` is adjusted so that the same visual frame is maintained (same row and column). If that's impossible, :ref:`frame<class_Sprite2D_property_frame>` is reset to ``0``. .. rst-class:: classref-section-separator diff --git a/classes/class_sprite3d.rst b/classes/class_sprite3d.rst index 42adf56d1..e5245998c 100644 --- a/classes/class_sprite3d.rst +++ b/classes/class_sprite3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Sprite3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Sprite3D.xml. .. _class_Sprite3D: @@ -94,7 +94,7 @@ Property Descriptions - void **set_frame** **(** :ref:`int<class_int>` value **)** - :ref:`int<class_int>` **get_frame** **(** **)** -Current frame to display from sprite sheet. :ref:`hframes<class_Sprite3D_property_hframes>` or :ref:`vframes<class_Sprite3D_property_vframes>` must be greater than 1. +Current frame to display from sprite sheet. :ref:`hframes<class_Sprite3D_property_hframes>` or :ref:`vframes<class_Sprite3D_property_vframes>` must be greater than 1. This property is automatically adjusted when :ref:`hframes<class_Sprite3D_property_hframes>` or :ref:`vframes<class_Sprite3D_property_vframes>` are changed to keep pointing to the same visual frame (same column and row). If that's impossible, this value is reset to ``0``. .. rst-class:: classref-item-separator @@ -128,7 +128,7 @@ Coordinates of the frame to display from sprite sheet. This is as an alias for t - void **set_hframes** **(** :ref:`int<class_int>` value **)** - :ref:`int<class_int>` **get_hframes** **(** **)** -The number of columns in the sprite sheet. +The number of columns in the sprite sheet. When this property is changed, :ref:`frame<class_Sprite3D_property_frame>` is adjusted so that the same visual frame is maintained (same row and column). If that's impossible, :ref:`frame<class_Sprite3D_property_frame>` is reset to ``0``. .. rst-class:: classref-item-separator @@ -196,7 +196,7 @@ The region of the atlas texture to display. :ref:`region_enabled<class_Sprite3D_ - void **set_vframes** **(** :ref:`int<class_int>` value **)** - :ref:`int<class_int>` **get_vframes** **(** **)** -The number of rows in the sprite sheet. +The number of rows in the sprite sheet. When this property is changed, :ref:`frame<class_Sprite3D_property_frame>` is adjusted so that the same visual frame is maintained (same row and column). If that's impossible, :ref:`frame<class_Sprite3D_property_frame>` is reset to ``0``. .. |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_spritebase3d.rst b/classes/class_spritebase3d.rst index 459f08751..68e9d3972 100644 --- a/classes/class_spritebase3d.rst +++ b/classes/class_spritebase3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SpriteBase3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/SpriteBase3D.xml. .. _class_SpriteBase3D: @@ -420,7 +420,9 @@ If ``true``, texture is flipped vertically. - void **set_modulate** **(** :ref:`Color<class_Color>` value **)** - :ref:`Color<class_Color>` **get_modulate** **(** **)** -A color value used to *multiply* the texture's colors. Can be used for mood-coloring or to simulate the color of light. +A color value used to *multiply* the texture's colors. Can be used for mood-coloring or to simulate the color of ambient light. + +\ **Note:** Unlike :ref:`CanvasItem.modulate<class_CanvasItem_property_modulate>` for 2D, colors with values above ``1.0`` (overbright) are not supported. \ **Note:** If a :ref:`GeometryInstance3D.material_override<class_GeometryInstance3D_property_material_override>` is defined on the **SpriteBase3D**, the material override must be configured to take vertex colors into account for albedo. Otherwise, the color defined in :ref:`modulate<class_SpriteBase3D_property_modulate>` will be ignored. For a :ref:`BaseMaterial3D<class_BaseMaterial3D>`, :ref:`BaseMaterial3D.vertex_color_use_as_albedo<class_BaseMaterial3D_property_vertex_color_use_as_albedo>` must be ``true``. For a :ref:`ShaderMaterial<class_ShaderMaterial>`, ``ALBEDO *= COLOR.rgb;`` must be inserted in the shader's ``fragment()`` function. @@ -530,6 +532,8 @@ If ``true``, the :ref:`Light3D<class_Light3D>` in the :ref:`Environment<class_En Filter flags for the texture. See :ref:`TextureFilter<enum_BaseMaterial3D_TextureFilter>` for options. +\ **Note:** Linear filtering may cause artifacts around the edges, which are especially noticeable on opaque textures. To prevent this, use textures with transparent or identical colors around the edges. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_spriteframes.rst b/classes/class_spriteframes.rst index a0c81ad68..f6c58efac 100644 --- a/classes/class_spriteframes.rst +++ b/classes/class_spriteframes.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SpriteFrames.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/SpriteFrames.xml. .. _class_SpriteFrames: diff --git a/classes/class_standardmaterial3d.rst b/classes/class_standardmaterial3d.rst index cc3309399..293880c1f 100644 --- a/classes/class_standardmaterial3d.rst +++ b/classes/class_standardmaterial3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/StandardMaterial3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/StandardMaterial3D.xml. .. _class_StandardMaterial3D: diff --git a/classes/class_staticbody2d.rst b/classes/class_staticbody2d.rst index 812f35299..fed916652 100644 --- a/classes/class_staticbody2d.rst +++ b/classes/class_staticbody2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/StaticBody2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/StaticBody2D.xml. .. _class_StaticBody2D: diff --git a/classes/class_staticbody3d.rst b/classes/class_staticbody3d.rst index 827a608e2..a0a6b2661 100644 --- a/classes/class_staticbody3d.rst +++ b/classes/class_staticbody3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/StaticBody3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/StaticBody3D.xml. .. _class_StaticBody3D: diff --git a/classes/class_streampeer.rst b/classes/class_streampeer.rst index 5f490f031..039eab45f 100644 --- a/classes/class_streampeer.rst +++ b/classes/class_streampeer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/StreamPeer.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/StreamPeer.xml. .. _class_StreamPeer: diff --git a/classes/class_streampeerbuffer.rst b/classes/class_streampeerbuffer.rst index 8390241dc..0d113839b 100644 --- a/classes/class_streampeerbuffer.rst +++ b/classes/class_streampeerbuffer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/StreamPeerBuffer.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/StreamPeerBuffer.xml. .. _class_StreamPeerBuffer: diff --git a/classes/class_streampeerextension.rst b/classes/class_streampeerextension.rst index 7969add94..91c49b54d 100644 --- a/classes/class_streampeerextension.rst +++ b/classes/class_streampeerextension.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/StreamPeerExtension.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/StreamPeerExtension.xml. .. _class_StreamPeerExtension: diff --git a/classes/class_streampeergzip.rst b/classes/class_streampeergzip.rst index 6418c70b9..5955e4178 100644 --- a/classes/class_streampeergzip.rst +++ b/classes/class_streampeergzip.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/StreamPeerGZIP.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/StreamPeerGZIP.xml. .. _class_StreamPeerGZIP: diff --git a/classes/class_streampeertcp.rst b/classes/class_streampeertcp.rst index 4f7d6e3c0..27768ec5e 100644 --- a/classes/class_streampeertcp.rst +++ b/classes/class_streampeertcp.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/StreamPeerTCP.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/StreamPeerTCP.xml. .. _class_StreamPeerTCP: diff --git a/classes/class_streampeertls.rst b/classes/class_streampeertls.rst index 9678facfc..3288a38c5 100644 --- a/classes/class_streampeertls.rst +++ b/classes/class_streampeertls.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/StreamPeerTLS.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/StreamPeerTLS.xml. .. _class_StreamPeerTLS: diff --git a/classes/class_string.rst b/classes/class_string.rst index 15a103378..5b9e2e9e6 100644 --- a/classes/class_string.rst +++ b/classes/class_string.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/String.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/String.xml. .. _class_String: @@ -458,16 +458,16 @@ Changes the appearance of the string: replaces underscores (``_``) with spaces, "move_local_x".capitalize() # Returns "Move Local X" "sceneFile_path".capitalize() # Returns "Scene File Path" + "2D, FPS, PNG".capitalize() # Returns "2d, Fps, Png" .. code-tab:: csharp "move_local_x".Capitalize(); // Returns "Move Local X" "sceneFile_path".Capitalize(); // Returns "Scene File Path" + "2D, FPS, PNG".Capitalize(); // Returns "2d, Fps, Png" -\ **Note:** This method not the same as the default appearance of properties in the Inspector dock, as it does not capitalize acronyms (``"2D"``, ``"FPS"``, ``"PNG"``, etc.) as you may expect. - .. rst-class:: classref-item-separator ---- @@ -671,6 +671,15 @@ Some additional handling is performed when ``values`` is an :ref:`Array<class_Ar See also the :doc:`GDScript format string <../tutorials/scripting/gdscript/gdscript_format_string>` tutorial. +\ **Note:** The replacement of placeholders is not done all at once, instead each placeholder is replaced in the order they are passed, this means that if one of the replacement strings contains a key it will also be replaced. This can be very powerful, but can also cause unexpected results if you are not careful. If you do not need to perform replacement in the replacement strings, make sure your replacements do not contain placeholders to ensure reliable results. + +:: + + print("{0} {1}".format(["{1}", "x"])) # Prints "x x". + print("{0} {1}".format(["x", "{0}"])) # Prints "x {0}". + print("{foo} {bar}".format({"foo": "{bar}", "bar": "baz"})) # Prints "baz baz". + print("{foo} {bar}".format({"bar": "baz", "foo": "{bar}"})) # Prints "{bar} baz". + \ **Note:** In C#, it's recommended to `interpolate strings with "$" <https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/tokens/interpolated>`__, instead. .. rst-class:: classref-item-separator @@ -803,7 +812,7 @@ This is faster than :ref:`split<class_String_method_split>`, if you only need on Returns the 32-bit hash value representing the string's contents. -\ **Note:** Strings with equal hash values are *not* guaranteed to be the same, as a result of hash collisions. On the countrary, strings with different hash values are guaranteed to be different. +\ **Note:** Strings with equal hash values are *not* guaranteed to be the same, as a result of hash collisions. On the contrary, strings with different hash values are guaranteed to be different. .. rst-class:: classref-item-separator @@ -1355,8 +1364,8 @@ Converts the given ``number`` to a string representation, in scientific notation .. code-tab:: gdscript var n = -5.2e8 - print(n) # Prints -520000000 - print(String.NumScientific(n)) # Prints -5.2e+08 + print(n) # Prints -520000000 + print(String.num_scientific(n)) # Prints -5.2e+08 .. code-tab:: csharp @@ -1833,7 +1842,7 @@ Converts the string representing an integer number into an :ref:`int<class_int>` :ref:`String<class_String>` **to_lower** **(** **)** |const| -Returns the string converted to lowercase. +Returns the string converted to ``lowercase``. .. rst-class:: classref-item-separator @@ -1859,6 +1868,25 @@ Returns the string converted to ``PascalCase``. Returns the string converted to ``snake_case``. +\ **Note:** Numbers followed by a *single* letter are not separated in the conversion to keep some words (such as "2D") together. + + +.. tabs:: + + .. code-tab:: gdscript + + "Node2D".to_snake_case() # Returns "node_2d" + "2nd place".to_snake_case() # Returns "2_nd_place" + "Texture3DAssetFolder".to_snake_case() # Returns "texture_3d_asset_folder" + + .. code-tab:: csharp + + "Node2D".ToSnakeCase(); // Returns "node_2d" + "2nd place".ToSnakeCase(); // Returns "2_nd_place" + "Texture3DAssetFolder".ToSnakeCase(); // Returns "texture_3d_asset_folder" + + + .. rst-class:: classref-item-separator ---- @@ -1869,7 +1897,7 @@ Returns the string converted to ``snake_case``. :ref:`String<class_String>` **to_upper** **(** **)** |const| -Returns the string converted to uppercase. +Returns the string converted to ``UPPERCASE``. .. rst-class:: classref-item-separator diff --git a/classes/class_stringname.rst b/classes/class_stringname.rst index 78f95eaec..38154d9fd 100644 --- a/classes/class_stringname.rst +++ b/classes/class_stringname.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/StringName.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/StringName.xml. .. _class_StringName: @@ -25,8 +25,14 @@ See also :ref:`NodePath<class_NodePath>`, which is a similar concept specificall All of :ref:`String<class_String>`'s methods are available in this class too. They convert the **StringName** into a string, and they also return a string. This is highly inefficient and should only be used if the string is desired. +\ **Note:** In C#, an explicit conversion to ``System.String`` is required to use the methods listed on this page. Use the ``ToString()`` method to cast a **StringName** to a string, and then use the equivalent methods in ``System.String`` or ``StringExtensions``. + \ **Note:** In a boolean context, a **StringName** will evaluate to ``false`` if it is empty (``StringName("")``). Otherwise, a **StringName** will always evaluate to ``true``. The ``not`` operator cannot be used. Instead, :ref:`is_empty<class_StringName_method_is_empty>` should be used to check for empty **StringName**\ s. +.. note:: + + There are notable differences when using this API with C#. See :ref:`doc_c_sharp_differences` for more information. + .. rst-class:: classref-reftable-group Constructors @@ -425,16 +431,16 @@ Changes the appearance of the string: replaces underscores (``_``) with spaces, "move_local_x".capitalize() # Returns "Move Local X" "sceneFile_path".capitalize() # Returns "Scene File Path" + "2D, FPS, PNG".capitalize() # Returns "2d, Fps, Png" .. code-tab:: csharp "move_local_x".Capitalize(); // Returns "Move Local X" "sceneFile_path".Capitalize(); // Returns "Scene File Path" + "2D, FPS, PNG".Capitalize(); // Returns "2d, Fps, Png" -\ **Note:** This method not the same as the default appearance of properties in the Inspector dock, as it does not capitalize acronyms (``"2D"``, ``"FPS"``, ``"PNG"``, etc.) as you may expect. - .. rst-class:: classref-item-separator ---- @@ -753,7 +759,7 @@ This is faster than :ref:`split<class_StringName_method_split>`, if you only nee Returns the 32-bit hash value representing the string's contents. -\ **Note:** Strings with equal hash values are *not* guaranteed to be the same, as a result of hash collisions. On the countrary, strings with different hash values are guaranteed to be different. +\ **Note:** Strings with equal hash values are *not* guaranteed to be the same, as a result of hash collisions. On the contrary, strings with different hash values are guaranteed to be different. .. rst-class:: classref-item-separator @@ -1672,7 +1678,7 @@ Converts the string representing an integer number into an :ref:`int<class_int>` :ref:`String<class_String>` **to_lower** **(** **)** |const| -Returns the string converted to lowercase. +Returns the string converted to ``lowercase``. .. rst-class:: classref-item-separator @@ -1698,6 +1704,25 @@ Returns the string converted to ``PascalCase``. Returns the string converted to ``snake_case``. +\ **Note:** Numbers followed by a *single* letter are not separated in the conversion to keep some words (such as "2D") together. + + +.. tabs:: + + .. code-tab:: gdscript + + "Node2D".to_snake_case() # Returns "node_2d" + "2nd place".to_snake_case() # Returns "2_nd_place" + "Texture3DAssetFolder".to_snake_case() # Returns "texture_3d_asset_folder" + + .. code-tab:: csharp + + "Node2D".ToSnakeCase(); // Returns "node_2d" + "2nd place".ToSnakeCase(); // Returns "2_nd_place" + "Texture3DAssetFolder".ToSnakeCase(); // Returns "texture_3d_asset_folder" + + + .. rst-class:: classref-item-separator ---- @@ -1708,7 +1733,7 @@ Returns the string converted to ``snake_case``. :ref:`String<class_String>` **to_upper** **(** **)** |const| -Returns the string converted to uppercase. +Returns the string converted to ``UPPERCASE``. .. rst-class:: classref-item-separator diff --git a/classes/class_stylebox.rst b/classes/class_stylebox.rst index 55a5f986b..d390f467b 100644 --- a/classes/class_stylebox.rst +++ b/classes/class_stylebox.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/StyleBox.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/StyleBox.xml. .. _class_StyleBox: diff --git a/classes/class_styleboxempty.rst b/classes/class_styleboxempty.rst index 3c0255d0a..9289ab8fc 100644 --- a/classes/class_styleboxempty.rst +++ b/classes/class_styleboxempty.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/StyleBoxEmpty.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/StyleBoxEmpty.xml. .. _class_StyleBoxEmpty: diff --git a/classes/class_styleboxflat.rst b/classes/class_styleboxflat.rst index 36a65dcb7..d5d60f483 100644 --- a/classes/class_styleboxflat.rst +++ b/classes/class_styleboxflat.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/StyleBoxFlat.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/StyleBoxFlat.xml. .. _class_StyleBoxFlat: diff --git a/classes/class_styleboxline.rst b/classes/class_styleboxline.rst index 6e39da7d8..b02e28bee 100644 --- a/classes/class_styleboxline.rst +++ b/classes/class_styleboxline.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/StyleBoxLine.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/StyleBoxLine.xml. .. _class_StyleBoxLine: diff --git a/classes/class_styleboxtexture.rst b/classes/class_styleboxtexture.rst index 8e8749ced..1223a1436 100644 --- a/classes/class_styleboxtexture.rst +++ b/classes/class_styleboxtexture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/StyleBoxTexture.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/StyleBoxTexture.xml. .. _class_StyleBoxTexture: diff --git a/classes/class_subviewport.rst b/classes/class_subviewport.rst index 890a7a73a..ae9db37fb 100644 --- a/classes/class_subviewport.rst +++ b/classes/class_subviewport.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SubViewport.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/SubViewport.xml. .. _class_SubViewport: diff --git a/classes/class_subviewportcontainer.rst b/classes/class_subviewportcontainer.rst index 4e133917c..b736ec4af 100644 --- a/classes/class_subviewportcontainer.rst +++ b/classes/class_subviewportcontainer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SubViewportContainer.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/SubViewportContainer.xml. .. _class_SubViewportContainer: diff --git a/classes/class_surfacetool.rst b/classes/class_surfacetool.rst index 012907589..4471cda7f 100644 --- a/classes/class_surfacetool.rst +++ b/classes/class_surfacetool.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SurfaceTool.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/SurfaceTool.xml. .. _class_SurfaceTool: @@ -401,7 +401,7 @@ Removes the index array by expanding the vertex array. Generates a LOD for a given ``nd_threshold`` in linear units (square root of quadric error metric), using at most ``target_index_count`` indices. -\ *Deprecated.* Unused internally and neglects to preserve normals or UVs. Consider using :ref:`ImporterMesh.generate_lods<class_ImporterMesh_method_generate_lods>` instead. +\ *Deprecated.* Unused internally and fails to preserve normals or UVs. Consider using :ref:`ImporterMesh.generate_lods<class_ImporterMesh_method_generate_lods>` instead. .. rst-class:: classref-item-separator diff --git a/classes/class_syntaxhighlighter.rst b/classes/class_syntaxhighlighter.rst index f73735a35..e1a4d3be9 100644 --- a/classes/class_syntaxhighlighter.rst +++ b/classes/class_syntaxhighlighter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SyntaxHighlighter.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/SyntaxHighlighter.xml. .. _class_SyntaxHighlighter: diff --git a/classes/class_systemfont.rst b/classes/class_systemfont.rst index 672390c4a..53d7cdfed 100644 --- a/classes/class_systemfont.rst +++ b/classes/class_systemfont.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SystemFont.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/SystemFont.xml. .. _class_SystemFont: @@ -25,7 +25,7 @@ It will attempt to match font style, but it's not guaranteed. The returned font might be part of a font collection or be a variable font with OpenType "weight", "width" and/or "italic" features set. -You can create :ref:`FontVariation<class_FontVariation>` of the system font for fine control over its features. +You can create :ref:`FontVariation<class_FontVariation>` of the system font for precise control over its features. \ **Note:** This class is implemented on iOS, Linux, macOS and Windows, on other platforms it will fallback to default theme font. diff --git a/classes/class_tabbar.rst b/classes/class_tabbar.rst index ea03bfa89..b549e76d6 100644 --- a/classes/class_tabbar.rst +++ b/classes/class_tabbar.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TabBar.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/TabBar.xml. .. _class_TabBar: diff --git a/classes/class_tabcontainer.rst b/classes/class_tabcontainer.rst index 7265cd9fe..42cb1ced4 100644 --- a/classes/class_tabcontainer.rst +++ b/classes/class_tabcontainer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TabContainer.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/TabContainer.xml. .. _class_TabContainer: @@ -423,7 +423,7 @@ If ``true``, tabs are visible. If ``false``, tabs' content and titles are hidden - void **set_use_hidden_tabs_for_min_size** **(** :ref:`bool<class_bool>` value **)** - :ref:`bool<class_bool>` **get_use_hidden_tabs_for_min_size** **(** **)** -If ``true``, children :ref:`Control<class_Control>` nodes that are hidden have their minimum size take into account in the total, instead of only the currently visible one. +If ``true``, child :ref:`Control<class_Control>` nodes that are hidden have their minimum size take into account in the total, instead of only the currently visible one. .. rst-class:: classref-section-separator diff --git a/classes/class_tcpserver.rst b/classes/class_tcpserver.rst index 7f52bfe32..08c41039d 100644 --- a/classes/class_tcpserver.rst +++ b/classes/class_tcpserver.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TCPServer.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/TCPServer.xml. .. _class_TCPServer: diff --git a/classes/class_textedit.rst b/classes/class_textedit.rst index 99c37bab9..ddea6ffee 100644 --- a/classes/class_textedit.rst +++ b/classes/class_textedit.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TextEdit.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/TextEdit.xml. .. _class_TextEdit: @@ -1134,7 +1134,7 @@ Allow moving caret, selecting and removing the individual composite character co If ``true``, a right-click moves the caret at the mouse position before displaying the context menu. -If ``false``, the context menu disregards mouse location. +If ``false``, the context menu ignores mouse location. .. rst-class:: classref-item-separator diff --git a/classes/class_textline.rst b/classes/class_textline.rst index f9c7092a7..5aacab68b 100644 --- a/classes/class_textline.rst +++ b/classes/class_textline.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TextLine.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/TextLine.xml. .. _class_TextLine: diff --git a/classes/class_textmesh.rst b/classes/class_textmesh.rst index 3eb1c2e79..a38f7882c 100644 --- a/classes/class_textmesh.rst +++ b/classes/class_textmesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TextMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/TextMesh.xml. .. _class_TextMesh: diff --git a/classes/class_textparagraph.rst b/classes/class_textparagraph.rst index a549c5f1c..fa69c291e 100644 --- a/classes/class_textparagraph.rst +++ b/classes/class_textparagraph.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TextParagraph.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/TextParagraph.xml. .. _class_TextParagraph: diff --git a/classes/class_textserver.rst b/classes/class_textserver.rst index 0ed6f5ef1..c64baf268 100644 --- a/classes/class_textserver.rst +++ b/classes/class_textserver.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TextServer.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/TextServer.xml. .. _class_TextServer: @@ -538,7 +538,7 @@ Vertical BGR subpixel layout. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_MAX** = ``5`` - +Represents the size of the :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` enum. .. rst-class:: classref-item-separator @@ -948,7 +948,7 @@ Determines whether the ellipsis at the end of the text is enforced and may not b :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_JUSTIFICATION_AWARE** = ``16`` - +Accounts for the text being justified before attempting to trim it (see :ref:`JustificationFlag<enum_TextServer_JustificationFlag>`). .. rst-class:: classref-item-separator @@ -1376,7 +1376,7 @@ Spacing at the bottom of the line. :ref:`SpacingType<enum_TextServer_SpacingType>` **SPACING_MAX** = ``4`` - +Represents the size of the :ref:`SpacingType<enum_TextServer_SpacingType>` enum. .. rst-class:: classref-item-separator diff --git a/classes/class_textserveradvanced.rst b/classes/class_textserveradvanced.rst index 819fbea5f..9db7578da 100644 --- a/classes/class_textserveradvanced.rst +++ b/classes/class_textserveradvanced.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/text_server_adv/doc_classes/TextServerAdvanced.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/text_server_adv/doc_classes/TextServerAdvanced.xml. .. _class_TextServerAdvanced: diff --git a/classes/class_textserverdummy.rst b/classes/class_textserverdummy.rst index 8e65c928b..2c44cd16b 100644 --- a/classes/class_textserverdummy.rst +++ b/classes/class_textserverdummy.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TextServerDummy.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/TextServerDummy.xml. .. _class_TextServerDummy: diff --git a/classes/class_textserverextension.rst b/classes/class_textserverextension.rst index c83473dee..6fefa6d93 100644 --- a/classes/class_textserverextension.rst +++ b/classes/class_textserverextension.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TextServerExtension.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/TextServerExtension.xml. .. _class_TextServerExtension: diff --git a/classes/class_textserverfallback.rst b/classes/class_textserverfallback.rst index 69a98d507..cd7faa743 100644 --- a/classes/class_textserverfallback.rst +++ b/classes/class_textserverfallback.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/text_server_fb/doc_classes/TextServerFallback.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/text_server_fb/doc_classes/TextServerFallback.xml. .. _class_TextServerFallback: diff --git a/classes/class_textservermanager.rst b/classes/class_textservermanager.rst index 0932f6e0c..9f12005ac 100644 --- a/classes/class_textservermanager.rst +++ b/classes/class_textservermanager.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TextServerManager.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/TextServerManager.xml. .. _class_TextServerManager: diff --git a/classes/class_texture.rst b/classes/class_texture.rst index 246ba9a41..9a145c066 100644 --- a/classes/class_texture.rst +++ b/classes/class_texture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Texture.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Texture.xml. .. _class_Texture: diff --git a/classes/class_texture2d.rst b/classes/class_texture2d.rst index 46787e5a7..f0a08c70f 100644 --- a/classes/class_texture2d.rst +++ b/classes/class_texture2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Texture2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Texture2D.xml. .. _class_Texture2D: @@ -238,6 +238,8 @@ Returns the texture height in pixels. Returns an :ref:`Image<class_Image>` that is a copy of data from this **Texture2D** (a new :ref:`Image<class_Image>` is created each time). :ref:`Image<class_Image>`\ s can be accessed and manipulated directly. +\ **Note:** This will return ``null`` if this **Texture2D** is invalid. + \ **Note:** This will fetch the texture data from the GPU, which might cause performance problems when overused. .. rst-class:: classref-item-separator diff --git a/classes/class_texture2darray.rst b/classes/class_texture2darray.rst index c5684ef19..9db7bef68 100644 --- a/classes/class_texture2darray.rst +++ b/classes/class_texture2darray.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Texture2DArray.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Texture2DArray.xml. .. _class_Texture2DArray: diff --git a/classes/class_texture2darrayrd.rst b/classes/class_texture2darrayrd.rst index 80b6ba946..ef2f819ee 100644 --- a/classes/class_texture2darrayrd.rst +++ b/classes/class_texture2darrayrd.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Texture2DArrayRD.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Texture2DArrayRD.xml. .. _class_Texture2DArrayRD: diff --git a/classes/class_texture2drd.rst b/classes/class_texture2drd.rst index c4246a053..e543b8672 100644 --- a/classes/class_texture2drd.rst +++ b/classes/class_texture2drd.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Texture2DRD.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Texture2DRD.xml. .. _class_Texture2DRD: diff --git a/classes/class_texture3d.rst b/classes/class_texture3d.rst index 58b4e527f..d486fd825 100644 --- a/classes/class_texture3d.rst +++ b/classes/class_texture3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Texture3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Texture3D.xml. .. _class_Texture3D: @@ -14,7 +14,7 @@ Texture3D **Inherited By:** :ref:`CompressedTexture3D<class_CompressedTexture3D>`, :ref:`ImageTexture3D<class_ImageTexture3D>`, :ref:`NoiseTexture3D<class_NoiseTexture3D>`, :ref:`PlaceholderTexture3D<class_PlaceholderTexture3D>`, :ref:`Texture3DRD<class_Texture3DRD>` -Base class for 3-dimensionnal textures. +Base class for 3-dimensional textures. .. rst-class:: classref-introduction-group diff --git a/classes/class_texture3drd.rst b/classes/class_texture3drd.rst index 08425d55e..39b5eb48d 100644 --- a/classes/class_texture3drd.rst +++ b/classes/class_texture3drd.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Texture3DRD.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Texture3DRD.xml. .. _class_Texture3DRD: diff --git a/classes/class_texturebutton.rst b/classes/class_texturebutton.rst index a85310ec4..8e25f7e3b 100644 --- a/classes/class_texturebutton.rst +++ b/classes/class_texturebutton.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TextureButton.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/TextureButton.xml. .. _class_TextureButton: diff --git a/classes/class_texturecubemaparrayrd.rst b/classes/class_texturecubemaparrayrd.rst index f4bc4ef43..1bbc85bf3 100644 --- a/classes/class_texturecubemaparrayrd.rst +++ b/classes/class_texturecubemaparrayrd.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TextureCubemapArrayRD.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/TextureCubemapArrayRD.xml. .. _class_TextureCubemapArrayRD: diff --git a/classes/class_texturecubemaprd.rst b/classes/class_texturecubemaprd.rst index aae757029..f21da381d 100644 --- a/classes/class_texturecubemaprd.rst +++ b/classes/class_texturecubemaprd.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TextureCubemapRD.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/TextureCubemapRD.xml. .. _class_TextureCubemapRD: diff --git a/classes/class_texturelayered.rst b/classes/class_texturelayered.rst index 45af51b26..fb1b30924 100644 --- a/classes/class_texturelayered.rst +++ b/classes/class_texturelayered.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TextureLayered.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/TextureLayered.xml. .. _class_TextureLayered: diff --git a/classes/class_texturelayeredrd.rst b/classes/class_texturelayeredrd.rst index 538432cf5..c8a0932ee 100644 --- a/classes/class_texturelayeredrd.rst +++ b/classes/class_texturelayeredrd.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TextureLayeredRD.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/TextureLayeredRD.xml. .. _class_TextureLayeredRD: diff --git a/classes/class_textureprogressbar.rst b/classes/class_textureprogressbar.rst index d8ab21094..b3d0b65a2 100644 --- a/classes/class_textureprogressbar.rst +++ b/classes/class_textureprogressbar.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TextureProgressBar.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/TextureProgressBar.xml. .. _class_TextureProgressBar: diff --git a/classes/class_texturerect.rst b/classes/class_texturerect.rst index cadc1baca..24bccc1e7 100644 --- a/classes/class_texturerect.rst +++ b/classes/class_texturerect.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TextureRect.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/TextureRect.xml. .. _class_TextureRect: diff --git a/classes/class_theme.rst b/classes/class_theme.rst index 591f06a84..a2d233194 100644 --- a/classes/class_theme.rst +++ b/classes/class_theme.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Theme.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Theme.xml. .. _class_Theme: diff --git a/classes/class_themedb.rst b/classes/class_themedb.rst index 588be34ff..3fd6748f3 100644 --- a/classes/class_themedb.rst +++ b/classes/class_themedb.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ThemeDB.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ThemeDB.xml. .. _class_ThemeDB: diff --git a/classes/class_thread.rst b/classes/class_thread.rst index db581ef55..c6dd390ad 100644 --- a/classes/class_thread.rst +++ b/classes/class_thread.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Thread.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Thread.xml. .. _class_Thread: diff --git a/classes/class_tiledata.rst b/classes/class_tiledata.rst index db8f6c0bb..cd6003cd8 100644 --- a/classes/class_tiledata.rst +++ b/classes/class_tiledata.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TileData.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/TileData.xml. .. _class_TileData: diff --git a/classes/class_tilemap.rst b/classes/class_tilemap.rst index c423ab2da..b5c150970 100644 --- a/classes/class_tilemap.rst +++ b/classes/class_tilemap.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TileMap.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/TileMap.xml. .. _class_TileMap: @@ -21,7 +21,7 @@ Description Node for 2D tile-based maps. Tilemaps use a :ref:`TileSet<class_TileSet>` which contain a list of tiles which are used to create grid-based maps. A TileMap may have several layers, layouting tiles on top of each other. -For performance reasons, all TileMap updates are batched at the end of a frame. Notably, this means that scene tiles from a :ref:`TileSetScenesCollectionSource<class_TileSetScenesCollectionSource>` may be initialized after their parent. +For performance reasons, all TileMap updates are batched at the end of a frame. Notably, this means that scene tiles from a :ref:`TileSetScenesCollectionSource<class_TileSetScenesCollectionSource>` may be initialized after their parent. This is only queued when inside the scene tree. To force an update earlier on, call :ref:`update_internals<class_TileMap_method_update_internals>`. diff --git a/classes/class_tilemappattern.rst b/classes/class_tilemappattern.rst index ed7bdd34f..b7dd87bf8 100644 --- a/classes/class_tilemappattern.rst +++ b/classes/class_tilemappattern.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TileMapPattern.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/TileMapPattern.xml. .. _class_TileMapPattern: diff --git a/classes/class_tileset.rst b/classes/class_tileset.rst index e46cf3364..bb2ef807c 100644 --- a/classes/class_tileset.rst +++ b/classes/class_tileset.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TileSet.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/TileSet.xml. .. _class_TileSet: diff --git a/classes/class_tilesetatlassource.rst b/classes/class_tilesetatlassource.rst index 8b2f0d31f..f5993688e 100644 --- a/classes/class_tilesetatlassource.rst +++ b/classes/class_tilesetatlassource.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TileSetAtlasSource.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/TileSetAtlasSource.xml. .. _class_TileSetAtlasSource: diff --git a/classes/class_tilesetscenescollectionsource.rst b/classes/class_tilesetscenescollectionsource.rst index 10e762131..04919845b 100644 --- a/classes/class_tilesetscenescollectionsource.rst +++ b/classes/class_tilesetscenescollectionsource.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TileSetScenesCollectionSource.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/TileSetScenesCollectionSource.xml. .. _class_TileSetScenesCollectionSource: diff --git a/classes/class_tilesetsource.rst b/classes/class_tilesetsource.rst index 479f32b67..dd96e6db2 100644 --- a/classes/class_tilesetsource.rst +++ b/classes/class_tilesetsource.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TileSetSource.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/TileSetSource.xml. .. _class_TileSetSource: diff --git a/classes/class_time.rst b/classes/class_time.rst index e9717ca61..6754434be 100644 --- a/classes/class_time.rst +++ b/classes/class_time.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Time.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Time.xml. .. _class_Time: @@ -25,7 +25,7 @@ This class conforms with as many of the ISO 8601 standards as possible. All date Conversion methods assume "the same timezone", and do not handle timezone conversions or DST automatically. Leap seconds are also not handled, they must be done manually if desired. Suffixes such as "Z" are not handled, you need to strip them away manually. -When getting time information from the system, the time can either be in the local timezone or UTC depending on the ``utc`` parameter. However, the :ref:`get_unix_time_from_system<class_Time_method_get_unix_time_from_system>` method always returns the time in UTC. +When getting time information from the system, the time can either be in the local timezone or UTC depending on the ``utc`` parameter. However, the :ref:`get_unix_time_from_system<class_Time_method_get_unix_time_from_system>` method always uses UTC as it returns the seconds passed since the `Unix epoch <https://en.wikipedia.org/wiki/Unix_time>`__. \ **Important:** The ``_from_system`` methods use the system clock that the user can manually set. **Never use** this method for precise time calculation since its results are subject to automatic adjustments by the user or the operating system. **Always use** :ref:`get_ticks_usec<class_Time_method_get_ticks_usec>` or :ref:`get_ticks_msec<class_Time_method_get_ticks_msec>` for precise time calculation instead, since they are guaranteed to be monotonic (i.e. never decrease). @@ -559,7 +559,7 @@ Converts the given ISO 8601 date and/or time string to a Unix timestamp. The str :ref:`float<class_float>` **get_unix_time_from_system** **(** **)** |const| -Returns the current Unix timestamp in seconds based on the system time in UTC. This method is implemented by the operating system and always returns the time in UTC. +Returns the current Unix timestamp in seconds based on the system time in UTC. This method is implemented by the operating system and always returns the time in UTC. The Unix timestamp is the number of seconds passed since 1970-01-01 at 00:00:00, the `Unix epoch <https://en.wikipedia.org/wiki/Unix_time>`__. \ **Note:** Unlike other methods that use integer timestamps, this method returns the timestamp as a :ref:`float<class_float>` for sub-second precision. diff --git a/classes/class_timer.rst b/classes/class_timer.rst index e01b1559e..7c0c69a1e 100644 --- a/classes/class_timer.rst +++ b/classes/class_timer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Timer.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Timer.xml. .. _class_Timer: diff --git a/classes/class_tlsoptions.rst b/classes/class_tlsoptions.rst index 8a31c59db..71a79f89f 100644 --- a/classes/class_tlsoptions.rst +++ b/classes/class_tlsoptions.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TLSOptions.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/TLSOptions.xml. .. _class_TLSOptions: diff --git a/classes/class_torusmesh.rst b/classes/class_torusmesh.rst index c10730f15..cf864bf57 100644 --- a/classes/class_torusmesh.rst +++ b/classes/class_torusmesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TorusMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/TorusMesh.xml. .. _class_TorusMesh: diff --git a/classes/class_touchscreenbutton.rst b/classes/class_touchscreenbutton.rst index 30d20a4a2..962ec6386 100644 --- a/classes/class_touchscreenbutton.rst +++ b/classes/class_touchscreenbutton.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TouchScreenButton.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/TouchScreenButton.xml. .. _class_TouchScreenButton: diff --git a/classes/class_transform2d.rst b/classes/class_transform2d.rst index cc9eb73dc..e5a73bed5 100644 --- a/classes/class_transform2d.rst +++ b/classes/class_transform2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Transform2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Transform2D.xml. .. _class_Transform2D: @@ -19,7 +19,7 @@ Description A 2×3 matrix (2 rows, 3 columns) used for 2D linear transformations. It can represent transformations such as translation, rotation, and scaling. It consists of three :ref:`Vector2<class_Vector2>` values: :ref:`x<class_Transform2D_property_x>`, :ref:`y<class_Transform2D_property_y>`, and the :ref:`origin<class_Transform2D_property_origin>`. -For more information, read the "Matrices and transforms" documentation article. +For a general introduction, see the :doc:`Matrices and transforms <../tutorials/math/matrices_and_transforms>` tutorial. .. note:: diff --git a/classes/class_transform3d.rst b/classes/class_transform3d.rst index 68eb7cf70..9526a4163 100644 --- a/classes/class_transform3d.rst +++ b/classes/class_transform3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Transform3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Transform3D.xml. .. _class_Transform3D: @@ -17,9 +17,11 @@ A 3×4 matrix representing a 3D transformation. Description ----------- -A 3×4 matrix (3 rows, 4 columns) used for 3D linear transformations. It can represent transformations such as translation, rotation, and scaling. It consists of a :ref:`basis<class_Transform3D_property_basis>` (first 3 columns) and a :ref:`Vector3<class_Vector3>` for the :ref:`origin<class_Transform3D_property_origin>` (last column). +The **Transform3D** built-in :ref:`Variant<class_Variant>` type is a 3×4 matrix representing a transformation in 3D space. It contains a :ref:`Basis<class_Basis>`, which on its own can represent rotation, scale, and shear. Additionally, combined with its own :ref:`origin<class_Transform3D_property_origin>`, the transform can also represent a translation. -For more information, read the "Matrices and transforms" documentation article. +For a general introduction, see the :doc:`Matrices and transforms <../tutorials/math/matrices_and_transforms>` tutorial. + +\ **Note:** Godot uses a `right-handed coordinate system <https://en.wikipedia.org/wiki/Right-hand_rule>`__, which is a common standard. For directions, the convention for built-in types like :ref:`Camera3D<class_Camera3D>` is for -Z to point forward (+X is right, +Y is up, and +Z is back). Other objects may use different direction conventions. For more information, see the `Importing 3D Scenes <../tutorials/assets_pipeline/importing_scenes.html#d-asset-direction-conventions>`__ tutorial. .. note:: @@ -155,7 +157,9 @@ Constants **IDENTITY** = ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` -**Transform3D** with no translation, rotation or scaling applied. When applied to other data structures, :ref:`IDENTITY<class_Transform3D_constant_IDENTITY>` performs no transformation. +A transform with no translation, no rotation, and its scale being ``1``. Its :ref:`basis<class_Transform3D_property_basis>` is equal to :ref:`Basis.IDENTITY<class_Basis_constant_IDENTITY>`. + +When multiplied by another :ref:`Variant<class_Variant>` such as :ref:`AABB<class_AABB>` or another **Transform3D**, no transformation occurs. .. _class_Transform3D_constant_FLIP_X: @@ -163,7 +167,7 @@ Constants **FLIP_X** = ``Transform3D(-1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` -**Transform3D** with mirroring applied perpendicular to the YZ plane. +**Transform3D** with mirroring applied perpendicular to the YZ plane. Its :ref:`basis<class_Transform3D_property_basis>` is equal to :ref:`Basis.FLIP_X<class_Basis_constant_FLIP_X>`. .. _class_Transform3D_constant_FLIP_Y: @@ -171,7 +175,7 @@ Constants **FLIP_Y** = ``Transform3D(1, 0, 0, 0, -1, 0, 0, 0, 1, 0, 0, 0)`` -**Transform3D** with mirroring applied perpendicular to the XZ plane. +**Transform3D** with mirroring applied perpendicular to the XZ plane. Its :ref:`basis<class_Transform3D_property_basis>` is equal to :ref:`Basis.FLIP_Y<class_Basis_constant_FLIP_Y>`. .. _class_Transform3D_constant_FLIP_Z: @@ -179,7 +183,7 @@ Constants **FLIP_Z** = ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, -1, 0, 0, 0)`` -**Transform3D** with mirroring applied perpendicular to the XY plane. +**Transform3D** with mirroring applied perpendicular to the XY plane. Its :ref:`basis<class_Transform3D_property_basis>` is equal to :ref:`Basis.FLIP_Z<class_Basis_constant_FLIP_Z>`. .. rst-class:: classref-section-separator @@ -196,7 +200,7 @@ Property Descriptions :ref:`Basis<class_Basis>` **basis** = ``Basis(1, 0, 0, 0, 1, 0, 0, 0, 1)`` -The basis is a matrix containing 3 :ref:`Vector3<class_Vector3>` as its columns: X axis, Y axis, and Z axis. These vectors can be interpreted as the basis vectors of local coordinate system traveling with the object. +The :ref:`Basis<class_Basis>` of this transform. It is composed by 3 axes (:ref:`Basis.x<class_Basis_property_x>`, :ref:`Basis.y<class_Basis_property_y>`, and :ref:`Basis.z<class_Basis_property_z>`). Together, these represent the transform's rotation, scale, and shear. .. rst-class:: classref-item-separator @@ -208,7 +212,7 @@ The basis is a matrix containing 3 :ref:`Vector3<class_Vector3>` as its columns: :ref:`Vector3<class_Vector3>` **origin** = ``Vector3(0, 0, 0)`` -The translation offset of the transform (column 3, the fourth column). Equivalent to array index ``3``. +The translation offset of this transform. In 3D space, this can be seen as the position. .. rst-class:: classref-section-separator @@ -225,7 +229,7 @@ Constructor Descriptions :ref:`Transform3D<class_Transform3D>` **Transform3D** **(** **)** -Constructs a default-initialized **Transform3D** set to :ref:`IDENTITY<class_Transform3D_constant_IDENTITY>`. +Constructs a **Transform3D** identical to the :ref:`IDENTITY<class_Transform3D_constant_IDENTITY>`. .. rst-class:: classref-item-separator @@ -245,7 +249,7 @@ Constructs a **Transform3D** as a copy of the given **Transform3D**. :ref:`Transform3D<class_Transform3D>` **Transform3D** **(** :ref:`Basis<class_Basis>` basis, :ref:`Vector3<class_Vector3>` origin **)** -Constructs a Transform3D from a :ref:`Basis<class_Basis>` and :ref:`Vector3<class_Vector3>`. +Constructs a **Transform3D** from a :ref:`Basis<class_Basis>` and :ref:`Vector3<class_Vector3>`. .. rst-class:: classref-item-separator @@ -255,7 +259,7 @@ Constructs a Transform3D from a :ref:`Basis<class_Basis>` and :ref:`Vector3<clas :ref:`Transform3D<class_Transform3D>` **Transform3D** **(** :ref:`Projection<class_Projection>` from **)** -Constructs a Transform3D from a :ref:`Projection<class_Projection>` by trimming the last row of the projection matrix (``from.x.w``, ``from.y.w``, ``from.z.w``, and ``from.w.w`` are not copied over). +Constructs a **Transform3D** from a :ref:`Projection<class_Projection>`. Because **Transform3D** is a 3×4 matrix and :ref:`Projection<class_Projection>` is a 4×4 matrix, this operation trims the last row of the projection matrix (``from.x.w``, ``from.y.w``, ``from.z.w``, and ``from.w.w`` are not included in the new transform). .. rst-class:: classref-item-separator @@ -265,7 +269,9 @@ Constructs a Transform3D from a :ref:`Projection<class_Projection>` by trimming :ref:`Transform3D<class_Transform3D>` **Transform3D** **(** :ref:`Vector3<class_Vector3>` x_axis, :ref:`Vector3<class_Vector3>` y_axis, :ref:`Vector3<class_Vector3>` z_axis, :ref:`Vector3<class_Vector3>` origin **)** -Constructs a Transform3D from four :ref:`Vector3<class_Vector3>` values (matrix columns). Each axis corresponds to local basis vectors (some of which may be scaled). +Constructs a **Transform3D** from four :ref:`Vector3<class_Vector3>` values (also called matrix columns). + +The first three arguments are the :ref:`basis<class_Transform3D_property_basis>`'s axes (:ref:`Basis.x<class_Basis_property_x>`, :ref:`Basis.y<class_Basis_property_y>`, and :ref:`Basis.z<class_Basis_property_z>`). .. rst-class:: classref-section-separator @@ -282,7 +288,9 @@ Method Descriptions :ref:`Transform3D<class_Transform3D>` **affine_inverse** **(** **)** |const| -Returns the inverse of the transform, under the assumption that the basis is invertible (must have non-zero determinant). +Returns the inverted version of this transform. Unlike :ref:`inverse<class_Transform3D_method_inverse>`, this method works with almost any :ref:`basis<class_Transform3D_property_basis>`, including non-uniform ones, but is slower. See also :ref:`Basis.inverse<class_Basis_method_inverse>`. + +\ **Note:** For this method to return correctly, the transform's :ref:`basis<class_Transform3D_property_basis>` needs to have a determinant that is not exactly ``0`` (see :ref:`Basis.determinant<class_Basis_method_determinant>`). .. rst-class:: classref-item-separator @@ -294,7 +302,9 @@ Returns the inverse of the transform, under the assumption that the basis is inv :ref:`Transform3D<class_Transform3D>` **interpolate_with** **(** :ref:`Transform3D<class_Transform3D>` xform, :ref:`float<class_float>` weight **)** |const| -Returns a transform interpolated between this transform and another by a given ``weight`` (on the range of 0.0 to 1.0). +Returns the result of the linear interpolation between this transform and ``xform`` by the given ``weight``. + +The ``weight`` should be between ``0.0`` and ``1.0`` (inclusive). Values outside this range are allowed and can be used to perform *extrapolation* instead. .. rst-class:: classref-item-separator @@ -306,7 +316,9 @@ Returns a transform interpolated between this transform and another by a given ` :ref:`Transform3D<class_Transform3D>` **inverse** **(** **)** |const| -Returns the inverse of the transform, under the assumption that the transformation basis is orthonormal (i.e. rotation/reflection is fine, scaling/skew is not). Use :ref:`affine_inverse<class_Transform3D_method_affine_inverse>` for non-orthonormal transforms (e.g. with scaling). +Returns the inverted version of this transform. See also :ref:`Basis.inverse<class_Basis_method_inverse>`. + +\ **Note:** For this method to return correctly, the transform's :ref:`basis<class_Transform3D_property_basis>` needs to be *orthonormal* (see :ref:`Basis.orthonormalized<class_Basis_method_orthonormalized>`). That means, the basis should only represent a rotation. If it does not, use :ref:`affine_inverse<class_Transform3D_method_affine_inverse>` instead. .. rst-class:: classref-item-separator @@ -342,7 +354,7 @@ Returns ``true`` if this transform is finite, by calling :ref:`@GlobalScope.is_f :ref:`Transform3D<class_Transform3D>` **looking_at** **(** :ref:`Vector3<class_Vector3>` target, :ref:`Vector3<class_Vector3>` up=Vector3(0, 1, 0), :ref:`bool<class_bool>` use_model_front=false **)** |const| -Returns a copy of the transform rotated such that the forward axis (-Z) points towards the ``target`` position. +Returns a copy of this transform rotated so that the forward axis (-Z) points towards the ``target`` position. The up axis (+Y) points as close to the ``up`` vector as possible while staying perpendicular to the forward axis. The resulting transform is orthonormalized. The existing rotation, scale, and skew information from the original transform is discarded. The ``target`` and ``up`` vectors cannot be zero, cannot be parallel to each other, and are defined in global/parent space. @@ -358,7 +370,7 @@ If ``use_model_front`` is ``true``, the +Z axis (asset front) is treated as forw :ref:`Transform3D<class_Transform3D>` **orthonormalized** **(** **)** |const| -Returns the transform with the basis orthogonal (90 degrees), and normalized axis vectors (scale of 1 or -1). +Returns a copy of this transform with its :ref:`basis<class_Transform3D_property_basis>` orthonormalized. An orthonormal basis is both *orthogonal* (the axes are perpendicular to each other) and *normalized* (the axes have a length of ``1``), which also means it can only represent rotation. See also :ref:`Basis.orthonormalized<class_Basis_method_orthonormalized>`. .. rst-class:: classref-item-separator @@ -370,7 +382,7 @@ Returns the transform with the basis orthogonal (90 degrees), and normalized axi :ref:`Transform3D<class_Transform3D>` **rotated** **(** :ref:`Vector3<class_Vector3>` axis, :ref:`float<class_float>` angle **)** |const| -Returns a copy of the transform rotated around the given ``axis`` by the given ``angle`` (in radians). +Returns a copy of this transform rotated around the given ``axis`` by the given ``angle`` (in radians). The ``axis`` must be a normalized vector. @@ -388,7 +400,7 @@ This can be seen as transforming with respect to the global/parent frame. :ref:`Transform3D<class_Transform3D>` **rotated_local** **(** :ref:`Vector3<class_Vector3>` axis, :ref:`float<class_float>` angle **)** |const| -Returns a copy of the transform rotated around the given ``axis`` by the given ``angle`` (in radians). +Returns a copy of this transform rotated around the given ``axis`` by the given ``angle`` (in radians). The ``axis`` must be a normalized vector. @@ -406,7 +418,7 @@ This can be seen as transforming with respect to the local frame. :ref:`Transform3D<class_Transform3D>` **scaled** **(** :ref:`Vector3<class_Vector3>` scale **)** |const| -Returns a copy of the transform scaled by the given ``scale`` factor. +Returns a copy of this transform scaled by the given ``scale`` factor. This method is an optimized version of multiplying the given transform ``X`` with a corresponding scaling transform ``S`` from the left, i.e., ``S * X``. @@ -422,7 +434,7 @@ This can be seen as transforming with respect to the global/parent frame. :ref:`Transform3D<class_Transform3D>` **scaled_local** **(** :ref:`Vector3<class_Vector3>` scale **)** |const| -Returns a copy of the transform scaled by the given ``scale`` factor. +Returns a copy of this transform scaled by the given ``scale`` factor. This method is an optimized version of multiplying the given transform ``X`` with a corresponding scaling transform ``S`` from the right, i.e., ``X * S``. @@ -438,7 +450,7 @@ This can be seen as transforming with respect to the local frame. :ref:`Transform3D<class_Transform3D>` **translated** **(** :ref:`Vector3<class_Vector3>` offset **)** |const| -Returns a copy of the transform translated by the given ``offset``. +Returns a copy of this transform translated by the given ``offset``. This method is an optimized version of multiplying the given transform ``X`` with a corresponding translation transform ``T`` from the left, i.e., ``T * X``. @@ -454,7 +466,7 @@ This can be seen as transforming with respect to the global/parent frame. :ref:`Transform3D<class_Transform3D>` **translated_local** **(** :ref:`Vector3<class_Vector3>` offset **)** |const| -Returns a copy of the transform translated by the given ``offset``. +Returns a copy of this transform translated by the given ``offset``. This method is an optimized version of multiplying the given transform ``X`` with a corresponding translation transform ``T`` from the right, i.e., ``X * T``. @@ -475,7 +487,7 @@ Operator Descriptions :ref:`bool<class_bool>` **operator !=** **(** :ref:`Transform3D<class_Transform3D>` right **)** -Returns ``true`` if the transforms are not equal. +Returns ``true`` if the components of both transforms are not equal. \ **Note:** Due to floating-point precision errors, consider using :ref:`is_equal_approx<class_Transform3D_method_is_equal_approx>` instead, which is more reliable. @@ -489,7 +501,7 @@ Returns ``true`` if the transforms are not equal. :ref:`AABB<class_AABB>` **operator *** **(** :ref:`AABB<class_AABB>` right **)** -Transforms (multiplies) the :ref:`AABB<class_AABB>` by the given **Transform3D** matrix. +Transforms (multiplies) the :ref:`AABB<class_AABB>` by this transformation matrix. .. rst-class:: classref-item-separator @@ -501,7 +513,9 @@ Transforms (multiplies) the :ref:`AABB<class_AABB>` by the given **Transform3D** :ref:`PackedVector3Array<class_PackedVector3Array>` **operator *** **(** :ref:`PackedVector3Array<class_PackedVector3Array>` right **)** -Transforms (multiplies) each element of the :ref:`Vector3<class_Vector3>` array by the given **Transform3D** matrix. +Transforms (multiplies) every :ref:`Vector3<class_Vector3>` element of the given :ref:`PackedVector3Array<class_PackedVector3Array>` by this transformation matrix. + +On larger arrays, this operation is much faster than transforming each :ref:`Vector3<class_Vector3>` individually. .. rst-class:: classref-item-separator @@ -513,7 +527,7 @@ Transforms (multiplies) each element of the :ref:`Vector3<class_Vector3>` array :ref:`Plane<class_Plane>` **operator *** **(** :ref:`Plane<class_Plane>` right **)** -Transforms (multiplies) the :ref:`Plane<class_Plane>` by the given **Transform3D** transformation matrix. +Transforms (multiplies) the :ref:`Plane<class_Plane>` by this transformation matrix. .. rst-class:: classref-item-separator @@ -525,7 +539,17 @@ Transforms (multiplies) the :ref:`Plane<class_Plane>` by the given **Transform3D :ref:`Transform3D<class_Transform3D>` **operator *** **(** :ref:`Transform3D<class_Transform3D>` right **)** -Composes these two transformation matrices by multiplying them together. This has the effect of transforming the second transform (the child) by the first transform (the parent). +Transforms (multiplies) this transform by the ``right`` transform. + +This is the operation performed between parent and child :ref:`Node3D<class_Node3D>`\ s. + +\ **Note:** If you need to only modify one attribute of this transform, consider using one of the following methods, instead: + +- For translation, see :ref:`translated<class_Transform3D_method_translated>` or :ref:`translated_local<class_Transform3D_method_translated_local>`. + +- For rotation, see :ref:`rotated<class_Transform3D_method_rotated>` or :ref:`rotated_local<class_Transform3D_method_rotated_local>`. + +- For scale, see :ref:`scaled<class_Transform3D_method_scaled>` or :ref:`scaled_local<class_Transform3D_method_scaled_local>`. .. rst-class:: classref-item-separator @@ -537,7 +561,7 @@ Composes these two transformation matrices by multiplying them together. This ha :ref:`Vector3<class_Vector3>` **operator *** **(** :ref:`Vector3<class_Vector3>` right **)** -Transforms (multiplies) the :ref:`Vector3<class_Vector3>` by the given **Transform3D** matrix. +Transforms (multiplies) the :ref:`Vector3<class_Vector3>` by this transformation matrix. .. rst-class:: classref-item-separator @@ -549,7 +573,7 @@ Transforms (multiplies) the :ref:`Vector3<class_Vector3>` by the given **Transfo :ref:`Transform3D<class_Transform3D>` **operator *** **(** :ref:`float<class_float>` right **)** -This operator multiplies all components of the **Transform3D**, including the :ref:`origin<class_Transform3D_property_origin>` vector, which scales it uniformly. +Multiplies all components of the **Transform3D** by the given :ref:`float<class_float>`, including the :ref:`origin<class_Transform3D_property_origin>`. This affects the transform's scale uniformly, scaling the :ref:`basis<class_Transform3D_property_basis>`. .. rst-class:: classref-item-separator @@ -561,7 +585,7 @@ This operator multiplies all components of the **Transform3D**, including the :r :ref:`Transform3D<class_Transform3D>` **operator *** **(** :ref:`int<class_int>` right **)** -This operator multiplies all components of the **Transform3D**, including the :ref:`origin<class_Transform3D_property_origin>` vector, which scales it uniformly. +Multiplies all components of the **Transform3D** by the given :ref:`int<class_int>`, including the :ref:`origin<class_Transform3D_property_origin>`. This affects the transform's scale uniformly, scaling the :ref:`basis<class_Transform3D_property_basis>`. .. rst-class:: classref-item-separator @@ -573,7 +597,7 @@ This operator multiplies all components of the **Transform3D**, including the :r :ref:`bool<class_bool>` **operator ==** **(** :ref:`Transform3D<class_Transform3D>` right **)** -Returns ``true`` if the transforms are exactly equal. +Returns ``true`` if the components of both transforms are exactly equal. \ **Note:** Due to floating-point precision errors, consider using :ref:`is_equal_approx<class_Transform3D_method_is_equal_approx>` instead, which is more reliable. diff --git a/classes/class_translation.rst b/classes/class_translation.rst index b77297381..3f94ef96d 100644 --- a/classes/class_translation.rst +++ b/classes/class_translation.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Translation.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Translation.xml. .. _class_Translation: diff --git a/classes/class_translationserver.rst b/classes/class_translationserver.rst index f66b5e567..c81851254 100644 --- a/classes/class_translationserver.rst +++ b/classes/class_translationserver.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TranslationServer.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/TranslationServer.xml. .. _class_TranslationServer: diff --git a/classes/class_tree.rst b/classes/class_tree.rst index 5228f1d0c..78991d373 100644 --- a/classes/class_tree.rst +++ b/classes/class_tree.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Tree.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Tree.xml. .. _class_Tree: diff --git a/classes/class_treeitem.rst b/classes/class_treeitem.rst index 58acc52d5..73374c6a8 100644 --- a/classes/class_treeitem.rst +++ b/classes/class_treeitem.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TreeItem.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/TreeItem.xml. .. _class_TreeItem: diff --git a/classes/class_trianglemesh.rst b/classes/class_trianglemesh.rst index 0c8228f9a..76cda79a8 100644 --- a/classes/class_trianglemesh.rst +++ b/classes/class_trianglemesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TriangleMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/TriangleMesh.xml. .. _class_TriangleMesh: diff --git a/classes/class_tubetrailmesh.rst b/classes/class_tubetrailmesh.rst index 4adc96da0..7196e577c 100644 --- a/classes/class_tubetrailmesh.rst +++ b/classes/class_tubetrailmesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TubeTrailMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/TubeTrailMesh.xml. .. _class_TubeTrailMesh: diff --git a/classes/class_tween.rst b/classes/class_tween.rst index a427e5eb6..65bda064c 100644 --- a/classes/class_tween.rst +++ b/classes/class_tween.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Tween.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Tween.xml. .. _class_Tween: @@ -21,7 +21,7 @@ Description Tweens are mostly useful for animations requiring a numerical property to be interpolated over a range of values. The name *tween* comes from *in-betweening*, an animation technique where you specify *keyframes* and the computer interpolates the frames that appear between them. Animating something with a **Tween** is called tweening. -\ **Tween** is more suited than :ref:`AnimationPlayer<class_AnimationPlayer>` for animations where you don't know the final values in advance. For example, interpolating a dynamically-chosen camera zoom value is best done with a **Tween**; it would be difficult to do the same thing with an :ref:`AnimationPlayer<class_AnimationPlayer>` node. Tweens are also more light-weight than :ref:`AnimationPlayer<class_AnimationPlayer>`, so they are very much suited for simple animations or general tasks that don't require visual tweaking provided by the editor. They can be used in a fire-and-forget manner for some logic that normally would be done by code. You can e.g. make something shoot periodically by using a looped :ref:`CallbackTweener<class_CallbackTweener>` with a delay. +\ **Tween** is more suited than :ref:`AnimationPlayer<class_AnimationPlayer>` for animations where you don't know the final values in advance. For example, interpolating a dynamically-chosen camera zoom value is best done with a **Tween**; it would be difficult to do the same thing with an :ref:`AnimationPlayer<class_AnimationPlayer>` node. Tweens are also more light-weight than :ref:`AnimationPlayer<class_AnimationPlayer>`, so they are very much suited for simple animations or general tasks that don't require visual tweaking provided by the editor. They can be used in a "fire-and-forget" manner for some logic that normally would be done by code. You can e.g. make something shoot periodically by using a looped :ref:`CallbackTweener<class_CallbackTweener>` with a delay. A **Tween** can be created by using either :ref:`SceneTree.create_tween<class_SceneTree_method_create_tween>` or :ref:`Node.create_tween<class_Node_method_create_tween>`. **Tween**\ s created manually (i.e. by using ``Tween.new()``) are invalid and can't be used for tweening values. @@ -710,6 +710,14 @@ Calling this method without arguments will make the **Tween** run infinitely, un If ``parallel`` is ``true``, the :ref:`Tweener<class_Tweener>`\ s appended after this method will by default run simultaneously, as opposed to sequentially. +\ **Note:** Just like with :ref:`parallel<class_Tween_method_parallel>`, the tweener added right before this method will also be part of the parallel step. + +:: + + tween.tween_property(self, "position", Vector2(300, 0), 0.5) + tween.set_parallel() + tween.tween_property(self, "modulate", Color.GREEN, 0.5) # Runs together with the position tweener. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_tweener.rst b/classes/class_tweener.rst index 63b7d8cde..f65707a79 100644 --- a/classes/class_tweener.rst +++ b/classes/class_tweener.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Tweener.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Tweener.xml. .. _class_Tweener: diff --git a/classes/class_udpserver.rst b/classes/class_udpserver.rst index d49ed5ab6..facf21cf8 100644 --- a/classes/class_udpserver.rst +++ b/classes/class_udpserver.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/UDPServer.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/UDPServer.xml. .. _class_UDPServer: diff --git a/classes/class_undoredo.rst b/classes/class_undoredo.rst index 7ee3c1e1b..09f4c448e 100644 --- a/classes/class_undoredo.rst +++ b/classes/class_undoredo.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/UndoRedo.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/UndoRedo.xml. .. _class_UndoRedo: diff --git a/classes/class_upnp.rst b/classes/class_upnp.rst index edfc61c1e..09276115b 100644 --- a/classes/class_upnp.rst +++ b/classes/class_upnp.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/upnp/doc_classes/UPNP.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/upnp/doc_classes/UPNP.xml. .. _class_UPNP: diff --git a/classes/class_upnpdevice.rst b/classes/class_upnpdevice.rst index 245cb1f6c..39da181a7 100644 --- a/classes/class_upnpdevice.rst +++ b/classes/class_upnpdevice.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/upnp/doc_classes/UPNPDevice.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/upnp/doc_classes/UPNPDevice.xml. .. _class_UPNPDevice: diff --git a/classes/class_variant.rst b/classes/class_variant.rst index d01ffcd5e..7849d276d 100644 --- a/classes/class_variant.rst +++ b/classes/class_variant.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Variant.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Variant.xml. .. _class_Variant: @@ -28,7 +28,7 @@ In computer programming, a Variant class is a class that is designed to store a foo = "Now foo is a string!" foo = RefCounted.new() # foo is an Object var bar: int = 2 # bar is a statically typed integer. - # bar = "Uh oh! I can't make static variables become a different type!" + # bar = "Uh oh! I can't make statically typed variables become a different type!" .. code-tab:: csharp @@ -62,7 +62,7 @@ The global :ref:`@GlobalScope.typeof<class_@GlobalScope_method_typeof>` function match typeof(foo): TYPE_NIL: print("foo is null") - TYPE_INTEGER: + TYPE_INT: print("foo is an integer") TYPE_OBJECT: # Note that Objects are their own special category. diff --git a/classes/class_vboxcontainer.rst b/classes/class_vboxcontainer.rst index e3665f466..510441f3f 100644 --- a/classes/class_vboxcontainer.rst +++ b/classes/class_vboxcontainer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VBoxContainer.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VBoxContainer.xml. .. _class_VBoxContainer: diff --git a/classes/class_vector2.rst b/classes/class_vector2.rst index f3c098c85..37bc057da 100644 --- a/classes/class_vector2.rst +++ b/classes/class_vector2.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Vector2.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Vector2.xml. .. _class_Vector2: @@ -520,7 +520,7 @@ Returns a new vector with all components clamped between the components of ``min Returns the 2D analog of the cross product for this vector and ``with``. -This is the signed area of the parallelogram formed by the two vectors. If the second vector is clockwise from the first vector, then the cross product is the positive area. If counter-clockwise, the cross product is the negative area. +This is the signed area of the parallelogram formed by the two vectors. If the second vector is clockwise from the first vector, then the cross product is the positive area. If counter-clockwise, the cross product is the negative area. If the two vectors are parallel this returns zero, making it useful for testing if two vectors are parallel. \ **Note:** Cross product is not defined in 2D mathematically. This method embeds the 2D vectors in the XY plane of 3D space and uses their cross product's Z component as the analog. diff --git a/classes/class_vector2i.rst b/classes/class_vector2i.rst index 56b3dfdb1..773d1c01b 100644 --- a/classes/class_vector2i.rst +++ b/classes/class_vector2i.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Vector2i.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Vector2i.xml. .. _class_Vector2i: diff --git a/classes/class_vector3.rst b/classes/class_vector3.rst index 39304e756..df52671e0 100644 --- a/classes/class_vector3.rst +++ b/classes/class_vector3.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Vector3.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Vector3.xml. .. _class_Vector3: @@ -562,6 +562,8 @@ Returns a new vector with all components clamped between the components of ``min Returns the cross product of this vector and ``with``. +This returns a vector perpendicular to both this and ``with``, which would be the normal vector of the plane defined by the two vectors. As there are two such vectors, in opposite directions, this method returns the vector defined by a right-handed coordinate system. If the two vectors are parallel this returns an empty vector, making it useful for testing if two vectors are parallel. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_vector3i.rst b/classes/class_vector3i.rst index f5bf5c78b..db3f30241 100644 --- a/classes/class_vector3i.rst +++ b/classes/class_vector3i.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Vector3i.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Vector3i.xml. .. _class_Vector3i: diff --git a/classes/class_vector4.rst b/classes/class_vector4.rst index 42f97b0b1..c7add96f5 100644 --- a/classes/class_vector4.rst +++ b/classes/class_vector4.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Vector4.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Vector4.xml. .. _class_Vector4: diff --git a/classes/class_vector4i.rst b/classes/class_vector4i.rst index 6b98458ef..5ef1dd647 100644 --- a/classes/class_vector4i.rst +++ b/classes/class_vector4i.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Vector4i.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Vector4i.xml. .. _class_Vector4i: diff --git a/classes/class_vehiclebody3d.rst b/classes/class_vehiclebody3d.rst index 76f77ca84..ea3d719c0 100644 --- a/classes/class_vehiclebody3d.rst +++ b/classes/class_vehiclebody3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VehicleBody3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VehicleBody3D.xml. .. _class_VehicleBody3D: diff --git a/classes/class_vehiclewheel3d.rst b/classes/class_vehiclewheel3d.rst index 7e8612be9..0627e14cc 100644 --- a/classes/class_vehiclewheel3d.rst +++ b/classes/class_vehiclewheel3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VehicleWheel3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VehicleWheel3D.xml. .. _class_VehicleWheel3D: @@ -333,7 +333,7 @@ This is the distance in meters the wheel is lowered from its origin point. Don't - void **set_roll_influence** **(** :ref:`float<class_float>` value **)** - :ref:`float<class_float>` **get_roll_influence** **(** **)** -This value affects the roll of your vehicle. If set to 1.0 for all wheels, your vehicle will be prone to rolling over, while a value of 0.0 will resist body roll. +This value affects the roll of your vehicle. If set to 1.0 for all wheels, your vehicle will resist body roll, while a value of 0.0 will be prone to rolling over. .. rst-class:: classref-section-separator diff --git a/classes/class_vflowcontainer.rst b/classes/class_vflowcontainer.rst index 0e53a2ec4..61d007e60 100644 --- a/classes/class_vflowcontainer.rst +++ b/classes/class_vflowcontainer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VFlowContainer.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VFlowContainer.xml. .. _class_VFlowContainer: diff --git a/classes/class_videostream.rst b/classes/class_videostream.rst index f024deadd..4f8a7b7ac 100644 --- a/classes/class_videostream.rst +++ b/classes/class_videostream.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VideoStream.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VideoStream.xml. .. _class_VideoStream: diff --git a/classes/class_videostreamplayback.rst b/classes/class_videostreamplayback.rst index 4b777b2a0..cdec518cd 100644 --- a/classes/class_videostreamplayback.rst +++ b/classes/class_videostreamplayback.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VideoStreamPlayback.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VideoStreamPlayback.xml. .. _class_VideoStreamPlayback: diff --git a/classes/class_videostreamplayer.rst b/classes/class_videostreamplayer.rst index 901b79850..94ee65a75 100644 --- a/classes/class_videostreamplayer.rst +++ b/classes/class_videostreamplayer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VideoStreamPlayer.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VideoStreamPlayer.xml. .. _class_VideoStreamPlayer: @@ -23,8 +23,6 @@ A control used for playback of :ref:`VideoStream<class_VideoStream>` resources. Supported video formats are `Ogg Theora <https://www.theora.org/>`__ (``.ogv``, :ref:`VideoStreamTheora<class_VideoStreamTheora>`) and any format exposed via a GDExtension plugin. -\ **Note:** Due to a bug, VideoStreamPlayer does not support localization remapping yet. - \ **Warning:** On Web, video playback *will* perform poorly due to missing architecture-specific assembly optimizations. .. rst-class:: classref-introduction-group diff --git a/classes/class_videostreamtheora.rst b/classes/class_videostreamtheora.rst index 75b542409..fddc8e020 100644 --- a/classes/class_videostreamtheora.rst +++ b/classes/class_videostreamtheora.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/theora/doc_classes/VideoStreamTheora.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/theora/doc_classes/VideoStreamTheora.xml. .. _class_VideoStreamTheora: diff --git a/classes/class_viewport.rst b/classes/class_viewport.rst index 62d8d61b1..989888ac1 100644 --- a/classes/class_viewport.rst +++ b/classes/class_viewport.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Viewport.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Viewport.xml. .. _class_Viewport: @@ -21,7 +21,7 @@ Abstract base class for viewports. Encapsulates drawing and interaction with a g Description ----------- -A Viewport creates a different view into the screen, or a sub-view inside another viewport. Children 2D Nodes will display on it, and children Camera3D 3D nodes will render on it too. +A **Viewport** creates a different view into the screen, or a sub-view inside another viewport. Child 2D nodes will display on it, and child Camera3D 3D nodes will render on it too. Optionally, a viewport can have its own 2D or 3D world, so it doesn't share what it draws with other viewports. @@ -768,7 +768,7 @@ enum **DefaultCanvasItemTextureFilter**: :ref:`DefaultCanvasItemTextureFilter<enum_Viewport_DefaultCanvasItemTextureFilter>` **DEFAULT_CANVAS_ITEM_TEXTURE_FILTER_NEAREST** = ``0`` -The texture filter reads from the nearest pixel only. The simplest and fastest method of filtering, but the texture will look pixelized. +The texture filter reads from the nearest pixel only. This makes the texture look pixelated from up close, and grainy from a distance (due to mipmaps not being sampled). .. _class_Viewport_constant_DEFAULT_CANVAS_ITEM_TEXTURE_FILTER_LINEAR: @@ -776,7 +776,7 @@ The texture filter reads from the nearest pixel only. The simplest and fastest m :ref:`DefaultCanvasItemTextureFilter<enum_Viewport_DefaultCanvasItemTextureFilter>` **DEFAULT_CANVAS_ITEM_TEXTURE_FILTER_LINEAR** = ``1`` -The texture filter blends between the nearest 4 pixels. Use this when you want to avoid a pixelated style, but do not want mipmaps. +The texture filter blends between the nearest 4 pixels. This makes the texture look smooth from up close, and grainy from a distance (due to mipmaps not being sampled). .. _class_Viewport_constant_DEFAULT_CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS: @@ -784,7 +784,9 @@ The texture filter blends between the nearest 4 pixels. Use this when you want t :ref:`DefaultCanvasItemTextureFilter<enum_Viewport_DefaultCanvasItemTextureFilter>` **DEFAULT_CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS** = ``2`` -The texture filter reads from the nearest pixel in the nearest mipmap. The fastest way to read from textures with mipmaps. +The texture filter blends between the nearest 4 pixels and between the nearest 2 mipmaps (or uses the nearest mipmap if :ref:`ProjectSettings.rendering/textures/default_filters/use_nearest_mipmap_filter<class_ProjectSettings_property_rendering/textures/default_filters/use_nearest_mipmap_filter>` is ``true``). This makes the texture look smooth from up close, and smooth from a distance. + +Use this for non-pixel art textures that may be viewed at a low scale (e.g. due to :ref:`Camera2D<class_Camera2D>` zoom or sprite scaling), as mipmaps are important to smooth out pixels that are smaller than on-screen pixels. .. _class_Viewport_constant_DEFAULT_CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS: @@ -792,7 +794,9 @@ The texture filter reads from the nearest pixel in the nearest mipmap. The faste :ref:`DefaultCanvasItemTextureFilter<enum_Viewport_DefaultCanvasItemTextureFilter>` **DEFAULT_CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS** = ``3`` -The texture filter blends between the nearest 4 pixels and between the nearest 2 mipmaps. +The texture filter reads from the nearest pixel and blends between the nearest 2 mipmaps (or uses the nearest mipmap if :ref:`ProjectSettings.rendering/textures/default_filters/use_nearest_mipmap_filter<class_ProjectSettings_property_rendering/textures/default_filters/use_nearest_mipmap_filter>` is ``true``). This makes the texture look pixelated from up close, and smooth from a distance. + +Use this for non-pixel art textures that may be viewed at a low scale (e.g. due to :ref:`Camera2D<class_Camera2D>` zoom or sprite scaling), as mipmaps are important to smooth out pixels that are smaller than on-screen pixels. .. _class_Viewport_constant_DEFAULT_CANVAS_ITEM_TEXTURE_FILTER_MAX: diff --git a/classes/class_viewporttexture.rst b/classes/class_viewporttexture.rst index 1b8ac6998..920d260a6 100644 --- a/classes/class_viewporttexture.rst +++ b/classes/class_viewporttexture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ViewportTexture.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ViewportTexture.xml. .. _class_ViewportTexture: diff --git a/classes/class_visibleonscreenenabler2d.rst b/classes/class_visibleonscreenenabler2d.rst index 0b7e63542..65fab2af4 100644 --- a/classes/class_visibleonscreenenabler2d.rst +++ b/classes/class_visibleonscreenenabler2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisibleOnScreenEnabler2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisibleOnScreenEnabler2D.xml. .. _class_VisibleOnScreenEnabler2D: diff --git a/classes/class_visibleonscreenenabler3d.rst b/classes/class_visibleonscreenenabler3d.rst index a10caf07f..ae62fa303 100644 --- a/classes/class_visibleonscreenenabler3d.rst +++ b/classes/class_visibleonscreenenabler3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisibleOnScreenEnabler3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisibleOnScreenEnabler3D.xml. .. _class_VisibleOnScreenEnabler3D: diff --git a/classes/class_visibleonscreennotifier2d.rst b/classes/class_visibleonscreennotifier2d.rst index 70fae8f02..5daa0b6bc 100644 --- a/classes/class_visibleonscreennotifier2d.rst +++ b/classes/class_visibleonscreennotifier2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisibleOnScreenNotifier2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisibleOnScreenNotifier2D.xml. .. _class_VisibleOnScreenNotifier2D: diff --git a/classes/class_visibleonscreennotifier3d.rst b/classes/class_visibleonscreennotifier3d.rst index 529fba91d..fdc6e1931 100644 --- a/classes/class_visibleonscreennotifier3d.rst +++ b/classes/class_visibleonscreennotifier3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisibleOnScreenNotifier3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisibleOnScreenNotifier3D.xml. .. _class_VisibleOnScreenNotifier3D: diff --git a/classes/class_visualinstance3d.rst b/classes/class_visualinstance3d.rst index 48bf791f7..1a219ea9b 100644 --- a/classes/class_visualinstance3d.rst +++ b/classes/class_visualinstance3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualInstance3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualInstance3D.xml. .. _class_VisualInstance3D: diff --git a/classes/class_visualshader.rst b/classes/class_visualshader.rst index b34af625c..a2f8ed06c 100644 --- a/classes/class_visualshader.rst +++ b/classes/class_visualshader.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShader.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShader.xml. .. _class_VisualShader: diff --git a/classes/class_visualshadernode.rst b/classes/class_visualshadernode.rst index deb0f83a5..1914cfec1 100644 --- a/classes/class_visualshadernode.rst +++ b/classes/class_visualshadernode.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNode.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNode.xml. .. _class_VisualShaderNode: diff --git a/classes/class_visualshadernodebillboard.rst b/classes/class_visualshadernodebillboard.rst index 2fd9828aa..c5803ddda 100644 --- a/classes/class_visualshadernodebillboard.rst +++ b/classes/class_visualshadernodebillboard.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeBillboard.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeBillboard.xml. .. _class_VisualShaderNodeBillboard: diff --git a/classes/class_visualshadernodebooleanconstant.rst b/classes/class_visualshadernodebooleanconstant.rst index 32da5a467..e776c108a 100644 --- a/classes/class_visualshadernodebooleanconstant.rst +++ b/classes/class_visualshadernodebooleanconstant.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeBooleanConstant.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeBooleanConstant.xml. .. _class_VisualShaderNodeBooleanConstant: diff --git a/classes/class_visualshadernodebooleanparameter.rst b/classes/class_visualshadernodebooleanparameter.rst index 3e9ffa31e..b0db77822 100644 --- a/classes/class_visualshadernodebooleanparameter.rst +++ b/classes/class_visualshadernodebooleanparameter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeBooleanParameter.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeBooleanParameter.xml. .. _class_VisualShaderNodeBooleanParameter: diff --git a/classes/class_visualshadernodeclamp.rst b/classes/class_visualshadernodeclamp.rst index 37cbf09ef..578e2737c 100644 --- a/classes/class_visualshadernodeclamp.rst +++ b/classes/class_visualshadernodeclamp.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeClamp.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeClamp.xml. .. _class_VisualShaderNodeClamp: diff --git a/classes/class_visualshadernodecolorconstant.rst b/classes/class_visualshadernodecolorconstant.rst index e4605cfe5..b41f5e85a 100644 --- a/classes/class_visualshadernodecolorconstant.rst +++ b/classes/class_visualshadernodecolorconstant.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeColorConstant.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeColorConstant.xml. .. _class_VisualShaderNodeColorConstant: diff --git a/classes/class_visualshadernodecolorfunc.rst b/classes/class_visualshadernodecolorfunc.rst index 442dbec40..3666e8f90 100644 --- a/classes/class_visualshadernodecolorfunc.rst +++ b/classes/class_visualshadernodecolorfunc.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeColorFunc.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeColorFunc.xml. .. _class_VisualShaderNodeColorFunc: diff --git a/classes/class_visualshadernodecolorop.rst b/classes/class_visualshadernodecolorop.rst index 42cd30ccf..fd0daf187 100644 --- a/classes/class_visualshadernodecolorop.rst +++ b/classes/class_visualshadernodecolorop.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeColorOp.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeColorOp.xml. .. _class_VisualShaderNodeColorOp: diff --git a/classes/class_visualshadernodecolorparameter.rst b/classes/class_visualshadernodecolorparameter.rst index 49615665b..3612ec415 100644 --- a/classes/class_visualshadernodecolorparameter.rst +++ b/classes/class_visualshadernodecolorparameter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeColorParameter.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeColorParameter.xml. .. _class_VisualShaderNodeColorParameter: diff --git a/classes/class_visualshadernodecomment.rst b/classes/class_visualshadernodecomment.rst index 4398f1c88..48a9c95d8 100644 --- a/classes/class_visualshadernodecomment.rst +++ b/classes/class_visualshadernodecomment.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeComment.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeComment.xml. .. _class_VisualShaderNodeComment: diff --git a/classes/class_visualshadernodecompare.rst b/classes/class_visualshadernodecompare.rst index 2a6547e76..47853804c 100644 --- a/classes/class_visualshadernodecompare.rst +++ b/classes/class_visualshadernodecompare.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeCompare.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeCompare.xml. .. _class_VisualShaderNodeCompare: diff --git a/classes/class_visualshadernodeconstant.rst b/classes/class_visualshadernodeconstant.rst index f5dd8e4f5..a958e5ace 100644 --- a/classes/class_visualshadernodeconstant.rst +++ b/classes/class_visualshadernodeconstant.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeConstant.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeConstant.xml. .. _class_VisualShaderNodeConstant: diff --git a/classes/class_visualshadernodecubemap.rst b/classes/class_visualshadernodecubemap.rst index 28e0cac7c..e0cd1789f 100644 --- a/classes/class_visualshadernodecubemap.rst +++ b/classes/class_visualshadernodecubemap.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeCubemap.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeCubemap.xml. .. _class_VisualShaderNodeCubemap: @@ -100,7 +100,7 @@ No hints are added to the uniform declaration. :ref:`TextureType<enum_VisualShaderNodeCubemap_TextureType>` **TYPE_COLOR** = ``1`` -Adds ``hint_albedo`` as hint to the uniform declaration for proper sRGB to linear conversion. +Adds ``source_color`` as hint to the uniform declaration for proper sRGB to linear conversion. .. _class_VisualShaderNodeCubemap_constant_TYPE_NORMAL_MAP: diff --git a/classes/class_visualshadernodecubemapparameter.rst b/classes/class_visualshadernodecubemapparameter.rst index 564a41a13..978194703 100644 --- a/classes/class_visualshadernodecubemapparameter.rst +++ b/classes/class_visualshadernodecubemapparameter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeCubemapParameter.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeCubemapParameter.xml. .. _class_VisualShaderNodeCubemapParameter: diff --git a/classes/class_visualshadernodecurvetexture.rst b/classes/class_visualshadernodecurvetexture.rst index 0e69e59af..9f0e8fd05 100644 --- a/classes/class_visualshadernodecurvetexture.rst +++ b/classes/class_visualshadernodecurvetexture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeCurveTexture.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeCurveTexture.xml. .. _class_VisualShaderNodeCurveTexture: diff --git a/classes/class_visualshadernodecurvexyztexture.rst b/classes/class_visualshadernodecurvexyztexture.rst index 3ad6b3c36..da5b79ed2 100644 --- a/classes/class_visualshadernodecurvexyztexture.rst +++ b/classes/class_visualshadernodecurvexyztexture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeCurveXYZTexture.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeCurveXYZTexture.xml. .. _class_VisualShaderNodeCurveXYZTexture: diff --git a/classes/class_visualshadernodecustom.rst b/classes/class_visualshadernodecustom.rst index ee0398f1d..fe93f2843 100644 --- a/classes/class_visualshadernodecustom.rst +++ b/classes/class_visualshadernodecustom.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeCustom.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeCustom.xml. .. _class_VisualShaderNodeCustom: diff --git a/classes/class_visualshadernodederivativefunc.rst b/classes/class_visualshadernodederivativefunc.rst index 8a4e7ed38..5ef36de34 100644 --- a/classes/class_visualshadernodederivativefunc.rst +++ b/classes/class_visualshadernodederivativefunc.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeDerivativeFunc.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeDerivativeFunc.xml. .. _class_VisualShaderNodeDerivativeFunc: diff --git a/classes/class_visualshadernodedeterminant.rst b/classes/class_visualshadernodedeterminant.rst index b85ba816c..84b663a11 100644 --- a/classes/class_visualshadernodedeterminant.rst +++ b/classes/class_visualshadernodedeterminant.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeDeterminant.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeDeterminant.xml. .. _class_VisualShaderNodeDeterminant: diff --git a/classes/class_visualshadernodedistancefade.rst b/classes/class_visualshadernodedistancefade.rst index 75abdfd09..17f0e48c8 100644 --- a/classes/class_visualshadernodedistancefade.rst +++ b/classes/class_visualshadernodedistancefade.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeDistanceFade.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeDistanceFade.xml. .. _class_VisualShaderNodeDistanceFade: diff --git a/classes/class_visualshadernodedotproduct.rst b/classes/class_visualshadernodedotproduct.rst index 0da9ecf2f..4e646b18a 100644 --- a/classes/class_visualshadernodedotproduct.rst +++ b/classes/class_visualshadernodedotproduct.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeDotProduct.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeDotProduct.xml. .. _class_VisualShaderNodeDotProduct: diff --git a/classes/class_visualshadernodeexpression.rst b/classes/class_visualshadernodeexpression.rst index 84fe57136..cbc746c62 100644 --- a/classes/class_visualshadernodeexpression.rst +++ b/classes/class_visualshadernodeexpression.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeExpression.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeExpression.xml. .. _class_VisualShaderNodeExpression: diff --git a/classes/class_visualshadernodefaceforward.rst b/classes/class_visualshadernodefaceforward.rst index cfad3a932..327c409d5 100644 --- a/classes/class_visualshadernodefaceforward.rst +++ b/classes/class_visualshadernodefaceforward.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeFaceForward.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeFaceForward.xml. .. _class_VisualShaderNodeFaceForward: diff --git a/classes/class_visualshadernodefloatconstant.rst b/classes/class_visualshadernodefloatconstant.rst index da21b8aaf..f225bb974 100644 --- a/classes/class_visualshadernodefloatconstant.rst +++ b/classes/class_visualshadernodefloatconstant.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeFloatConstant.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeFloatConstant.xml. .. _class_VisualShaderNodeFloatConstant: diff --git a/classes/class_visualshadernodefloatfunc.rst b/classes/class_visualshadernodefloatfunc.rst index 81f2e131e..f3fc36c00 100644 --- a/classes/class_visualshadernodefloatfunc.rst +++ b/classes/class_visualshadernodefloatfunc.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeFloatFunc.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeFloatFunc.xml. .. _class_VisualShaderNodeFloatFunc: diff --git a/classes/class_visualshadernodefloatop.rst b/classes/class_visualshadernodefloatop.rst index b94f0caf5..4d497955d 100644 --- a/classes/class_visualshadernodefloatop.rst +++ b/classes/class_visualshadernodefloatop.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeFloatOp.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeFloatOp.xml. .. _class_VisualShaderNodeFloatOp: diff --git a/classes/class_visualshadernodefloatparameter.rst b/classes/class_visualshadernodefloatparameter.rst index 69ee8e994..8a23d57a2 100644 --- a/classes/class_visualshadernodefloatparameter.rst +++ b/classes/class_visualshadernodefloatparameter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeFloatParameter.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeFloatParameter.xml. .. _class_VisualShaderNodeFloatParameter: diff --git a/classes/class_visualshadernodefresnel.rst b/classes/class_visualshadernodefresnel.rst index 233e804d7..872312536 100644 --- a/classes/class_visualshadernodefresnel.rst +++ b/classes/class_visualshadernodefresnel.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeFresnel.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeFresnel.xml. .. _class_VisualShaderNodeFresnel: diff --git a/classes/class_visualshadernodeglobalexpression.rst b/classes/class_visualshadernodeglobalexpression.rst index f6244e9c6..3436d83a5 100644 --- a/classes/class_visualshadernodeglobalexpression.rst +++ b/classes/class_visualshadernodeglobalexpression.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeGlobalExpression.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeGlobalExpression.xml. .. _class_VisualShaderNodeGlobalExpression: diff --git a/classes/class_visualshadernodegroupbase.rst b/classes/class_visualshadernodegroupbase.rst index 267f01251..15b49ef51 100644 --- a/classes/class_visualshadernodegroupbase.rst +++ b/classes/class_visualshadernodegroupbase.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeGroupBase.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeGroupBase.xml. .. _class_VisualShaderNodeGroupBase: diff --git a/classes/class_visualshadernodeif.rst b/classes/class_visualshadernodeif.rst index 644cff3d0..72253f961 100644 --- a/classes/class_visualshadernodeif.rst +++ b/classes/class_visualshadernodeif.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeIf.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeIf.xml. .. _class_VisualShaderNodeIf: diff --git a/classes/class_visualshadernodeinput.rst b/classes/class_visualshadernodeinput.rst index 1c2648915..2b3d308b3 100644 --- a/classes/class_visualshadernodeinput.rst +++ b/classes/class_visualshadernodeinput.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeInput.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeInput.xml. .. _class_VisualShaderNodeInput: diff --git a/classes/class_visualshadernodeintconstant.rst b/classes/class_visualshadernodeintconstant.rst index a66a552c2..6c6cdec95 100644 --- a/classes/class_visualshadernodeintconstant.rst +++ b/classes/class_visualshadernodeintconstant.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeIntConstant.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeIntConstant.xml. .. _class_VisualShaderNodeIntConstant: diff --git a/classes/class_visualshadernodeintfunc.rst b/classes/class_visualshadernodeintfunc.rst index 9e26fff36..7274a48d7 100644 --- a/classes/class_visualshadernodeintfunc.rst +++ b/classes/class_visualshadernodeintfunc.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeIntFunc.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeIntFunc.xml. .. _class_VisualShaderNodeIntFunc: diff --git a/classes/class_visualshadernodeintop.rst b/classes/class_visualshadernodeintop.rst index b8a076233..42ef028e9 100644 --- a/classes/class_visualshadernodeintop.rst +++ b/classes/class_visualshadernodeintop.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeIntOp.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeIntOp.xml. .. _class_VisualShaderNodeIntOp: diff --git a/classes/class_visualshadernodeintparameter.rst b/classes/class_visualshadernodeintparameter.rst index c1afeedf6..620145a2e 100644 --- a/classes/class_visualshadernodeintparameter.rst +++ b/classes/class_visualshadernodeintparameter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeIntParameter.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeIntParameter.xml. .. _class_VisualShaderNodeIntParameter: diff --git a/classes/class_visualshadernodeis.rst b/classes/class_visualshadernodeis.rst index 01732ffa9..a30313a00 100644 --- a/classes/class_visualshadernodeis.rst +++ b/classes/class_visualshadernodeis.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeIs.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeIs.xml. .. _class_VisualShaderNodeIs: diff --git a/classes/class_visualshadernodelinearscenedepth.rst b/classes/class_visualshadernodelinearscenedepth.rst index 2f1979ebb..dac3fed55 100644 --- a/classes/class_visualshadernodelinearscenedepth.rst +++ b/classes/class_visualshadernodelinearscenedepth.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeLinearSceneDepth.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeLinearSceneDepth.xml. .. _class_VisualShaderNodeLinearSceneDepth: diff --git a/classes/class_visualshadernodemix.rst b/classes/class_visualshadernodemix.rst index 6ef979776..8277cf1d4 100644 --- a/classes/class_visualshadernodemix.rst +++ b/classes/class_visualshadernodemix.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeMix.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeMix.xml. .. _class_VisualShaderNodeMix: diff --git a/classes/class_visualshadernodemultiplyadd.rst b/classes/class_visualshadernodemultiplyadd.rst index a18fadfdf..b7dca11ce 100644 --- a/classes/class_visualshadernodemultiplyadd.rst +++ b/classes/class_visualshadernodemultiplyadd.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeMultiplyAdd.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeMultiplyAdd.xml. .. _class_VisualShaderNodeMultiplyAdd: diff --git a/classes/class_visualshadernodeouterproduct.rst b/classes/class_visualshadernodeouterproduct.rst index 32fe7d4d7..75254f2b8 100644 --- a/classes/class_visualshadernodeouterproduct.rst +++ b/classes/class_visualshadernodeouterproduct.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeOuterProduct.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeOuterProduct.xml. .. _class_VisualShaderNodeOuterProduct: diff --git a/classes/class_visualshadernodeoutput.rst b/classes/class_visualshadernodeoutput.rst index dddcc17f5..334550742 100644 --- a/classes/class_visualshadernodeoutput.rst +++ b/classes/class_visualshadernodeoutput.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeOutput.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeOutput.xml. .. _class_VisualShaderNodeOutput: diff --git a/classes/class_visualshadernodeparameter.rst b/classes/class_visualshadernodeparameter.rst index 0750b5c00..e98a22ac7 100644 --- a/classes/class_visualshadernodeparameter.rst +++ b/classes/class_visualshadernodeparameter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeParameter.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeParameter.xml. .. _class_VisualShaderNodeParameter: diff --git a/classes/class_visualshadernodeparameterref.rst b/classes/class_visualshadernodeparameterref.rst index db84f4a7b..084d72d9d 100644 --- a/classes/class_visualshadernodeparameterref.rst +++ b/classes/class_visualshadernodeparameterref.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeParameterRef.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeParameterRef.xml. .. _class_VisualShaderNodeParameterRef: diff --git a/classes/class_visualshadernodeparticleaccelerator.rst b/classes/class_visualshadernodeparticleaccelerator.rst index 52aade37a..bc61e55b3 100644 --- a/classes/class_visualshadernodeparticleaccelerator.rst +++ b/classes/class_visualshadernodeparticleaccelerator.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeParticleAccelerator.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeParticleAccelerator.xml. .. _class_VisualShaderNodeParticleAccelerator: diff --git a/classes/class_visualshadernodeparticleboxemitter.rst b/classes/class_visualshadernodeparticleboxemitter.rst index 2e9043e58..2522fd71c 100644 --- a/classes/class_visualshadernodeparticleboxemitter.rst +++ b/classes/class_visualshadernodeparticleboxemitter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeParticleBoxEmitter.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeParticleBoxEmitter.xml. .. _class_VisualShaderNodeParticleBoxEmitter: diff --git a/classes/class_visualshadernodeparticleconevelocity.rst b/classes/class_visualshadernodeparticleconevelocity.rst index b0c7f8b89..c5c0f02b8 100644 --- a/classes/class_visualshadernodeparticleconevelocity.rst +++ b/classes/class_visualshadernodeparticleconevelocity.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeParticleConeVelocity.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeParticleConeVelocity.xml. .. _class_VisualShaderNodeParticleConeVelocity: diff --git a/classes/class_visualshadernodeparticleemit.rst b/classes/class_visualshadernodeparticleemit.rst index 068f34592..62f9312cc 100644 --- a/classes/class_visualshadernodeparticleemit.rst +++ b/classes/class_visualshadernodeparticleemit.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeParticleEmit.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeParticleEmit.xml. .. _class_VisualShaderNodeParticleEmit: diff --git a/classes/class_visualshadernodeparticleemitter.rst b/classes/class_visualshadernodeparticleemitter.rst index 76432277b..1c1920949 100644 --- a/classes/class_visualshadernodeparticleemitter.rst +++ b/classes/class_visualshadernodeparticleemitter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeParticleEmitter.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeParticleEmitter.xml. .. _class_VisualShaderNodeParticleEmitter: diff --git a/classes/class_visualshadernodeparticlemeshemitter.rst b/classes/class_visualshadernodeparticlemeshemitter.rst index 58a7a706e..f63c2b374 100644 --- a/classes/class_visualshadernodeparticlemeshemitter.rst +++ b/classes/class_visualshadernodeparticlemeshemitter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeParticleMeshEmitter.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeParticleMeshEmitter.xml. .. _class_VisualShaderNodeParticleMeshEmitter: diff --git a/classes/class_visualshadernodeparticlemultiplybyaxisangle.rst b/classes/class_visualshadernodeparticlemultiplybyaxisangle.rst index 4008f9976..2a3ab8d2e 100644 --- a/classes/class_visualshadernodeparticlemultiplybyaxisangle.rst +++ b/classes/class_visualshadernodeparticlemultiplybyaxisangle.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeParticleMultiplyByAxisAngle.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeParticleMultiplyByAxisAngle.xml. .. _class_VisualShaderNodeParticleMultiplyByAxisAngle: diff --git a/classes/class_visualshadernodeparticleoutput.rst b/classes/class_visualshadernodeparticleoutput.rst index b8ba1d447..68b8b23dd 100644 --- a/classes/class_visualshadernodeparticleoutput.rst +++ b/classes/class_visualshadernodeparticleoutput.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeParticleOutput.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeParticleOutput.xml. .. _class_VisualShaderNodeParticleOutput: diff --git a/classes/class_visualshadernodeparticlerandomness.rst b/classes/class_visualshadernodeparticlerandomness.rst index f2871a446..b69c74ce1 100644 --- a/classes/class_visualshadernodeparticlerandomness.rst +++ b/classes/class_visualshadernodeparticlerandomness.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeParticleRandomness.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeParticleRandomness.xml. .. _class_VisualShaderNodeParticleRandomness: diff --git a/classes/class_visualshadernodeparticleringemitter.rst b/classes/class_visualshadernodeparticleringemitter.rst index 0bc1bfae1..12e6c9a15 100644 --- a/classes/class_visualshadernodeparticleringemitter.rst +++ b/classes/class_visualshadernodeparticleringemitter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeParticleRingEmitter.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeParticleRingEmitter.xml. .. _class_VisualShaderNodeParticleRingEmitter: diff --git a/classes/class_visualshadernodeparticlesphereemitter.rst b/classes/class_visualshadernodeparticlesphereemitter.rst index 7d2003c53..82e8ba8fd 100644 --- a/classes/class_visualshadernodeparticlesphereemitter.rst +++ b/classes/class_visualshadernodeparticlesphereemitter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeParticleSphereEmitter.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeParticleSphereEmitter.xml. .. _class_VisualShaderNodeParticleSphereEmitter: diff --git a/classes/class_visualshadernodeproximityfade.rst b/classes/class_visualshadernodeproximityfade.rst index f32907ea0..0e29048e1 100644 --- a/classes/class_visualshadernodeproximityfade.rst +++ b/classes/class_visualshadernodeproximityfade.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeProximityFade.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeProximityFade.xml. .. _class_VisualShaderNodeProximityFade: diff --git a/classes/class_visualshadernoderandomrange.rst b/classes/class_visualshadernoderandomrange.rst index 9f8af834d..c5063221c 100644 --- a/classes/class_visualshadernoderandomrange.rst +++ b/classes/class_visualshadernoderandomrange.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeRandomRange.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeRandomRange.xml. .. _class_VisualShaderNodeRandomRange: diff --git a/classes/class_visualshadernoderemap.rst b/classes/class_visualshadernoderemap.rst index 9d8ea9289..bd9e8b77b 100644 --- a/classes/class_visualshadernoderemap.rst +++ b/classes/class_visualshadernoderemap.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeRemap.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeRemap.xml. .. _class_VisualShaderNodeRemap: diff --git a/classes/class_visualshadernoderesizablebase.rst b/classes/class_visualshadernoderesizablebase.rst index cbde702fa..28cd2a86e 100644 --- a/classes/class_visualshadernoderesizablebase.rst +++ b/classes/class_visualshadernoderesizablebase.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeResizableBase.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeResizableBase.xml. .. _class_VisualShaderNodeResizableBase: diff --git a/classes/class_visualshadernoderotationbyaxis.rst b/classes/class_visualshadernoderotationbyaxis.rst index 2910b93a7..25d5fe352 100644 --- a/classes/class_visualshadernoderotationbyaxis.rst +++ b/classes/class_visualshadernoderotationbyaxis.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeRotationByAxis.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeRotationByAxis.xml. .. _class_VisualShaderNodeRotationByAxis: diff --git a/classes/class_visualshadernodesample3d.rst b/classes/class_visualshadernodesample3d.rst index 8cf38a225..ba8690e87 100644 --- a/classes/class_visualshadernodesample3d.rst +++ b/classes/class_visualshadernodesample3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeSample3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeSample3D.xml. .. _class_VisualShaderNodeSample3D: diff --git a/classes/class_visualshadernodescreennormalworldspace.rst b/classes/class_visualshadernodescreennormalworldspace.rst index 245ff920b..fbb05a602 100644 --- a/classes/class_visualshadernodescreennormalworldspace.rst +++ b/classes/class_visualshadernodescreennormalworldspace.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeScreenNormalWorldSpace.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeScreenNormalWorldSpace.xml. .. _class_VisualShaderNodeScreenNormalWorldSpace: diff --git a/classes/class_visualshadernodescreenuvtosdf.rst b/classes/class_visualshadernodescreenuvtosdf.rst index 4df8e804f..c41b1beb9 100644 --- a/classes/class_visualshadernodescreenuvtosdf.rst +++ b/classes/class_visualshadernodescreenuvtosdf.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeScreenUVToSDF.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeScreenUVToSDF.xml. .. _class_VisualShaderNodeScreenUVToSDF: diff --git a/classes/class_visualshadernodesdfraymarch.rst b/classes/class_visualshadernodesdfraymarch.rst index ce4b035d1..5e14e6b67 100644 --- a/classes/class_visualshadernodesdfraymarch.rst +++ b/classes/class_visualshadernodesdfraymarch.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeSDFRaymarch.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeSDFRaymarch.xml. .. _class_VisualShaderNodeSDFRaymarch: diff --git a/classes/class_visualshadernodesdftoscreenuv.rst b/classes/class_visualshadernodesdftoscreenuv.rst index 6aab48f89..5fcef3d09 100644 --- a/classes/class_visualshadernodesdftoscreenuv.rst +++ b/classes/class_visualshadernodesdftoscreenuv.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeSDFToScreenUV.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeSDFToScreenUV.xml. .. _class_VisualShaderNodeSDFToScreenUV: diff --git a/classes/class_visualshadernodesmoothstep.rst b/classes/class_visualshadernodesmoothstep.rst index b8a4b7a84..ca1348709 100644 --- a/classes/class_visualshadernodesmoothstep.rst +++ b/classes/class_visualshadernodesmoothstep.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeSmoothStep.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeSmoothStep.xml. .. _class_VisualShaderNodeSmoothStep: diff --git a/classes/class_visualshadernodestep.rst b/classes/class_visualshadernodestep.rst index 4d37fe8e3..642912b5d 100644 --- a/classes/class_visualshadernodestep.rst +++ b/classes/class_visualshadernodestep.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeStep.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeStep.xml. .. _class_VisualShaderNodeStep: diff --git a/classes/class_visualshadernodeswitch.rst b/classes/class_visualshadernodeswitch.rst index 2cbb9b7e5..817474463 100644 --- a/classes/class_visualshadernodeswitch.rst +++ b/classes/class_visualshadernodeswitch.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeSwitch.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeSwitch.xml. .. _class_VisualShaderNodeSwitch: diff --git a/classes/class_visualshadernodetexture.rst b/classes/class_visualshadernodetexture.rst index d9c926d5f..c56414760 100644 --- a/classes/class_visualshadernodetexture.rst +++ b/classes/class_visualshadernodetexture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeTexture.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeTexture.xml. .. _class_VisualShaderNodeTexture: @@ -148,7 +148,7 @@ No hints are added to the uniform declaration. :ref:`TextureType<enum_VisualShaderNodeTexture_TextureType>` **TYPE_COLOR** = ``1`` -Adds ``hint_albedo`` as hint to the uniform declaration for proper sRGB to linear conversion. +Adds ``source_color`` as hint to the uniform declaration for proper sRGB to linear conversion. .. _class_VisualShaderNodeTexture_constant_TYPE_NORMAL_MAP: diff --git a/classes/class_visualshadernodetexture2darray.rst b/classes/class_visualshadernodetexture2darray.rst index da69c59ab..ef743b495 100644 --- a/classes/class_visualshadernodetexture2darray.rst +++ b/classes/class_visualshadernodetexture2darray.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeTexture2DArray.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeTexture2DArray.xml. .. _class_VisualShaderNodeTexture2DArray: diff --git a/classes/class_visualshadernodetexture2darrayparameter.rst b/classes/class_visualshadernodetexture2darrayparameter.rst index 9926a6483..47a99fbe8 100644 --- a/classes/class_visualshadernodetexture2darrayparameter.rst +++ b/classes/class_visualshadernodetexture2darrayparameter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeTexture2DArrayParameter.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeTexture2DArrayParameter.xml. .. _class_VisualShaderNodeTexture2DArrayParameter: diff --git a/classes/class_visualshadernodetexture2dparameter.rst b/classes/class_visualshadernodetexture2dparameter.rst index 3fd2ac37a..508b7e40f 100644 --- a/classes/class_visualshadernodetexture2dparameter.rst +++ b/classes/class_visualshadernodetexture2dparameter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeTexture2DParameter.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeTexture2DParameter.xml. .. _class_VisualShaderNodeTexture2DParameter: diff --git a/classes/class_visualshadernodetexture3d.rst b/classes/class_visualshadernodetexture3d.rst index 4887bd665..4c45d0552 100644 --- a/classes/class_visualshadernodetexture3d.rst +++ b/classes/class_visualshadernodetexture3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeTexture3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeTexture3D.xml. .. _class_VisualShaderNodeTexture3D: diff --git a/classes/class_visualshadernodetexture3dparameter.rst b/classes/class_visualshadernodetexture3dparameter.rst index 9aaa1210e..10442d217 100644 --- a/classes/class_visualshadernodetexture3dparameter.rst +++ b/classes/class_visualshadernodetexture3dparameter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeTexture3DParameter.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeTexture3DParameter.xml. .. _class_VisualShaderNodeTexture3DParameter: diff --git a/classes/class_visualshadernodetextureparameter.rst b/classes/class_visualshadernodetextureparameter.rst index 9ba2f704b..a6d03ca49 100644 --- a/classes/class_visualshadernodetextureparameter.rst +++ b/classes/class_visualshadernodetextureparameter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeTextureParameter.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeTextureParameter.xml. .. _class_VisualShaderNodeTextureParameter: @@ -164,7 +164,7 @@ Sample the texture using the filter determined by the node this shader is attach :ref:`TextureFilter<enum_VisualShaderNodeTextureParameter_TextureFilter>` **FILTER_NEAREST** = ``1`` -The texture filter reads from the nearest pixel only. The simplest and fastest method of filtering, but the texture will look pixelized. +The texture filter reads from the nearest pixel only. This makes the texture look pixelated from up close, and grainy from a distance (due to mipmaps not being sampled). .. _class_VisualShaderNodeTextureParameter_constant_FILTER_LINEAR: @@ -172,7 +172,7 @@ The texture filter reads from the nearest pixel only. The simplest and fastest m :ref:`TextureFilter<enum_VisualShaderNodeTextureParameter_TextureFilter>` **FILTER_LINEAR** = ``2`` -The texture filter blends between the nearest four pixels. Use this for most cases where you want to avoid a pixelated style. +The texture filter blends between the nearest 4 pixels. This makes the texture look smooth from up close, and grainy from a distance (due to mipmaps not being sampled). .. _class_VisualShaderNodeTextureParameter_constant_FILTER_NEAREST_MIPMAP: @@ -180,7 +180,9 @@ The texture filter blends between the nearest four pixels. Use this for most cas :ref:`TextureFilter<enum_VisualShaderNodeTextureParameter_TextureFilter>` **FILTER_NEAREST_MIPMAP** = ``3`` -The texture filter reads from the nearest pixel in the nearest mipmap. This is the fastest way to read from textures with mipmaps. +The texture filter reads from the nearest pixel and blends between the nearest 2 mipmaps (or uses the nearest mipmap if :ref:`ProjectSettings.rendering/textures/default_filters/use_nearest_mipmap_filter<class_ProjectSettings_property_rendering/textures/default_filters/use_nearest_mipmap_filter>` is ``true``). This makes the texture look pixelated from up close, and smooth from a distance. + +Use this for non-pixel art textures that may be viewed at a low scale (e.g. due to :ref:`Camera2D<class_Camera2D>` zoom or sprite scaling), as mipmaps are important to smooth out pixels that are smaller than on-screen pixels. .. _class_VisualShaderNodeTextureParameter_constant_FILTER_LINEAR_MIPMAP: @@ -188,7 +190,9 @@ The texture filter reads from the nearest pixel in the nearest mipmap. This is t :ref:`TextureFilter<enum_VisualShaderNodeTextureParameter_TextureFilter>` **FILTER_LINEAR_MIPMAP** = ``4`` -The texture filter blends between the nearest 4 pixels and between the nearest 2 mipmaps. Use this for non-pixel art textures that may be viewed at a low scale (e.g. due to :ref:`Camera2D<class_Camera2D>` zoom), as mipmaps are important to smooth out pixels that are smaller than on-screen pixels. +The texture filter blends between the nearest 4 pixels and between the nearest 2 mipmaps (or uses the nearest mipmap if :ref:`ProjectSettings.rendering/textures/default_filters/use_nearest_mipmap_filter<class_ProjectSettings_property_rendering/textures/default_filters/use_nearest_mipmap_filter>` is ``true``). This makes the texture look smooth from up close, and smooth from a distance. + +Use this for non-pixel art textures that may be viewed at a low scale (e.g. due to :ref:`Camera2D<class_Camera2D>` zoom or sprite scaling), as mipmaps are important to smooth out pixels that are smaller than on-screen pixels. .. _class_VisualShaderNodeTextureParameter_constant_FILTER_NEAREST_MIPMAP_ANISOTROPIC: @@ -196,9 +200,9 @@ The texture filter blends between the nearest 4 pixels and between the nearest 2 :ref:`TextureFilter<enum_VisualShaderNodeTextureParameter_TextureFilter>` **FILTER_NEAREST_MIPMAP_ANISOTROPIC** = ``5`` -The texture filter reads from the nearest pixel, but selects a mipmap based on the angle between the surface and the camera view. This reduces artifacts on surfaces that are almost in line with the camera. The anisotropic filtering level can be changed by adjusting :ref:`ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level<class_ProjectSettings_property_rendering/textures/default_filters/anisotropic_filtering_level>`. +The texture filter reads from the nearest pixel and blends between 2 mipmaps (or uses the nearest mipmap if :ref:`ProjectSettings.rendering/textures/default_filters/use_nearest_mipmap_filter<class_ProjectSettings_property_rendering/textures/default_filters/use_nearest_mipmap_filter>` is ``true``) based on the angle between the surface and the camera view. This makes the texture look pixelated from up close, and smooth from a distance. Anisotropic filtering improves texture quality on surfaces that are almost in line with the camera, but is slightly slower. The anisotropic filtering level can be changed by adjusting :ref:`ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level<class_ProjectSettings_property_rendering/textures/default_filters/anisotropic_filtering_level>`. -\ **Note:** This texture filter is rarely useful in 2D projects. :ref:`FILTER_LINEAR_MIPMAP<class_VisualShaderNodeTextureParameter_constant_FILTER_LINEAR_MIPMAP>` is usually more appropriate. +\ **Note:** This texture filter is rarely useful in 2D projects. :ref:`FILTER_NEAREST_MIPMAP<class_VisualShaderNodeTextureParameter_constant_FILTER_NEAREST_MIPMAP>` is usually more appropriate in this case. .. _class_VisualShaderNodeTextureParameter_constant_FILTER_LINEAR_MIPMAP_ANISOTROPIC: @@ -206,9 +210,9 @@ The texture filter reads from the nearest pixel, but selects a mipmap based on t :ref:`TextureFilter<enum_VisualShaderNodeTextureParameter_TextureFilter>` **FILTER_LINEAR_MIPMAP_ANISOTROPIC** = ``6`` -The texture filter blends between the nearest 4 pixels and selects a mipmap based on the angle between the surface and the camera view. This reduces artifacts on surfaces that are almost in line with the camera. This is the slowest of the filtering options, but results in the highest quality texturing. The anisotropic filtering level can be changed by adjusting :ref:`ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level<class_ProjectSettings_property_rendering/textures/default_filters/anisotropic_filtering_level>`. +The texture filter blends between the nearest 4 pixels and blends between 2 mipmaps (or uses the nearest mipmap if :ref:`ProjectSettings.rendering/textures/default_filters/use_nearest_mipmap_filter<class_ProjectSettings_property_rendering/textures/default_filters/use_nearest_mipmap_filter>` is ``true``) based on the angle between the surface and the camera view. This makes the texture look smooth from up close, and smooth from a distance. Anisotropic filtering improves texture quality on surfaces that are almost in line with the camera, but is slightly slower. The anisotropic filtering level can be changed by adjusting :ref:`ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level<class_ProjectSettings_property_rendering/textures/default_filters/anisotropic_filtering_level>`. -\ **Note:** This texture filter is rarely useful in 2D projects. :ref:`FILTER_LINEAR_MIPMAP<class_VisualShaderNodeTextureParameter_constant_FILTER_LINEAR_MIPMAP>` is usually more appropriate. +\ **Note:** This texture filter is rarely useful in 2D projects. :ref:`FILTER_LINEAR_MIPMAP<class_VisualShaderNodeTextureParameter_constant_FILTER_LINEAR_MIPMAP>` is usually more appropriate in this case. .. _class_VisualShaderNodeTextureParameter_constant_FILTER_MAX: diff --git a/classes/class_visualshadernodetextureparametertriplanar.rst b/classes/class_visualshadernodetextureparametertriplanar.rst index 9c2deaf38..45fc37e92 100644 --- a/classes/class_visualshadernodetextureparametertriplanar.rst +++ b/classes/class_visualshadernodetextureparametertriplanar.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeTextureParameterTriplanar.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeTextureParameterTriplanar.xml. .. _class_VisualShaderNodeTextureParameterTriplanar: diff --git a/classes/class_visualshadernodetexturesdf.rst b/classes/class_visualshadernodetexturesdf.rst index 0f3a9cff5..6479afbdf 100644 --- a/classes/class_visualshadernodetexturesdf.rst +++ b/classes/class_visualshadernodetexturesdf.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeTextureSDF.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeTextureSDF.xml. .. _class_VisualShaderNodeTextureSDF: diff --git a/classes/class_visualshadernodetexturesdfnormal.rst b/classes/class_visualshadernodetexturesdfnormal.rst index 87f75a592..3fb304f23 100644 --- a/classes/class_visualshadernodetexturesdfnormal.rst +++ b/classes/class_visualshadernodetexturesdfnormal.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeTextureSDFNormal.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeTextureSDFNormal.xml. .. _class_VisualShaderNodeTextureSDFNormal: diff --git a/classes/class_visualshadernodetransformcompose.rst b/classes/class_visualshadernodetransformcompose.rst index f7e9dd54d..0491bff12 100644 --- a/classes/class_visualshadernodetransformcompose.rst +++ b/classes/class_visualshadernodetransformcompose.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeTransformCompose.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeTransformCompose.xml. .. _class_VisualShaderNodeTransformCompose: diff --git a/classes/class_visualshadernodetransformconstant.rst b/classes/class_visualshadernodetransformconstant.rst index 1b140cbf2..1fd35db01 100644 --- a/classes/class_visualshadernodetransformconstant.rst +++ b/classes/class_visualshadernodetransformconstant.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeTransformConstant.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeTransformConstant.xml. .. _class_VisualShaderNodeTransformConstant: diff --git a/classes/class_visualshadernodetransformdecompose.rst b/classes/class_visualshadernodetransformdecompose.rst index 21add3494..cf607ead5 100644 --- a/classes/class_visualshadernodetransformdecompose.rst +++ b/classes/class_visualshadernodetransformdecompose.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeTransformDecompose.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeTransformDecompose.xml. .. _class_VisualShaderNodeTransformDecompose: diff --git a/classes/class_visualshadernodetransformfunc.rst b/classes/class_visualshadernodetransformfunc.rst index 6329aac5f..a93c68bb8 100644 --- a/classes/class_visualshadernodetransformfunc.rst +++ b/classes/class_visualshadernodetransformfunc.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeTransformFunc.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeTransformFunc.xml. .. _class_VisualShaderNodeTransformFunc: diff --git a/classes/class_visualshadernodetransformop.rst b/classes/class_visualshadernodetransformop.rst index 68abde405..438f6e87b 100644 --- a/classes/class_visualshadernodetransformop.rst +++ b/classes/class_visualshadernodetransformop.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeTransformOp.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeTransformOp.xml. .. _class_VisualShaderNodeTransformOp: diff --git a/classes/class_visualshadernodetransformparameter.rst b/classes/class_visualshadernodetransformparameter.rst index ca5e54bfa..9c9007f13 100644 --- a/classes/class_visualshadernodetransformparameter.rst +++ b/classes/class_visualshadernodetransformparameter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeTransformParameter.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeTransformParameter.xml. .. _class_VisualShaderNodeTransformParameter: diff --git a/classes/class_visualshadernodetransformvecmult.rst b/classes/class_visualshadernodetransformvecmult.rst index 11e189b2c..37661334c 100644 --- a/classes/class_visualshadernodetransformvecmult.rst +++ b/classes/class_visualshadernodetransformvecmult.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeTransformVecMult.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeTransformVecMult.xml. .. _class_VisualShaderNodeTransformVecMult: diff --git a/classes/class_visualshadernodeuintconstant.rst b/classes/class_visualshadernodeuintconstant.rst index eda432e59..e9028ec27 100644 --- a/classes/class_visualshadernodeuintconstant.rst +++ b/classes/class_visualshadernodeuintconstant.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeUIntConstant.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeUIntConstant.xml. .. _class_VisualShaderNodeUIntConstant: diff --git a/classes/class_visualshadernodeuintfunc.rst b/classes/class_visualshadernodeuintfunc.rst index f5bada1ea..bc8e81f7d 100644 --- a/classes/class_visualshadernodeuintfunc.rst +++ b/classes/class_visualshadernodeuintfunc.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeUIntFunc.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeUIntFunc.xml. .. _class_VisualShaderNodeUIntFunc: diff --git a/classes/class_visualshadernodeuintop.rst b/classes/class_visualshadernodeuintop.rst index 77c25c5c1..f4f5b2bf2 100644 --- a/classes/class_visualshadernodeuintop.rst +++ b/classes/class_visualshadernodeuintop.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeUIntOp.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeUIntOp.xml. .. _class_VisualShaderNodeUIntOp: diff --git a/classes/class_visualshadernodeuintparameter.rst b/classes/class_visualshadernodeuintparameter.rst index 81d7a492a..f9f5ddf47 100644 --- a/classes/class_visualshadernodeuintparameter.rst +++ b/classes/class_visualshadernodeuintparameter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeUIntParameter.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeUIntParameter.xml. .. _class_VisualShaderNodeUIntParameter: diff --git a/classes/class_visualshadernodeuvfunc.rst b/classes/class_visualshadernodeuvfunc.rst index d47b64841..a5d572e09 100644 --- a/classes/class_visualshadernodeuvfunc.rst +++ b/classes/class_visualshadernodeuvfunc.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeUVFunc.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeUVFunc.xml. .. _class_VisualShaderNodeUVFunc: diff --git a/classes/class_visualshadernodeuvpolarcoord.rst b/classes/class_visualshadernodeuvpolarcoord.rst index 85943b116..a06bf9b99 100644 --- a/classes/class_visualshadernodeuvpolarcoord.rst +++ b/classes/class_visualshadernodeuvpolarcoord.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeUVPolarCoord.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeUVPolarCoord.xml. .. _class_VisualShaderNodeUVPolarCoord: diff --git a/classes/class_visualshadernodevarying.rst b/classes/class_visualshadernodevarying.rst index 3ebad00c5..318b88fdb 100644 --- a/classes/class_visualshadernodevarying.rst +++ b/classes/class_visualshadernodevarying.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeVarying.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeVarying.xml. .. _class_VisualShaderNodeVarying: diff --git a/classes/class_visualshadernodevaryinggetter.rst b/classes/class_visualshadernodevaryinggetter.rst index 928fe3ebf..d5899e156 100644 --- a/classes/class_visualshadernodevaryinggetter.rst +++ b/classes/class_visualshadernodevaryinggetter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeVaryingGetter.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeVaryingGetter.xml. .. _class_VisualShaderNodeVaryingGetter: diff --git a/classes/class_visualshadernodevaryingsetter.rst b/classes/class_visualshadernodevaryingsetter.rst index 714ef3d8b..145c96664 100644 --- a/classes/class_visualshadernodevaryingsetter.rst +++ b/classes/class_visualshadernodevaryingsetter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeVaryingSetter.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeVaryingSetter.xml. .. _class_VisualShaderNodeVaryingSetter: diff --git a/classes/class_visualshadernodevec2constant.rst b/classes/class_visualshadernodevec2constant.rst index 6e75e7d04..02d36ee35 100644 --- a/classes/class_visualshadernodevec2constant.rst +++ b/classes/class_visualshadernodevec2constant.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeVec2Constant.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeVec2Constant.xml. .. _class_VisualShaderNodeVec2Constant: diff --git a/classes/class_visualshadernodevec2parameter.rst b/classes/class_visualshadernodevec2parameter.rst index 3876e2fff..ff6a55fdf 100644 --- a/classes/class_visualshadernodevec2parameter.rst +++ b/classes/class_visualshadernodevec2parameter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeVec2Parameter.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeVec2Parameter.xml. .. _class_VisualShaderNodeVec2Parameter: diff --git a/classes/class_visualshadernodevec3constant.rst b/classes/class_visualshadernodevec3constant.rst index 2e6db594b..6b3a8536f 100644 --- a/classes/class_visualshadernodevec3constant.rst +++ b/classes/class_visualshadernodevec3constant.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeVec3Constant.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeVec3Constant.xml. .. _class_VisualShaderNodeVec3Constant: diff --git a/classes/class_visualshadernodevec3parameter.rst b/classes/class_visualshadernodevec3parameter.rst index 06b5da199..b53ed7b6b 100644 --- a/classes/class_visualshadernodevec3parameter.rst +++ b/classes/class_visualshadernodevec3parameter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeVec3Parameter.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeVec3Parameter.xml. .. _class_VisualShaderNodeVec3Parameter: diff --git a/classes/class_visualshadernodevec4constant.rst b/classes/class_visualshadernodevec4constant.rst index 3c104ce3b..c3fa32891 100644 --- a/classes/class_visualshadernodevec4constant.rst +++ b/classes/class_visualshadernodevec4constant.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeVec4Constant.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeVec4Constant.xml. .. _class_VisualShaderNodeVec4Constant: diff --git a/classes/class_visualshadernodevec4parameter.rst b/classes/class_visualshadernodevec4parameter.rst index 5f0b22e9c..211ac8eca 100644 --- a/classes/class_visualshadernodevec4parameter.rst +++ b/classes/class_visualshadernodevec4parameter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeVec4Parameter.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeVec4Parameter.xml. .. _class_VisualShaderNodeVec4Parameter: diff --git a/classes/class_visualshadernodevectorbase.rst b/classes/class_visualshadernodevectorbase.rst index d42aca534..19f2f37da 100644 --- a/classes/class_visualshadernodevectorbase.rst +++ b/classes/class_visualshadernodevectorbase.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeVectorBase.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeVectorBase.xml. .. _class_VisualShaderNodeVectorBase: diff --git a/classes/class_visualshadernodevectorcompose.rst b/classes/class_visualshadernodevectorcompose.rst index 735d98834..65c8113f0 100644 --- a/classes/class_visualshadernodevectorcompose.rst +++ b/classes/class_visualshadernodevectorcompose.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeVectorCompose.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeVectorCompose.xml. .. _class_VisualShaderNodeVectorCompose: diff --git a/classes/class_visualshadernodevectordecompose.rst b/classes/class_visualshadernodevectordecompose.rst index 5ba6a3305..11e8e1f84 100644 --- a/classes/class_visualshadernodevectordecompose.rst +++ b/classes/class_visualshadernodevectordecompose.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeVectorDecompose.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeVectorDecompose.xml. .. _class_VisualShaderNodeVectorDecompose: diff --git a/classes/class_visualshadernodevectordistance.rst b/classes/class_visualshadernodevectordistance.rst index 147c49c43..c38aea133 100644 --- a/classes/class_visualshadernodevectordistance.rst +++ b/classes/class_visualshadernodevectordistance.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeVectorDistance.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeVectorDistance.xml. .. _class_VisualShaderNodeVectorDistance: diff --git a/classes/class_visualshadernodevectorfunc.rst b/classes/class_visualshadernodevectorfunc.rst index a8507384f..c2074ef86 100644 --- a/classes/class_visualshadernodevectorfunc.rst +++ b/classes/class_visualshadernodevectorfunc.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeVectorFunc.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeVectorFunc.xml. .. _class_VisualShaderNodeVectorFunc: diff --git a/classes/class_visualshadernodevectorlen.rst b/classes/class_visualshadernodevectorlen.rst index 44ccf60b2..ad799938a 100644 --- a/classes/class_visualshadernodevectorlen.rst +++ b/classes/class_visualshadernodevectorlen.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeVectorLen.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeVectorLen.xml. .. _class_VisualShaderNodeVectorLen: diff --git a/classes/class_visualshadernodevectorop.rst b/classes/class_visualshadernodevectorop.rst index 305516d39..dd639affe 100644 --- a/classes/class_visualshadernodevectorop.rst +++ b/classes/class_visualshadernodevectorop.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeVectorOp.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeVectorOp.xml. .. _class_VisualShaderNodeVectorOp: diff --git a/classes/class_visualshadernodevectorrefract.rst b/classes/class_visualshadernodevectorrefract.rst index f32fff90b..f2092d082 100644 --- a/classes/class_visualshadernodevectorrefract.rst +++ b/classes/class_visualshadernodevectorrefract.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeVectorRefract.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeVectorRefract.xml. .. _class_VisualShaderNodeVectorRefract: diff --git a/classes/class_visualshadernodeworldpositionfromdepth.rst b/classes/class_visualshadernodeworldpositionfromdepth.rst index 83f0c66d7..e2d441b2c 100644 --- a/classes/class_visualshadernodeworldpositionfromdepth.rst +++ b/classes/class_visualshadernodeworldpositionfromdepth.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeWorldPositionFromDepth.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VisualShaderNodeWorldPositionFromDepth.xml. .. _class_VisualShaderNodeWorldPositionFromDepth: diff --git a/classes/class_voxelgi.rst b/classes/class_voxelgi.rst index 4f58febec..d35872900 100644 --- a/classes/class_voxelgi.rst +++ b/classes/class_voxelgi.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VoxelGI.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VoxelGI.xml. .. _class_VoxelGI: diff --git a/classes/class_voxelgidata.rst b/classes/class_voxelgidata.rst index bc14248c5..b969f8562 100644 --- a/classes/class_voxelgidata.rst +++ b/classes/class_voxelgidata.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VoxelGIData.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VoxelGIData.xml. .. _class_VoxelGIData: diff --git a/classes/class_vscrollbar.rst b/classes/class_vscrollbar.rst index 1ce6a98b3..437ff02f3 100644 --- a/classes/class_vscrollbar.rst +++ b/classes/class_vscrollbar.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VScrollBar.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VScrollBar.xml. .. _class_VScrollBar: diff --git a/classes/class_vseparator.rst b/classes/class_vseparator.rst index ed3dd8bd6..6b0776454 100644 --- a/classes/class_vseparator.rst +++ b/classes/class_vseparator.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VSeparator.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VSeparator.xml. .. _class_VSeparator: diff --git a/classes/class_vslider.rst b/classes/class_vslider.rst index 9cf0cd0fa..4adb20284 100644 --- a/classes/class_vslider.rst +++ b/classes/class_vslider.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VSlider.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VSlider.xml. .. _class_VSlider: diff --git a/classes/class_vsplitcontainer.rst b/classes/class_vsplitcontainer.rst index 92ce0c6eb..ac7c6b706 100644 --- a/classes/class_vsplitcontainer.rst +++ b/classes/class_vsplitcontainer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VSplitContainer.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/VSplitContainer.xml. .. _class_VSplitContainer: diff --git a/classes/class_weakref.rst b/classes/class_weakref.rst index 4d59894aa..946272f4e 100644 --- a/classes/class_weakref.rst +++ b/classes/class_weakref.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/WeakRef.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/WeakRef.xml. .. _class_WeakRef: diff --git a/classes/class_webrtcdatachannel.rst b/classes/class_webrtcdatachannel.rst index 6486ccf5b..26ec071d2 100644 --- a/classes/class_webrtcdatachannel.rst +++ b/classes/class_webrtcdatachannel.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/webrtc/doc_classes/WebRTCDataChannel.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/webrtc/doc_classes/WebRTCDataChannel.xml. .. _class_WebRTCDataChannel: diff --git a/classes/class_webrtcdatachannelextension.rst b/classes/class_webrtcdatachannelextension.rst index 26ad43121..788880299 100644 --- a/classes/class_webrtcdatachannelextension.rst +++ b/classes/class_webrtcdatachannelextension.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/webrtc/doc_classes/WebRTCDataChannelExtension.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/webrtc/doc_classes/WebRTCDataChannelExtension.xml. .. _class_WebRTCDataChannelExtension: diff --git a/classes/class_webrtcmultiplayerpeer.rst b/classes/class_webrtcmultiplayerpeer.rst index 1dc714aaf..abfa77026 100644 --- a/classes/class_webrtcmultiplayerpeer.rst +++ b/classes/class_webrtcmultiplayerpeer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/webrtc/doc_classes/WebRTCMultiplayerPeer.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/webrtc/doc_classes/WebRTCMultiplayerPeer.xml. .. _class_WebRTCMultiplayerPeer: diff --git a/classes/class_webrtcpeerconnection.rst b/classes/class_webrtcpeerconnection.rst index 7188fdf4a..31e8ba63c 100644 --- a/classes/class_webrtcpeerconnection.rst +++ b/classes/class_webrtcpeerconnection.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/webrtc/doc_classes/WebRTCPeerConnection.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/webrtc/doc_classes/WebRTCPeerConnection.xml. .. _class_WebRTCPeerConnection: diff --git a/classes/class_webrtcpeerconnectionextension.rst b/classes/class_webrtcpeerconnectionextension.rst index 7e45be5a1..d81ebc781 100644 --- a/classes/class_webrtcpeerconnectionextension.rst +++ b/classes/class_webrtcpeerconnectionextension.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/webrtc/doc_classes/WebRTCPeerConnectionExtension.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/webrtc/doc_classes/WebRTCPeerConnectionExtension.xml. .. _class_WebRTCPeerConnectionExtension: diff --git a/classes/class_websocketmultiplayerpeer.rst b/classes/class_websocketmultiplayerpeer.rst index 2ec1fa173..863d6ea0d 100644 --- a/classes/class_websocketmultiplayerpeer.rst +++ b/classes/class_websocketmultiplayerpeer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml. .. _class_WebSocketMultiplayerPeer: diff --git a/classes/class_websocketpeer.rst b/classes/class_websocketpeer.rst index 1cc7542a6..4cff0c0d0 100644 --- a/classes/class_websocketpeer.rst +++ b/classes/class_websocketpeer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/websocket/doc_classes/WebSocketPeer.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/websocket/doc_classes/WebSocketPeer.xml. .. _class_WebSocketPeer: diff --git a/classes/class_webxrinterface.rst b/classes/class_webxrinterface.rst index 5b26677f6..24fa549a9 100644 --- a/classes/class_webxrinterface.rst +++ b/classes/class_webxrinterface.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/webxr/doc_classes/WebXRInterface.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/webxr/doc_classes/WebXRInterface.xml. .. _class_WebXRInterface: diff --git a/classes/class_window.rst b/classes/class_window.rst index 17e3e4258..f345ec5b2 100644 --- a/classes/class_window.rst +++ b/classes/class_window.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Window.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Window.xml. .. _class_Window: @@ -1611,7 +1611,7 @@ Ends a bulk theme override update. See :ref:`begin_bulk_theme_override<class_Win :ref:`Vector2<class_Vector2>` **get_contents_minimum_size** **(** **)** |const| -Returns the combined minimum size from the child :ref:`Control<class_Control>` nodes of the window. Use :ref:`child_controls_changed<class_Window_method_child_controls_changed>` to update it when children nodes have changed. +Returns the combined minimum size from the child :ref:`Control<class_Control>` nodes of the window. Use :ref:`child_controls_changed<class_Window_method_child_controls_changed>` to update it when child nodes have changed. The value returned by this method can be overridden with :ref:`_get_contents_minimum_size<class_Window_private_method__get_contents_minimum_size>`. diff --git a/classes/class_workerthreadpool.rst b/classes/class_workerthreadpool.rst index 6e2cda3d4..b6368f0b2 100644 --- a/classes/class_workerthreadpool.rst +++ b/classes/class_workerthreadpool.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/WorkerThreadPool.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/WorkerThreadPool.xml. .. _class_WorkerThreadPool: diff --git a/classes/class_world2d.rst b/classes/class_world2d.rst index f92612b95..3211d8f7d 100644 --- a/classes/class_world2d.rst +++ b/classes/class_world2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/World2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/World2D.xml. .. _class_World2D: diff --git a/classes/class_world3d.rst b/classes/class_world3d.rst index bff502856..f1e3fa97e 100644 --- a/classes/class_world3d.rst +++ b/classes/class_world3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/World3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/World3D.xml. .. _class_World3D: diff --git a/classes/class_worldboundaryshape2d.rst b/classes/class_worldboundaryshape2d.rst index a1b56eb9a..5b4b57b66 100644 --- a/classes/class_worldboundaryshape2d.rst +++ b/classes/class_worldboundaryshape2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/WorldBoundaryShape2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/WorldBoundaryShape2D.xml. .. _class_WorldBoundaryShape2D: diff --git a/classes/class_worldboundaryshape3d.rst b/classes/class_worldboundaryshape3d.rst index 62d4d912a..5f36b2626 100644 --- a/classes/class_worldboundaryshape3d.rst +++ b/classes/class_worldboundaryshape3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/WorldBoundaryShape3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/WorldBoundaryShape3D.xml. .. _class_WorldBoundaryShape3D: diff --git a/classes/class_worldenvironment.rst b/classes/class_worldenvironment.rst index d957c6a09..8b208212f 100644 --- a/classes/class_worldenvironment.rst +++ b/classes/class_worldenvironment.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/WorldEnvironment.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/WorldEnvironment.xml. .. _class_WorldEnvironment: diff --git a/classes/class_x509certificate.rst b/classes/class_x509certificate.rst index e900e7cf8..1ba8900e7 100644 --- a/classes/class_x509certificate.rst +++ b/classes/class_x509certificate.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/X509Certificate.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/X509Certificate.xml. .. _class_X509Certificate: diff --git a/classes/class_xmlparser.rst b/classes/class_xmlparser.rst index feca2a542..fb1d03c9b 100644 --- a/classes/class_xmlparser.rst +++ b/classes/class_xmlparser.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/XMLParser.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/XMLParser.xml. .. _class_XMLParser: diff --git a/classes/class_xranchor3d.rst b/classes/class_xranchor3d.rst index fbf6feac2..dba7a64b9 100644 --- a/classes/class_xranchor3d.rst +++ b/classes/class_xranchor3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/XRAnchor3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/XRAnchor3D.xml. .. _class_XRAnchor3D: diff --git a/classes/class_xrcamera3d.rst b/classes/class_xrcamera3d.rst index 5f795fec9..2b4624f62 100644 --- a/classes/class_xrcamera3d.rst +++ b/classes/class_xrcamera3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/XRCamera3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/XRCamera3D.xml. .. _class_XRCamera3D: diff --git a/classes/class_xrcontroller3d.rst b/classes/class_xrcontroller3d.rst index 6c270f2f9..cb1437994 100644 --- a/classes/class_xrcontroller3d.rst +++ b/classes/class_xrcontroller3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/XRController3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/XRController3D.xml. .. _class_XRController3D: diff --git a/classes/class_xrinterface.rst b/classes/class_xrinterface.rst index c535049ad..4926025f1 100644 --- a/classes/class_xrinterface.rst +++ b/classes/class_xrinterface.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/XRInterface.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/XRInterface.xml. .. _class_XRInterface: diff --git a/classes/class_xrinterfaceextension.rst b/classes/class_xrinterfaceextension.rst index ede448295..560acabbb 100644 --- a/classes/class_xrinterfaceextension.rst +++ b/classes/class_xrinterfaceextension.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/XRInterfaceExtension.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/XRInterfaceExtension.xml. .. _class_XRInterfaceExtension: diff --git a/classes/class_xrnode3d.rst b/classes/class_xrnode3d.rst index 9f3ba27f1..5dda3927f 100644 --- a/classes/class_xrnode3d.rst +++ b/classes/class_xrnode3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/XRNode3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/XRNode3D.xml. .. _class_XRNode3D: diff --git a/classes/class_xrorigin3d.rst b/classes/class_xrorigin3d.rst index 31c8aaab4..911ceabfb 100644 --- a/classes/class_xrorigin3d.rst +++ b/classes/class_xrorigin3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/XROrigin3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/XROrigin3D.xml. .. _class_XROrigin3D: @@ -21,11 +21,11 @@ Description This is a special node within the AR/VR system that maps the physical location of the center of our tracking space to the virtual location within our game world. -There should be only one of these nodes in your scene and you must have one. All the XRCamera3D, XRController3D and XRAnchor3D nodes should be direct children of this node for spatial tracking to work correctly. +Multiple origin points can be added to the scene tree, but only one can used at a time. All the :ref:`XRCamera3D<class_XRCamera3D>`, :ref:`XRController3D<class_XRController3D>`, and :ref:`XRAnchor3D<class_XRAnchor3D>` nodes should be direct children of this node for spatial tracking to work correctly. It is the position of this node that you update when your character needs to move through your game world while we're not moving in the real world. Movement in the real world is always in relation to this origin point. -For example, if your character is driving a car, the XROrigin3D node should be a child node of this car. Or, if you're implementing a teleport system to move your character, you should change the position of this node. +For example, if your character is driving a car, the **XROrigin3D** node should be a child node of this car. Or, if you're implementing a teleport system to move your character, you should change the position of this node. .. rst-class:: classref-introduction-group @@ -68,7 +68,7 @@ Property Descriptions - void **set_current** **(** :ref:`bool<class_bool>` value **)** - :ref:`bool<class_bool>` **is_current** **(** **)** -Is this XROrigin3D node the current origin used by the :ref:`XRServer<class_XRServer>`? +If ``true``, this origin node is currently being used by the :ref:`XRServer<class_XRServer>`. Only one origin point can be used at a time. .. rst-class:: classref-item-separator @@ -85,9 +85,7 @@ Is this XROrigin3D node the current origin used by the :ref:`XRServer<class_XRSe - void **set_world_scale** **(** :ref:`float<class_float>` value **)** - :ref:`float<class_float>` **get_world_scale** **(** **)** -Allows you to adjust the scale to your game's units. Most AR/VR platforms assume a scale of 1 game world unit = 1 real world meter. - -\ **Note:** This method is a passthrough to the :ref:`XRServer<class_XRServer>` itself. +The scale of the game world compared to the real world. This is the same as :ref:`XRServer.world_scale<class_XRServer_property_world_scale>`. By default, most AR/VR platforms assume that 1 game unit corresponds to 1 real world meter. .. |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_xrpose.rst b/classes/class_xrpose.rst index 94f17febd..15f196079 100644 --- a/classes/class_xrpose.rst +++ b/classes/class_xrpose.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/XRPose.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/XRPose.xml. .. _class_XRPose: diff --git a/classes/class_xrpositionaltracker.rst b/classes/class_xrpositionaltracker.rst index 28078ef53..caf6fdcce 100644 --- a/classes/class_xrpositionaltracker.rst +++ b/classes/class_xrpositionaltracker.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/XRPositionalTracker.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/XRPositionalTracker.xml. .. _class_XRPositionalTracker: diff --git a/classes/class_xrserver.rst b/classes/class_xrserver.rst index a32116e91..75fbda39d 100644 --- a/classes/class_xrserver.rst +++ b/classes/class_xrserver.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/XRServer.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/XRServer.xml. .. _class_XRServer: @@ -306,7 +306,7 @@ The current origin of our tracking space in the virtual world. This is used by t - void **set_world_scale** **(** :ref:`float<class_float>` value **)** - :ref:`float<class_float>` **get_world_scale** **(** **)** -Allows you to adjust the scale to your game's units. Most AR/VR platforms assume a scale of 1 game world unit = 1 real world meter. +The scale of the game world compared to the real world. By default, most AR/VR platforms assume that 1 game unit corresponds to 1 real world meter. .. rst-class:: classref-section-separator diff --git a/classes/class_zippacker.rst b/classes/class_zippacker.rst index 04c2512fb..d50171d6b 100644 --- a/classes/class_zippacker.rst +++ b/classes/class_zippacker.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/zip/doc_classes/ZIPPacker.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/zip/doc_classes/ZIPPacker.xml. .. _class_ZIPPacker: diff --git a/classes/class_zipreader.rst b/classes/class_zipreader.rst index 66252b9e7..edbabb19f 100644 --- a/classes/class_zipreader.rst +++ b/classes/class_zipreader.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/modules/zip/doc_classes/ZIPReader.xml. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/4.2/modules/zip/doc_classes/ZIPReader.xml. .. _class_ZIPReader: diff --git a/classes/index.rst b/classes/index.rst index 8731b60a2..dc6910ec0 100644 --- a/classes/index.rst +++ b/classes/index.rst @@ -3,7 +3,7 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. .. _doc_class_reference: